Internet-Draft SVG Tests March 2020
Fossati Expires 14 September 2020 [Page]
Workgroup:
None
Internet-Draft:
draft-fossati-svg-test-03
Published:
Intended Status:
Informational
Expires:
Author:
T. Fossati

SVG Fun with kramdown-rfc2629

Abstract

This memo is for experimenting with SVG in the context of RFC production.

Status of This Memo

This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.

Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at https://datatracker.ietf.org/drafts/current/.

Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."

This Internet-Draft will expire on 14 September 2020.

▲

Table of Contents

1. Introduction

This memo is for experimenting with SVG in the context of RFC production.

This document assumes a kramdown-rfc2629 based editing flow.

1.1. Conventions used in this document

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.

1.2. Tools

Install goat and svgcheck (Go and Python are obvious prerequisites):

$ go get github.com/blampe/goat
$ pip install svgcheck

Install kramdown-rfc2629 (at least 1.3.2):

$ gem install kramdown-rfc2629 -v '>= 1.3.2'

2. Draw

Two options:

    ~~~ goat
     .-.
    |o o|
   C| | |D
    | - |
    '___'
    ~~~

    ~~~ goat
    {::include my-diagram.txt}
    ~~~
    {: #dia-1 title="My Diagram"}

3. Build

To go from markdown to XML, HTML and TXT:

$ kdrfc -3h draft-fossati-svg-test.md

Before submitting to the datatracker the XML file needs to be "prepped":

$ xml2rfc --preptool --v3 draft-fossati-svg-test.xml

The "prepped" file, draft-fossati-svg-test.prepped.xml in this case, is what needs to be uploaded to the datatracker.

4. Examples

4.1. Hello World

o , ` 0 0 Y ) ! `

4.2. An Inlined Sequence Diagram

] ' n > r i e c a v c i ~ i t ~ # A [ e a u ~ f o e t e t T i t ] i n s a u S ( r e i k c < R a r V a c u N d h f a S < w T e t e o d g a a . t C r r r s u c t > r [ N t ] t u n R t a S r d k i w t s e S i i e l n G u e n t i C r a t i i c n a e i a c e a u n ) a e I o n ~ m < E t r u o h R t s l ~ 1 c E - n C i t S o t t i t a t S n t u A u n e T e C t a > r c T h a o g t e v v ) i t p i ~ t n n e q e T e l m t R f r e a S c f i n a S e e A ~ n o s f e R ~ s u n A t R S r i R e e c e ~ ( n d l l C i r e d t n d ~ C e D e a w # [ n i ~ t r a e t e d u h S e A c e d c i a . r g s e i a w o S i A S d z i r ~ T i O e t r f t e i i ~ u d r c e t t e r O n t u e d t i i C g A s ~ i a G l O ( e 2 ) C G n # e i g g n e C n r ~ t A t e g c E i a . y A a e c n i n i d u

4.3. A Sourced "Box and Arrows" Diagram

l A T S S A 2 e R T S S c C 1 T T e l d e 3 C S l l e A P H i s v 6 R i r 7 R E H e d T A l R 2 5 T c S 4 P P M e A 1 d A T T P
Figure 1: STIR Delegation Flow

5. IANA Considerations

No requests are made to IANA.

6. Security Considerations

There are none.

7. Acknowledgments

Yaron for pointing out the current limitations in the tooling and providing the workaround. Carsten for working the kramdown magic.

8. Normative References

[RFC2119]
Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, , <https://www.rfc-editor.org/info/rfc2119>.
[RFC8174]
Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, , <https://www.rfc-editor.org/info/rfc8174>.

Author's Address

Thomas Fossati