idnits 2.17.1 draft-iab-svg-rfc-02.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** The document seems to lack a Security Considerations section. == There are 1 instance of lines with non-RFC2606-compliant FQDNs in the document. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year -- The document date (February 26, 2016) is 2981 days in the past. Is this intentional? -- Found something which looks like a code comment -- if you have code sections in the document, please surround them with '' and '' lines. Checking references for intended status: Informational ---------------------------------------------------------------------------- == Missing Reference: 'SVG' is mentioned on line 80, but not defined == Outdated reference: A later version (-04) exists of draft-iab-xml2rfc-03 -- Obsolete informational reference (is this intentional?): RFC 793 (Obsoleted by RFC 9293) Summary: 1 error (**), 0 flaws (~~), 4 warnings (==), 3 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Network Working Group N. Brownlee 3 Internet-Draft The University of Auckland 4 Intended status: Informational IAB 5 Expires: August 29, 2016 February 26, 2016 7 SVG Drawings for RFCs: SVG 1.2 RFC 8 draft-iab-svg-rfc-02 10 Abstract 12 . Maybe the text in section This document specifies SVG 1.2 RFC - an 13 SVG profile for use in diagrams that may appear in RFCs - and 14 considers some of the issues concerning the creation and use of such 15 diagrams. 17 Status of This Memo 19 This Internet-Draft is submitted in full conformance with the 20 provisions of BCP 78 and BCP 79. 22 Internet-Drafts are working documents of the Internet Engineering 23 Task Force (IETF). Note that other groups may also distribute 24 working documents as Internet-Drafts. The list of current Internet- 25 Drafts is at http://datatracker.ietf.org/drafts/current/. 27 Internet-Drafts are draft documents valid for a maximum of six months 28 and may be updated, replaced, or obsoleted by other documents at any 29 time. It is inappropriate to use Internet-Drafts as reference 30 material or to cite them other than as "work in progress." 32 This Internet-Draft will expire on August 29, 2016. 34 Copyright Notice 36 Copyright (c) 2016 IETF Trust and the persons identified as the 37 document authors. All rights reserved. 39 This document is subject to BCP 78 and the IETF Trust's Legal 40 Provisions Relating to IETF Documents 41 (http://trustee.ietf.org/license-info) in effect on the date of 42 publication of this document. Please review these documents 43 carefully, as they describe your rights and restrictions with respect 44 to this document. Code Components extracted from this document must 45 include Simplified BSD License text as described in Section 4.e of 46 the Trust Legal Provisions and are provided without warranty as 47 described in the Simplified BSD License. 49 Table of Contents 51 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 52 2. SVG 1.2 RFC: An SVG profile for RFCs . . . . . . . . . . . . 3 53 2.1. Elements, properties and attributes allowed in SVG 1.2 54 RFC . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 55 3. How to create SVG drawings . . . . . . . . . . . . . . . . . 6 56 4. Accessibility Considerations . . . . . . . . . . . . . . . . 7 57 5. Examples of diagrams common in RFCs . . . . . . . . . . . . . 8 58 5.1. Packet Layout Diagrams . . . . . . . . . . . . . . . . . 8 59 5.2. Sequence Diagrams (1) . . . . . . . . . . . . . . . . . . 8 60 5.3. Sequence Diagrams (2) . . . . . . . . . . . . . . . . . . 8 61 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 8 62 7. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 8 63 8. Revision History [RFC Editor please delete] . . . . . . . . . 8 64 9. References . . . . . . . . . . . . . . . . . . . . . . . . . 10 65 9.1. Normative References . . . . . . . . . . . . . . . . . . 10 66 9.2. Informative References . . . . . . . . . . . . . . . . . 11 67 Appendix A. RELAX NG Compact (rnc) Schema for SVG 1.2 RFC . . . 12 68 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 53 70 1. Introduction 72 Over the last few years the RFC Editor has worked with the Internet 73 community to develop specifications for changes in the format of 74 RFCs. An outline of the resulting specifications was published as 75 [RFC6949] in May 2013. Since then a Design Team has been working 76 with the RFC Editor to flesh out those specifications. One aspect of 77 the changes is to allow line drawings in RFCs; [RFC6949] says 79 "Graphics may include ASCII art and a more complex form to be 80 defined, such as SVG line art [SVG]. Color and grayscale will not 81 be accepted. RFCs must correctly display in monochromatic black- 82 and-white to allow for monochrome displays, black-and-white 83 printing, and support for visual disabilities." 85 SVG (Scalable Vector Graphics) has been developed by W3C, the World 86 Wide Web Consortium; its current standard is SVG 1.1 Full 87 [W3C.REC-SVG11-20110816]. This document defines SVG 1.2 RFC, an SVG 88 profile (i.e. a subset of SVG) that is suitable for RFC line 89 drawings. 91 Note that in RFCs, the text provides normative descriptions of 92 protocols, systems, etc. Diagrams may be used to help explain 93 concepts more clearly, but they provide supporting detail, and should 94 not be considered to be complete specifications in themselves. 96 The details (particularly any vocabularies) described in this 97 document are expected to change based on experience gained in 98 implementing the RFC production center's toolset. Revised documents 99 will be published capturing those changes as the toolset is 100 completed. Other implementors must not expect those changes to 101 remain backwards-compatible with the details described in this 102 document. 104 2. SVG 1.2 RFC: An SVG profile for RFCs 106 As a starting point for SVG 1.2 RFC, the Design Team decided to use 107 SVG 1.2 Tiny [W3C.REC-SVGTiny12-20081222]. SVG 1.2 Tiny is an SVG 108 subset intended to be implemented on small, mobile devices such as 109 cellphones and smartphones. That should allow RFCs to be rendered 110 well on such devices, especially those that have small screens. 111 However, RFCs are self-contained documents that do not change once 112 they are published. The use of SVG drawings in RFCs is intended to 113 allow authors to create drawings that are simple to produce, and 114 easier to understand than our traditional 'ASCII Art' ones. In 115 short, we are also trying to improve access to the content in RFCs, 116 so SVG drawings need to be kept as simple as possible. 118 Appendix A (below) provides a complete RELAX NG Compact (rnc) schema 119 for SVG 1.2 RFC. It is derived from the SVG 1.2 schema, and is the 120 formal definition of SVG 1.2 RFC. The remainder of this section 121 gives a simplified - i.e. easier to read and dunderstand - overview 122 of SVG 1.2 RFC. 124 SVG can provide a complete User Interface, but within RFCs, all we 125 need are simple diagrams that do not change once the RFC is 126 published. Therefore, SVG RFC does not allow anything from the 127 following sections in SVG Tiny 1.2 [W3C.REC-SVGTiny12-20081222]: 129 12 Multimedia 130 13 Interactivity 131 15 Scripting 132 16 Animation 133 18 Metadata 134 19 Extensibility 136 Note that SVG Tiny 1.2 elements may have many properties or 137 attributes that are needed to support aspects of the above sections. 138 Those are not allowed in SVG 1.2 RFC. 140 Considering the other sections in SVG Tiny 1.2 141 [W3C.REC-SVGTiny12-20081222]: 143 9 Basic Shapes 145 10 Text 146 Everything in these sections is allowed in SVG 1.2 RFC. 148 11 Painting: Filling, Stroking, Colors and Paint Servers 149 Anything relating to 'color' is not allowed in SVG 1.2 RFC, 150 everything else is allowed. This is a requirement documented in 151 [RFC6949]. 153 14 Linking 154 SVG Tiny 1.2 allows internationalized IRIs in references. In 155 SVG 1.2 RFC such links must be ASCII only. That should not 156 cause problems, since one can just use the URI form of any IRI. 157 Authors should try to use links only to URIs that are long-term 158 stable. 160 17 Fonts 161 SVG 1.2 RFC only allows 'serif', 'sans-serif' and 'monospace' 162 generic font families from the WebFonts facility, described in 163 CSS 2.1, [W3C.REC-CSS2-20110607], section 15, Fonts. In 164 particular, the SVG 'font' element is not allowed. 166 2.1. Elements, properties and attributes allowed in SVG 1.2 RFC 168 Elements, properties and attributes selected for SVG 1.2 RFC from 169 [W3C.REC-SVGTiny12-20081222]. 171 In the list below, elements and properties are listed on the 172 left,and their allowed values are given in parentheses on the 173 right. 175 is the list of allowed colors, a black-and-white 176 subset of the SVG color names. 178