-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathsep-0012.html
674 lines (637 loc) · 32.6 KB
/
sep-0012.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
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
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
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
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
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
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
<!--
This HTML is auto-generated. DO NOT EDIT THIS FILE!
DO NOT USE THIS HTML FILE AS YOUR TEMPLATE!
-->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.8.1: http://docutils.sourceforge.net/" />
<meta http-equiv="Content-Type" content="text/html;charset=utf-8">
<meta name="robots" content="index,follow">
<title>SEP 12 -- Sample reStructuredText SEP Template</title>
<link rel="stylesheet" type="text/css" charset="utf-8" media="all" href="common.css"/>
<link rel="stylesheet" href="sep.css" type="text/css" />
</head>
<body lang="en" dir="ltr">
<div id="dpage">
<div id="dpage-inner">
<div id="header">
</div> <!-- /#header -->
<div style="margin-left: 10px;">
<p>
[<b><a href="http://AuburnSPaRC.github.com/SEP/sep-0000.html">SEP Index</a></b>]
[<b><a href="https://github.com/AuburnSPaRC/SEP/blob/master/sep-0012.txt">SEP Source</a></b>]
</p>
<div>
<table class="rfc2822 docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">SEP:</th><td class="field-body">12</td>
</tr>
<tr class="field"><th class="field-name">Title:</th><td class="field-body">Sample reStructuredText SEP Template</td>
</tr>
<tr class="field"><th class="field-name">Version:</th><td class="field-body">5ef736d43c3e266046837a674d77d3a29b78fdfb</td>
</tr>
<tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference external" href="https://github.com/AuburnSPaRC/SEP/blob/master/sep-0012.txt"> Tue Apr 17 10:37:52 2012 -0500</a></td>
</tr>
<tr class="field"><th class="field-name">Author:</th><td class="field-body">Michael Carroll</td>
</tr>
<tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td>
</tr>
<tr class="field"><th class="field-name">Type:</th><td class="field-body">Process</td>
</tr>
<tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference external" href="https://AuburnSPaRC.github.com/SEP/sep-0012">text/x-rst</a></td>
</tr>
<tr class="field"><th class="field-name">Created:</th><td class="field-body">05-Aug-2002</td>
</tr>
<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">30-Aug-2002</td>
</tr>
</tbody>
</table>
<hr />
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#abstract" id="id22">Abstract</a></li>
<li><a class="reference internal" href="#rationale" id="id23">Rationale</a></li>
<li><a class="reference internal" href="#how-to-use-this-template" id="id24">How to Use This Template</a></li>
<li><a class="reference internal" href="#restructuredtext-sep-formatting-requirements" id="id25">ReStructuredText SEP Formatting Requirements</a><ul>
<li><a class="reference internal" href="#general" id="id26">General</a></li>
<li><a class="reference internal" href="#section-headings" id="id27">Section Headings</a></li>
<li><a class="reference internal" href="#paragraphs" id="id28">Paragraphs</a></li>
<li><a class="reference internal" href="#inline-markup" id="id29">Inline Markup</a></li>
<li><a class="reference internal" href="#block-quotes" id="id30">Block Quotes</a></li>
<li><a class="reference internal" href="#literal-blocks" id="id31">Literal Blocks</a></li>
<li><a class="reference internal" href="#lists" id="id32">Lists</a></li>
<li><a class="reference internal" href="#tables" id="id33">Tables</a></li>
<li><a class="reference internal" href="#hyperlinks" id="id34">Hyperlinks</a></li>
<li><a class="reference internal" href="#footnotes" id="id35">Footnotes</a></li>
<li><a class="reference internal" href="#images" id="id36">Images</a></li>
<li><a class="reference internal" href="#comments" id="id37">Comments</a></li>
<li><a class="reference internal" href="#escaping-mechanism" id="id38">Escaping Mechanism</a></li>
</ul>
</li>
<li><a class="reference internal" href="#habits-to-avoid" id="id39">Habits to Avoid</a></li>
<li><a class="reference internal" href="#resources" id="id40">Resources</a></li>
<li><a class="reference internal" href="#references" id="id41">References</a></li>
<li><a class="reference internal" href="#copyright" id="id42">Copyright</a></li>
</ul>
</div>
<div class="section" id="abstract">
<h1><a class="toc-backref" href="#id22">Abstract</a></h1>
<p>This SEP provides a boilerplate or sample template for creating your
own reStructuredText SEPs. In conjunction with the content guidelines
in SEP 1 <a class="footnote-reference" href="#id6" id="id1">[1]</a>, this should make it easy for you to conform your own
SEPs to the format outlined below.</p>
<p>Note: if you are reading this SEP via the web, you should first grab
the text (reStructuredText) source of this SEP in order to complete
the steps below. <strong>DO NOT USE THE HTML FILE AS YOUR TEMPLATE!</strong></p>
<p>To get the source this (or any) SEP, look at the top of the HTML page
and click on the date & time on the "Last-Modified" line. It is a
link to the source text in the ROS repository.</p>
<p>This template is entirely based on the PEP 9 template by David Goodger
and Barry Warsaw. The Author field of this document has been changed
in order to reflect reponsibility for maintenance.</p>
</div>
<div class="section" id="rationale">
<h1><a class="toc-backref" href="#id23">Rationale</a></h1>
<p>SEP submissions come in a wide variety of forms, not all adhering
to the format guidelines set forth below. Use this template, in
conjunction with the format guidelines below, to ensure that your
SEP submission won't get automatically rejected because of form.</p>
<p>ReStructuredText is offered as an alternative to plaintext SEPs, to
allow SEP authors more functionality and expressivity, while
maintaining easy readability in the source text. The processed HTML
form makes the functionality accessible to readers: live hyperlinks,
styled text, tables, images, and automatic tables of contents, among
other advantages.</p>
</div>
<div class="section" id="how-to-use-this-template">
<h1><a class="toc-backref" href="#id24">How to Use This Template</a></h1>
<p>To use this template you must first decide whether your SEP is going
to be an Informational, Process, or Rules SEP. Most SEPs are
Process because they propose a new process for the SPaRC team.
When in doubt, read SEP 1 for details.</p>
<p>Once you've decided which type of SEP yours is going to be, follow the
directions below.</p>
<ul>
<li><p class="first">Make a copy of this file (<tt class="docutils literal">.txt</tt> file, <strong>not</strong> HTML!) and perform
the following edits.</p>
</li>
<li><p class="first">Replace the "SEP: 9" header with "SEP: XXX" since you don't yet have
a SEP number assignment.</p>
</li>
<li><p class="first">Change the Title header to the title of your SEP.</p>
</li>
<li><p class="first">Leave the Version and Last-Modified headers alone; we'll take care
of those when we check your SEP into Github repository.
These headers consist of keywords ("Revision" and "Date" enclosed in
"$"-signs) which are automatically expanded by the repository.
Please do not edit the expanded date or revision text.</p>
</li>
<li><p class="first">Change the Author header to include your name, and optionally your
email address. Be sure to follow the format carefully: your name
must appear first, and it must not be contained in parentheses.
Your email address may appear second (or it can be omitted) and if
it appears, it must appear in angle brackets. It is okay to
obfuscate your email address.</p>
</li>
<li><p class="first">If there is a mailing list for discussion of your new feature, add a
Discussions-To header right after the Author header.</p>
</li>
<li><p class="first">Change the Status header to "Draft".</p>
</li>
<li><p class="first">For Rule SEPs, change the Type header to "Rules".</p>
</li>
<li><p class="first">For Informational SEPs, change the Type header to "Informational".</p>
</li>
<li><p class="first">Change the Created header to today's date. Be sure to follow the
format carefully: it must be in <tt class="docutils literal"><span class="pre">dd-mmm-yyyy</span></tt> format, where the
<tt class="docutils literal">mmm</tt> is the 3 English letter month abbreviation, i.e. one of Jan,
Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec.</p>
</li>
<li><p class="first">Leave Post-History alone for now; you'll add dates to this header
each time you post your SEP. If you posted your SEP to the lists on
August 14, 2001 and September 3, 2001, the Post-History header would
look like:</p>
<pre class="literal-block">
Post-History: 14-Aug-2001, 03-Sept-2001
</pre>
<p>You must manually add new dates and check them in. If you don't
have check-in privileges, send your changes to the SEP editors.</p>
</li>
<li><p class="first">Add a Replaces header if your SEP obsoletes an earlier SEP. The
value of this header is the number of the SEP that your new SEP is
replacing. Only add this header if the older SEP is in "final"
form, i.e. is either Accepted, Final, or Rejected. You aren't
replacing an older open SEP if you're submitting a competing idea.</p>
</li>
<li><p class="first">Now write your Abstract, Rationale, and other content for your SEP,
replacing all this gobbledygook with your own text. Be sure to
adhere to the format guidelines below, specifically on the
prohibition of tab characters and the indentation requirements.</p>
</li>
<li><p class="first">Update your References and Copyright section. Usually you'll place
your SEP into the public domain, in which case just leave the
Copyright section alone. Alternatively, you can use the <a class="reference external" href="http://www.opencontent.org/openpub/">Open
Publication License</a> <a class="footnote-reference" href="#id14" id="id15">[5]</a>, but public domain is still strongly
preferred.</p>
</li>
<li><p class="first">Leave the Emacs stanza at the end of this file alone, including the
formfeed character ("^L", or <tt class="docutils literal">\f</tt>).</p>
</li>
<li><p class="first">Send your SEP submission to the ROS developers at <a class="reference external" href="mailto:ros-developers@code.ros.org">ros-developers@code.ros.org</a>.</p>
</li>
</ul>
</div>
<div class="section" id="restructuredtext-sep-formatting-requirements">
<h1><a class="toc-backref" href="#id25">ReStructuredText SEP Formatting Requirements</a></h1>
<p>The following is a SEP-specific summary of reStructuredText syntax.
For the sake of simplicity and brevity, much detail is omitted. For
more detail, see <a class="reference internal" href="#resources">Resources</a> below. <a class="reference internal" href="#literal-blocks">Literal blocks</a> (in which no
markup processing is done) are used for examples throughout, to
illustrate the plaintext markup.</p>
<div class="section" id="general">
<h2><a class="toc-backref" href="#id26">General</a></h2>
<p>You must adhere to the Emacs convention of adding two spaces at the
end of every sentence. You should fill your paragraphs to column 70,
but under no circumstances should your lines extend past column 79.
If your code samples spill over column 79, you should rewrite them.</p>
<p>Tab characters must never appear in the document at all. A SEP should
include the standard Emacs stanza included by example at the bottom of
this SEP.</p>
</div>
<div class="section" id="section-headings">
<h2><a class="toc-backref" href="#id27">Section Headings</a></h2>
<p>SEP headings must begin in column zero and the initial letter of each
word must be capitalized as in book titles. Acronyms should be in all
capitals. Section titles must be adorned with an underline, a single
repeated punctuation character, which begins in column zero and must
extend at least as far as the right edge of the title text (4
characters minimum). First-level section titles are underlined with
"=" (equals signs), second-level section titles with "-" (hyphens),
and third-level section titles with "'" (single quotes or
apostrophes). For example:</p>
<pre class="literal-block">
First-Level Title
=================
Second-Level Title
------------------
Third-Level Title
'''''''''''''''''
</pre>
<p>If there are more than three levels of sections in your SEP, you may
insert overline/underline-adorned titles for the first and second
levels as follows:</p>
<pre class="literal-block">
============================
First-Level Title (optional)
============================
-----------------------------
Second-Level Title (optional)
-----------------------------
Third-Level Title
=================
Fourth-Level Title
------------------
Fifth-Level Title
'''''''''''''''''
</pre>
<p>You shouldn't have more than five levels of sections in your SEP. If
you do, you should consider rewriting it.</p>
<p>You must use two blank lines between the last line of a section's body
and the next section heading. If a subsection heading immediately
follows a section heading, a single blank line in-between is
sufficient.</p>
<p>The body of each section is not normally indented, although some
constructs do use indentation, as described below. Blank lines are
used to separate constructs.</p>
</div>
<div class="section" id="paragraphs">
<h2><a class="toc-backref" href="#id28">Paragraphs</a></h2>
<p>Paragraphs are left-aligned text blocks separated by blank lines.
Paragraphs are not indented unless they are part of an indented
construct (such as a block quote or a list item).</p>
</div>
<div class="section" id="inline-markup">
<h2><a class="toc-backref" href="#id29">Inline Markup</a></h2>
<p>Portions of text within paragraphs and other text blocks may be
styled. For example:</p>
<pre class="literal-block">
Text may be marked as *emphasized* (single asterisk markup,
typically shown in italics) or **strongly emphasized** (double
asterisks, typically boldface). ``Inline literals`` (using double
backquotes) are typically rendered in a monospaced typeface. No
further markup recognition is done within the double backquotes,
so they're safe for any kind of code snippets.
</pre>
</div>
<div class="section" id="block-quotes">
<h2><a class="toc-backref" href="#id30">Block Quotes</a></h2>
<p>Block quotes consist of indented body elements. For example:</p>
<pre class="literal-block">
This is a paragraph.
This is a block quote.
A block quote may contain many paragraphs.
</pre>
<p>Block quotes are used to quote extended passages from other sources.
Block quotes may be nested inside other body elements. Use 4 spaces
per indent level.</p>
</div>
<div class="section" id="literal-blocks">
<h2><a class="toc-backref" href="#id31">Literal Blocks</a></h2>
<!-- In the text below, double backquotes are used to denote inline
literals. "``::``" is written so that the colons will appear in a
monospaced font; the backquotes (``) are markup, not part of the
text. See "Inline Markup" above.
By the way, this is a comment, described in "Comments" below. -->
<p>Literal blocks are used for code samples or preformatted ASCII art. To
indicate a literal block, preface the indented text block with
"<tt class="docutils literal">::</tt>" (two colons). The literal block continues until the end of
the indentation. Indent the text block by 4 spaces. For example:</p>
<pre class="literal-block">
This is a typical paragraph. A literal block follows.
::
for a in [5,4,3,2,1]: # this is program code, shown as-is
print a
print "it's..."
# a literal block continues until the indentation ends
</pre>
<p>The paragraph containing only "<tt class="docutils literal">::</tt>" will be completely removed from
the output; no empty paragraph will remain. "<tt class="docutils literal">::</tt>" is also
recognized at the end of any paragraph. If immediately preceded by
whitespace, both colons will be removed from the output. When text
immediately precedes the "<tt class="docutils literal">::</tt>", <em>one</em> colon will be removed from
the output, leaving only one colon visible (i.e., "<tt class="docutils literal">::</tt>" will be
replaced by "<tt class="docutils literal">:</tt>"). For example, one colon will remain visible
here:</p>
<pre class="literal-block">
Paragraph::
Literal block
</pre>
</div>
<div class="section" id="lists">
<h2><a class="toc-backref" href="#id32">Lists</a></h2>
<p>Bullet list items begin with one of "-", "*", or "+" (hyphen,
asterisk, or plus sign), followed by whitespace and the list item
body. List item bodies must be left-aligned and indented relative to
the bullet; the text immediately after the bullet determines the
indentation. For example:</p>
<pre class="literal-block">
This paragraph is followed by a list.
* This is the first bullet list item. The blank line above the
first list item is required; blank lines between list items
(such as below this paragraph) are optional.
* This is the first paragraph in the second item in the list.
This is the second paragraph in the second item in the list.
The blank line above this paragraph is required. The left edge
of this paragraph lines up with the paragraph above, both
indented relative to the bullet.
- This is a sublist. The bullet lines up with the left edge of
the text blocks above. A sublist is a new list so requires a
blank line above and below.
* This is the third item of the main list.
This paragraph is not part of the list.
</pre>
<p>Enumerated (numbered) list items are similar, but use an enumerator
instead of a bullet. Enumerators are numbers (1, 2, 3, ...), letters
(A, B, C, ...; uppercase or lowercase), or Roman numerals (i, ii, iii,
iv, ...; uppercase or lowercase), formatted with a period suffix
("1.", "2."), parentheses ("(1)", "(2)"), or a right-parenthesis
suffix ("1)", "2)"). For example:</p>
<pre class="literal-block">
1. As with bullet list items, the left edge of paragraphs must
align.
2. Each list item may contain multiple paragraphs, sublists, etc.
This is the second paragraph of the second list item.
a) Enumerated lists may be nested.
b) Blank lines may be omitted between list items.
</pre>
<p>Definition lists are written like this:</p>
<pre class="literal-block">
what
Definition lists associate a term with a definition.
how
The term is a one-line phrase, and the definition is one
or more paragraphs or body elements, indented relative to
the term.
</pre>
</div>
<div class="section" id="tables">
<h2><a class="toc-backref" href="#id33">Tables</a></h2>
<p>Simple tables are easy and compact:</p>
<pre class="literal-block">
===== ===== =======
A B A and B
===== ===== =======
False False False
True False False
False True False
True True True
===== ===== =======
</pre>
<p>There must be at least two columns in a table (to differentiate from
section titles). Column spans use underlines of hyphens ("Inputs"
spans the first two columns):</p>
<pre class="literal-block">
===== ===== ======
Inputs Output
------------ ------
A B A or B
===== ===== ======
False False False
True False True
False True True
True True True
===== ===== ======
</pre>
<p>Text in a first-column cell starts a new row. No text in the first
column indicates a continuation line; the rest of the cells may
consist of multiple lines. For example:</p>
<pre class="literal-block">
===== =========================
col 1 col 2
===== =========================
1 Second column of row 1.
2 Second column of row 2.
Second line of paragraph.
3 - Second column of row 3.
- Second item in bullet
list (row 3, column 2).
===== =========================
</pre>
</div>
<div class="section" id="hyperlinks">
<h2><a class="toc-backref" href="#id34">Hyperlinks</a></h2>
<p>When referencing an external web page in the body of a SEP, you should
include the title of the page in the text, with either an inline
hyperlink reference to the URL or a footnote reference (see
<a class="reference internal" href="#footnotes">Footnotes</a> below). Do not include the URL in the body text of the
SEP.</p>
<p>Hyperlink references use backquotes and a trailing underscore to mark
up the reference text; backquotes are optional if the reference text
is a single word. For example:</p>
<pre class="literal-block">
In this paragraph, we refer to the `ROS web site`_.
</pre>
<p>An explicit target provides the URL. Put targets in a References
section at the end of the SEP, or immediately after the reference.
Hyperlink targets begin with two periods and a space (the "explicit
markup start"), followed by a leading underscore, the reference text,
a colon, and the URL (absolute or relative):</p>
<pre class="literal-block">
.. _ROS web site: http://ros.org/
</pre>
<p>The reference text and the target text must match (although the match
is case-insensitive and ignores differences in whitespace). Note that
the underscore trails the reference text but precedes the target text.
If you think of the underscore as a right-pointing arrow, it points
<em>away</em> from the reference and <em>toward</em> the target.</p>
<p>The same mechanism can be used for internal references. Every unique
section title implicitly defines an internal hyperlink target. We can
make a link to the Abstract section like this:</p>
<pre class="literal-block">
Here is a hyperlink reference to the `Abstract`_ section. The
backquotes are optional since the reference text is a single word;
we can also just write: Abstract_.
</pre>
<p>Footnotes containing the URLs from external targets will be generated
automatically at the end of the References section of the SEP, along
with footnote references linking the reference text to the footnotes.</p>
<p>Text of the form "SEP x" or "RFC x" (where "x" is a number) will be
linked automatically to the appropriate URLs.</p>
</div>
<div class="section" id="footnotes">
<h2><a class="toc-backref" href="#id35">Footnotes</a></h2>
<p>Footnote references consist of a left square bracket, a number, a
right square bracket, and a trailing underscore:</p>
<pre class="literal-block">
This sentence ends with a footnote reference [1]_.
</pre>
<p>Whitespace must precede the footnote reference. Leave a space between
the footnote reference and the preceding word.</p>
<p>When referring to another SEP, include the SEP number in the body
text, such as "SEP 1". The title may optionally appear. Add a
footnote reference following the title. For example:</p>
<pre class="literal-block">
Refer to SEP 1 [2]_ for more information.
</pre>
<p>Add a footnote that includes the SEP's title and author. It may
optionally include the explicit URL on a separate line, but only in
the References section. Footnotes begin with ".. " (the explicit
markup start), followed by the footnote marker (no underscores),
followed by the footnote body. For example:</p>
<pre class="literal-block">
References
==========
.. [2] SEP 1, "SEP Purpose and Guidelines", Carroll
(http://AuburnSPaRC.github.com/SEP/sep-0001.html)
</pre>
<p>If you decide to provide an explicit URL for a SEP, please use this as
the URL template:</p>
<pre class="literal-block">
http://AuburnSPaRC.github.com/SEP/sep-xxxx.html
</pre>
<p>SEP numbers in URLs must be padded with zeros from the left, so as to
be exactly 4 characters wide, however SEP numbers in the text are
never padded.</p>
<p>During the course of developing your SEP, you may have to add, remove,
and rearrange footnote references, possibly resulting in mismatched
references, obsolete footnotes, and confusion. Auto-numbered
footnotes allow more freedom. Instead of a number, use a label of the
form "#word", where "word" is a mnemonic consisting of alphanumerics
plus internal hyphens, underscores, and periods (no whitespace or
other characters are allowed). For example:</p>
<pre class="literal-block">
Refer to SEP 1 [#SEP-1]_ for more information.
References
==========
.. [#SEP-1] SEP 1, "SEP Purpose and Guidelines", Warsaw, Hylton
http://AuburnSPaRC.github.com/SEP/sep-0001.html
</pre>
<p>Footnotes and footnote references will be numbered automatically, and
the numbers will always match. Once a SEP is finalized, auto-numbered
labels should be replaced by numbers for simplicity.</p>
</div>
<div class="section" id="images">
<h2><a class="toc-backref" href="#id36">Images</a></h2>
<p>If your SEP contains a diagram, you may include it in the processed
output using the "image" directive:</p>
<pre class="literal-block">
.. image:: diagram.png
</pre>
<p>Any browser-friendly graphics format is possible: .png, .jpeg, .gif,
.tiff, etc.</p>
<p>Since this image will not be visible to readers of the SEP in source
text form, you should consider including a description or ASCII art
alternative, using a comment (below).</p>
</div>
<div class="section" id="comments">
<h2><a class="toc-backref" href="#id37">Comments</a></h2>
<p>A comment block is an indented block of arbitrary text immediately
following an explicit markup start: two periods and whitespace. Leave
the ".." on a line by itself to ensure that the comment is not
misinterpreted as another explicit markup construct. Comments are not
visible in the processed document. For the benefit of those reading
your SEP in source form, please consider including a descriptions of
or ASCII art alternatives to any images you include. For example:</p>
<pre class="literal-block">
.. image:: dataflow.png
..
Data flows from the input module, through the "black box"
module, and finally into (and through) the output module.
</pre>
<p>The Emacs stanza at the bottom of this document is inside a comment.</p>
</div>
<div class="section" id="escaping-mechanism">
<h2><a class="toc-backref" href="#id38">Escaping Mechanism</a></h2>
<p>reStructuredText uses backslashes ("<tt class="docutils literal">\</tt>") to override the special
meaning given to markup characters and get the literal characters
themselves. To get a literal backslash, use an escaped backslash
("<tt class="docutils literal">\\</tt>"). There are two contexts in which backslashes have no
special meaning: <a class="reference internal" href="#literal-blocks">literal blocks</a> and inline literals (see <a class="reference internal" href="#inline-markup">Inline
Markup</a> above). In these contexts, no markup recognition is done,
and a single backslash represents a literal backslash, without having
to double up.</p>
<p>If you find that you need to use a backslash in your text, consider
using inline literals or a literal block instead.</p>
</div>
</div>
<div class="section" id="habits-to-avoid">
<h1><a class="toc-backref" href="#id39">Habits to Avoid</a></h1>
<p>Many programmers who are familiar with TeX often write quotation marks
like this:</p>
<pre class="literal-block">
`single-quoted' or ``double-quoted''
</pre>
<p>Backquotes are significant in reStructuredText, so this practice
should be avoided. For ordinary text, use ordinary 'single-quotes' or
"double-quotes". For inline literal text (see <a class="reference internal" href="#inline-markup">Inline Markup</a>
above), use double-backquotes:</p>
<pre class="literal-block">
``literal text: in here, anything goes!``
</pre>
</div>
<div class="section" id="resources">
<h1><a class="toc-backref" href="#id40">Resources</a></h1>
<p>Many other constructs and variations are possible. For more details
about the reStructuredText markup, in increasing order of
thoroughness, please see:</p>
<ul class="simple">
<li><a class="reference external" href="http://docutils.sourceforge.net/docs/rst/quickstart.html">A ReStructuredText Primer</a> <a class="footnote-reference" href="#id16" id="id17">[6]</a>, a gentle introduction.</li>
<li><a class="reference external" href="http://docutils.sourceforge.net/docs/rst/quickref.html">Quick reStructuredText</a> <a class="footnote-reference" href="#id18" id="id19">[7]</a>, a users' quick reference.</li>
<li><a class="reference external" href="http://docutils.sourceforge.net/spec/rst/reStructuredText.html">reStructuredText Markup Specification</a> <a class="footnote-reference" href="#id20" id="id21">[8]</a>, the final authority.</li>
</ul>
<p>The processing of reStructuredText SEPs is done using <a class="reference external" href="http://docutils.sourceforge.net/">Docutils</a> <a class="footnote-reference" href="#id7" id="id9">[2]</a>. If
you have a question or require assistance with reStructuredText or
Docutils, please <a class="reference external" href="mailto:docutils-users@lists.sourceforge.net?subject=SEPs">post a message</a> <a class="footnote-reference" href="#id10" id="id11">[3]</a> to the <a class="reference external" href="http://docutils.sf.net/docs/user/mailing-lists.html#docutils-users">Docutils-users mailing
list</a> <a class="footnote-reference" href="#id12" id="id13">[4]</a>. The <a class="reference external" href="http://docutils.sourceforge.net/">Docutils project web site</a> <a class="footnote-reference" href="#id7" id="id8">[2]</a> has more information.</p>
</div>
<div class="section" id="references">
<h1><a class="toc-backref" href="#id41">References</a></h1>
<table class="docutils footnote" frame="void" id="id6" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td>SEP 1, SEP Purpose and Guidelines
(<a class="reference external" href="http://AuburnSPaRC.github.com/SEP/sep-0001.html">http://AuburnSPaRC.github.com/SEP/sep-0001.html</a>)</td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id7" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label">[2]</td><td><em>(<a class="fn-backref" href="#id8">1</a>, <a class="fn-backref" href="#id9">2</a>)</em> <a class="reference external" href="http://docutils.sourceforge.net/">http://docutils.sourceforge.net/</a></td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id10" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id11">[3]</a></td><td><a class="reference external" href="mailto:docutils-users@lists.sourceforge.net?subject=SEPs">mailto:docutils-users@lists.sourceforge.net?subject=SEPs</a></td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id12" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id13">[4]</a></td><td><a class="reference external" href="http://docutils.sf.net/docs/user/mailing-lists.html#docutils-users">http://docutils.sf.net/docs/user/mailing-lists.html#docutils-users</a></td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id14" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id15">[5]</a></td><td><a class="reference external" href="http://www.opencontent.org/openpub/">http://www.opencontent.org/openpub/</a></td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id16" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id17">[6]</a></td><td><a class="reference external" href="http://docutils.sourceforge.net/docs/rst/quickstart.html">http://docutils.sourceforge.net/docs/rst/quickstart.html</a></td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id18" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id19">[7]</a></td><td><a class="reference external" href="http://docutils.sourceforge.net/docs/rst/quickref.html">http://docutils.sourceforge.net/docs/rst/quickref.html</a></td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id20" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id21">[8]</a></td><td><a class="reference external" href="http://docutils.sourceforge.net/spec/rst/reStructuredText.html">http://docutils.sourceforge.net/spec/rst/reStructuredText.html</a></td></tr>
</tbody>
</table>
</div>
<div class="section" id="copyright">
<h1><a class="toc-backref" href="#id42">Copyright</a></h1>
<p>This document has been placed in the public domain.</p>
<!-- Local Variables:
mode: indented-text
indent-tabs-mode: nil
sentence-end-double-space: t
fill-column: 70
coding: utf-8
End: -->
</div>
</div></div> <!-- /#dpage-inner, /#dpage -->
</body>
</html>