root / dotorg / v8 / html / beps / bep_0002.html

Revision 10994, 34.3 kB (checked in by dave, 11 months ago)

Fix broken hyperlink in reference.

Line 
1<?xml version="1.0" encoding="utf-8" ?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6<meta name="generator" content="Docutils 0.5: http://docutils.sourceforge.net/" />
7<title></title>
8<link rel="stylesheet" href="../css/bep.css" type="text/css" />
9</head>
10<body>
11<div class="document">
12
13<div id="upper" class="clear">
14<div id="wrap">
15<div id="header">
16<h1><a href="../index.html">BitTorrent<span>.org</span></a></h1>
17</div>
18<div id="nav">
19<ul>
20<li><a href="../index.html">Home</a></li>
21<li><a href="../introduction.html">For Users</a></li>
22<li><span>For Developers</span></li>
23<!-- <li><a href="./blog">Blog</a></li> -->
24<li><a href="../donate.html">Donate!</a></li>
25</ul>
26</div> <!-- nav -->
27<!-- ### Begin Content ### -->
28<div id="second">
29
30
31
32<table class="rfc2822 docutils field-list" frame="void" rules="none">
33<col class="field-name" />
34<col class="field-body" />
35<tbody valign="top">
36<tr class="field"><th class="field-name">BEP:</th><td class="field-body">2</td>
37</tr>
38<tr class="field"><th class="field-name">Title:</th><td class="field-body">Sample reStructured Text BEP Template</td>
39</tr>
40<tr class="field"><th class="field-name">Version:</th><td class="field-body">10848</td>
41</tr>
42<tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference external" href="https://svn.bittorrent.com/trac.cgi/browser/dotorg/trunk/html/beps/bep_0002.rst">2008-02-15 14:53:10 -0800 (Fri, 15 Feb 2008)</a></td>
43</tr>
44<tr class="field"><th class="field-name">Author:</th><td class="field-body">David Harrison &lt;dave&#32;&#97;t&#32;bittorrent.com&gt;</td>
45</tr>
46<tr class="field"><th class="field-name">Status:</th><td class="field-body">Active</td>
47</tr>
48<tr class="field"><th class="field-name">Type:</th><td class="field-body">Process</td>
49</tr>
50<tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference external" href="http://www.bittorrent.org/beps/bep-0012">text/x-rst</a></td>
51</tr>
52<tr class="field"><th class="field-name">Created:</th><td class="field-body">02-Feb-2008</td>
53</tr>
54<tr class="field"><th class="field-name">Post-History:</th><td class="field-body"></td>
55</tr>
56</tbody>
57</table>
58<hr />
59<div class="contents topic" id="contents">
60<p class="topic-title first">Contents</p>
61<ul class="simple">
62<li><a class="reference internal" href="#abstract" id="id22">Abstract</a></li>
63<li><a class="reference internal" href="#rationale" id="id23">Rationale</a></li>
64<li><a class="reference internal" href="#how-to-use-this-template" id="id24">How to Use This Template</a></li>
65<li><a class="reference internal" href="#restructuredtext-bep-formatting-requirements" id="id25">ReStructuredText BEP Formatting Requirements</a><ul>
66<li><a class="reference internal" href="#general" id="id26">General</a></li>
67<li><a class="reference internal" href="#section-headings" id="id27">Section Headings</a></li>
68<li><a class="reference internal" href="#paragraphs" id="id28">Paragraphs</a></li>
69<li><a class="reference internal" href="#inline-markup" id="id29">Inline Markup</a></li>
70<li><a class="reference internal" href="#block-quotes" id="id30">Block Quotes</a></li>
71<li><a class="reference internal" href="#literal-blocks" id="id31">Literal Blocks</a></li>
72<li><a class="reference internal" href="#lists" id="id32">Lists</a></li>
73<li><a class="reference internal" href="#tables" id="id33">Tables</a></li>
74<li><a class="reference internal" href="#hyperlinks" id="id34">Hyperlinks</a></li>
75<li><a class="reference internal" href="#footnotes" id="id35">Footnotes</a></li>
76<li><a class="reference internal" href="#images" id="id36">Images</a></li>
77<li><a class="reference internal" href="#comments" id="id37">Comments</a></li>
78<li><a class="reference internal" href="#escaping-mechanism" id="id38">Escaping Mechanism</a></li>
79</ul>
80</li>
81<li><a class="reference internal" href="#habits-to-avoid" id="id39">Habits to Avoid</a></li>
82<li><a class="reference internal" href="#resources" id="id40">Resources</a></li>
83<li><a class="reference internal" href="#acknowledgements" id="id41">Acknowledgements</a></li>
84<li><a class="reference internal" href="#references" id="id42">References</a></li>
85<li><a class="reference internal" href="#copyright" id="id43">Copyright</a></li>
86</ul>
87</div>
88<div class="section" id="abstract">
89<h1>Abstract</h1>
90<p>This BEP provides a boilerplate or sample template for creating your
91own reStructuredText BEPs.  In conjunction with the content guidelines
92in BEP 1 <a class="footnote-reference" href="#bep-1" id="id1">[1]</a>, this should make it easy for you to conform your own
93BEPs to the format outlined below.</p>
94<p>Note: if you are reading this BEP via the web, you should first grab
95the text (reStructuredText) source of this BEP in order to complete
96the steps below.  <strong>DO NOT USE THE HTML FILE AS YOUR TEMPLATE!</strong></p>
97<p>To get the source this (or any) BEP, look at the top of the HTML page
98and click on the date &amp; time on the &quot;Last-Modified&quot; line.  It is a
99link to the source text in the BitTorrent.org subversion repository.</p>
100</div>
101<div class="section" id="rationale">
102<h1>Rationale</h1>
103<p>BEP submissions come in a wide variety of forms, not all adhering
104to the format guidelines set forth below.  Use this template, in
105conjunction with the format guidelines below, to ensure that your
106BEP submission won't get automatically rejected because of form.</p>
107<p>ReStructuredText is offered as an alternative to plaintext BEPs, to
108allow BEP authors more functionality and expressivity, while
109maintaining easy readability in the source text.  The processed HTML
110form makes the functionality accessible to readers: live hyperlinks,
111styled text, tables, images, and automatic tables of contents, among
112other advantages.</p>
113</div>
114<div class="section" id="how-to-use-this-template">
115<h1>How to Use This Template</h1>
116<p>To use this template you must first decide whether your BEP is going
117to be an Informational or Standards Track BEP.  Most BEPs are
118Standards Track because they propose a new feature for the BitTorrent
119system including the BitTorrent suite of protocols.  When in doubt,
120read BEP 1 for details or contact the BEP editors
121&lt;<a class="reference external" href="mailto:editor&#37;&#52;&#48;bittorrent&#46;org">editor<span>&#64;</span>bittorrent<span>&#46;</span>org</a>&gt;.</p>
122<p>Once you've decided which type of BEP yours is going to be, follow the
123directions below.</p>
124<p class="first">Make a copy of this file (<tt class="docutils literal"><span class="pre">.rst</span></tt> file, <strong>not</strong> HTML!)  and perform
125the following edits.</p>
126<ul>
127<li><p class="first">Replace the &quot;BEP: 2&quot; header with &quot;BEP: XXX&quot; since you don't yet have
128a BEP number assignment.</p>
129</li>
130<li><p class="first">Change the Title header to the title of your BEP.</p>
131</li>
132<li><p class="first">Leave the Version and Last-Modified headers alone; we'll take care
133of those when we check your BEP into BitTorrent's Subversion repository.
134These headers consist of keywords (&quot;Revision&quot; and &quot;Date&quot; enclosed in
135&quot;$&quot;-signs) which are automatically expanded by the repository.
136Please do not edit the expanded date or revision text.</p>
137</li>
138<li><p class="first">Change the Author header to include your name, and optionally your
139email address.  Be sure to follow the format carefully: your name
140must appear first, and it must not be contained in parentheses.
141Your email address may appear second (or it can be omitted) and if
142it appears, it must appear in angle brackets.  It is okay to
143obfuscate your email address.</p>
144</li>
145<li><p class="first">If there is a mailing list for discussion of your new feature, add a
146Discussions-To header right after the Author header.  You should not
147add a Discussions-To header if the mailing list to be used is
148<a class="reference external" href="mailto:bittorrent-list&#37;&#52;&#48;bittorrent&#46;org">bittorrent-list<span>&#64;</span>bittorrent<span>&#46;</span>org</a>, or if discussions should be sent to
149you directly.  Most Informational BEPs don't have a Discussions-To
150header.</p>
151</li>
152<li><p class="first">Change the Status header to &quot;Draft&quot;.</p>
153</li>
154<li><p class="first">For Standards Track BEPs, change the Type header to &quot;Standards
155Track&quot;.</p>
156</li>
157<li><p class="first">For Informational BEPs, change the Type header to &quot;Informational&quot;.</p>
158</li>
159<li><p class="first">For Standards Track BEPs, if your feature depends on the acceptance
160of some other currently in-development BEP, add a Requires header
161right after the Type header.  The value should be the BEP number of
162the BEP yours depends on.  Don't add this header if your dependent
163feature is described in a Final BEP.</p>
164</li>
165<li><p class="first">Change the Created header to today's date.  Be sure to follow the
166format carefully: it must be in <tt class="docutils literal"><span class="pre">dd-mmm-yyyy</span></tt> format, where the
167<tt class="docutils literal"><span class="pre">mmm</span></tt> is the 3 English letter month abbreviation, i.e. one of Jan,
168Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec.</p>
169</li>
170<li><p class="first">Leave Post-History alone for now; you'll add dates to this header
171each time you post your BEP to <a class="reference external" href="mailto:bittorrent-list&#37;&#52;&#48;bittorrent&#46;org">bittorrent-list<span>&#64;</span>bittorrent<span>&#46;</span>org</a>.  If
172you posted your BEP to the lists on August 14, 2001 and September 3,
1732001, the Post-History header would look like:</p>
174<pre class="literal-block">
175Post-History: 14-Aug-2001, 03-Sept-2001
176</pre>
177<p>You must manually add new dates and check them in.  If you don't
178have check-in privileges, send your changes to the BEP editors.</p>
179</li>
180<li><p class="first">Add a Replaces header if your BEP obsoletes an earlier BEP.  The
181value of this header is the number of the BEP that your new BEP is
182replacing.  Only add this header if the older BEP is in &quot;final&quot;
183form, i.e. is either Accepted, Final, or Rejected.  You aren't
184replacing an older open BEP if you're submitting a competing idea.</p>
185</li>
186<li><p class="first">Now write your Abstract, Rationale, and other content for your BEP,
187replacing all this gobbledygook with your own text. Be sure to
188adhere to the format guidelines below, specifically on the
189prohibition of tab characters and the indentation requirements.</p>
190</li>
191<li><p class="first">Update your References and Copyright section.  Usually you'll place
192your BEP into the public domain, in which case just leave the
193Copyright section alone.  Alternatively, you can use the <a class="reference external" href="http://www.opencontent.org/openpub/">Open
194Publication License</a> <a class="footnote-reference" href="#id14" id="id15">[6]</a>, but public domain is still strongly
195preferred.</p>
196</li>
197<li><p class="first">Leave the Emacs stanza at the end of this file alone, including the
198formfeed character (&quot;^L&quot;, or <tt class="docutils literal"><span class="pre">\f</span></tt>).</p>
199</li>
200<li><p class="first">Send your BEP submission to the BEP editors at <a class="reference external" href="mailto:editor&#37;&#52;&#48;bittorrent&#46;org">editor<span>&#64;</span>bittorrent<span>&#46;</span>org</a>.</p>
201</li>
202</ul>
203</div>
204<div class="section" id="restructuredtext-bep-formatting-requirements">
205<h1>ReStructuredText BEP Formatting Requirements</h1>
206<p>The following is a BEP-specific summary of reStructuredText syntax.
207For the sake of simplicity and brevity, much detail is omitted.  For
208more detail, see <a class="reference internal" href="#resources">Resources</a> below.  <a class="reference internal" href="#literal-blocks">Literal blocks</a> (in which no
209markup processing is done) are used for examples throughout, to
210illustrate the plaintext markup.</p>
211<div class="section" id="general">
212<h2>General</h2>
213<p>You must adhere to the Emacs convention of adding two spaces at the
214end of every sentence.</p>
215<p>Tab characters must never appear in the document at all.  A BEP should
216include the standard Emacs stanza included by example at the bottom of
217this BEP.</p>
218</div>
219<div class="section" id="section-headings">
220<h2>Section Headings</h2>
221<p>BEP headings must begin in column zero and the initial letter of each
222word must be capitalized as in book titles.  Acronyms should be in all
223capitals.  Section titles must be adorned with an underline, a single
224repeated punctuation character, which begins in column zero and must
225extend at least as far as the right edge of the title text (4
226characters minimum).  First-level section titles are underlined with
227&quot;=&quot; (equals signs), second-level section titles with &quot;-&quot; (hyphens),
228and third-level section titles with &quot;'&quot; (single quotes or
229apostrophes).  For example:</p>
230<pre class="literal-block">
231First-Level Title
232=================
233
234Second-Level Title
235------------------
236
237Third-Level Title
238'''''''''''''''''
239</pre>
240<p>If there are more than three levels of sections in your BEP, you may
241insert overline/underline-adorned titles for the first and second
242levels as follows:</p>
243<pre class="literal-block">
244============================
245First-Level Title (optional)
246============================
247
248-----------------------------
249Second-Level Title (optional)
250-----------------------------
251
252Third-Level Title
253=================
254
255Fourth-Level Title
256------------------
257
258Fifth-Level Title
259'''''''''''''''''
260</pre>
261<p>You shouldn't have more than five levels of sections in your BEP.  If
262you do, you should consider rewriting it.</p>
263<p>You must use two blank lines between the last line of a section's body
264and the next section heading.  If a subsection heading immediately
265follows a section heading, a single blank line in-between is
266sufficient.</p>
267<p>The body of each section is not normally indented, although some
268constructs do use indentation, as described below.  Blank lines are
269used to separate constructs.</p>
270</div>
271<div class="section" id="paragraphs">
272<h2>Paragraphs</h2>
273<p>Paragraphs are left-aligned text blocks separated by blank lines.
274Paragraphs are not indented unless they are part of an indented
275construct (such as a block quote or a list item).</p>
276</div>
277<div class="section" id="inline-markup">
278<h2>Inline Markup</h2>
279<p>Portions of text within paragraphs and other text blocks may be
280styled.  For example:</p>
281<pre class="literal-block">
282Text may be marked as *emphasized* (single asterisk markup,
283typically shown in italics) or **strongly emphasized** (double
284asterisks, typically boldface).  ``Inline literals`` (using double
285backquotes) are typically rendered in a monospaced typeface.  No
286further markup recognition is done within the double backquotes,
287so they're safe for any kind of code snippets.
288</pre>
289</div>
290<div class="section" id="block-quotes">
291<h2>Block Quotes</h2>
292<p>Block quotes consist of indented body elements.  For example:</p>
293<pre class="literal-block">
294This is a paragraph.
295
296    This is a block quote.
297
298    A block quote may contain many paragraphs.
299</pre>
300<p>Block quotes are used to quote extended passages from other sources.
301Block quotes may be nested inside other body elements.  Use 4 spaces
302per indent level.</p>
303</div>
304<div class="section" id="literal-blocks">
305<h2>Literal Blocks</h2>
306<!-- In the text below, double backquotes are used to denote inline
307literals.  "``::``" is written so that the colons will appear in a
308monospaced font; the backquotes (``) are markup, not part of the
309text.  See "Inline Markup" above.
310
311By the way, this is a comment, described in "Comments" below. -->
312<p>Literal blocks are used for code samples or preformatted ASCII art. To
313indicate a literal block, preface the indented text block with
314&quot;<tt class="docutils literal"><span class="pre">::</span></tt>&quot; (two colons).  The literal block continues until the end of
315the indentation.  Indent the text block by 4 spaces.  For example:</p>
316<pre class="literal-block">
317This is a typical paragraph.  A literal block follows.
318
319::
320
321    for a in [5,4,3,2,1]:   # this is program code, shown as-is
322        print a
323    print &quot;it's...&quot;
324    # a literal block continues until the indentation ends
325</pre>
326<p>The paragraph containing only &quot;<tt class="docutils literal"><span class="pre">::</span></tt>&quot; will be completely removed from
327the output; no empty paragraph will remain.  &quot;<tt class="docutils literal"><span class="pre">::</span></tt>&quot; is also
328recognized at the end of any paragraph.  If immediately preceded by
329whitespace, both colons will be removed from the output.  When text
330immediately precedes the &quot;<tt class="docutils literal"><span class="pre">::</span></tt>&quot;, <em>one</em> colon will be removed from
331the output, leaving only one colon visible (i.e., &quot;<tt class="docutils literal"><span class="pre">::</span></tt>&quot; will be
332replaced by &quot;<tt class="docutils literal"><span class="pre">:</span></tt>&quot;).  For example, one colon will remain visible
333here:</p>
334<pre class="literal-block">
335Paragraph::
336
337    Literal block
338</pre>
339</div>
340<div class="section" id="lists">
341<h2>Lists</h2>
342<p>Bullet list items begin with one of &quot;-&quot;, &quot;*&quot;, or &quot;+&quot; (hyphen,
343asterisk, or plus sign), followed by whitespace and the list item
344body.  List item bodies must be left-aligned and indented relative to
345the bullet; the text immediately after the bullet determines the
346indentation.  For example:</p>
347<pre class="literal-block">
348This paragraph is followed by a list.
349
350* This is the first bullet list item.  The blank line above the
351  first list item is required; blank lines between list items
352  (such as below this paragraph) are optional.
353
354* This is the first paragraph in the second item in the list.
355
356  This is the second paragraph in the second item in the list.
357  The blank line above this paragraph is required.  The left edge
358  of this paragraph lines up with the paragraph above, both
359  indented relative to the bullet.
360
361  - This is a sublist.  The bullet lines up with the left edge of
362    the text blocks above.  A sublist is a new list so requires a
363    blank line above and below.
364
365* This is the third item of the main list.
366
367This paragraph is not part of the list.
368</pre>
369<p>Enumerated (numbered) list items are similar, but use an enumerator
370instead of a bullet.  Enumerators are numbers (1, 2, 3, ...), letters
371(A, B, C, ...; uppercase or lowercase), or Roman numerals (i, ii, iii,
372iv, ...; uppercase or lowercase), formatted with a period suffix
373(&quot;1.&quot;, &quot;2.&quot;), parentheses (&quot;(1)&quot;, &quot;(2)&quot;), or a right-parenthesis
374suffix (&quot;1)&quot;, &quot;2)&quot;).  For example:</p>
375<pre class="literal-block">
3761. As with bullet list items, the left edge of paragraphs must
377   align.
378
3792. Each list item may contain multiple paragraphs, sublists, etc.
380
381   This is the second paragraph of the second list item.
382
383   a) Enumerated lists may be nested.
384   b) Blank lines may be omitted between list items.
385</pre>
386<p>Definition lists are written like this:</p>
387<pre class="literal-block">
388what
389    Definition lists associate a term with a definition.
390
391how
392    The term is a one-line phrase, and the definition is one
393    or more paragraphs or body elements, indented relative to
394    the term.
395</pre>
396</div>
397<div class="section" id="tables">
398<h2>Tables</h2>
399<p>Simple tables are easy and compact but you are not required to use
400simple tables:</p>
401<pre class="literal-block">
402=====  =====  =======
403  A      B    A and B
404=====  =====  =======
405False  False  False
406True   False  False
407False  True   False
408True   True   True
409=====  =====  =======
410</pre>
411<p>There must be at least two columns in a table (to differentiate from
412section titles).  Column spans use underlines of hyphens (&quot;Inputs&quot;
413spans the first two columns):</p>
414<pre class="literal-block">
415=====  =====  ======
416   Inputs     Output
417------------  ------
418  A      B    A or B
419=====  =====  ======
420False  False  False
421True   False  True
422False  True   True
423True   True   True
424=====  =====  ======
425</pre>
426<p>Text in a first-column cell starts a new row.  No text in the first
427column indicates a continuation line; the rest of the cells may
428consist of multiple lines.  For example:</p>
429<pre class="literal-block">
430=====  =========================
431col 1  col 2
432=====  =========================
4331      Second column of row 1.
4342      Second column of row 2.
435       Second line of paragraph.
4363      - Second column of row 3.
437
438       - Second item in bullet
439         list (row 3, column 2).
440=====  =========================
441</pre>
442</div>
443<div class="section" id="hyperlinks">
444<h2>Hyperlinks</h2>
445<p>When referencing an external web page in the body of a BEP, you should
446include the title of the page in the text, with either an inline
447hyperlink reference to the URL or a footnote reference (see
448<a class="reference internal" href="#footnotes">Footnotes</a> below).  Do not include the URL in the body text of the
449BEP.</p>
450<p>Hyperlink references use backquotes and a trailing underscore to mark
451up the reference text; backquotes are optional if the reference text
452is a single word.  For example:</p>
453<pre class="literal-block">
454In this paragraph, we refer to the `BitTorrent web site`_.
455</pre>
456<p>An explicit target provides the URL.  Put targets in a References
457section at the end of the BEP, or immediately after the reference.
458Hyperlink targets begin with two periods and a space (the &quot;explicit
459markup start&quot;), followed by a leading underscore, the reference text,
460a colon, and the URL (absolute or relative):</p>
461<pre class="literal-block">
462.. _BitTorrent web site: http://www.bittorrent.org/
463</pre>
464<p>The reference text and the target text must match (although the match
465is case-insensitive and ignores differences in whitespace).  Note that
466the underscore trails the reference text but precedes the target text.
467If you think of the underscore as a right-pointing arrow, it points
468<em>away</em> from the reference and <em>toward</em> the target.</p>
469<p>The same mechanism can be used for internal references.  Every unique
470section title implicitly defines an internal hyperlink target.  We can
471make a link to the Abstract section like this:</p>
472<pre class="literal-block">
473Here is a hyperlink reference to the `Abstract`_ section.  The
474backquotes are optional since the reference text is a single word;
475we can also just write: Abstract_.
476</pre>
477<p>Footnotes containing the URLs from external targets will be generated
478automatically at the end of the References section of the BEP, along
479with footnote references linking the reference text to the footnotes.</p>
480<p>Text of the form &quot;BEP x&quot; or &quot;RFC x&quot; (where &quot;x&quot; is a number) will be
481linked automatically to the appropriate URLs.</p>
482</div>
483<div class="section" id="footnotes">
484<h2>Footnotes</h2>
485<p>Footnote references consist of a left square bracket, a number, a
486right square bracket, and a trailing underscore:</p>
487<pre class="literal-block">
488This sentence ends with a footnote reference [1]_.
489</pre>
490<p>Whitespace must precede the footnote reference.  Leave a space between
491the footnote reference and the preceding word.</p>
492<p>When referring to another BEP, include the BEP number in the body
493text, such as &quot;BEP 1&quot;.  The title may optionally appear.  Add a
494footnote reference following the title.  For example:</p>
495<pre class="literal-block">
496Refer to BEP 1 [2]_ for more information.
497</pre>
498<p>Add a footnote that includes the BEP's title and author.  It may
499optionally include the explicit URL on a separate line, but only in
500the References section.  Footnotes begin with &quot;.. &quot; (the explicit
501markup start), followed by the footnote marker (no underscores),
502followed by the footnote body.  For example:</p>
503<pre class="literal-block">
504References
505==========
506
507.. [2] BEP 1, &quot;BEP Purpose and Guidelines&quot;, Harrison
508   (http://www.bittorrent.org/beps/bep_0001)
509</pre>
510<p>If you decide to provide an explicit URL for a BEP, please use this as
511the URL template:</p>
512<pre class="literal-block">
513http://www.bittorrent.org/beps/bep_xxxx
514</pre>
515<p>BEP numbers in URLs must be padded with zeros from the left, so as to
516be exactly 4 characters wide, however BEP numbers in the text are
517never padded.</p>
518<p>During the course of developing your BEP, you may have to add, remove,
519and rearrange footnote references, possibly resulting in mismatched
520references, obsolete footnotes, and confusion.  Auto-numbered
521footnotes allow more freedom.  Instead of a number, use a label of the
522form &quot;#word&quot;, where &quot;word&quot; is a mnemonic consisting of alphanumerics
523plus internal hyphens, underscores, and periods (no whitespace or
524other characters are allowed).  For example:</p>
525<pre class="literal-block">
526Refer to BEP 1 [#BEP-1]_ for more information.
527
528References
529==========
530
531.. [#BEP-1] BEP 1, &quot;BEP Purpose and Guidelines&quot;, Harrison
532
533   http://www.bittorrent.org/beps/bep-0001
534</pre>
535<p>Footnotes and footnote references will be numbered automatically, and
536the numbers will always match.  Once a BEP is finalized, auto-numbered
537labels should be replaced by numbers for simplicity.</p>
538</div>
539<div class="section" id="images">
540<h2>Images</h2>
541<p>If your BEP contains a diagram, you may include it in the processed
542output using the &quot;image&quot; directive:</p>
543<pre class="literal-block">
544.. image:: diagram.png
545</pre>
546<p>Any browser-friendly graphics format is possible: .png, .jpeg, .gif,
547.tiff, etc.</p>
548<p>Since this image will not be visible to readers of the BEP in source
549text form, you should consi