specifications

Specification and standard documents
git clone git://git.finwo.net/misc/specifications
Log | Files | Refs | README | LICENSE

0000.pdf (12781B)


      1 %PDF-1.1
      2 1 0 obj
      3 <<
      4 /CreationDate (D:20200721141631)
      5 /Producer (text2pdf v1.1 (\251 Phil Smith, 1996))
      6 /Title (0000 - Specification Format)
      7 >>
      8 endobj
      9 2 0 obj
     10 <<
     11 /Type /Catalog
     12 /Pages 3 0 R
     13 >>
     14 endobj
     15 4 0 obj
     16 <<
     17 /Type /Font
     18 /Subtype /Type1
     19 /Name /F1
     20 /BaseFont /Courier
     21 >>
     22 endobj
     23 5 0 obj
     24 <<
     25   /Font << /F1 4 0 R >>
     26   /ProcSet [ /PDF /Text ]
     27 >>
     28 endobj
     29 6 0 obj
     30 <<
     31 /Type /Page
     32 /Parent 3 0 R
     33 /Resources 5 0 R
     34 /Contents 7 0 R
     35 >>
     36 endobj
     37 7 0 obj
     38 <<
     39 /Length 8 0 R
     40 >>
     41 stream
     42 BT
     43 /F1 10 Tf
     44 1 0 0 1 50 802 Tm
     45 12 TL
     46 (Specification: 0000                                                   Robin Bron)'
     47 (Obsoleted by: 0003                                                   August 2018)'
     48 ()'
     49 ()'
     50 (                              Specification Format)'
     51 ()'
     52 ()'
     53 ()'
     54 ()'
     55 ()'
     56 ()'
     57 ()'
     58 ()'
     59 ()'
     60 ()'
     61 ()'
     62 ()'
     63 ()'
     64 ()'
     65 ()'
     66 ()'
     67 ()'
     68 ()'
     69 ()'
     70 ()'
     71 ()'
     72 ()'
     73 ()'
     74 ()'
     75 ()'
     76 ()'
     77 ()'
     78 ()'
     79 ()'
     80 ()'
     81 ()'
     82 ()'
     83 ()'
     84 ()'
     85 ()'
     86 ()'
     87 ()'
     88 ()'
     89 ()'
     90 ()'
     91 ()'
     92 ()'
     93 ()'
     94 ()'
     95 ()'
     96 ()'
     97 (Copyright Notice)'
     98 ()'
     99 (   This document is licensed under a)'
    100 (   Creative Commons Attribution 4.0 International License)'
    101 ()'
    102 (   You should have received a copy of the license along with this work. If not,)'
    103 (   see <http://creativecommons.org/licenses/by/4.0/>)'
    104 ()'
    105 (Bron                                                                    [Page 1])'
    106 ET
    107 endstream
    108 endobj
    109 8 0 obj
    110 810
    111 endobj
    112 9 0 obj
    113 <<
    114 /Type /Page
    115 /Parent 3 0 R
    116 /Resources 5 0 R
    117 /Contents 10 0 R
    118 >>
    119 endobj
    120 10 0 obj
    121 <<
    122 /Length 11 0 R
    123 >>
    124 stream
    125 BT
    126 /F1 10 Tf
    127 1 0 0 1 50 802 Tm
    128 12 TL
    129 (SPEC 0000                    Specification Format                    August 2018)'
    130 ()'
    131 (Table of contents)'
    132 ()'
    133 (    1. Conventions ........................................................... 3)'
    134 (    2. Character encoding .................................................... 3)'
    135 (    3. Line definition ....................................................... 3)'
    136 (       3.1 Line numbering .................................................... 3)'
    137 (    4. Pages ................................................................. 3)'
    138 (       4.1 Page header ....................................................... 3)'
    139 (       4.2 Page footer ....................................................... 3)'
    140 (    5. Paragraphs ............................................................ 3)'
    141 (    6. Document header ....................................................... 4)'
    142 (       6.1. Descriptive header ............................................... 4)'
    143 (       6.2. Short author identification ...................................... 4)'
    144 (       6.3. Publish date ..................................................... 4)'
    145 (    7. Document footer ....................................................... 5)'
    146 (    8. Section titles ........................................................ 5)'
    147 (    9. Document title ........................................................ 5)'
    148 (   10. Informative resources ................................................. 6)'
    149 (   11. Author information .................................................... 7)'
    150 ()'
    151 ()'
    152 ()'
    153 ()'
    154 ()'
    155 ()'
    156 ()'
    157 ()'
    158 ()'
    159 ()'
    160 ()'
    161 ()'
    162 ()'
    163 ()'
    164 ()'
    165 ()'
    166 ()'
    167 ()'
    168 ()'
    169 ()'
    170 ()'
    171 ()'
    172 ()'
    173 ()'
    174 ()'
    175 ()'
    176 ()'
    177 ()'
    178 ()'
    179 ()'
    180 ()'
    181 ()'
    182 ()'
    183 ()'
    184 ()'
    185 ()'
    186 ()'
    187 ()'
    188 (Bron                                                                    [Page 2])'
    189 ET
    190 endstream
    191 endobj
    192 11 0 obj
    193 1817
    194 endobj
    195 12 0 obj
    196 <<
    197 /Type /Page
    198 /Parent 3 0 R
    199 /Resources 5 0 R
    200 /Contents 13 0 R
    201 >>
    202 endobj
    203 13 0 obj
    204 <<
    205 /Length 14 0 R
    206 >>
    207 stream
    208 BT
    209 /F1 10 Tf
    210 1 0 0 1 50 802 Tm
    211 12 TL
    212 (SPEC 0000                    Specification Format                    August 2018)'
    213 ()'
    214 (1. Conventions)'
    215 ()'
    216 (   The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",)'
    217 (   "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this)'
    218 (   document are to be interpreted as described in RFC2119 when, and only when,)'
    219 (   they appear in all capitals, as shown here.)'
    220 ()'
    221 (2. Character Encoding)'
    222 ()'
    223 (   Plain-text files for specifications MUST use the UTF-8 standard.)'
    224 ()'
    225 (3. Line definition)'
    226 ()'
    227 (   A line of text is a sequence of 0 or more characters followed by a line feed)'
    228 (   character. For the sake of and clarity, the ending line feed character is not)'
    229 (   part of the line.)'
    230 ()'
    231 (   Lines MUST NOT exceed 80 characters in length, excluding the ending line feed)'
    232 (   character. A line is called a blank line if it consists of 0 characters.)'
    233 ()'
    234 (3.1. Line numbering)'
    235 ()'
    236 (   Assuming a document is in digital format[1] and has a length of greater than)'
    237 (   0 bytes, the first character in the document is part of line 1.)'
    238 ()'
    239 (4. Pages)'
    240 ()'
    241 (   A page is a sequence of 60 lines. That means for every line number n, the)'
    242 (   line is the start of a new page when n mod 60 = 1.)'
    243 ()'
    244 (4.1 Page header)'
    245 ()'
    246 (   The first line of a page SHOULD consist of a left-aligned spec number)'
    247 (   indicator, a centered \(short\) document title and a right-aligned short)'
    248 (   publishing date \(see 6.3\). Line 2 of a page MUST always be blank, excluding)'
    249 (   the first page of the document.)'
    250 ()'
    251 (4.2 Page footer)'
    252 ()'
    253 (   The last line of a page MUST consist of a left-align last name of the)'
    254 (   author or authors and a right-aligned page number between square brackets.)'
    255 (   The second-to-last line of a page must be blank, just like line 2 of a page.)'
    256 ()'
    257 (5. Paragraphs)'
    258 ()'
    259 (   A paragraph is a sequence of consecutive lines all of a length greater than 0)'
    260 (   characters. Paragraphs are separated by either one or more blank lines or a)'
    261 (   page break. Paragraphs MUST NOT span multiple pages, limiting their size to)'
    262 (   56 lines.)'
    263 ()'
    264 ()'
    265 ()'
    266 ()'
    267 ()'
    268 ()'
    269 ()'
    270 ()'
    271 (Bron                                                                    [Page 3])'
    272 ET
    273 endstream
    274 endobj
    275 14 0 obj
    276 2259
    277 endobj
    278 15 0 obj
    279 <<
    280 /Type /Page
    281 /Parent 3 0 R
    282 /Resources 5 0 R
    283 /Contents 16 0 R
    284 >>
    285 endobj
    286 16 0 obj
    287 <<
    288 /Length 17 0 R
    289 >>
    290 stream
    291 BT
    292 /F1 10 Tf
    293 1 0 0 1 50 802 Tm
    294 12 TL
    295 (SPEC 0000                    Specification Format                    August 2018)'
    296 ()'
    297 (6. Document header)'
    298 ()'
    299 (   The first lines of the first page of a specification document MUST always)'
    300 (   contain left-aligned description headers \(see 6.1\) and right-aligned author)'
    301 (   identification and a right-aligned publishing date.)'
    302 ()'
    303 (   After the initial lines \(see 6.1 through 6.3\), references to other)'
    304 (   specifications MUST be included when the specification obsoletes or updates)'
    305 (   the references specification.)'
    306 ()'
    307 (   After the initial lines and the references, the document title is REQUIRED to)'
    308 (   be written on the first page of the document. For it's specification, see)'
    309 (   section 9.)'
    310 ()'
    311 (   The bottom of the first page of the document MUST include a copyright notice)'
    312 (   and/or license, a link to the license or the inclusion text required by the)'
    313 (   license in question.)'
    314 ()'
    315 (6.1. Descriptive header)'
    316 ()'
    317 (   Each descriptive header is made up of a key and a value. Whitespace is not)'
    318 (   allowed in both the key and the value. Whitespace can only be included in the)'
    319 (   value by wrapping the value in quote characters.)'
    320 ()'
    321 (   The key of the header consists of all characters of the line up to the first)'
    322 (   semicolon, excluding the semicolon itself and omitting all white-space)'
    323 (   characters.)'
    324 ()'
    325 (   The value of the header starts at the first non-whitespace character after)'
    326 (   the first semicolon of the line. If the first character is a quote, the value)'
    327 (   ends at the next quote in the line. If the first character is not a quote,)'
    328 (   the value ends at the next whitespace character.)'
    329 ()'
    330 (6.2. Short author identification)'
    331 ()'
    332 (   In order to allow the author or authors to take some credit and to track who)'
    333 (   has written what, the author's name MUST be added right-aligned on the first)'
    334 (   line of the first page of the document. To prevent mixing notations between)'
    335 (   documents, the names SHOULD be written as only the first letters of all given)'
    336 (   names in capitals, separated by dots, a space and the Family name starting)'
    337 (   with an uppercase character. When written by a group with a name, the short)'
    338 (   author identification string SHOULD state the group's name instead of the)'
    339 (   individual authors.)'
    340 ()'
    341 (6.3. Publish date)'
    342 ()'
    343 (   Dates contained in specification documents following the format described in)'
    344 (   this document MUST follow the Gregorian calendar.)'
    345 ()'
    346 (   The publish date of the document MUST include a month starting with a capital)'
    347 (   character and fully written year. The day of the month MAY be added on the)'
    348 (   first page of the document, but MUST NOT be included in the short date on all)'
    349 (   pages.)'
    350 ()'
    351 ()'
    352 ()'
    353 ()'
    354 (Bron                                                                    [Page 4])'
    355 ET
    356 endstream
    357 endobj
    358 17 0 obj
    359 2875
    360 endobj
    361 18 0 obj
    362 <<
    363 /Type /Page
    364 /Parent 3 0 R
    365 /Resources 5 0 R
    366 /Contents 19 0 R
    367 >>
    368 endobj
    369 19 0 obj
    370 <<
    371 /Length 20 0 R
    372 >>
    373 stream
    374 BT
    375 /F1 10 Tf
    376 1 0 0 1 50 802 Tm
    377 12 TL
    378 (SPEC 0000                    Specification Format                    August 2018)'
    379 ()'
    380 (7. Document footer)'
    381 ()'
    382 (   The document SHOULD close, starting on a new page, with all informative)'
    383 (   resources which were used to write the document, noting their keyword and)'
    384 (   document title. A URI to the resource SHOULD be included.)'
    385 ()'
    386 (   After the informative resources, the document SHOULD end with one or several)'
    387 (   pages dedicated to the information of the author or authors.)'
    388 ()'
    389 (8. Section titles)'
    390 ()'
    391 (   Section titles SHOULD be a short text about the subject the section)'
    392 (   describes. Whether it is simply the keyword of what it explains, a problem)'
    393 (   statement or other type of text is up to the author as long as it's relevant)'
    394 (   to the section's body and fits within a single line.)'
    395 ()'
    396 (   A section title MUST start with a capital character & MUST NOT contain any)'
    397 (   other capital letters, excluding where they are required in names or)'
    398 (   abbreviations.)'
    399 ()'
    400 (9. Document title)'
    401 ()'
    402 (   The title of the document should clearly state the main subject of the)'
    403 (   document and it's contents. Each word of the document title MUST start with a)'
    404 (   capital character when noted as the title of the document.)'
    405 ()'
    406 (   On the first page of the document, the title should be centered horizontally)'
    407 (   and have at least 2 blank lines both above and below it. The document title)'
    408 (   SHOULD be as close to the document's descriptive headers as possible.)'
    409 ()'
    410 ()'
    411 ()'
    412 ()'
    413 ()'
    414 ()'
    415 ()'
    416 ()'
    417 ()'
    418 ()'
    419 ()'
    420 ()'
    421 ()'
    422 ()'
    423 ()'
    424 ()'
    425 ()'
    426 ()'
    427 ()'
    428 ()'
    429 ()'
    430 ()'
    431 ()'
    432 ()'
    433 ()'
    434 ()'
    435 ()'
    436 ()'
    437 (Bron                                                                    [Page 5])'
    438 ET
    439 endstream
    440 endobj
    441 20 0 obj
    442 1733
    443 endobj
    444 21 0 obj
    445 <<
    446 /Type /Page
    447 /Parent 3 0 R
    448 /Resources 5 0 R
    449 /Contents 22 0 R
    450 >>
    451 endobj
    452 22 0 obj
    453 <<
    454 /Length 23 0 R
    455 >>
    456 stream
    457 BT
    458 /F1 10 Tf
    459 1 0 0 1 50 802 Tm
    460 12 TL
    461 (SPEC 0000                    Specification Format                    August 2018)'
    462 ()'
    463 (10. Informative resources)'
    464 ()'
    465 (   [RFC2119]  RFC Key Words)'
    466 (              S. Bradner)'
    467 (              https://tools.ietf.org/html/rfc2119)'
    468 ()'
    469 ()'
    470 ()'
    471 ()'
    472 ()'
    473 ()'
    474 ()'
    475 ()'
    476 ()'
    477 ()'
    478 ()'
    479 ()'
    480 ()'
    481 ()'
    482 ()'
    483 ()'
    484 ()'
    485 ()'
    486 ()'
    487 ()'
    488 ()'
    489 ()'
    490 ()'
    491 ()'
    492 ()'
    493 ()'
    494 ()'
    495 ()'
    496 ()'
    497 ()'
    498 ()'
    499 ()'
    500 ()'
    501 ()'
    502 ()'
    503 ()'
    504 ()'
    505 ()'
    506 ()'
    507 ()'
    508 ()'
    509 ()'
    510 ()'
    511 ()'
    512 ()'
    513 ()'
    514 ()'
    515 ()'
    516 ()'
    517 ()'
    518 ()'
    519 ()'
    520 (Bron                                                                    [Page 6])'
    521 ET
    522 endstream
    523 endobj
    524 23 0 obj
    525 565
    526 endobj
    527 24 0 obj
    528 <<
    529 /Type /Page
    530 /Parent 3 0 R
    531 /Resources 5 0 R
    532 /Contents 25 0 R
    533 >>
    534 endobj
    535 25 0 obj
    536 <<
    537 /Length 26 0 R
    538 >>
    539 stream
    540 BT
    541 /F1 10 Tf
    542 1 0 0 1 50 802 Tm
    543 12 TL
    544 (SPEC 0000                    Specification Format                    August 2018)'
    545 ()'
    546 (11. Author information)'
    547 ()'
    548 (   Name ....... Robin Bron)'
    549 (   Nickname ... Finwo)'
    550 (   EMail ...... robin@finwo.nl)'
    551 ()'
    552 ()'
    553 ()'
    554 ()'
    555 ()'
    556 ()'
    557 ()'
    558 ()'
    559 ()'
    560 ()'
    561 ()'
    562 ()'
    563 ()'
    564 ()'
    565 ()'
    566 ()'
    567 ()'
    568 ()'
    569 ()'
    570 ()'
    571 ()'
    572 ()'
    573 ()'
    574 ()'
    575 ()'
    576 ()'
    577 ()'
    578 ()'
    579 ()'
    580 ()'
    581 ()'
    582 ()'
    583 ()'
    584 ()'
    585 ()'
    586 ()'
    587 ()'
    588 ()'
    589 ()'
    590 ()'
    591 ()'
    592 ()'
    593 ()'
    594 ()'
    595 ()'
    596 ()'
    597 ()'
    598 ()'
    599 ()'
    600 ()'
    601 ()'
    602 ()'
    603 (Bron                                                                    [Page 7])'
    604 ET
    605 endstream
    606 endobj
    607 26 0 obj
    608 539
    609 endobj
    610 3 0 obj
    611 <<
    612 /Type /Pages
    613 /Count 7
    614 /MediaBox [ 0 0 595 842 ]
    615 /Kids [ 6 0 R 9 0 R 12 0 R 15 0 R 18 0 R 21 0 R 24 0 R ]
    616 >>
    617 endobj
    618 xref
    619 0 27
    620 0000000000 65535 f 0000000009 00000 n 0000000150 00000 n 0000012036 00000 n 0000000199 00000 n 0000000277 00000 n 0000000348 00000 n 0000000428 00000 n 0000001290 00000 n 0000001309 00000 n 0000001390 00000 n 0000003261 00000 n 0000003282 00000 n 0000003364 00000 n 0000005677 00000 n 0000005698 00000 n 0000005780 00000 n 0000008709 00000 n 0000008730 00000 n 0000008812 00000 n 0000010599 00000 n 0000010620 00000 n 0000010702 00000 n 0000011321 00000 n 0000011341 00000 n 0000011423 00000 n 0000012016 00000 n trailer
    621 <<
    622 /Size 27
    623 /Root 2 0 R
    624 /Info 1 0 R
    625 >>
    626 startxref
    627 12162
    628 %%EOF