glep-0002: Revert to ReST version

1 files changed, 468 insertions, 134 deletions

diff --git a/glep-0002.txt b/glep-0002.txt
index 0d3aec7..06a1964 100644
--- a/glep-0002.txt
+++ b/glep-0002.txt
@@ -1,172 +1,358 @@
 GLEP: 2
-Title: Sample Wiki Markup GLEP Template
+Title: Sample ReStructuredText GLEP Template
 Version: $Revision$
 Last-Modified: $Date$
-Author:	Grant Goodyear <g2boojum@gentoo.org>, Chris Reffett <creffett@gentoo.org>
+Author:	Grant Goodyear <g2boojum@gentoo.org>,
 Status: Active
 Type: Informational
-Content-Type: text/x-wiki
+Content-Type: text/x-rst
 Created: 31 May 2003
 Post-History: 2-Jun-2003, 17-Dec-2013
 
-==Credits==
 
-The text of this GLEP was, to a significant extent, stolen from Python's <ref name="python">http://www.python.org</ref> PEP-0012 <ref name="pep12"> http://www.python.org/peps/pep-0012.html</ref> by David Goodger and Barry A. Warsaw.
+Credits
+=======
 
-Note: if you are reading this GLEP via the web, you should first grab the text (Wiki Markup) source of this GLEP in order to complete the steps below.  '''DO NOT USE THE HTML FILE AS YOUR TEMPLATE!'''
+The text of this GLEP was, to a significant extent, stolen from Python's
+[#PYTHON]_ PEP-0012 [#PEP12]_ by David Goodger and Barry A. Warsaw.
 
-To get the source of this (or any) GLEP, look at the top of the page and click on the link titled "View source".
 
-==Abstract==
+Abstract
+========
 
-This GLEP provides a boilerplate or sample template for creating your own Wiki text GLEPs.  In conjunction with the content guidelines in GLEP 1 <ref name="glep1">GLEP 1, GLEP Purpose and Guidelines, Goodyear, (http://wiki.gentoo.org/index.php?title=GLEP:1)</ref>, this should make it easy for you to conform your own GLEPs to the format outlined below.                                                                                                                                                                          
+This GLEP provides a boilerplate or sample template for creating your own
+reStructuredText GLEPs.  In conjunction with the content guidelines in GLEP 1
+[#GLEP1]_, this should make it easy for you to conform your own GLEPs to the
+format outlined below.
 
-==Motivation==                                   
+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.
+**DO NOT USE THE HTML FILE AS YOUR TEMPLATE!**
 
-Provide adequate motivation here.  In this particular case, we need to provide people with the information necessary to submit GLEPs in the proper form.                                                                                                                                                        
+To get the source of this (or any) GLEP, look at the top of the HTML page and
+click on the link titled "GLEP Source".
 
-==Rationale==
+Motivation
+==========
 
-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.                                                                                                                                                                                          
+Provide adequate motivation here.  In this particular case, we need to provide
+people with the information necessary to submit GLEPs in the proper form.
 
-Wiki Markup is used to allow GLEP authors more functionality and expressivity, while maintaining easy readability in the source text.  The format makes the functionality accessible to readers: live hyperlinks, styled text, tables, images, and automatic tables of contents, among other advantages.  
+Rationale
+=========
 
-==Backwards Compatibility==
+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.
 
-Not a problem for this GLEP.  This section should be included even when it is only to state that there are no backwards compatibility issues.
+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.  
 
-==How to Use This Template==
 
-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 <glep@gentoo.org>.
-Once you've decided which type of GLEP yours is going to be, follow the directions below.
+Backwards Compatibility
+=======================
 
-* Make a copy of the source as described under "Abstract" and perform the following edits.
+Not a problem for this GLEP.  This section should be included *even* when it
+is only to state that there are no backwards compatibility issues.
 
-* Replace the "GLEP: 2" header with "GLEP: XXX" since you don't yet have a GLEP number assignment.
 
-* Change the Title header to the title of your GLEP.
+How to Use This Template
+========================
 
-* Leave the Version header alone; we'll take care of those when we add your GLEP to the wiki.
+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 <glep@gentoo.org>.
 
-* 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.
+Once you've decided which type of GLEP yours is going to be, follow the
+directions below.
 
-* 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 gentoo-dev@gentoo.org, or if discussions should be sent to you directly.  Most Informational GLEPs don't have a Discussions-To header.
+- Make a copy of this file (``.txt`` file, **not** HTML!) and perform
+  the following edits.
 
-* Change the Status header to "Draft".
+- Replace the "GLEP: 2" header with "GLEP: XXX" since you don't yet have
+  a GLEP number assignment.
 
-* For Standards Track GLEPs, change the Type header to "Standards Track".
+- Change the Title header to the title of your GLEP.
 
-* For Informational GLEPs, change the Type header to "Informational".
+- Leave the Version and Last-Modified headers alone; we'll take care
+  of those when we check your GLEP into CVS.
 
-* 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.
+- 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.
 
-* Change the Created header to today's date.  Be sure to follow the format carefully: it must be in dd-mmm-yyyy format, where the mmm is the 3 English letter month abbreviation, i.e. one of Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec.
+- 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 gentoo-dev@gentoo.org, or if discussions should be sent to you
+  directly.  Most Informational GLEPs don't have a Discussions-To header.
 
-* Leave Post-History alone for now; you'll add dates to this header each time you post your GLEP to gentoo-dev@gentoo.org.  If you posted your GLEP to the list on August 14, 2003 and September 3, 2003, the Post-History header would look like:
+- Change the Status header to "Draft".
 
-    Post-History: 14-Aug-2003, 03-Sept-2003
+- For Standards Track GLEPs, change the Type header to "Standards
+  Track".
 
-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.
+- For Informational GLEPs, change the Type header to "Informational".
 
-* 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 "final" form, i.e. is either Accepted, Final, or Rejected.  You aren't replacing an older open GLEP if you're submitting a competing idea.
-* 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.
-* Update your References section.  You should leave the Copyright section as-is, since all new GLEPs are to be licensed under the Creative Commons Attribution-ShareAlike License, Version 3.0.
-* Send your GLEP submission to the GLEP editors at glep@gentoo.org.
+- 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.
 
-==Wiki Markup GLEP Formatting Requirements==
+- Change the Created header to today's date.  Be sure to follow the
+  format carefully: it must be in ``dd-mmm-yyyy`` format, where the ``mmm`` is
+  the 3 English letter month abbreviation, i.e. one of Jan, Feb, Mar, Apr,
+  May, Jun, Jul, Aug, Sep, Oct, Nov, Dec.
 
-The following is a GLEP-specific summary of Wiki Markup syntax.  For the sake of simplicity and brevity, much detail is omitted.  For more detail, see [[#Resources|Resources]] below. <nowiki><nowiki></nowiki> blocks  (in which no markup processing is done) are used for examples throughout, to illustrate the plaintext markup.
+- Leave Post-History alone for now; you'll add dates to this header
+  each time you post your GLEP to gentoo-dev@gentoo.org.  If you posted your
+  GLEP to the list on August 14, 2003 and September 3, 2003, the Post-History
+  header would look like::
 
-===General===
+      Post-History: 14-Aug-2003, 03-Sept-2003
 
-You must adhere to the convention of adding two spaces at the end of every sentence.  There are no longer line length restrictions when creating GLEPs.
+  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.
 
-===Section Headings===
+- 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 "final" form, i.e.
+  is either Accepted, Final, or Rejected.  You aren't replacing an older open
+  GLEP if you're submitting a competing idea.
 
-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 properly marked as such using the "=" (equals sign) character, with the number of equals corresponding to the level of the heading plus one, so two equals signs on each side for a first-level title, three on each side for a second-level title, and so on up to five levels.  For example:
-<pre>
-==First-Level Title==
-===Second-Level Title===
-====Third-Level Title====
-</pre>
-You shouldn't have more than five levels of sections in your GLEP.  If you do, you should consider rewriting it.
+- 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.
 
-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.
+- 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 `Open Publication License`__,
+  but public domain is still strongly preferred.
 
-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.
+  __ http://www.opencontent.org/openpub/
 
-===Paragraphs===
+- Send your GLEP submission to the GLEP editors at glep@gentoo.org.
 
-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). Wiki Markup formatting interprets newlines in a specific way. A single newline is treated as formatting and so there is no line inserted into the displayed product, but two newlines is interpreted as a line break and inserts a newline into the final product.  For example,
-this does not display a line break, but
 
-this has two newlines and therefore does.
+ReStructuredText GLEP Formatting Requirements
+=============================================
 
-===Inline Markup===
+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
+`Resources`_ below.  `Literal blocks`_ (in which no markup processing is done)
+are used for examples throughout, to illustrate the plaintext markup.
 
-Portions of text within paragraphs and other text blocks may be styled.  For example:
 
-Text may be marked as ''emphasized'' (double apostrophe markup, typically shown in italics) or '''strongly emphasized''' (triple apostrophes, typically boldface).  Preformatted sections (set off using <nowiki><pre></nowiki> tags) are typically rendered in a monospaced typeface.  No further markup recognition is done within the tags,  so they're safe for any kind of code snippets.  Alternatively, if the snippet should not be set aside in a monospaced typeface, the <nowiki><nowiki></nowiki> tag may be used, but this strips line breaks and other whitespace.
+General
+-------
 
-===Block Quotes===
+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.
 
-Block quotes consist of indented body elements.  For example:
+
+Section Headings
+----------------
+
+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 "=" (equals signs), second-level section
+titles with "-" (hyphens), and third-level section titles with "'" (single
+quotes or apostrophes).  For example::
+
+    First-Level Title
+    =================
+
+    Second-Level Title
+    ------------------
+
+    Third-Level Title
+    '''''''''''''''''
+
+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::
+
+    ============================
+    First-Level Title (optional)
+    ============================
+
+    -----------------------------
+    Second-Level Title (optional)
+    -----------------------------
+
+    Third-Level Title
+    =================
+
+    Fourth-Level Title
+    ------------------
+
+    Fifth-Level Title
+    '''''''''''''''''
+
+You shouldn't have more than five levels of sections in your GLEP.  If you do,
+you should consider rewriting it.
+
+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.
+
+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.
+
+
+Paragraphs
+----------
+
+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).
+
+
+Inline Markup
+-------------
+
+Portions of text within paragraphs and other text blocks may be
+styled.  For example::
+
+    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.
+
+
+Block Quotes
+------------
+
+Block quotes consist of indented body elements.  For example::
 
     This is a paragraph.
 
         This is a block quote.
+
         A block quote may contain many paragraphs.
 
-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.  A contiguous block quote should not have extra spacing between lines; this causes the wiki to break them up into separate quotes.
+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.
+
+
+Literal Blocks
+--------------
+
+..  
+    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.
+
+Literal blocks are used for code samples or preformatted ASCII art. To
+indicate a literal block, preface the indented text block with
+"``::``" (two colons).  The literal block continues until the end of
+the indentation.  Indent the text block by a tab.  For example::
+
+    This is a typical paragraph.  A literal block follows.
+
+    ::
+
+        for a in [5,4,3,2,1]:   # this is program code, shown as-is
+            print a
+        print "it's..."
+        # a literal block continues until the indentation ends
+
+The paragraph containing only "``::``" will be completely removed from
+the output; no empty paragraph will remain.  "``::``" 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 "``::``", *one* colon will be removed from
+the output, leaving only one colon visible (i.e., "``::``" will be
+replaced by "``:``").  For example, one colon will remain visible
+here::
+
+    Paragraph::
+
+        Literal block
+
+
+Lists
+-----
+
+Bullet list items begin with one of "-", "*", or "+" (hyphen,
+asterisk, or plus sign), followed by whitespace and the list item
+body.  List item bodies must be left-aligned and indented relative to
+the bullet; the text immediately after the bullet determines the
+indentation.  For example::
+
+    This paragraph is followed by a list.
 
-===Literal Blocks===
+    * 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.
 
-<!--
-In the text below, <pre> and <nowiki> tags are used to indicate to the markup parser that a tag should be displayed literally. Thus, <nowiki><pre></nowiki> and <nowiki><nowiki></nowiki> are displayed as <pre> and <nowiki> respectively.  See "Inline Markup" above.
+    * This is the first paragraph in the second item in the list.
 
-By the way, this is a comment, described in "Comments" below.
--->
-Literal blocks are used for code samples or preformatted ASCII art.  To indicate a literal block, preface the text block with <nowiki><pre></nowiki>.  The literal block continues until the <nowiki></pre></nowiki> block is reached.  For example:
+      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 typical paragraph.  A literal block follows.
+      - 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.
 
-<pre>
-for a in [5,4,3,2,1]:   # this is program code, shown as-is
-    print a
-print "it's..."
-</pre>
+    * This is the third item of the main list.
 
-===Lists===
+    This paragraph is not part of the list.
 
-Bullet list items begin with "*" (asterisk) for a bulleted list followed by whitespace and the list item body.  Sub-lists may be created by adding additional list symbols, so "**" would add a bullet for a sub-list, "***" would add a bullet for a sub-sub-list, and so on.  For example:
+Enumerated (numbered) list items are similar, but use an enumerator
+instead of a bullet.  Enumerators are numbers (1, 2, 3, ...), letters
+(A, B, C, ...; uppercase or lowercase), or Roman numerals (i, ii, iii,
+iv, ...; uppercase or lowercase), formatted with a period suffix
+("1.", "2."), parentheses ("(1)", "(2)"), or a right-parenthesis
+suffix ("1)", "2)").  For example::
 
-This paragraph is followed by a list.
+    1. As with bullet list items, the left edge of paragraphs must
+       align.
 
-* This is the first bullet list item.
-* This is the first paragraph in the second item in the list. <br />This is the second paragraph in the second item in the list. In order to add extra paragraphs to a list item, add the <nowiki><br /></nowiki> tag before the second paragraph. 
-** This is is a sublist.
-* This is the third item of the main list.
+    2. Each list item may contain multiple paragraphs, sublists, etc.
 
-This paragraph is not part of the list.
+       This is the second paragraph of the second list item.
 
-Enumerated (numbered) list items are similar, but use the "#" symbol instead of the "*" symbol.
+       a) Enumerated lists may be nested.
+       b) Blank lines may be omitted between list items.
 
-# First entry of an enumerated list.
-# Each list item may contain multiple paragraphs, sublists, etc. <br />This is the second paragraph of the second list item.
-## Enumerated lists may be nested.
-## Keep in mind that you should not have extra newlines between list elements, since they must be in a contiguous group in order to be numbered properly
+Definition lists are written like this::
 
-Definition lists are written like this:
+    what
+        Definition lists associate a term with a definition.
 
-;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.
 
-;how
-:the term is a one-line phrase preceded by ; (a semicolon), and the definition is preceded by : (a colon).
 
-===Tables===
+Tables
+------
 
-Simple tables are easy and compact:
+Simple tables are easy and compact::
 
     =====  =====  =======
       A      B    A and B
@@ -179,7 +365,7 @@ Simple tables are easy and compact:
 
 There must be at least two columns in a table (to differentiate from
 section titles).  Column spans use underlines of hyphens ("Inputs"
-spans the first two columns):
+spans the first two columns)::
 
     =====  =====  ======
        Inputs     Output
@@ -208,75 +394,223 @@ consist of multiple lines.  For example::
              list (row 3, column 2).
     =====  =========================
 
-===Hyperlinks===
 
-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 [[#Footnotes|Footnotes]] below).  Do not include the URL in the body text of the GLEP.
+Hyperlinks
+----------
+
+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
+`Footnotes`_ below).  Do not include the URL in the body text of the
+GLEP.
+
+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::
+
+    In this paragraph, we refer to the `Python web site`_.
+
+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 "explicit
+markup start"), followed by a leading underscore, the reference text,
+a colon, and the URL (absolute or relative)::
+
+    .. _Python web site: http://www.python.org/
+
+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
+*away* from the reference and *toward* the target.
+
+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::
+
+    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_.
+
+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.
+
+Text of the form "GLEP x" or "RFC x" (where "x" is a number) will be
+linked automatically to the appropriate URLs.
+
+
+Footnotes
+---------
+
+Footnote references consist of a left square bracket, a number, a
+right square bracket, and a trailing underscore::
+
+    This sentence ends with a footnote reference [1]_.
+
+Whitespace must precede the footnote reference.  Leave a space between
+the footnote reference and the preceding word.
+
+When referring to another GLEP, include the GLEP number in the body
+text, such as "GLEP 1".  The title may optionally appear.  Add a
+footnote reference following the title.  For example::
+
+    Refer to GLEP 1 [2]_ for more information.
+
+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 ".. " (the explicit
+markup start), followed by the footnote marker (no underscores),
+followed by the footnote body.  For example::
+
+    References
+    ==========
+
+    .. [2] GLEP 1, "GLEP Purpose and Guidelines", Goodyear, Warsaw, Hylton
+       (http://glep.gentoo.org/glep-0001.html)
+
+If you decide to provide an explicit URL for a GLEP, please use this as
+the URL template::
+
+    http://glep.gentoo.org/glep-xxxx.html
+
+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.
+
+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 "#word", where "word" is a mnemonic consisting of alphanumerics
+plus internal hyphens, underscores, and periods (no whitespace or
+other characters are allowed).  For example::
+
+    Refer to GLEP 1 [#GLEP-1]_ for more information.
+
+    References
+    ==========
+
+    .. [#GLEP-1] GLEP 1, "GLEP Purpose and Guidelines", Goodyear
+       http://glep.gentoo.org/glep-0001.html
+
+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.
+
+
+Images
+------
+
+If your GLEP contains a diagram, you may include it in the processed
+output using the "image" directive::
+
+    .. image:: diagram.png
+
+Any browser-friendly graphics format is possible: .png, .jpeg, .gif,
+.tiff, etc.
+
+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).
+
+
+Comments
+--------
+
+A comment block is an indented block of arbitrary text immediately
+following an explicit markup start: two periods and whitespace.  Leave
+the ".." on a line by itself to ensure that the comment is not
+misinterpreted as another explicit markup construct.  Comments are not
+visible in the processed document.  For the benefit of those reading
+your GLEP in source form, please consider including a descriptions of
+or ASCII art alternatives to any images you include.  For example::
+
+     .. image:: dataflow.png
+
+     ..
+        Data flows from the input module, through the "black box"
+        module, and finally into (and through) the output module.
 
-Hyperlink references can be accomplished using single brackets. These brackets should contain the link, a space, then the text to display for the hyperlink. For example:
 
-<pre>In this paragraph, we refer to the [http://www.python.org/ Python web site]</pre>
 
-There are certain limitations to embedding hyperlinks like this, mostly related to special characters requiring replacement. [http://en.wikipedia.org/wiki/Help:Wiki_markup#External_links Wikipedia] has a list of these special cases.
+Escaping Mechanism
+------------------
 
-A similar mechanism can be used for internal references or references within the wiki, although these use double brackets instead of single brackets and a vertical pipe to differentiate between the target and the display text.  Every unique section title implicitly defines an internal hyperlink target.  We can make a link to the Abstract section like this:
+reStructuredText uses backslashes ("``\``") to override the special
+meaning given to markup characters and get the literal characters
+themselves.  To get a literal backslash, use an escaped backslash
+("``\\``").  There are two contexts in which backslashes have no
+special meaning: `literal blocks`_ and inline literals (see `Inline
+Markup`_ above).  In these contexts, no markup recognition is done,
+and a single backslash represents a literal backslash, without having
+to double up.
 
-<pre>Here is a hyperlink reference to the [[#Abstract|Abstract]] section.</pre>
+If you find that you need to use a backslash in your text, consider
+using inline literals or a literal block instead.
 
-===Footnotes===
 
-<nowiki>
-The references section will be generated via the Mediawiki "Cite" extension. In order to add a refence, use <ref name="(name)">(Link/name of source)</ref>.  Any subsequent references to the same source may use <ref name="(name)"/> to refer to the same source.  All references should have a name associated with them. Under the References section, the tag <references/> should be used to output all of the references in a list. </nowiki>
+Habits to Avoid
+===============
 
-When referring to another GLEP, include the GLEP number in the body text, such as "GLEP 1".  The title may optionally appear.  Add a footnote reference following the title, which should include the title and author's name, and may optionally include an explicit URL. If you decide to provide an explicit URL for a GLEP, please use this as the URL template:
+Many programmers who are familiar with TeX often write quotation marks
+like this::
 
-    http://wiki.gentoo.org/wiki/GLEP:xxxx.html <!--Subject to chance once we actually get the namespace -->
+    `single-quoted' or ``double-quoted''
 
-A citation of GLEP 1 done like this might look like:
+Backquotes are significant in reStructuredText, so this practice
+should be avoided.  For ordinary text, use ordinary 'single-quotes' or
+"double-quotes".  For inline literal text (see `Inline Markup`_
+above), use double-backquotes::
 
-<pre>Refer to GLEP 1 for more information.<ref name="glep1">
-GLEP 1, GLEP Purpose and Guidelines, Goodyear, (http://wiki.gentoo.org/wiki/GLEP:0001.html)</ref></pre>
+    ``literal text: in here, anything goes!``
 
 
-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. 
+Resources
+=========
 
-Footnotes and footnote references will be numbered and inserted automatically, and the numbers will always match. 
+Many other constructs and variations are possible.  For more details
+about the reStructuredText markup, in increasing order of
+thoroughness, please see:
 
-===Images===
+* `A ReStructuredText Primer`__, a gentle introduction.
 
-If your GLEP contains a diagram, you first must upload it at the [[Special:Upload|upload page.] You may then include it in the processed
-output using a File: tag:
+  __ http://docutils.sourceforge.net/docs/rst/quickstart.html
 
-<pre>[[File:diagram.png]]</pre>
+* `Quick reStructuredText`__, a users' quick reference.
 
-Any browser-friendly graphics format is possible: .png, .jpeg, .gif, .tiff, etc.
+  __ http://docutils.sourceforge.net/docs/rst/quickref.html
 
-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).
+* `reStructuredText Markup Specification`__, the final authority.
 
-===Comments===
+  __ http://docutils.sourceforge.net/spec/rst/reStructuredText.html
 
-A comment block is a block of markup text that will not appear in the final page.  It is delimited by <nowiki><!-- and --></nowiki>, and so looks like this:
+The processing of reStructuredText GLEPs is done using Docutils_.  If
+you have a question or require assistance with reStructuredText or
+Docutils, please `post a message`_ to the `Docutils-Users mailing
+list`_.  The `Docutils project web site`_ has more information.
 
-    <pre><!--Here is a comment!--></pre>
+.. _Docutils: http://docutils.sourceforge.net/
+.. _post a message:
+   mailto:docutils-users@lists.sourceforge.net?subject=GLEPs
+.. _Docutils-Users mailing list:
+   http://lists.sourceforge.net/lists/listinfo/docutils-users
+.. _Docutils project web site: http://docutils.sourceforge.net/
 
-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:
 
-<pre>
-[[File:dataflow.png]]
-<!--Data flows from the input module, through the "black box" module, and finally into (and through) the output module.-->
-</pre>
+References
+==========
 
-==Resources==
+.. [#PYTHON] http://www.python.org
 
-Wiki Markup has a large number of formatting options, this guide should only be considered to be a basic introduction. For more information, the following links may be useful:
+.. [#PEP12] http://www.python.org/peps/pep-0012.html
 
-* The Wikipedia Cheat Sheet, which is a quick reference for basic formatting. <ref name="wikicheatsheet">http://en.wikipedia.org/wiki/Wikipedia:Cheatsheet</ref>
-* The Wikipedia help page on Wiki Markup, which is much more in-depth and has many subpages for specific topics. <ref name="wikimarkupguide">http://en.wikipedia.org/wiki/Help:Wiki_markup</ref>
+.. [#GLEP1] GLEP 1, GLEP Purpose and Guidelines, Goodyear, 
+   (http://glep.gentoo.org/glep-0001.html)
 
-==References==
 
-This section should include a <nowiki><references /></nowiki> tag, which will automatically generate all footnotes from the above document.
-<references/>
+Copyright
+=========
 
-==Copyright==
+This document has been placed in the public domain.
 
-This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/3.0/.