en/glep/glep-0002.html

<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">

<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  <meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
  <title>GLEP 2 -- Sample ReStructuredText GLEP Template</title>
  <link rel="stylesheet" href="tools/glep.css" type="text/css" />
</head>
<body bgcolor="white">
<table class="navigation" cellpadding="0" cellspacing="0"
       width="100%" border="0">
<tr><td class="navicon" width="150" height="35">
<a href="http://www.gentoo.org/" title="Gentoo Linux Home Page">
<img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]"
 border="0" width="150" height="35" /></a></td>
<td class="textlinks" align="left">
[<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>]
[<b><a href="http://www.gentoo.org/proj/en/glep">GLEP Index</a></b>]
[<b><a href="http://www.gentoo.org/proj/en/glep/glep-0002.txt">GLEP Source</a></b>]
</td></tr></table>
<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">GLEP:</th><td class="field-body">2</td>
</tr>
<tr class="field"><th class="field-name">Title:</th><td class="field-body">Sample ReStructuredText GLEP Template</td>
</tr>
<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.4</td>
</tr>
<tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference" href="http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/glep/glep-0002.txt?cvsroot=gentoo">2003/07/19 12:09:20</a></td>
</tr>
<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>
</tr>
<tr class="field"><th class="field-name">Status:</th><td class="field-body">Active</td>
</tr>
<tr class="field"><th class="field-name">Type:</th><td class="field-body">Informational</td>
</tr>
<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>
</tr>
<tr class="field"><th class="field-name">Created:</th><td class="field-body">31 May 2003</td>
</tr>
<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">2-Jun-2003</td>
</tr>
</tbody>
</table>
<hr />
<div class="contents topic">
<p class="topic-title first"><a id="contents" name="contents">Contents</a></p>
<ul class="simple">
<li><a class="reference" href="#credits" id="id23" name="id23">Credits</a></li>
<li><a class="reference" href="#abstract" id="id24" name="id24">Abstract</a></li>
<li><a class="reference" href="#motivation" id="id25" name="id25">Motivation</a></li>
<li><a class="reference" href="#rationale" id="id26" name="id26">Rationale</a></li>
<li><a class="reference" href="#backwards-compatibility" id="id27" name="id27">Backwards Compatibility</a></li>
<li><a class="reference" href="#how-to-use-this-template" id="id28" name="id28">How to Use This Template</a></li>
<li><a class="reference" href="#restructuredtext-glep-formatting-requirements" id="id29" name="id29">ReStructuredText GLEP Formatting Requirements</a><ul>
<li><a class="reference" href="#general" id="id30" name="id30">General</a></li>
<li><a class="reference" href="#section-headings" id="id31" name="id31">Section Headings</a></li>
<li><a class="reference" href="#paragraphs" id="id32" name="id32">Paragraphs</a></li>
<li><a class="reference" href="#inline-markup" id="id33" name="id33">Inline Markup</a></li>
<li><a class="reference" href="#block-quotes" id="id34" name="id34">Block Quotes</a></li>
<li><a class="reference" href="#literal-blocks" id="id35" name="id35">Literal Blocks</a></li>
<li><a class="reference" href="#lists" id="id36" name="id36">Lists</a></li>
<li><a class="reference" href="#tables" id="id37" name="id37">Tables</a></li>
<li><a class="reference" href="#hyperlinks" id="id38" name="id38">Hyperlinks</a></li>
<li><a class="reference" href="#footnotes" id="id39" name="id39">Footnotes</a></li>
<li><a class="reference" href="#images" id="id40" name="id40">Images</a></li>
<li><a class="reference" href="#comments" id="id41" name="id41">Comments</a></li>
<li><a class="reference" href="#escaping-mechanism" id="id42" name="id42">Escaping Mechanism</a></li>
</ul>
</li>
<li><a class="reference" href="#habits-to-avoid" id="id43" name="id43">Habits to Avoid</a></li>
<li><a class="reference" href="#resources" id="id44" name="id44">Resources</a></li>
<li><a class="reference" href="#references" id="id45" name="id45">References</a></li>
<li><a class="reference" href="#copyright" id="id46" name="id46">Copyright</a></li>
</ul>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id23" id="credits" name="credits">Credits</a></h1>
<p>The text of this GLEP was, to a significant extent, stolen from Python's
<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>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id24" id="abstract" name="abstract">Abstract</a></h1>
<p>This GLEP provides a boilerplate or sample template for creating your own
reStructuredText GLEPs.  In conjunction with the content guidelines in GLEP 1
<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
format outlined below.</p>
<p>Note: if you are reading this GLEP via the web, you should first grab the text
(reStructuredText) source of this GLEP in order to complete the steps below.
<strong>DO NOT USE THE HTML FILE AS YOUR TEMPLATE!</strong></p>
<p>To get the source of this (or any) GLEP, look at the top of the HTML page and
click on the link titled &quot;GLEP Source&quot;.</p>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id25" id="motivation" name="motivation">Motivation</a></h1>
<p>Provide adequate motivation here.  In this particular case, we need to provide
people with the information necessary to submit GLEPs in the proper form.</p>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id26" id="rationale" name="rationale">Rationale</a></h1>
<p>GLEP 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 GLEP submission won't get
automatically rejected because of form.</p>
<p>ReStructuredText is used to allow GLEP 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">
<h1><a class="toc-backref" href="#id27" id="backwards-compatibility" name="backwards-compatibility">Backwards Compatibility</a></h1>
<p>Not a problem for this GLEP.  This section should be included <em>even</em> when it
is only to state that there are no backwards compatibility issues.</p>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id28" id="how-to-use-this-template" name="how-to-use-this-template">How to Use This Template</a></h1>
<p>To use this template you must first decide whether your GLEP is going to be an
Informational or Standards Track GLEP.  Most GLEPs are Standards Track because
they propose new functionality for some aspect of Gentoo Linux.  When in
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>
<p>Once you've decided which type of GLEP 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"><span class="pre">.txt</span></tt> file, <strong>not</strong> HTML!) and perform
the following edits.</p>
</li>
<li><p class="first">Replace the &quot;GLEP: 2&quot; header with &quot;GLEP: XXX&quot; since you don't yet have
a GLEP number assignment.</p>
</li>
<li><p class="first">Change the Title header to the title of your GLEP.</p>
</li>
<li><p class="first">Leave the Version and Last-Modified headers alone; we'll take care
of those when we check your GLEP into CVS.</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.  Your e-mail address
here will e automatically obfuscated.</p>
</li>
<li><p class="first">If there is a forum thread or a mailing list for discussion
of your new feature, add a Discussions-To header right after the Author
header.  You should not add a Discussions-To header if the mailing list to
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
directly.  Most Informational GLEPs don't have a Discussions-To header.</p>
</li>
<li><p class="first">Change the Status header to &quot;Draft&quot;.</p>
</li>
<li><p class="first">For Standards Track GLEPs, change the Type header to &quot;Standards
Track&quot;.</p>
</li>
<li><p class="first">For Informational GLEPs, change the Type header to &quot;Informational&quot;.</p>
</li>
<li><p class="first">For Standards Track GLEPs, if your feature depends on the acceptance
of some other currently in-development GLEP, add a Requires header right
after the Type header.  The value should be the GLEP number of the GLEP
yours depends on.  Don't add this header if your dependent feature is
described in a Final GLEP.</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"><span class="pre">mmm</span></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 GLEP to <a class="reference" href="mailto:gentoo-dev&#64;gentoo.org">gentoo-dev&#64;gentoo.org</a>.  If you posted your
GLEP to the list on August 14, 2003 and September 3, 2003, the Post-History
header would look like:</p>
<pre class="literal-block">
Post-History: 14-Aug-2003, 03-Sept-2003
</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 GLEP editors.</p>
</li>
<li><p class="first">Add a Replaces header if your GLEP obsoletes an earlier GLEP.  The
value of this header is the number of the GLEP that your new GLEP is
replacing.  Only add this header if the older GLEP is in &quot;final&quot; form, i.e.
is either Accepted, Final, or Rejected.  You aren't replacing an older open
GLEP if you're submitting a competing idea.</p>
</li>
<li><p class="first">Now write your Abstract, Rationale, and other content for your GLEP,
replacing all of this gobbledygook with your own text. Be sure to adhere to
the format guidelines below, specifically on the indentation requirements.</p>
</li>
<li><p class="first">Update your References and Copyright section.  Usually you'll place
your GLEP into the public domain, in which case just leave the Copyright
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>,
but public domain is still strongly preferred.</p>
</li>
<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>
</li>
</ul>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id29" id="restructuredtext-glep-formatting-requirements" name="restructuredtext-glep-formatting-requirements">ReStructuredText GLEP Formatting Requirements</a></h1>
<p>The following is a GLEP-specific summary of reStructuredText syntax.  For the
sake of simplicity and brevity, much detail is omitted.  For more detail, see
<a class="reference" href="#resources">Resources</a> below.  <a class="reference" 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">
<h2><a class="toc-backref" href="#id30" id="general" name="general">General</a></h2>
<p>You must adhere to the 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>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id31" id="section-headings" name="section-headings">Section Headings</a></h2>
<p>GLEP 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 &quot;=&quot; (equals signs), second-level section
titles with &quot;-&quot; (hyphens), and third-level section titles with &quot;'&quot; (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 GLEP, 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 GLEP.  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">
<h2><a class="toc-backref" href="#id32" id="paragraphs" name="paragraphs">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">
<h2><a class="toc-backref" href="#id33" id="inline-markup" name="inline-markup">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">
<h2><a class="toc-backref" href="#id34" id="block-quotes" name="block-quotes">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 a 4-space tab
per indent level.</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id35" id="literal-blocks" name="literal-blocks">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
&quot;<tt class="docutils literal"><span class="pre">::</span></tt>&quot; (two colons).  The literal block continues until the end of
the indentation.  Indent the text block by a tab.  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 &quot;it's...&quot;
    # a literal block continues until the indentation ends
</pre>
<p>The paragraph containing only &quot;<tt class="docutils literal"><span class="pre">::</span></tt>&quot; will be completely removed from
the output; no empty paragraph will remain.  &quot;<tt class="docutils literal"><span class="pre">::</span></tt>&quot; 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 &quot;<tt class="docutils literal"><span class="pre">::</span></tt>&quot;, <em>one</em> colon will be removed from
the output, leaving only one colon visible (i.e., &quot;<tt class="docutils literal"><span class="pre">::</span></tt>&quot; will be
replaced by &quot;<tt class="docutils literal"><span class="pre">:</span></tt>&quot;).  For example, one colon will remain visible
here:</p>
<pre class="literal-block">
Paragraph::

    Literal block
</pre>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id36" id="lists" name="lists">Lists</a></h2>
<p>Bullet list items begin with one of &quot;-&quot;, &quot;*&quot;, or &quot;+&quot; (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
(&quot;1.&quot;, &quot;2.&quot;), parentheses (&quot;(1)&quot;, &quot;(2)&quot;), or a right-parenthesis
suffix (&quot;1)&quot;, &quot;2)&quot;).  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">
<h2><a class="toc-backref" href="#id37" id="tables" name="tables">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 (&quot;Inputs&quot;
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">
<h2><a class="toc-backref" href="#id38" id="hyperlinks" name="hyperlinks">Hyperlinks</a></h2>
<p>When referencing an external web page in the body of a GLEP, 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" href="#footnotes">Footnotes</a> below).  Do not include the URL in the body text of the
GLEP.</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 `Python web site`_.
</pre>
<p>An explicit target provides the URL.  Put targets in a References
section at the end of the GLEP, or immediately after the reference.
Hyperlink targets begin with two periods and a space (the &quot;explicit
markup start&quot;), followed by a leading underscore, the reference text,
a colon, and the URL (absolute or relative):</p>
<pre class="literal-block">
.. _Python web site: http://www.python.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 GLEP, along
with footnote references linking the reference text to the footnotes.</p>
<p>Text of the form &quot;GLEP x&quot; or &quot;RFC x&quot; (where &quot;x&quot; is a number) will be
linked automatically to the appropriate URLs.</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id39" id="footnotes" name="footnotes">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 GLEP, include the GLEP number in the body
text, such as &quot;GLEP 1&quot;.  The title may optionally appear.  Add a
footnote reference following the title.  For example:</p>
<pre class="literal-block">
Refer to GLEP 1 [2]_ for more information.
</pre>
<p>Add a footnote that includes the GLEP's title and author.  It may
optionally include the explicit URL on a separate line, but only in
the References section.  Footnotes begin with &quot;.. &quot; (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] GLEP 1, &quot;GLEP Purpose and Guidelines&quot;, Goodyear, Warsaw, Hylton
   (http://glep.gentoo.org/glep-0001.html)
</pre>
<p>If you decide to provide an explicit URL for a GLEP, please use this as
the URL template:</p>
<pre class="literal-block">
http://glep.gentoo.org/glep-xxxx.html
</pre>
<p>GLEP numbers in URLs must be padded with zeros from the left, so as to
be exactly 4 characters wide, however GLEP numbers in the text are
never padded.</p>
<p>During the course of developing your GLEP, 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 &quot;#word&quot;, where &quot;word&quot; 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 GLEP 1 [#GLEP-1]_ for more information.

References
==========

.. [#GLEP-1] GLEP 1, &quot;GLEP Purpose and Guidelines&quot;, Goodyear
   http://glep.gentoo.org/glep-0001.html
</pre>
<p>Footnotes and footnote references will be numbered automatically, and
the numbers will always match.  Once a GLEP is finalized, auto-numbered
labels should be replaced by numbers for simplicity.</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id40" id="images" name="images">Images</a></h2>
<p>If your GLEP contains a diagram, you may include it in the processed
output using the &quot;image&quot; 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 GLEP in source
text form, you should consider including a description or ASCII art
alternative, using a comment (below).</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id41" id="comments" name="comments">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 &quot;..&quot; 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 GLEP 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 &quot;black box&quot;
   module, and finally into (and through) the output module.
</pre>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id42" id="escaping-mechanism" name="escaping-mechanism">Escaping Mechanism</a></h2>
<p>reStructuredText uses backslashes (&quot;<tt class="docutils literal"><span class="pre">\</span></tt>&quot;) to override the special
meaning given to markup characters and get the literal characters
themselves.  To get a literal backslash, use an escaped backslash
(&quot;<tt class="docutils literal"><span class="pre">\\</span></tt>&quot;).  There are two contexts in which backslashes have no
special meaning: <a class="reference" href="#literal-blocks">literal blocks</a> and inline literals (see <a class="reference" 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">
<h1><a class="toc-backref" href="#id43" id="habits-to-avoid" name="habits-to-avoid">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
&quot;double-quotes&quot;.  For inline literal text (see <a class="reference" 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">
<h1><a class="toc-backref" href="#id44" id="resources" name="resources">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" 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>
<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>
<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>
</ul>
<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
you have a question or require assistance with reStructuredText or
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
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>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id45" id="references" name="references">References</a></h1>
<table class="docutils footnote" frame="void" id="python" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<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>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="pep12" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<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>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="glep1" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id3" name="glep1">[3]</a></td><td>GLEP 1, GLEP Purpose and Guidelines, Goodyear,
(<a class="reference" href="http://glep.gentoo.org/glep-0001.html">http://glep.gentoo.org/glep-0001.html</a>)</td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id8" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<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>
</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" 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>
</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" 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>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id15" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<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>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id17" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<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>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id19" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<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>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id21" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<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>
</tbody>
</table>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id46" id="copyright" name="copyright">Copyright</a></h1>
<p>This document has been placed in the public domain.</p>
</div>

</div>
<div class="footer">
<hr class="footer" />
<a class="reference" href="glep-0002.txt">View document source</a>.
Generated on: 2007-10-13 13:39 UTC.
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.

</div>
</body>
</html>
