Contents of /xml/htdocs/proj/en/glep/glep-0002.html

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.5 - (hide annotations) (download) (as text)
Sat Jul 19 12:09:20 2003 UTC (15 years, 8 months ago) by liquidx
Branch: MAIN
Changes since 1.4: +5 -5 lines
File MIME type: text/html
marking GLEP1 GLEP2 active

1 g2boojum 1.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     <!--
5     This HTML is auto-generated. DO NOT EDIT THIS FILE! If you are writing a new
6     PEP, see http://www.python.org/peps/pep-0001.html for instructions and links
8     -->
9     <head>
10     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
11 liquidx 1.5 <meta name="generator" content="Docutils 0.3.0: http://docutils.sourceforge.net/" />
12 g2boojum 1.1 <title>GLEP 2 -- Sample ReStructuredText GLEP Template</title>
13     <link rel="stylesheet" href="tools/glep.css" type="text/css" />
14     </head>
15     <body bgcolor="white">
16     <table class="navigation" cellpadding="0" cellspacing="0"
17     width="100%" border="0">
18     <tr><td class="navicon" width="150" height="35">
19     <a href="http://www.gentoo.org/" title="Gentoo Linux Home Page">
20     <img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]"
21     border="0" width="150" height="35" /></a></td>
22     <td class="textlinks" align="left">
23     [<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>]
24 g2boojum 1.2 [<b><a href="http://www.gentoo.org/proj/en/glep">GLEP Index</a></b>]
25     [<b><a href="http://www.gentoo.org/proj/en/glep/glep-0002.txt">GLEP Source</a></b>]
26 g2boojum 1.1 </td></tr></table>
27     <div class="document">
28     <table class="rfc2822 field-list" frame="void" rules="none">
29     <col class="field-name" />
30     <col class="field-body" />
31     <tbody valign="top">
32     <tr class="field"><th class="field-name">GLEP:</th><td class="field-body">2</td>
33     </tr>
34     <tr class="field"><th class="field-name">Title:</th><td class="field-body">Sample ReStructuredText GLEP Template</td>
35     </tr>
36 liquidx 1.5 <tr class="field"><th class="field-name">Version:</th><td class="field-body">1.3</td>
37 g2boojum 1.1 </tr>
38 liquidx 1.5 <tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference" href="http://cvs.gentoo.org/cgi-bin/viewcvs.cgi/gentoo/xml/htdocs/proj/en/glep/glep-0002.txt">2003/06/10 17:33:02</a></td>
39 g2boojum 1.1 </tr>
40     <tr class="field"><th class="field-name">Author:</th><td class="field-body">Grant Goodyear &lt;g2boojum&#32;&#97;t&#32;gentoo.org&gt;,</td>
41     </tr>
42 liquidx 1.5 <tr class="field"><th class="field-name">Status:</th><td class="field-body">Active</td>
43 g2boojum 1.1 </tr>
44     <tr class="field"><th class="field-name">Type:</th><td class="field-body">Informational</td>
45     </tr>
46 g2boojum 1.2 <tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference" href="glep-0002.html">text/x-rst</a></td>
47 g2boojum 1.1 </tr>
48     <tr class="field"><th class="field-name">Created:</th><td class="field-body">31 May 2003</td>
49     </tr>
50 g2boojum 1.3 <tr class="field"><th class="field-name">Post-History:</th><td class="field-body">2-Jun-2003</td>
51 g2boojum 1.1 </tr>
52     </tbody>
53     </table>
54     <hr />
55     <div class="contents topic" id="contents">
56     <p class="topic-title"><a name="contents">Contents</a></p>
57     <ul class="simple">
58     <li><a class="reference" href="#credits" id="id23" name="id23">Credits</a></li>
59     <li><a class="reference" href="#abstract" id="id24" name="id24">Abstract</a></li>
60     <li><a class="reference" href="#motivation" id="id25" name="id25">Motivation</a></li>
61     <li><a class="reference" href="#rationale" id="id26" name="id26">Rationale</a></li>
62     <li><a class="reference" href="#backwards-compatibility" id="id27" name="id27">Backwards Compatibility</a></li>
63     <li><a class="reference" href="#how-to-use-this-template" id="id28" name="id28">How to Use This Template</a></li>
64     <li><a class="reference" href="#restructuredtext-glep-formatting-requirements" id="id29" name="id29">ReStructuredText GLEP Formatting Requirements</a><ul>
65     <li><a class="reference" href="#general" id="id30" name="id30">General</a></li>
66     <li><a class="reference" href="#section-headings" id="id31" name="id31">Section Headings</a></li>
67     <li><a class="reference" href="#paragraphs" id="id32" name="id32">Paragraphs</a></li>
68     <li><a class="reference" href="#inline-markup" id="id33" name="id33">Inline Markup</a></li>
69     <li><a class="reference" href="#block-quotes" id="id34" name="id34">Block Quotes</a></li>
70     <li><a class="reference" href="#literal-blocks" id="id35" name="id35">Literal Blocks</a></li>
71     <li><a class="reference" href="#lists" id="id36" name="id36">Lists</a></li>
72     <li><a class="reference" href="#tables" id="id37" name="id37">Tables</a></li>
73     <li><a class="reference" href="#hyperlinks" id="id38" name="id38">Hyperlinks</a></li>
74     <li><a class="reference" href="#footnotes" id="id39" name="id39">Footnotes</a></li>
75     <li><a class="reference" href="#images" id="id40" name="id40">Images</a></li>
76     <li><a class="reference" href="#comments" id="id41" name="id41">Comments</a></li>
77     <li><a class="reference" href="#escaping-mechanism" id="id42" name="id42">Escaping Mechanism</a></li>
78     </ul>
79     </li>
80     <li><a class="reference" href="#habits-to-avoid" id="id43" name="id43">Habits to Avoid</a></li>
81     <li><a class="reference" href="#resources" id="id44" name="id44">Resources</a></li>
82     <li><a class="reference" href="#references" id="id45" name="id45">References</a></li>
83     <li><a class="reference" href="#copyright" id="id46" name="id46">Copyright</a></li>
84     </ul>
85     </div>
86     <div class="section" id="credits">
87     <h1><a class="toc-backref" href="#id23" name="credits">Credits</a></h1>
88     <p>The text of this GLEP was, to a significant extent, stolen from Python's
89     <a class="footnote-reference" href="#python" id="id1" name="id1">[1]</a> PEP-0012 <a class="footnote-reference" href="#pep12" id="id2" name="id2">[2]</a> by David Goodger and Barry A. Warsaw.</p>
90     </div>
91     <div class="section" id="abstract">
92     <h1><a class="toc-backref" href="#id24" name="abstract">Abstract</a></h1>
93     <p>This GLEP provides a boilerplate or sample template for creating your own
94     reStructuredText GLEPs. In conjunction with the content guidelines in GLEP 1
95     <a class="footnote-reference" href="#glep1" id="id3" name="id3">[3]</a>, this should make it easy for you to conform your own GLEPs to the
96     format outlined below.</p>
97     <p>Note: if you are reading this GLEP via the web, you should first grab the text
98     (reStructuredText) source of this GLEP in order to complete the steps below.
99     <strong>DO NOT USE THE HTML FILE AS YOUR TEMPLATE!</strong></p>
100     <p>To get the source of this (or any) GLEP, look at the top of the HTML page and
101     click on the link titled &quot;GLEP Source&quot;.</p>
102     </div>
103     <div class="section" id="motivation">
104     <h1><a class="toc-backref" href="#id25" name="motivation">Motivation</a></h1>
105     <p>Provide adequate motivation here. In this particular case, we need to provide
106     people with the information necessary to submit GLEPs in the proper form.</p>
107     </div>
108     <div class="section" id="rationale">
109     <h1><a class="toc-backref" href="#id26" name="rationale">Rationale</a></h1>
110     <p>GLEP submissions come in a wide variety of forms, not all adhering to the
111     format guidelines set forth below. Use this template, in conjunction with the
112     format guidelines below, to ensure that your GLEP submission won't get
113     automatically rejected because of form.</p>
114     <p>ReStructuredText is used to allow GLEP authors more functionality and
115     expressivity, while maintaining easy readability in the source text. The
116     processed HTML form makes the functionality accessible to readers: live
117     hyperlinks, styled text, tables, images, and automatic tables of contents,
118     among other advantages.</p>
119     </div>
120     <div class="section" id="backwards-compatibility">
121     <h1><a class="toc-backref" href="#id27" name="backwards-compatibility">Backwards Compatibility</a></h1>
122     <p>Not a problem for this GLEP. This section should be included <em>even</em> when it
123     is only to state that there are no backwards compatibility issues.</p>
124     </div>
125     <div class="section" id="how-to-use-this-template">
126     <h1><a class="toc-backref" href="#id28" name="how-to-use-this-template">How to Use This Template</a></h1>
127     <p>To use this template you must first decide whether your GLEP is going to be an
128     Informational or Standards Track GLEP. Most GLEPs are Standards Track because
129     they propose new functionality for some aspect of Gentoo Linux. When in
130     doubt, read GLEP 1 for details or contact the GLEP editors &lt;<a class="reference" href="mailto:glep&#64;gentoo.org">glep&#64;gentoo.org</a>&gt;.</p>
131     <p>Once you've decided which type of GLEP yours is going to be, follow the
132     directions below.</p>
133     <ul>
134     <li><p class="first">Make a copy of this file (<tt class="literal"><span class="pre">.txt</span></tt> file, <strong>not</strong> HTML!) and perform
135     the following edits.</p>
136     </li>
137     <li><p class="first">Replace the &quot;GLEP: 2&quot; header with &quot;GLEP: XXX&quot; since you don't yet have
138     a GLEP number assignment.</p>
139     </li>
140     <li><p class="first">Change the Title header to the title of your GLEP.</p>
141     </li>
142     <li><p class="first">Leave the Version and Last-Modified headers alone; we'll take care
143     of those when we check your GLEP into CVS.</p>
144     </li>
145     <li><p class="first">Change the Author header to include your name, and optionally your
146     email address. Be sure to follow the format carefully: your name must
147     appear first, and it must not be contained in parentheses. Your email
148     address may appear second (or it can be omitted) and if it appears, it must
149     appear in angle brackets. Your e-mail address
150     here will e automatically obfuscated.</p>
151     </li>
152     <li><p class="first">If there is a forum thread or a mailing list for discussion
153     of your new feature, add a Discussions-To header right after the Author
154     header. You should not add a Discussions-To header if the mailing list to
155     be used is <a class="reference" href="mailto:gentoo-dev&#64;gentoo.org">gentoo-dev&#64;gentoo.org</a>, or if discussions should be sent to you
156     directly. Most Informational GLEPs don't have a Discussions-To header.</p>
157     </li>
158     <li><p class="first">Change the Status header to &quot;Draft&quot;.</p>
159     </li>
160     <li><p class="first">For Standards Track GLEPs, change the Type header to &quot;Standards
161     Track&quot;.</p>
162     </li>
163     <li><p class="first">For Informational GLEPs, change the Type header to &quot;Informational&quot;.</p>
164     </li>
165     <li><p class="first">For Standards Track GLEPs, if your feature depends on the acceptance
166     of some other currently in-development GLEP, add a Requires header right
167     after the Type header. The value should be the GLEP number of the GLEP
168     yours depends on. Don't add this header if your dependent feature is
169     described in a Final GLEP.</p>
170     </li>
171     <li><p class="first">Change the Created header to today's date. Be sure to follow the
172     format carefully: it must be in <tt class="literal"><span class="pre">dd-mmm-yyyy</span></tt> format, where the <tt class="literal"><span class="pre">mmm</span></tt> is
173     the 3 English letter month abbreviation, i.e. one of Jan, Feb, Mar, Apr,
174     May, Jun, Jul, Aug, Sep, Oct, Nov, Dec.</p>
175     </li>
176     <li><p class="first">Leave Post-History alone for now; you'll add dates to this header
177     each time you post your GLEP to <a class="reference" href="mailto:gentoo-dev&#64;gentoo.org">gentoo-dev&#64;gentoo.org</a>. If you posted your
178     GLEP to the list on August 14, 2003 and September 3, 2003, the Post-History
179     header would look like:</p>
180     <pre class="literal-block">
181     Post-History: 14-Aug-2003, 03-Sept-2003
182     </pre>
183     <p>You must manually add new dates and check them in. If you don't have
184     check-in privileges, send your changes to the GLEP editors.</p>
185     </li>
186     <li><p class="first">Add a Replaces header if your GLEP obsoletes an earlier GLEP. The
187     value of this header is the number of the GLEP that your new GLEP is
188     replacing. Only add this header if the older GLEP is in &quot;final&quot; form, i.e.
189     is either Accepted, Final, or Rejected. You aren't replacing an older open
190     GLEP if you're submitting a competing idea.</p>
191     </li>
192     <li><p class="first">Now write your Abstract, Rationale, and other content for your GLEP,
193     replacing all of this gobbledygook with your own text. Be sure to adhere to
194     the format guidelines below, specifically on the indentation requirements.</p>
195     </li>
196     <li><p class="first">Update your References and Copyright section. Usually you'll place
197     your GLEP into the public domain, in which case just leave the Copyright
198     section alone. Alternatively, you can use the <a class="reference" href="http://www.opencontent.org/openpub/">Open Publication License</a> <a class="footnote-reference" href="#id15" id="id16" name="id16">[7]</a>,
199     but public domain is still strongly preferred.</p>
200     </li>
201     <li><p class="first">Send your GLEP submission to the GLEP editors at <a class="reference" href="mailto:glep&#64;gentoo.org">glep&#64;gentoo.org</a>.</p>
202     </li>
203     </ul>
204     </div>
205     <div class="section" id="restructuredtext-glep-formatting-requirements">
206     <h1><a class="toc-backref" href="#id29" name="restructuredtext-glep-formatting-requirements">ReStructuredText GLEP Formatting Requirements</a></h1>
207     <p>The following is a GLEP-specific summary of reStructuredText syntax. For the
208     sake of simplicity and brevity, much detail is omitted. For more detail, see
209     <a class="reference" href="#resources">Resources</a> below. <a class="reference" href="#literal-blocks">Literal blocks</a> (in which no markup processing is done)
210     are used for examples throughout, to illustrate the plaintext markup.</p>
211     <div class="section" id="general">
212     <h2><a class="toc-backref" href="#id30" name="general">General</a></h2>
213     <p>You must adhere to the convention of adding two spaces at the end of every
214     sentence. You should fill your paragraphs to column 70, but under no
215     circumstances should your lines extend past column 79. If your code samples
216     spill over column 79, you should rewrite them.</p>
217     </div>
218     <div class="section" id="section-headings">
219     <h2><a class="toc-backref" href="#id31" name="section-headings">Section Headings</a></h2>
220     <p>GLEP headings must begin in column zero and the initial letter of each word
221     must be capitalized as in book titles. Acronyms should be in all capitals.
222     Section titles must be adorned with an underline, a single repeated
223     punctuation character, which begins in column zero and must extend at least as
224     far as the right edge of the title text (4 characters minimum). First-level
225     section titles are underlined with &quot;=&quot; (equals signs), second-level section
226     titles with &quot;-&quot; (hyphens), and third-level section titles with &quot;'&quot; (single
227     quotes or apostrophes). For example:</p>
228     <pre class="literal-block">
229     First-Level Title
230     =================
232     Second-Level Title
233     ------------------
235     Third-Level Title
236     '''''''''''''''''
237     </pre>
238     <p>If there are more than three levels of sections in your GLEP, you may insert
239     overline/underline-adorned titles for the first and second levels as follows:</p>
240     <pre class="literal-block">
241     ============================
242     First-Level Title (optional)
243     ============================
245     -----------------------------
246     Second-Level Title (optional)
247     -----------------------------
249     Third-Level Title
250     =================
252     Fourth-Level Title
253     ------------------
255     Fifth-Level Title
256     '''''''''''''''''
257     </pre>
258     <p>You shouldn't have more than five levels of sections in your GLEP. If you do,
259     you should consider rewriting it.</p>
260     <p>You must use two blank lines between the last line of a section's body and the
261     next section heading. If a subsection heading immediately follows a section
262     heading, a single blank line in-between is sufficient.</p>
263     <p>The body of each section is not normally indented, although some constructs do
264     use indentation, as described below. Blank lines are used to separate
265     constructs.</p>
266     </div>
267     <div class="section" id="paragraphs">
268     <h2><a class="toc-backref" href="#id32" name="paragraphs">Paragraphs</a></h2>
269     <p>Paragraphs are left-aligned text blocks separated by blank lines. Paragraphs
270     are not indented unless they are part of an indented construct (such as a
271     block quote or a list item).</p>
272     </div>
273     <div class="section" id="inline-markup">
274     <h2><a class="toc-backref" href="#id33" name="inline-markup">Inline Markup</a></h2>
275     <p>Portions of text within paragraphs and other text blocks may be
276     styled. For example:</p>
277     <pre class="literal-block">
278     Text may be marked as *emphasized* (single asterisk markup,
279     typically shown in italics) or **strongly emphasized** (double
280     asterisks, typically boldface). ``Inline literals`` (using double
281     backquotes) are typically rendered in a monospaced typeface. No
282     further markup recognition is done within the double backquotes,
283     so they're safe for any kind of code snippets.
284     </pre>
285     </div>
286     <div class="section" id="block-quotes">
287     <h2><a class="toc-backref" href="#id34" name="block-quotes">Block Quotes</a></h2>
288     <p>Block quotes consist of indented body elements. For example:</p>
289     <pre class="literal-block">
290     This is a paragraph.
292     This is a block quote.
294     A block quote may contain many paragraphs.
295     </pre>
296     <p>Block quotes are used to quote extended passages from other sources.
297     Block quotes may be nested inside other body elements. Use a 4-space tab
298     per indent level.</p>
299     </div>
300     <div class="section" id="literal-blocks">
301     <h2><a class="toc-backref" href="#id35" name="literal-blocks">Literal Blocks</a></h2>
302     <!-- In the text below, double backquotes are used to denote inline
303     literals. "``::``" is written so that the colons will appear in a
304     monospaced font; the backquotes (``) are markup, not part of the
305     text. See "Inline Markup" above.
307     By the way, this is a comment, described in "Comments" below. -->
308     <p>Literal blocks are used for code samples or preformatted ASCII art. To
309     indicate a literal block, preface the indented text block with
310     &quot;<tt class="literal"><span class="pre">::</span></tt>&quot; (two colons). The literal block continues until the end of
311     the indentation. Indent the text block by a tab. For example:</p>
312     <pre class="literal-block">
313     This is a typical paragraph. A literal block follows.
315     ::
317     for a in [5,4,3,2,1]: # this is program code, shown as-is
318     print a
319     print &quot;it's...&quot;
320     # a literal block continues until the indentation ends
321     </pre>
322     <p>The paragraph containing only &quot;<tt class="literal"><span class="pre">::</span></tt>&quot; will be completely removed from
323     the output; no empty paragraph will remain. &quot;<tt class="literal"><span class="pre">::</span></tt>&quot; is also
324     recognized at the end of any paragraph. If immediately preceded by
325     whitespace, both colons will be removed from the output. When text
326     immediately precedes the &quot;<tt class="literal"><span class="pre">::</span></tt>&quot;, <em>one</em> colon will be removed from
327     the output, leaving only one colon visible (i.e., &quot;<tt class="literal"><span class="pre">::</span></tt>&quot; will be
328     replaced by &quot;<tt class="literal"><span class="pre">:</span></tt>&quot;). For example, one colon will remain visible
329     here:</p>
330     <pre class="literal-block">
331     Paragraph::
333     Literal block
334     </pre>
335     </div>
336     <div class="section" id="lists">
337     <h2><a class="toc-backref" href="#id36" name="lists">Lists</a></h2>
338     <p>Bullet list items begin with one of &quot;-&quot;, &quot;*&quot;, or &quot;+&quot; (hyphen,
339     asterisk, or plus sign), followed by whitespace and the list item
340     body. List item bodies must be left-aligned and indented relative to
341     the bullet; the text immediately after the bullet determines the
342     indentation. For example:</p>
343     <pre class="literal-block">
344     This paragraph is followed by a list.
346     * This is the first bullet list item. The blank line above the
347     first list item is required; blank lines between list items
348     (such as below this paragraph) are optional.
350     * This is the first paragraph in the second item in the list.
352     This is the second paragraph in the second item in the list.
353     The blank line above this paragraph is required. The left edge
354     of this paragraph lines up with the paragraph above, both
355     indented relative to the bullet.
357     - This is a sublist. The bullet lines up with the left edge of
358     the text blocks above. A sublist is a new list so requires a
359     blank line above and below.
361     * This is the third item of the main list.
363     This paragraph is not part of the list.
364     </pre>
365     <p>Enumerated (numbered) list items are similar, but use an enumerator
366     instead of a bullet. Enumerators are numbers (1, 2, 3, ...), letters
367     (A, B, C, ...; uppercase or lowercase), or Roman numerals (i, ii, iii,
368     iv, ...; uppercase or lowercase), formatted with a period suffix
369     (&quot;1.&quot;, &quot;2.&quot;), parentheses (&quot;(1)&quot;, &quot;(2)&quot;), or a right-parenthesis
370     suffix (&quot;1)&quot;, &quot;2)&quot;). For example:</p>
371     <pre class="literal-block">
372     1. As with bullet list items, the left edge of paragraphs must
373     align.
375     2. Each list item may contain multiple paragraphs, sublists, etc.
377     This is the second paragraph of the second list item.
379     a) Enumerated lists may be nested.
380     b) Blank lines may be omitted between list items.
381     </pre>
382     <p>Definition lists are written like this:</p>
383     <pre class="literal-block">
384     what
385     Definition lists associate a term with a definition.
387     how
388     The term is a one-line phrase, and the definition is one
389     or more paragraphs or body elements, indented relative to
390     the term.
391     </pre>
392     </div>
393     <div class="section" id="tables">
394     <h2><a class="toc-backref" href="#id37" name="tables">Tables</a></h2>
395     <p>Simple tables are easy and compact:</p>
396     <pre class="literal-block">
397     ===== ===== =======
398     A B A and B
399     ===== ===== =======
400     False False False
401     True False False
402     False True False
403     True True True
404     ===== ===== =======
405     </pre>
406     <p>There must be at least two columns in a table (to differentiate from
407     section titles). Column spans use underlines of hyphens (&quot;Inputs&quot;
408     spans the first two columns):</p>
409     <pre class="literal-block">
410     ===== ===== ======
411     Inputs Output
412     ------------ ------
413     A B A or B
414     ===== ===== ======
415     False False False
416     True False True
417     False True True
418     True True True
419     ===== ===== ======
420     </pre>
421     <p>Text in a first-column cell starts a new row. No text in the first
422     column indicates a continuation line; the rest of the cells may
423     consist of multiple lines. For example:</p>
424     <pre class="literal-block">
425     ===== =========================
426     col 1 col 2
427     ===== =========================
428     1 Second column of row 1.
429     2 Second column of row 2.
430     Second line of paragraph.
431     3 - Second column of row 3.
433     - Second item in bullet
434     list (row 3, column 2).
435     ===== =========================
436     </pre>
437     </div>
438     <div class="section" id="hyperlinks">
439     <h2><a class="toc-backref" href="#id38" name="hyperlinks">Hyperlinks</a></h2>
440     <p>When referencing an external web page in the body of a GLEP, you should
441     include the title of the page in the text, with either an inline
442     hyperlink reference to the URL or a footnote reference (see
443     <a class="reference" href="#footnotes">Footnotes</a> below). Do not include the URL in the body text of the
444     GLEP.</p>
445     <p>Hyperlink references use backquotes and a trailing underscore to mark
446     up the reference text; backquotes are optional if the reference text
447     is a single word. For example:</p>
448     <pre class="literal-block">
449     In this paragraph, we refer to the `Python web site`_.
450     </pre>
451     <p>An explicit target provides the URL. Put targets in a References
452     section at the end of the GLEP, or immediately after the reference.
453     Hyperlink targets begin with two periods and a space (the &quot;explicit
454     markup start&quot;), followed by a leading underscore, the reference text,
455     a colon, and the URL (absolute or relative):</p>
456     <pre class="literal-block">
457     .. _Python web site: http://www.python.org/
458     </pre>
459     <p>The reference text and the target text must match (although the match
460     is case-insensitive and ignores differences in whitespace). Note that
461     the underscore trails the reference text but precedes the target text.
462     If you think of the underscore as a right-pointing arrow, it points
463     <em>away</em> from the reference and <em>toward</em> the target.</p>
464     <p>The same mechanism can be used for internal references. Every unique
465     section title implicitly defines an internal hyperlink target. We can
466     make a link to the Abstract section like this:</p>
467     <pre class="literal-block">
468     Here is a hyperlink reference to the `Abstract`_ section. The
469     backquotes are optional since the reference text is a single word;
470     we can also just write: Abstract_.
471     </pre>
472     <p>Footnotes containing the URLs from external targets will be generated
473     automatically at the end of the References section of the GLEP, along
474     with footnote references linking the reference text to the footnotes.</p>
475     <p>Text of the form &quot;GLEP x&quot; or &quot;RFC x&quot; (where &quot;x&quot; is a number) will be
476     linked automatically to the appropriate URLs.</p>
477     </div>
478     <div class="section" id="footnotes">
479     <h2><a class="toc-backref" href="#id39" name="footnotes">Footnotes</a></h2>
480     <p>Footnote references consist of a left square bracket, a number, a
481     right square bracket, and a trailing underscore:</p>
482     <pre class="literal-block">
483     This sentence ends with a footnote reference [1]_.
484     </pre>
485     <p>Whitespace must precede the footnote reference. Leave a space between
486     the footnote reference and the preceding word.</p>
487     <p>When referring to another GLEP, include the GLEP number in the body
488     text, such as &quot;GLEP 1&quot;. The title may optionally appear. Add a
489     footnote reference following the title. For example:</p>
490     <pre class="literal-block">
491     Refer to GLEP 1 [2]_ for more information.
492     </pre>
493     <p>Add a footnote that includes the GLEP's title and author. It may
494     optionally include the explicit URL on a separate line, but only in
495     the References section. Footnotes begin with &quot;.. &quot; (the explicit
496     markup start), followed by the footnote marker (no underscores),
497     followed by the footnote body. For example:</p>
498     <pre class="literal-block">
499     References
500     ==========
502     .. [2] GLEP 1, &quot;GLEP Purpose and Guidelines&quot;, Goodyear, Warsaw, Hylton
503     (http://glep.gentoo.org/glep-0001.html)
504     </pre>
505     <p>If you decide to provide an explicit URL for a GLEP, please use this as
506     the URL template:</p>
507     <pre class="literal-block">
508     http://glep.gentoo.org/glep-xxxx.html
509     </pre>
510     <p>GLEP numbers in URLs must be padded with zeros from the left, so as to
511     be exactly 4 characters wide, however GLEP numbers in the text are
512     never padded.</p>
513     <p>During the course of developing your GLEP, you may have to add, remove,
514     and rearrange footnote references, possibly resulting in mismatched
515     references, obsolete footnotes, and confusion. Auto-numbered
516     footnotes allow more freedom. Instead of a number, use a label of the
517     form &quot;#word&quot;, where &quot;word&quot; is a mnemonic consisting of alphanumerics
518     plus internal hyphens, underscores, and periods (no whitespace or
519     other characters are allowed). For example:</p>
520     <pre class="literal-block">
521     Refer to GLEP 1 [#GLEP-1]_ for more information.
523     References
524     ==========
526     .. [#GLEP-1] GLEP 1, &quot;GLEP Purpose and Guidelines&quot;, Goodyear
527     http://glep.gentoo.org/glep-0001.html
528     </pre>
529     <p>Footnotes and footnote references will be numbered automatically, and
530     the numbers will always match. Once a GLEP is finalized, auto-numbered
531     labels should be replaced by numbers for simplicity.</p>
532     </div>
533     <div class="section" id="images">
534     <h2><a class="toc-backref" href="#id40" name="images">Images</a></h2>
535     <p>If your GLEP contains a diagram, you may include it in the processed
536     output using the &quot;image&quot; directive:</p>
537     <pre class="literal-block">
538     .. image:: diagram.png
539     </pre>
540     <p>Any browser-friendly graphics format is possible: .png, .jpeg, .gif,
541     .tiff, etc.</p>
542     <p>Since this image will not be visible to readers of the GLEP in source
543     text form, you should consider including a description or ASCII art
544     alternative, using a comment (below).</p>
545     </div>
546     <div class="section" id="comments">
547     <h2><a class="toc-backref" href="#id41" name="comments">Comments</a></h2>
548     <p>A comment block is an indented block of arbitrary text immediately
549     following an explicit markup start: two periods and whitespace. Leave
550     the &quot;..&quot; on a line by itself to ensure that the comment is not
551     misinterpreted as another explicit markup construct. Comments are not
552     visible in the processed document. For the benefit of those reading
553     your GLEP in source form, please consider including a descriptions of
554     or ASCII art alternatives to any images you include. For example:</p>
555     <pre class="literal-block">
556     .. image:: dataflow.png
558     ..
559     Data flows from the input module, through the &quot;black box&quot;
560     module, and finally into (and through) the output module.
561     </pre>
562     </div>
563     <div class="section" id="escaping-mechanism">
564     <h2><a class="toc-backref" href="#id42" name="escaping-mechanism">Escaping Mechanism</a></h2>
565     <p>reStructuredText uses backslashes (&quot;<tt class="literal"><span class="pre">\</span></tt>&quot;) to override the special
566     meaning given to markup characters and get the literal characters
567     themselves. To get a literal backslash, use an escaped backslash
568     (&quot;<tt class="literal"><span class="pre">\\</span></tt>&quot;). There are two contexts in which backslashes have no
569     special meaning: <a class="reference" href="#literal-blocks">literal blocks</a> and inline literals (see <a class="reference" href="#inline-markup">Inline
570     Markup</a> above). In these contexts, no markup recognition is done,
571     and a single backslash represents a literal backslash, without having
572     to double up.</p>
573     <p>If you find that you need to use a backslash in your text, consider
574     using inline literals or a literal block instead.</p>
575     </div>
576     </div>
577     <div class="section" id="habits-to-avoid">
578     <h1><a class="toc-backref" href="#id43" name="habits-to-avoid">Habits to Avoid</a></h1>
579     <p>Many programmers who are familiar with TeX often write quotation marks
580     like this:</p>
581     <pre class="literal-block">
582     `single-quoted' or ``double-quoted''
583     </pre>
584     <p>Backquotes are significant in reStructuredText, so this practice
585     should be avoided. For ordinary text, use ordinary 'single-quotes' or
586     &quot;double-quotes&quot;. For inline literal text (see <a class="reference" href="#inline-markup">Inline Markup</a>
587     above), use double-backquotes:</p>
588     <pre class="literal-block">
589     ``literal text: in here, anything goes!``
590     </pre>
591     </div>
592     <div class="section" id="resources">
593     <h1><a class="toc-backref" href="#id44" name="resources">Resources</a></h1>
594     <p>Many other constructs and variations are possible. For more details
595     about the reStructuredText markup, in increasing order of
596     thoroughness, please see:</p>
597     <ul class="simple">
598     <li><a class="reference" href="http://docutils.sourceforge.net/docs/rst/quickstart.html">A ReStructuredText Primer</a> <a class="footnote-reference" href="#id17" id="id18" name="id18">[8]</a>, a gentle introduction.</li>
599     <li><a class="reference" href="http://docutils.sourceforge.net/docs/rst/quickref.html">Quick reStructuredText</a> <a class="footnote-reference" href="#id19" id="id20" name="id20">[9]</a>, a users' quick reference.</li>
600     <li><a class="reference" href="http://docutils.sourceforge.net/spec/rst/reStructuredText.html">reStructuredText Markup Specification</a> <a class="footnote-reference" href="#id21" id="id22" name="id22">[10]</a>, the final authority.</li>
601     </ul>
602     <p>The processing of reStructuredText GLEPs is done using <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> <a class="footnote-reference" href="#id8" id="id9" name="id9">[4]</a>. If
603     you have a question or require assistance with reStructuredText or
604     Docutils, please <a class="reference" href="mailto:docutils-users&#64;lists.sourceforge.net?subject=GLEPs">post a message</a> <a class="footnote-reference" href="#id10" id="id11" name="id11">[5]</a> to the <a class="reference" href="http://lists.sourceforge.net/lists/listinfo/docutils-users">Docutils-Users mailing
605     list</a> <a class="footnote-reference" href="#id12" id="id13" name="id13">[6]</a>. The <a class="reference" href="http://docutils.sourceforge.net/">Docutils project web site</a> <a class="footnote-reference" href="#id8" id="id14" name="id14">[4]</a> has more information.</p>
606     </div>
607     <div class="section" id="references">
608     <h1><a class="toc-backref" href="#id45" name="references">References</a></h1>
609     <table class="footnote" frame="void" id="python" rules="none">
610     <colgroup><col class="label" /><col /></colgroup>
611     <tbody valign="top">
612     <tr><td class="label"><a class="fn-backref" href="#id1" name="python">[1]</a></td><td><a class="reference" href="http://www.python.org">http://www.python.org</a></td></tr>
613     </tbody>
614     </table>
615     <table class="footnote" frame="void" id="pep12" rules="none">
616     <colgroup><col class="label" /><col /></colgroup>
617     <tbody valign="top">
618     <tr><td class="label"><a class="fn-backref" href="#id2" name="pep12">[2]</a></td><td><a class="reference" href="http://www.python.org/peps/pep-0012.html">http://www.python.org/peps/pep-0012.html</a></td></tr>
619     </tbody>
620     </table>
621     <table class="footnote" frame="void" id="glep1" rules="none">
622     <colgroup><col class="label" /><col /></colgroup>
623     <tbody valign="top">
624     <tr><td class="label"><a class="fn-backref" href="#id3" name="glep1">[3]</a></td><td>GLEP 1, GLEP Purpose and Guidelines, Goodyear,
625     (<a class="reference" href="http://glep.gentoo.org/glep-0001.html">http://glep.gentoo.org/glep-0001.html</a>)</td></tr>
626     </tbody>
627     </table>
628     <table class="footnote" frame="void" id="id8" rules="none">
629     <colgroup><col class="label" /><col /></colgroup>
630     <tbody valign="top">
631     <tr><td class="label"><a name="id8">[4]</a></td><td><em>(<a class="fn-backref" href="#id9">1</a>, <a class="fn-backref" href="#id14">2</a>)</em> <a class="reference" href="http://docutils.sourceforge.net/">http://docutils.sourceforge.net/</a></td></tr>
632     </tbody>
633     </table>
634     <table class="footnote" frame="void" id="id10" rules="none">
635     <colgroup><col class="label" /><col /></colgroup>
636     <tbody valign="top">
637     <tr><td class="label"><a class="fn-backref" href="#id11" name="id10">[5]</a></td><td><a class="reference" href="mailto:docutils-users&#64;lists.sourceforge.net?subject=GLEPs">mailto:docutils-users&#64;lists.sourceforge.net?subject=GLEPs</a></td></tr>
638     </tbody>
639     </table>
640     <table class="footnote" frame="void" id="id12" rules="none">
641     <colgroup><col class="label" /><col /></colgroup>
642     <tbody valign="top">
643     <tr><td class="label"><a class="fn-backref" href="#id13" name="id12">[6]</a></td><td><a class="reference" href="http://lists.sourceforge.net/lists/listinfo/docutils-users">http://lists.sourceforge.net/lists/listinfo/docutils-users</a></td></tr>
644     </tbody>
645     </table>
646     <table class="footnote" frame="void" id="id15" rules="none">
647     <colgroup><col class="label" /><col /></colgroup>
648     <tbody valign="top">
649     <tr><td class="label"><a class="fn-backref" href="#id16" name="id15">[7]</a></td><td><a class="reference" href="http://www.opencontent.org/openpub/">http://www.opencontent.org/openpub/</a></td></tr>
650     </tbody>
651     </table>
652     <table class="footnote" frame="void" id="id17" rules="none">
653     <colgroup><col class="label" /><col /></colgroup>
654     <tbody valign="top">
655     <tr><td class="label"><a class="fn-backref" href="#id18" name="id17">[8]</a></td><td><a class="reference" href="http://docutils.sourceforge.net/docs/rst/quickstart.html">http://docutils.sourceforge.net/docs/rst/quickstart.html</a></td></tr>
656     </tbody>
657     </table>
658     <table class="footnote" frame="void" id="id19" rules="none">
659     <colgroup><col class="label" /><col /></colgroup>
660     <tbody valign="top">
661     <tr><td class="label"><a class="fn-backref" href="#id20" name="id19">[9]</a></td><td><a class="reference" href="http://docutils.sourceforge.net/docs/rst/quickref.html">http://docutils.sourceforge.net/docs/rst/quickref.html</a></td></tr>
662     </tbody>
663     </table>
664     <table class="footnote" frame="void" id="id21" rules="none">
665     <colgroup><col class="label" /><col /></colgroup>
666     <tbody valign="top">
667     <tr><td class="label"><a class="fn-backref" href="#id22" name="id21">[10]</a></td><td><a class="reference" href="http://docutils.sourceforge.net/spec/rst/reStructuredText.html">http://docutils.sourceforge.net/spec/rst/reStructuredText.html</a></td></tr>
668     </tbody>
669     </table>
670     </div>
671     <div class="section" id="copyright">
672     <h1><a class="toc-backref" href="#id46" name="copyright">Copyright</a></h1>
673     <p>This document has been placed in the public domain.</p>
674     </div>
675     </div>
677     <hr class="footer"/>
678     <div class="footer">
679     <a class="reference" href="glep-0002.txt">View document source</a>.
680 liquidx 1.5 Generated on: 2003-07-19 12:06 UTC.
681 g2boojum 1.1 Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
682     </div>
683     </body>
684     </html>

  ViewVC Help
Powered by ViewVC 1.1.20