commit 0e62fca0deda4e41966070305c5fb5d4ab09c371
parent be9b61ca9f66bf6950e3d2ba60ba2a4ca5822fdf
Author: finwo <finwo@pm.me>
Date: Thu, 4 Jun 2020 18:10:19 +0200
Overwritten 0000 by 0003, it's too similair
Diffstat:
| M | docs/spec/0000.pdf | | | 310 | ++++++++++++++++++++++++++++++++++++++++---------------------------------------- |
| D | docs/spec/0003.pdf | | | 628 | ------------------------------------------------------------------------------- |
| M | src/0000.txt | | | 282 | ++++++++++++++++++++++++++++++++++++++++---------------------------------------- |
| D | src/0003.txt | | | 420 | ------------------------------------------------------------------------------- |
4 files changed, 296 insertions(+), 1344 deletions(-)
diff --git a/docs/spec/0000.pdf b/docs/spec/0000.pdf
@@ -1,7 +1,7 @@
%PDF-1.1
1 0 obj
<<
-/CreationDate (D:20200603125958)
+/CreationDate (D:20200604180922)
/Producer (text2pdf v1.1 (\251 Phil Smith, 1996))
/Title (./0000.txt)
>>
@@ -43,14 +43,14 @@ BT
/F1 10 Tf
1 0 0 1 50 802 Tm
12 TL
-(Specification: 0000 Robin Bron)'
-( Ratus B.V.)'
-( August 2018)'
+(Specification: 0000 Robin Bron)'
+( August 2018)'
+()'
+()'
+( Specification Format)'
()'
-(Obsoleted by: 0003)'
()'
()'
-( Specification Format)'
()'
()'
()'
@@ -99,15 +99,15 @@ BT
( This document is licensed under a)'
( Creative Commons Attribution 4.0 International License)'
()'
-( You should have received a copy of the license along with this work.)'
-( If not, see <http://creativecommons.org/licenses/by/4.0/>)'
+( You should have received a copy of the license along with this work. If not,)'
+( see <http://creativecommons.org/licenses/by/4.0/>)'
()'
-(Bron [Page 1])'
+(Bron [Page 1])'
ET
endstream
endobj
8 0 obj
-866
+810
endobj
9 0 obj
<<
@@ -126,27 +126,27 @@ BT
/F1 10 Tf
1 0 0 1 50 802 Tm
12 TL
-(SPEC 0000 Specification Format August 2018)'
+(SPEC 0000 Specification Format August 2018)'
()'
(Table of contents)'
()'
-( 1. Conventions .................................................. 3)'
-( 2. Character encoding ........................................... 3)'
-( 3. Line definition .............................................. 3)'
-( 3.1 Line numbering ........................................... 3)'
-( 4. Pages ........................................................ 3)'
-( 4.1 Page header .............................................. 3)'
-( 4.2 Page footer .............................................. 3)'
-( 5. Paragraphs ................................................... 4)'
-( 6. Document header .............................................. 4)'
-( 6.1. Descriptive header ...................................... 4)'
-( 6.2. Short author identification ............................. 4)'
-( 6.3. Publish date ............................................ 4)'
-( 7. Document footer .............................................. 5)'
-( 8. Section titles ............................................... 5)'
-( 9. Document title ............................................... 5)'
-( 10. Informative resources ........................................ 6)'
-( 11. Author information ........................................... 7)'
+( 1. Conventions ........................................................... 3)'
+( 2. Character encoding .................................................... 3)'
+( 3. Line definition ....................................................... 3)'
+( 3.1 Line numbering .................................................... 3)'
+( 4. Pages ................................................................. 3)'
+( 4.1 Page header ....................................................... 3)'
+( 4.2 Page footer ....................................................... 3)'
+( 5. Paragraphs ............................................................ 3)'
+( 6. Document header ....................................................... 4)'
+( 6.1. Descriptive header ............................................... 4)'
+( 6.2. Short author identification ...................................... 4)'
+( 6.3. Publish date ..................................................... 4)'
+( 7. Document footer ....................................................... 5)'
+( 8. Section titles ........................................................ 5)'
+( 9. Document title ........................................................ 5)'
+( 10. Informative resources ................................................. 6)'
+( 11. Author information .................................................... 7)'
()'
()'
()'
@@ -185,12 +185,12 @@ BT
()'
()'
()'
-(Bron [Page 2])'
+(Bron [Page 2])'
ET
endstream
endobj
11 0 obj
-1646
+1817
endobj
12 0 obj
<<
@@ -209,71 +209,71 @@ BT
/F1 10 Tf
1 0 0 1 50 802 Tm
12 TL
-(SPEC 0000 Specification Format August 2018)'
+(SPEC 0000 Specification Format August 2018)'
()'
(1. Conventions)'
()'
-( 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)'
-( RFC2119 when, and only when, they appear in all capitals, as shown)'
-( here.)'
+( 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 RFC2119 when, and only when,)'
+( they appear in all capitals, as shown here.)'
()'
(2. Character Encoding)'
()'
-( Plain-text files for specifications MUST use the CP437 standard with)'
-( the exclusion of character code 0x0A which represents a line feed as)'
-( specified in RFC20.)'
+( Plain-text files for specifications MUST use the UTF-8 standard.)'
()'
(3. Line definition)'
()'
-( A line of text is a sequence of 0 or more characters followed by a)'
-( line feed character. For the sake of and clarity, the ending line)'
-( feed character is part of the line.)'
+( A line of text is a sequence of 0 or more characters followed by a line feed)'
+( character. For the sake of and clarity, the ending line feed character is not)'
+( part of the line.)'
()'
-( Lines MUST NOT exceed 72 characters in length, including the ending)'
-( line feed character. A line is called a blank line if it consists of)'
-( only a line feed charachter.)'
+( Lines MUST NOT exceed 80 characters in length, excluding the ending line feed)'
+( character. A line is called a blank line if it consists of 0 characters.)'
()'
(3.1. Line numbering)'
()'
-( To ensure the following page dimension section is clear, we need to)'
-( define how lines are numbered.)'
-()'
-( Assuming a document is in digital format[1] and has a length of)'
-( greater than 0 bytes, the first character in the document is part of)'
-( line 0. Numbering lines from 0 instead of 1 gives us an advantage of)'
-( clarity in the next section.)'
+( Assuming a document is in digital format[1] and has a length of greater than)'
+( 0 bytes, the first character in the document is part of line 1.)'
()'
(4. Pages)'
()'
-( A page is a sequence of 60 lines. That means for every line number)'
-( n, the line is the start of a new page when n mod 60 = 0.)'
+( A page is a sequence of 60 lines. That means for every line number n, the)'
+( line is the start of a new page when n mod 60 = 1.)'
()'
(4.1 Page header)'
()'
-( The first line of a page SHOULD consist of a left-aligned spec)'
-( number indicator, a centered \(short\) document title and a)'
-( right-aligned publishing date \(see 6.3\). The second line of a page)'
-( MUST always be blank, excluding the first page of the document.)'
+( The first line of a page SHOULD consist of a left-aligned spec number)'
+( indicator, a centered \(short\) document title and a right-aligned short)'
+( publishing date \(see 6.3\). Line 2 of a page MUST always be blank, excluding)'
+( the first page of the document.)'
()'
(4.2 Page footer)'
()'
-( The last line of a page MUST consist of a left-align last name of)'
-( the author and a right-aligned page number between square brackets.)'
-( The second-to-last line of a page must be blank, just like the)'
-( second line of a page.)'
+( The last line of a page MUST consist of a left-align last name of the)'
+( author or authors and a right-aligned page number between square brackets.)'
+( The second-to-last line of a page must be blank, just like line 2 of a page.)'
+()'
+(5. Paragraphs)'
+()'
+( A paragraph is a sequence of consecutive lines all of a length greater than 0)'
+( characters. Paragraphs are separated by either one or more blank lines or a)'
+( page break. Paragraphs MUST NOT span multiple pages, limiting their size to)'
+( 56 lines.)'
+()'
+()'
()'
()'
()'
()'
()'
-(Bron [Page 3])'
+()'
+(Bron [Page 3])'
ET
endstream
endobj
14 0 obj
-2292
+2259
endobj
15 0 obj
<<
@@ -292,71 +292,71 @@ BT
/F1 10 Tf
1 0 0 1 50 802 Tm
12 TL
-(SPEC 0000 Specification Format August 2018)'
-()'
-(5. Paragraphs)'
-()'
-( A paragraph is a sequence of consecutive lines containing characters)'
-( other than only a line feed. Paragraphs are separated by either a)'
-( blank line or a page break. Paragraphs MUST NOT span multiple pages,)'
-( limiting their size to 56 lines.)'
+(SPEC 0000 Specification Format August 2018)'
()'
(6. Document header)'
()'
-( The first lines of the first page of a specification document SHALL)'
-( always contain left-aligned description headers \(see 6.1\) and)'
-( right-aligned author identification and a right-aligned publishing)'
-( date.)'
+( The first lines of the first page of a specification document MUST always)'
+( contain left-aligned description headers \(see 6.1\) and right-aligned author)'
+( identification and a right-aligned publishing date.)'
+()'
+( After the initial lines \(see 6.1 through 6.3\), references to other)'
+( specifications MUST be included when the specification obsoletes or updates)'
+( the references specification.)'
()'
-( After the initial lines \(see 6.1 to 6.3\), the document title is)'
-( REQUIRED to be written on the first page of the document. For it's)'
-( specification, see section 9.)'
+( After the initial lines and the references, the document title is REQUIRED to)'
+( be written on the first page of the document. For it's specification, see)'
+( section 9.)'
()'
-( Further information on the first page should give a quick)'
-( description of the contents of the document.)'
+( The bottom of the first page of the document MUST include a copyright notice)'
+( and/or license, a link to the license or the inclusion text required by the)'
+( license in question.)'
()'
(6.1. Descriptive header)'
()'
-( Each descriptive header is made up of a key and a value. Whitespace)'
-( is not allowed in both the key and the value. Whitespace can only be)'
-( included in the value by wrapping the value in quote characters.)'
+( Each descriptive header is made up of a key and a value. Whitespace is not)'
+( allowed in both the key and the value. Whitespace can only be included in the)'
+( value by wrapping the value in quote characters.)'
()'
-( The key of the header consists of all characters of the line up to)'
-( the first semicolon, excluding the semicolon itself and omitting all)'
-( white-space characters.)'
+( The key of the header consists of all characters of the line up to the first)'
+( semicolon, excluding the semicolon itself and omitting all white-space)'
+( characters.)'
()'
-( The value of the header starts at the first non-whitespace character)'
-( after the first semicolon of the line. If the first character is a)'
-( quote, the value ends at the next quote in the line. If the first)'
-( character is not a quote, the value ends at the next whitespace)'
-( character.)'
+( The value of the header starts at the first non-whitespace character after)'
+( the first semicolon of the line. If the first character is a quote, the value)'
+( ends at the next quote in the line. If the first character is not a quote,)'
+( the value ends at the next whitespace character.)'
()'
(6.2. Short author identification)'
()'
-( In order to allow authors to take some credit and to track who has)'
-( written what, the author's name MUST be added right-aligned on the)'
-( first line of the first page of the document. To prevent mixing)'
-( notations between documents, the names SHOULD be written as only the)'
-( first letters of all given names in capitals, separated by dots, a)'
-( space and the Family name starting with a capital. When written by a)'
-( group with a name, the short author identification string SHOULD)'
-( state the group's name.)'
+( In order to allow the author or authors to take some credit and to track who)'
+( has written what, the author's name MUST be added right-aligned on the first)'
+( line of the first page of the document. To prevent mixing notations between)'
+( documents, the names SHOULD be written as only the first letters of all given)'
+( names in capitals, separated by dots, a space and the Family name starting)'
+( with an uppercase character. When written by a group with a name, the short)'
+( author identification string SHOULD state the group's name instead of the)'
+( individual authors.)'
()'
(6.3. Publish date)'
()'
-( Because a document is unlikely to have been written within a day, a)'
-( publish date is simply the month's name starting with a capital)'
-( followed by the year, both following the Gregorian calendar.)'
+( Dates contained in specification documents following the format described in)'
+( this document MUST follow the Gregorian calendar.)'
()'
+( The publish date of the document MUST include a month starting with a capital)'
+( character and fully written year. The day of the month MAY be added on the)'
+( first page of the document, but MUST NOT be included in the short date on all)'
+( pages.)'
()'
()'
()'
-(Bron [Page 4])'
+()'
+(Bron [Page 4])'
ET
endstream
endobj
17 0 obj
-2627
+2875
endobj
18 0 obj
<<
@@ -375,41 +375,38 @@ BT
/F1 10 Tf
1 0 0 1 50 802 Tm
12 TL
-(SPEC 0000 Specification Format August 2018)'
+(SPEC 0000 Specification Format August 2018)'
()'
(7. Document footer)'
()'
-( The document SHOULD close, starting on a new page, with all)'
-( informative resources which were used to write the document, noting)'
-( their keyword and document title. When possible, a URL to the)'
-( resource SHOULD be included.)'
+( The document SHOULD close, starting on a new page, with all informative)'
+( resources which were used to write the document, noting their keyword and)'
+( document title. A URI to the resource SHOULD be included.)'
()'
-( After the informative resources, the document SHOULD end with one)'
-( or several pages dedicated to the information of the author\(s\) and)'
-( if possible their contact information.)'
+( After the informative resources, the document SHOULD end with one or several)'
+( pages dedicated to the information of the author or authors.)'
()'
(8. Section titles)'
()'
( Section titles SHOULD be a short text about the subject the section)'
-( describes. Whether it is simply the keyword of what it explains, a)'
-( problem statement or other type of text is up to the author as long)'
-( as it's relevant to the section's body.)'
+( describes. Whether it is simply the keyword of what it explains, a problem)'
+( statement or other type of text is up to the author as long as it's relevant)'
+( to the section's body and fits within a single line.)'
()'
-( A section title MUST start with a capital character & MUST NOT)'
-( contain any other capital letters, excluding where they are required)'
-( in names or abbreviations.)'
+( A section title MUST start with a capital character & MUST NOT contain any)'
+( other capital letters, excluding where they are required in names or)'
+( abbreviations.)'
()'
(9. Document title)'
()'
-( The title of the document should clearly state the main subject of)'
-( the document and it's contents. Each word of the document title must)'
-( start with a capital character when noted as the title of the)'
-( document.)'
+( The title of the document should clearly state the main subject of the)'
+( document and it's contents. Each word of the document title MUST start with a)'
+( capital character when noted as the title of the document.)'
+()'
+( On the first page of the document, the title should be centered horizontally)'
+( and have at least 2 blank lines both above and below it. The document title)'
+( SHOULD be as close to the document's descriptive headers as possible.)'
()'
-( On the first page of the document, the title should be centered)'
-( horizontally and have at least 2 blank lines both above and below)'
-( it. The document title SHOULD be as close to the document's)'
-( descriptive headers.)'
()'
()'
()'
@@ -434,12 +431,15 @@ BT
()'
()'
()'
-(Bron [Page 5])'
+()'
+()'
+()'
+(Bron [Page 5])'
ET
endstream
endobj
20 0 obj
-1732
+1733
endobj
21 0 obj
<<
@@ -458,33 +458,33 @@ BT
/F1 10 Tf
1 0 0 1 50 802 Tm
12 TL
-(SPEC 0000 Specification format August 2018)'
+(SPEC 0000 Specification Format August 2018)'
()'
(10. Informative resources)'
()'
-( [CP437] IBM Code page 437)'
-( https://en.wikipedia.org/wiki/Code_page_437)'
+( [RFC2119] RFC Key Words)'
+( S. Bradner)'
+( https://tools.ietf.org/html/rfc2119)'
+()'
+()'
+()'
+()'
+()'
+()'
+()'
+()'
+()'
+()'
+()'
+()'
+()'
+()'
+()'
()'
-( [RFC20] ASCII format for Network Interchange)'
-( Vint Cerf)'
-( https://tools.ietf.org/html/rfc20)'
()'
-( [RFC822] Standard for ARPA Internet Text Messages)'
-( David H. Crocker)'
-( https://tools.ietf.org/html/rfc822)'
()'
-( [RFC1111] RFC Instructions)'
-( J. Postel)'
-( https://tools.ietf.org/html/rfc1111)'
()'
-( [RFC2119] RFC Key Words)'
-( S. Bradner)'
-( https://tools.ietf.org/html/rfc2119)'
()'
-( [RFC7322] RFC Style Guid)'
-( H. Flanagan)'
-( S. Ginoza)'
-( https://tools.ietf.org/html/rfc7322)'
()'
()'
()'
@@ -517,12 +517,12 @@ BT
()'
()'
()'
-(Bron [Page 6])'
+(Bron [Page 6])'
ET
endstream
endobj
23 0 obj
-1114
+565
endobj
24 0 obj
<<
@@ -541,7 +541,7 @@ BT
/F1 10 Tf
1 0 0 1 50 802 Tm
12 TL
-(SPEC 0000 Specification format August 2018)'
+(SPEC 0000 Specification Format August 2018)'
()'
(11. Author information)'
()'
@@ -600,12 +600,12 @@ BT
()'
()'
()'
-(Bron [Page 7])'
+(Bron [Page 7])'
ET
endstream
endobj
26 0 obj
-521
+539
endobj
3 0 obj
<<
@@ -617,12 +617,12 @@ endobj
endobj
xref
0 27
-0000000000 65535 f 0000000009 00000 n 0000000133 00000 n 0000012220 00000 n 0000000182 00000 n 0000000260 00000 n 0000000331 00000 n 0000000411 00000 n 0000001329 00000 n 0000001348 00000 n 0000001429 00000 n 0000003129 00000 n 0000003150 00000 n 0000003232 00000 n 0000005578 00000 n 0000005599 00000 n 0000005681 00000 n 0000008362 00000 n 0000008383 00000 n 0000008465 00000 n 0000010251 00000 n 0000010272 00000 n 0000010354 00000 n 0000011522 00000 n 0000011543 00000 n 0000011625 00000 n 0000012200 00000 n trailer
+0000000000 65535 f 0000000009 00000 n 0000000133 00000 n 0000012019 00000 n 0000000182 00000 n 0000000260 00000 n 0000000331 00000 n 0000000411 00000 n 0000001273 00000 n 0000001292 00000 n 0000001373 00000 n 0000003244 00000 n 0000003265 00000 n 0000003347 00000 n 0000005660 00000 n 0000005681 00000 n 0000005763 00000 n 0000008692 00000 n 0000008713 00000 n 0000008795 00000 n 0000010582 00000 n 0000010603 00000 n 0000010685 00000 n 0000011304 00000 n 0000011324 00000 n 0000011406 00000 n 0000011999 00000 n trailer
<<
/Size 27
/Root 2 0 R
/Info 1 0 R
>>
startxref
-12346
+12145
%%EOF
diff --git a/docs/spec/0003.pdf b/docs/spec/0003.pdf
@@ -1,628 +0,0 @@
-%PDF-1.1
-1 0 obj
-<<
-/CreationDate (D:20200603120702)
-/Producer (text2pdf v1.1 (\251 Phil Smith, 1996))
-/Title (./0003.txt)
->>
-endobj
-2 0 obj
-<<
-/Type /Catalog
-/Pages 3 0 R
->>
-endobj
-4 0 obj
-<<
-/Type /Font
-/Subtype /Type1
-/Name /F1
-/BaseFont /Courier
->>
-endobj
-5 0 obj
-<<
- /Font << /F1 4 0 R >>
- /ProcSet [ /PDF /Text ]
->>
-endobj
-6 0 obj
-<<
-/Type /Page
-/Parent 3 0 R
-/Resources 5 0 R
-/Contents 7 0 R
->>
-endobj
-7 0 obj
-<<
-/Length 8 0 R
->>
-stream
-BT
-/F1 10 Tf
-1 0 0 1 50 802 Tm
-12 TL
-(Specification: 0003 Robin Bron)'
-( June 2020)'
-()'
-(Obsoletes: 0000)'
-()'
-()'
-( Specification Format)'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-(Copyright Notice)'
-()'
-( This document is licensed under a)'
-( Creative Commons Attribution 4.0 International License)'
-()'
-( You should have received a copy of the license along with this work. If not,)'
-( see <http://creativecommons.org/licenses/by/4.0/>)'
-()'
-(Bron [Page 1])'
-ET
-endstream
-endobj
-8 0 obj
-825
-endobj
-9 0 obj
-<<
-/Type /Page
-/Parent 3 0 R
-/Resources 5 0 R
-/Contents 10 0 R
->>
-endobj
-10 0 obj
-<<
-/Length 11 0 R
->>
-stream
-BT
-/F1 10 Tf
-1 0 0 1 50 802 Tm
-12 TL
-(SPEC 0003 Specification Format June 2020)'
-()'
-(Table of contents)'
-()'
-( 1. Conventions ........................................................... 3)'
-( 2. Character encoding .................................................... 3)'
-( 3. Line definition ....................................................... 3)'
-( 3.1 Line numbering .................................................... 3)'
-( 4. Pages ................................................................. 3)'
-( 4.1 Page header ....................................................... 3)'
-( 4.2 Page footer ....................................................... 3)'
-( 5. Paragraphs ............................................................ 3)'
-( 6. Document header ....................................................... 4)'
-( 6.1. Descriptive header ............................................... 4)'
-( 6.2. Short author identification ...................................... 4)'
-( 6.3. Publish date ..................................................... 4)'
-( 7. Document footer ....................................................... 5)'
-( 8. Section titles ........................................................ 5)'
-( 9. Document title ........................................................ 5)'
-( 10. Informative resources ................................................. 6)'
-( 11. Author information .................................................... 7)'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-(Bron [Page 2])'
-ET
-endstream
-endobj
-11 0 obj
-1817
-endobj
-12 0 obj
-<<
-/Type /Page
-/Parent 3 0 R
-/Resources 5 0 R
-/Contents 13 0 R
->>
-endobj
-13 0 obj
-<<
-/Length 14 0 R
->>
-stream
-BT
-/F1 10 Tf
-1 0 0 1 50 802 Tm
-12 TL
-(SPEC 0003 Specification Format June 2020)'
-()'
-(1. Conventions)'
-()'
-( 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 RFC2119 when, and only when,)'
-( they appear in all capitals, as shown here.)'
-()'
-(2. Character Encoding)'
-()'
-( Plain-text files for specifications MUST use the UTF-8 standard.)'
-()'
-(3. Line definition)'
-()'
-( A line of text is a sequence of 0 or more characters followed by a line feed)'
-( character. For the sake of and clarity, the ending line feed character is not)'
-( part of the line.)'
-()'
-( Lines MUST NOT exceed 80 characters in length, excluding the ending line feed)'
-( character. A line is called a blank line if it consists of 0 characters.)'
-()'
-(3.1. Line numbering)'
-()'
-( Assuming a document is in digital format[1] and has a length of greater than)'
-( 0 bytes, the first character in the document is part of line 1.)'
-()'
-(4. Pages)'
-()'
-( A page is a sequence of 60 lines. That means for every line number n, the)'
-( line is the start of a new page when n mod 60 = 1.)'
-()'
-(4.1 Page header)'
-()'
-( The first line of a page SHOULD consist of a left-aligned spec number)'
-( indicator, a centered \(short\) document title and a right-aligned short)'
-( publishing date \(see 6.3\). Line 2 of a page MUST always be blank, excluding)'
-( the first page of the document.)'
-()'
-(4.2 Page footer)'
-()'
-( The last line of a page MUST consist of a left-align last name of the)'
-( author or authors and a right-aligned page number between square brackets.)'
-( The second-to-last line of a page must be blank, just like line 2 of a page.)'
-()'
-(5. Paragraphs)'
-()'
-( A paragraph is a sequence of consecutive lines all of a length greater than 0)'
-( characters. Paragraphs are separated by either one or more blank lines or a)'
-( page break. Paragraphs MUST NOT span multiple pages, limiting their size to)'
-( 56 lines.)'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-(Bron [Page 3])'
-ET
-endstream
-endobj
-14 0 obj
-2259
-endobj
-15 0 obj
-<<
-/Type /Page
-/Parent 3 0 R
-/Resources 5 0 R
-/Contents 16 0 R
->>
-endobj
-16 0 obj
-<<
-/Length 17 0 R
->>
-stream
-BT
-/F1 10 Tf
-1 0 0 1 50 802 Tm
-12 TL
-(SPEC 0003 Specification Format June 2020)'
-()'
-(6. Document header)'
-()'
-( The first lines of the first page of a specification document MUST always)'
-( contain left-aligned description headers \(see 6.1\) and right-aligned author)'
-( identification and a right-aligned publishing date.)'
-()'
-( After the initial lines \(see 6.1 through 6.3\), references to other)'
-( specifications MUST be included when the specification obsoletes or updates)'
-( the references specification.)'
-()'
-( After the initial lines and the references, the document title is REQUIRED to)'
-( be written on the first page of the document. For it's specification, see)'
-( section 9.)'
-()'
-( The bottom of the first page of the document MUST include a copyright notice)'
-( and/or license, a link to the license or the inclusion text required by the)'
-( license in question.)'
-()'
-(6.1. Descriptive header)'
-()'
-( Each descriptive header is made up of a key and a value. Whitespace is not)'
-( allowed in both the key and the value. Whitespace can only be included in the)'
-( value by wrapping the value in quote characters.)'
-()'
-( The key of the header consists of all characters of the line up to the first)'
-( semicolon, excluding the semicolon itself and omitting all white-space)'
-( characters.)'
-()'
-( The value of the header starts at the first non-whitespace character after)'
-( the first semicolon of the line. If the first character is a quote, the value)'
-( ends at the next quote in the line. If the first character is not a quote,)'
-( the value ends at the next whitespace character.)'
-()'
-(6.2. Short author identification)'
-()'
-( In order to allow the author or authors to take some credit and to track who)'
-( has written what, the author's name MUST be added right-aligned on the first)'
-( line of the first page of the document. To prevent mixing notations between)'
-( documents, the names SHOULD be written as only the first letters of all given)'
-( names in capitals, separated by dots, a space and the Family name starting)'
-( with an uppercase character. When written by a group with a name, the short)'
-( author identification string SHOULD state the group's name instead of the)'
-( individual authors.)'
-()'
-(6.3. Publish date)'
-()'
-( Dates contained in specification documents following the format described in)'
-( this document MUST follow the Gregorian calendar.)'
-()'
-( The publish date of the document MUST include a month starting with a capital)'
-( character and fully written year. The day of the month MAY be added on the)'
-( first page of the document, but MUST NOT be included in the short date on all)'
-( pages.)'
-()'
-()'
-()'
-()'
-(Bron [Page 4])'
-ET
-endstream
-endobj
-17 0 obj
-2875
-endobj
-18 0 obj
-<<
-/Type /Page
-/Parent 3 0 R
-/Resources 5 0 R
-/Contents 19 0 R
->>
-endobj
-19 0 obj
-<<
-/Length 20 0 R
->>
-stream
-BT
-/F1 10 Tf
-1 0 0 1 50 802 Tm
-12 TL
-(SPEC 0003 Specification Format June 2020)'
-()'
-(7. Document footer)'
-()'
-( The document SHOULD close, starting on a new page, with all informative)'
-( resources which were used to write the document, noting their keyword and)'
-( document title. A URI to the resource SHOULD be included.)'
-()'
-( After the informative resources, the document SHOULD end with one or several)'
-( pages dedicated to the information of the author or authors.)'
-()'
-(8. Section titles)'
-()'
-( Section titles SHOULD be a short text about the subject the section)'
-( describes. Whether it is simply the keyword of what it explains, a problem)'
-( statement or other type of text is up to the author as long as it's relevant)'
-( to the section's body and fits within a single line.)'
-()'
-( A section title MUST start with a capital character & MUST NOT contain any)'
-( other capital letters, excluding where they are required in names or)'
-( abbreviations.)'
-()'
-(9. Document title)'
-()'
-( The title of the document should clearly state the main subject of the)'
-( document and it's contents. Each word of the document title MUST start with a)'
-( capital character when noted as the title of the document.)'
-()'
-( On the first page of the document, the title should be centered horizontally)'
-( and have at least 2 blank lines both above and below it. The document title)'
-( SHOULD be as close to the document's descriptive headers as possible.)'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-(Bron [Page 5])'
-ET
-endstream
-endobj
-20 0 obj
-1733
-endobj
-21 0 obj
-<<
-/Type /Page
-/Parent 3 0 R
-/Resources 5 0 R
-/Contents 22 0 R
->>
-endobj
-22 0 obj
-<<
-/Length 23 0 R
->>
-stream
-BT
-/F1 10 Tf
-1 0 0 1 50 802 Tm
-12 TL
-(SPEC 0003 Specification Format June 2020)'
-()'
-(10. Informative resources)'
-()'
-( [RFC2119] RFC Key Words)'
-( S. Bradner)'
-( https://tools.ietf.org/html/rfc2119)'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-(Bron [Page 6])'
-ET
-endstream
-endobj
-23 0 obj
-565
-endobj
-24 0 obj
-<<
-/Type /Page
-/Parent 3 0 R
-/Resources 5 0 R
-/Contents 25 0 R
->>
-endobj
-25 0 obj
-<<
-/Length 26 0 R
->>
-stream
-BT
-/F1 10 Tf
-1 0 0 1 50 802 Tm
-12 TL
-(SPEC 0003 Specification Format June 2020)'
-()'
-(11. Author information)'
-()'
-( Name ....... Robin Bron)'
-( Nickname ... Finwo)'
-( EMail ...... robin@finwo.nl)'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-()'
-(Bron [Page 7])'
-ET
-endstream
-endobj
-26 0 obj
-539
-endobj
-3 0 obj
-<<
-/Type /Pages
-/Count 7
-/MediaBox [ 0 0 595 842 ]
-/Kids [ 6 0 R 9 0 R 12 0 R 15 0 R 18 0 R 21 0 R 24 0 R ]
->>
-endobj
-xref
-0 27
-0000000000 65535 f 0000000009 00000 n 0000000133 00000 n 0000012034 00000 n 0000000182 00000 n 0000000260 00000 n 0000000331 00000 n 0000000411 00000 n 0000001288 00000 n 0000001307 00000 n 0000001388 00000 n 0000003259 00000 n 0000003280 00000 n 0000003362 00000 n 0000005675 00000 n 0000005696 00000 n 0000005778 00000 n 0000008707 00000 n 0000008728 00000 n 0000008810 00000 n 0000010597 00000 n 0000010618 00000 n 0000010700 00000 n 0000011319 00000 n 0000011339 00000 n 0000011421 00000 n 0000012014 00000 n trailer
-<<
-/Size 27
-/Root 2 0 R
-/Info 1 0 R
->>
-startxref
-12160
-%%EOF
diff --git a/src/0000.txt b/src/0000.txt
@@ -1,11 +1,11 @@
-Specification: 0000 Robin Bron
- Ratus B.V.
- August 2018
+Specification: 0000 Robin Bron
+ August 2018
+
+
+ Specification Format
-Obsoleted by: 0003
- Specification Format
@@ -54,31 +54,31 @@ Copyright Notice
This document is licensed under a
Creative Commons Attribution 4.0 International License
- You should have received a copy of the license along with this work.
- If not, see <http://creativecommons.org/licenses/by/4.0/>
+ You should have received a copy of the license along with this work. If not,
+ see <http://creativecommons.org/licenses/by/4.0/>
-Bron [Page 1]
-SPEC 0000 Specification Format August 2018
+Bron [Page 1]
+SPEC 0000 Specification Format August 2018
Table of contents
- 1. Conventions .................................................. 3
- 2. Character encoding ........................................... 3
- 3. Line definition .............................................. 3
- 3.1 Line numbering ........................................... 3
- 4. Pages ........................................................ 3
- 4.1 Page header .............................................. 3
- 4.2 Page footer .............................................. 3
- 5. Paragraphs ................................................... 4
- 6. Document header .............................................. 4
- 6.1. Descriptive header ...................................... 4
- 6.2. Short author identification ............................. 4
- 6.3. Publish date ............................................ 4
- 7. Document footer .............................................. 5
- 8. Section titles ............................................... 5
- 9. Document title ............................................... 5
- 10. Informative resources ........................................ 6
- 11. Author information ........................................... 7
+ 1. Conventions ........................................................... 3
+ 2. Character encoding .................................................... 3
+ 3. Line definition ....................................................... 3
+ 3.1 Line numbering .................................................... 3
+ 4. Pages ................................................................. 3
+ 4.1 Page header ....................................................... 3
+ 4.2 Page footer ....................................................... 3
+ 5. Paragraphs ............................................................ 3
+ 6. Document header ....................................................... 4
+ 6.1. Descriptive header ............................................... 4
+ 6.2. Short author identification ...................................... 4
+ 6.3. Publish date ..................................................... 4
+ 7. Document footer ....................................................... 5
+ 8. Section titles ........................................................ 5
+ 9. Document title ........................................................ 5
+ 10. Informative resources ................................................. 6
+ 11. Author information .................................................... 7
@@ -117,162 +117,158 @@ Table of contents
-Bron [Page 2]
-SPEC 0000 Specification Format August 2018
+Bron [Page 2]
+SPEC 0000 Specification Format August 2018
1. Conventions
- 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
- RFC2119 when, and only when, they appear in all capitals, as shown
- here.
+ 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 RFC2119 when, and only when,
+ they appear in all capitals, as shown here.
2. Character Encoding
- Plain-text files for specifications MUST use the CP437 standard with
- the exclusion of character code 0x0A which represents a line feed as
- specified in RFC20.
+ Plain-text files for specifications MUST use the UTF-8 standard.
3. Line definition
- A line of text is a sequence of 0 or more characters followed by a
- line feed character. For the sake of and clarity, the ending line
- feed character is part of the line.
+ A line of text is a sequence of 0 or more characters followed by a line feed
+ character. For the sake of and clarity, the ending line feed character is not
+ part of the line.
- Lines MUST NOT exceed 72 characters in length, including the ending
- line feed character. A line is called a blank line if it consists of
- only a line feed charachter.
+ Lines MUST NOT exceed 80 characters in length, excluding the ending line feed
+ character. A line is called a blank line if it consists of 0 characters.
3.1. Line numbering
- To ensure the following page dimension section is clear, we need to
- define how lines are numbered.
-
- Assuming a document is in digital format[1] and has a length of
- greater than 0 bytes, the first character in the document is part of
- line 0. Numbering lines from 0 instead of 1 gives us an advantage of
- clarity in the next section.
+ Assuming a document is in digital format[1] and has a length of greater than
+ 0 bytes, the first character in the document is part of line 1.
4. Pages
- A page is a sequence of 60 lines. That means for every line number
- n, the line is the start of a new page when n mod 60 = 0.
+ A page is a sequence of 60 lines. That means for every line number n, the
+ line is the start of a new page when n mod 60 = 1.
4.1 Page header
- The first line of a page SHOULD consist of a left-aligned spec
- number indicator, a centered (short) document title and a
- right-aligned publishing date (see 6.3). The second line of a page
- MUST always be blank, excluding the first page of the document.
+ The first line of a page SHOULD consist of a left-aligned spec number
+ indicator, a centered (short) document title and a right-aligned short
+ publishing date (see 6.3). Line 2 of a page MUST always be blank, excluding
+ the first page of the document.
4.2 Page footer
- The last line of a page MUST consist of a left-align last name of
- the author and a right-aligned page number between square brackets.
- The second-to-last line of a page must be blank, just like the
- second line of a page.
+ The last line of a page MUST consist of a left-align last name of the
+ author or authors and a right-aligned page number between square brackets.
+ The second-to-last line of a page must be blank, just like line 2 of a page.
+
+5. Paragraphs
+
+ A paragraph is a sequence of consecutive lines all of a length greater than 0
+ characters. Paragraphs are separated by either one or more blank lines or a
+ page break. Paragraphs MUST NOT span multiple pages, limiting their size to
+ 56 lines.
+
-Bron [Page 3]
-SPEC 0000 Specification Format August 2018
-5. Paragraphs
- A paragraph is a sequence of consecutive lines containing characters
- other than only a line feed. Paragraphs are separated by either a
- blank line or a page break. Paragraphs MUST NOT span multiple pages,
- limiting their size to 56 lines.
+Bron [Page 3]
+SPEC 0000 Specification Format August 2018
6. Document header
- The first lines of the first page of a specification document SHALL
- always contain left-aligned description headers (see 6.1) and
- right-aligned author identification and a right-aligned publishing
- date.
+ The first lines of the first page of a specification document MUST always
+ contain left-aligned description headers (see 6.1) and right-aligned author
+ identification and a right-aligned publishing date.
- After the initial lines (see 6.1 to 6.3), the document title is
- REQUIRED to be written on the first page of the document. For it's
- specification, see section 9.
+ After the initial lines (see 6.1 through 6.3), references to other
+ specifications MUST be included when the specification obsoletes or updates
+ the references specification.
- Further information on the first page should give a quick
- description of the contents of the document.
+ After the initial lines and the references, the document title is REQUIRED to
+ be written on the first page of the document. For it's specification, see
+ section 9.
+
+ The bottom of the first page of the document MUST include a copyright notice
+ and/or license, a link to the license or the inclusion text required by the
+ license in question.
6.1. Descriptive header
- Each descriptive header is made up of a key and a value. Whitespace
- is not allowed in both the key and the value. Whitespace can only be
- included in the value by wrapping the value in quote characters.
+ Each descriptive header is made up of a key and a value. Whitespace is not
+ allowed in both the key and the value. Whitespace can only be included in the
+ value by wrapping the value in quote characters.
- The key of the header consists of all characters of the line up to
- the first semicolon, excluding the semicolon itself and omitting all
- white-space characters.
+ The key of the header consists of all characters of the line up to the first
+ semicolon, excluding the semicolon itself and omitting all white-space
+ characters.
- The value of the header starts at the first non-whitespace character
- after the first semicolon of the line. If the first character is a
- quote, the value ends at the next quote in the line. If the first
- character is not a quote, the value ends at the next whitespace
- character.
+ The value of the header starts at the first non-whitespace character after
+ the first semicolon of the line. If the first character is a quote, the value
+ ends at the next quote in the line. If the first character is not a quote,
+ the value ends at the next whitespace character.
6.2. Short author identification
- In order to allow authors to take some credit and to track who has
- written what, the author's name MUST be added right-aligned on the
- first line of the first page of the document. To prevent mixing
- notations between documents, the names SHOULD be written as only the
- first letters of all given names in capitals, separated by dots, a
- space and the Family name starting with a capital. When written by a
- group with a name, the short author identification string SHOULD
- state the group's name.
+ In order to allow the author or authors to take some credit and to track who
+ has written what, the author's name MUST be added right-aligned on the first
+ line of the first page of the document. To prevent mixing notations between
+ documents, the names SHOULD be written as only the first letters of all given
+ names in capitals, separated by dots, a space and the Family name starting
+ with an uppercase character. When written by a group with a name, the short
+ author identification string SHOULD state the group's name instead of the
+ individual authors.
6.3. Publish date
- Because a document is unlikely to have been written within a day, a
- publish date is simply the month's name starting with a capital
- followed by the year, both following the Gregorian calendar.
+ Dates contained in specification documents following the format described in
+ this document MUST follow the Gregorian calendar.
+
+ The publish date of the document MUST include a month starting with a capital
+ character and fully written year. The day of the month MAY be added on the
+ first page of the document, but MUST NOT be included in the short date on all
+ pages.
-Bron [Page 4]
-SPEC 0000 Specification Format August 2018
+Bron [Page 4]
+SPEC 0000 Specification Format August 2018
7. Document footer
- The document SHOULD close, starting on a new page, with all
- informative resources which were used to write the document, noting
- their keyword and document title. When possible, a URL to the
- resource SHOULD be included.
+ The document SHOULD close, starting on a new page, with all informative
+ resources which were used to write the document, noting their keyword and
+ document title. A URI to the resource SHOULD be included.
- After the informative resources, the document SHOULD end with one
- or several pages dedicated to the information of the author(s) and
- if possible their contact information.
+ After the informative resources, the document SHOULD end with one or several
+ pages dedicated to the information of the author or authors.
8. Section titles
Section titles SHOULD be a short text about the subject the section
- describes. Whether it is simply the keyword of what it explains, a
- problem statement or other type of text is up to the author as long
- as it's relevant to the section's body.
+ describes. Whether it is simply the keyword of what it explains, a problem
+ statement or other type of text is up to the author as long as it's relevant
+ to the section's body and fits within a single line.
- A section title MUST start with a capital character & MUST NOT
- contain any other capital letters, excluding where they are required
- in names or abbreviations.
+ A section title MUST start with a capital character & MUST NOT contain any
+ other capital letters, excluding where they are required in names or
+ abbreviations.
9. Document title
- The title of the document should clearly state the main subject of
- the document and it's contents. Each word of the document title must
- start with a capital character when noted as the title of the
- document.
+ The title of the document should clearly state the main subject of the
+ document and it's contents. Each word of the document title MUST start with a
+ capital character when noted as the title of the document.
- On the first page of the document, the title should be centered
- horizontally and have at least 2 blank lines both above and below
- it. The document title SHOULD be as close to the document's
- descriptive headers.
+ On the first page of the document, the title should be centered horizontally
+ and have at least 2 blank lines both above and below it. The document title
+ SHOULD be as close to the document's descriptive headers as possible.
@@ -297,34 +293,19 @@ SPEC 0000 Specification Format August 2018
-Bron [Page 5]
-SPEC 0000 Specification format August 2018
-10. Informative resources
- [CP437] IBM Code page 437
- https://en.wikipedia.org/wiki/Code_page_437
- [RFC20] ASCII format for Network Interchange
- Vint Cerf
- https://tools.ietf.org/html/rfc20
- [RFC822] Standard for ARPA Internet Text Messages
- David H. Crocker
- https://tools.ietf.org/html/rfc822
+Bron [Page 5]
+SPEC 0000 Specification Format August 2018
- [RFC1111] RFC Instructions
- J. Postel
- https://tools.ietf.org/html/rfc1111
+10. Informative resources
[RFC2119] RFC Key Words
S. Bradner
https://tools.ietf.org/html/rfc2119
- [RFC7322] RFC Style Guid
- H. Flanagan
- S. Ginoza
- https://tools.ietf.org/html/rfc7322
@@ -357,8 +338,27 @@ SPEC 0000 Specification format August 2018
-Bron [Page 6]
-SPEC 0000 Specification format August 2018
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Bron [Page 6]
+SPEC 0000 Specification Format August 2018
11. Author information
@@ -417,4 +417,4 @@ SPEC 0000 Specification format August 2018
-Bron [Page 7]
+Bron [Page 7]
diff --git a/src/0003.txt b/src/0003.txt
@@ -1,420 +0,0 @@
-Specification: 0003 Robin Bron
- June 2020
-
-Obsoletes: 0000
-
-
- Specification Format
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Copyright Notice
-
- This document is licensed under a
- Creative Commons Attribution 4.0 International License
-
- You should have received a copy of the license along with this work. If not,
- see <http://creativecommons.org/licenses/by/4.0/>
-
-Bron [Page 1]
-SPEC 0003 Specification Format June 2020
-
-Table of contents
-
- 1. Conventions ........................................................... 3
- 2. Character encoding .................................................... 3
- 3. Line definition ....................................................... 3
- 3.1 Line numbering .................................................... 3
- 4. Pages ................................................................. 3
- 4.1 Page header ....................................................... 3
- 4.2 Page footer ....................................................... 3
- 5. Paragraphs ............................................................ 3
- 6. Document header ....................................................... 4
- 6.1. Descriptive header ............................................... 4
- 6.2. Short author identification ...................................... 4
- 6.3. Publish date ..................................................... 4
- 7. Document footer ....................................................... 5
- 8. Section titles ........................................................ 5
- 9. Document title ........................................................ 5
- 10. Informative resources ................................................. 6
- 11. Author information .................................................... 7
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Bron [Page 2]
-SPEC 0003 Specification Format June 2020
-
-1. Conventions
-
- 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 RFC2119 when, and only when,
- they appear in all capitals, as shown here.
-
-2. Character Encoding
-
- Plain-text files for specifications MUST use the UTF-8 standard.
-
-3. Line definition
-
- A line of text is a sequence of 0 or more characters followed by a line feed
- character. For the sake of and clarity, the ending line feed character is not
- part of the line.
-
- Lines MUST NOT exceed 80 characters in length, excluding the ending line feed
- character. A line is called a blank line if it consists of 0 characters.
-
-3.1. Line numbering
-
- Assuming a document is in digital format[1] and has a length of greater than
- 0 bytes, the first character in the document is part of line 1.
-
-4. Pages
-
- A page is a sequence of 60 lines. That means for every line number n, the
- line is the start of a new page when n mod 60 = 1.
-
-4.1 Page header
-
- The first line of a page SHOULD consist of a left-aligned spec number
- indicator, a centered (short) document title and a right-aligned short
- publishing date (see 6.3). Line 2 of a page MUST always be blank, excluding
- the first page of the document.
-
-4.2 Page footer
-
- The last line of a page MUST consist of a left-align last name of the
- author or authors and a right-aligned page number between square brackets.
- The second-to-last line of a page must be blank, just like line 2 of a page.
-
-5. Paragraphs
-
- A paragraph is a sequence of consecutive lines all of a length greater than 0
- characters. Paragraphs are separated by either one or more blank lines or a
- page break. Paragraphs MUST NOT span multiple pages, limiting their size to
- 56 lines.
-
-
-
-
-
-
-
-
-Bron [Page 3]
-SPEC 0003 Specification Format June 2020
-
-6. Document header
-
- The first lines of the first page of a specification document MUST always
- contain left-aligned description headers (see 6.1) and right-aligned author
- identification and a right-aligned publishing date.
-
- After the initial lines (see 6.1 through 6.3), references to other
- specifications MUST be included when the specification obsoletes or updates
- the references specification.
-
- After the initial lines and the references, the document title is REQUIRED to
- be written on the first page of the document. For it's specification, see
- section 9.
-
- The bottom of the first page of the document MUST include a copyright notice
- and/or license, a link to the license or the inclusion text required by the
- license in question.
-
-6.1. Descriptive header
-
- Each descriptive header is made up of a key and a value. Whitespace is not
- allowed in both the key and the value. Whitespace can only be included in the
- value by wrapping the value in quote characters.
-
- The key of the header consists of all characters of the line up to the first
- semicolon, excluding the semicolon itself and omitting all white-space
- characters.
-
- The value of the header starts at the first non-whitespace character after
- the first semicolon of the line. If the first character is a quote, the value
- ends at the next quote in the line. If the first character is not a quote,
- the value ends at the next whitespace character.
-
-6.2. Short author identification
-
- In order to allow the author or authors to take some credit and to track who
- has written what, the author's name MUST be added right-aligned on the first
- line of the first page of the document. To prevent mixing notations between
- documents, the names SHOULD be written as only the first letters of all given
- names in capitals, separated by dots, a space and the Family name starting
- with an uppercase character. When written by a group with a name, the short
- author identification string SHOULD state the group's name instead of the
- individual authors.
-
-6.3. Publish date
-
- Dates contained in specification documents following the format described in
- this document MUST follow the Gregorian calendar.
-
- The publish date of the document MUST include a month starting with a capital
- character and fully written year. The day of the month MAY be added on the
- first page of the document, but MUST NOT be included in the short date on all
- pages.
-
-
-
-
-Bron [Page 4]
-SPEC 0003 Specification Format June 2020
-
-7. Document footer
-
- The document SHOULD close, starting on a new page, with all informative
- resources which were used to write the document, noting their keyword and
- document title. A URI to the resource SHOULD be included.
-
- After the informative resources, the document SHOULD end with one or several
- pages dedicated to the information of the author or authors.
-
-8. Section titles
-
- Section titles SHOULD be a short text about the subject the section
- describes. Whether it is simply the keyword of what it explains, a problem
- statement or other type of text is up to the author as long as it's relevant
- to the section's body and fits within a single line.
-
- A section title MUST start with a capital character & MUST NOT contain any
- other capital letters, excluding where they are required in names or
- abbreviations.
-
-9. Document title
-
- The title of the document should clearly state the main subject of the
- document and it's contents. Each word of the document title MUST start with a
- capital character when noted as the title of the document.
-
- On the first page of the document, the title should be centered horizontally
- and have at least 2 blank lines both above and below it. The document title
- SHOULD be as close to the document's descriptive headers as possible.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Bron [Page 5]
-SPEC 0003 Specification Format June 2020
-
-10. Informative resources
-
- [RFC2119] RFC Key Words
- S. Bradner
- https://tools.ietf.org/html/rfc2119
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Bron [Page 6]
-SPEC 0003 Specification Format June 2020
-
-11. Author information
-
- Name ....... Robin Bron
- Nickname ... Finwo
- EMail ...... robin@finwo.nl
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Bron [Page 7]
