| … | |
… | |
| 6 | PEP, see http://www.python.org/peps/pep-0001.html for instructions and links |
6 | PEP, see http://www.python.org/peps/pep-0001.html for instructions and links |
| 7 | to templates. DO NOT USE THIS HTML FILE AS YOUR TEMPLATE! |
7 | to templates. DO NOT USE THIS HTML FILE AS YOUR TEMPLATE! |
| 8 | --> |
8 | --> |
| 9 | <head> |
9 | <head> |
| 10 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
10 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
| 11 | <meta name="generator" content="Docutils 0.2.8: http://docutils.sourceforge.net/" /> |
11 | <meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" /> |
| 12 | <title>GLEP 2 -- Sample ReStructuredText GLEP Template</title> |
12 | <title>GLEP 2 -- Sample ReStructuredText GLEP Template</title> |
| 13 | <link rel="stylesheet" href="tools/glep.css" type="text/css" /> |
13 | <style type="text/css"> |
|
|
14 | |
|
|
15 | /* |
|
|
16 | :Author: David Goodger |
|
|
17 | :Contact: goodger@users.sourceforge.net |
|
|
18 | :date: $Date: 2006/10/10 20:25:14 $ |
|
|
19 | :version: $Revision: 1.7 $ |
|
|
20 | :copyright: This stylesheet has been placed in the public domain. |
|
|
21 | |
|
|
22 | Default cascading style sheet for the PEP HTML output of Docutils. |
|
|
23 | */ |
|
|
24 | |
|
|
25 | .first { |
|
|
26 | margin-top: 0 } |
|
|
27 | |
|
|
28 | .last { |
|
|
29 | margin-bottom: 0 } |
|
|
30 | |
|
|
31 | .navigation { |
|
|
32 | width: 100% ; |
|
|
33 | background: #cc99ff ; |
|
|
34 | margin-top: 0px ; |
|
|
35 | margin-bottom: 0px } |
|
|
36 | |
|
|
37 | .navigation .navicon { |
|
|
38 | width: 150px ; |
|
|
39 | height: 35px } |
|
|
40 | |
|
|
41 | .navigation .textlinks { |
|
|
42 | padding-left: 1em ; |
|
|
43 | text-align: left } |
|
|
44 | |
|
|
45 | .navigation td, .navigation th { |
|
|
46 | padding-left: 0em ; |
|
|
47 | padding-right: 0em ; |
|
|
48 | vertical-align: middle } |
|
|
49 | |
|
|
50 | .rfc2822 { |
|
|
51 | margin-top: 0.5em ; |
|
|
52 | margin-left: 0.5em ; |
|
|
53 | margin-right: 0.5em ; |
|
|
54 | margin-bottom: 0em } |
|
|
55 | |
|
|
56 | .rfc2822 td { |
|
|
57 | text-align: left } |
|
|
58 | |
|
|
59 | .rfc2822 th.field-name { |
|
|
60 | text-align: right ; |
|
|
61 | font-family: sans-serif ; |
|
|
62 | padding-right: 0.5em ; |
|
|
63 | font-weight: bold ; |
|
|
64 | margin-bottom: 0em } |
|
|
65 | |
|
|
66 | a.toc-backref { |
|
|
67 | text-decoration: none ; |
|
|
68 | color: black } |
|
|
69 | |
|
|
70 | body { |
|
|
71 | margin: 0px ; |
|
|
72 | margin-bottom: 1em ; |
|
|
73 | padding: 0px } |
|
|
74 | |
|
|
75 | dd { |
|
|
76 | margin-bottom: 0.5em } |
|
|
77 | |
|
|
78 | div.section { |
|
|
79 | margin-left: 1em ; |
|
|
80 | margin-right: 1em ; |
|
|
81 | margin-bottom: 1.5em } |
|
|
82 | |
|
|
83 | div.section div.section { |
|
|
84 | margin-left: 0em ; |
|
|
85 | margin-right: 0em ; |
|
|
86 | margin-top: 1.5em } |
|
|
87 | |
|
|
88 | div.abstract { |
|
|
89 | margin: 2em 5em } |
|
|
90 | |
|
|
91 | div.abstract p.topic-title { |
|
|
92 | font-weight: bold ; |
|
|
93 | text-align: center } |
|
|
94 | |
|
|
95 | div.attention, div.caution, div.danger, div.error, div.hint, |
|
|
96 | div.important, div.note, div.tip, div.warning { |
|
|
97 | margin: 2em ; |
|
|
98 | border: medium outset ; |
|
|
99 | padding: 1em } |
|
|
100 | |
|
|
101 | div.attention p.admonition-title, div.caution p.admonition-title, |
|
|
102 | div.danger p.admonition-title, div.error p.admonition-title, |
|
|
103 | div.warning p.admonition-title { |
|
|
104 | color: red ; |
|
|
105 | font-weight: bold ; |
|
|
106 | font-family: sans-serif } |
|
|
107 | |
|
|
108 | div.hint p.admonition-title, div.important p.admonition-title, |
|
|
109 | div.note p.admonition-title, div.tip p.admonition-title { |
|
|
110 | font-weight: bold ; |
|
|
111 | font-family: sans-serif } |
|
|
112 | |
|
|
113 | div.figure { |
|
|
114 | margin-left: 2em } |
|
|
115 | |
|
|
116 | div.footer, div.header { |
|
|
117 | font-size: smaller } |
|
|
118 | |
|
|
119 | div.footer { |
|
|
120 | margin-left: 1em ; |
|
|
121 | margin-right: 1em } |
|
|
122 | |
|
|
123 | div.system-messages { |
|
|
124 | margin: 5em } |
|
|
125 | |
|
|
126 | div.system-messages h1 { |
|
|
127 | color: red } |
|
|
128 | |
|
|
129 | div.system-message { |
|
|
130 | border: medium outset ; |
|
|
131 | padding: 1em } |
|
|
132 | |
|
|
133 | div.system-message p.system-message-title { |
|
|
134 | color: red ; |
|
|
135 | font-weight: bold } |
|
|
136 | |
|
|
137 | div.topic { |
|
|
138 | margin: 2em } |
|
|
139 | |
|
|
140 | h1 { |
|
|
141 | font-family: sans-serif ; |
|
|
142 | font-size: large } |
|
|
143 | |
|
|
144 | h2 { |
|
|
145 | font-family: sans-serif ; |
|
|
146 | font-size: medium } |
|
|
147 | |
|
|
148 | h3 { |
|
|
149 | font-family: sans-serif ; |
|
|
150 | font-size: small } |
|
|
151 | |
|
|
152 | h4 { |
|
|
153 | font-family: sans-serif ; |
|
|
154 | font-style: italic ; |
|
|
155 | font-size: small } |
|
|
156 | |
|
|
157 | h5 { |
|
|
158 | font-family: sans-serif; |
|
|
159 | font-size: x-small } |
|
|
160 | |
|
|
161 | h6 { |
|
|
162 | font-family: sans-serif; |
|
|
163 | font-style: italic ; |
|
|
164 | font-size: x-small } |
|
|
165 | |
|
|
166 | .section hr { |
|
|
167 | width: 75% } |
|
|
168 | |
|
|
169 | ol.simple, ul.simple { |
|
|
170 | margin-bottom: 1em } |
|
|
171 | |
|
|
172 | ol.arabic { |
|
|
173 | list-style: decimal } |
|
|
174 | |
|
|
175 | ol.loweralpha { |
|
|
176 | list-style: lower-alpha } |
|
|
177 | |
|
|
178 | ol.upperalpha { |
|
|
179 | list-style: upper-alpha } |
|
|
180 | |
|
|
181 | ol.lowerroman { |
|
|
182 | list-style: lower-roman } |
|
|
183 | |
|
|
184 | ol.upperroman { |
|
|
185 | list-style: upper-roman } |
|
|
186 | |
|
|
187 | p.caption { |
|
|
188 | font-style: italic } |
|
|
189 | |
|
|
190 | p.credits { |
|
|
191 | font-style: italic ; |
|
|
192 | font-size: smaller } |
|
|
193 | |
|
|
194 | p.label { |
|
|
195 | white-space: nowrap } |
|
|
196 | |
|
|
197 | p.topic-title { |
|
|
198 | font-family: sans-serif ; |
|
|
199 | font-weight: bold } |
|
|
200 | |
|
|
201 | pre.line-block { |
|
|
202 | font-family: serif ; |
|
|
203 | font-size: 100% } |
|
|
204 | |
|
|
205 | pre.literal-block, pre.doctest-block { |
|
|
206 | margin-left: 2em ; |
|
|
207 | margin-right: 2em ; |
|
|
208 | background-color: #eeeeee } |
|
|
209 | |
|
|
210 | span.classifier { |
|
|
211 | font-family: sans-serif ; |
|
|
212 | font-style: oblique } |
|
|
213 | |
|
|
214 | span.classifier-delimiter { |
|
|
215 | font-family: sans-serif ; |
|
|
216 | font-weight: bold } |
|
|
217 | |
|
|
218 | span.interpreted { |
|
|
219 | font-family: sans-serif } |
|
|
220 | |
|
|
221 | span.option-argument { |
|
|
222 | font-style: italic } |
|
|
223 | |
|
|
224 | span.pre { |
|
|
225 | white-space: pre } |
|
|
226 | |
|
|
227 | span.problematic { |
|
|
228 | color: red } |
|
|
229 | |
|
|
230 | table { |
|
|
231 | margin-top: 0.5em ; |
|
|
232 | margin-bottom: 0.5em } |
|
|
233 | |
|
|
234 | td, th { |
|
|
235 | padding-left: 0.5em ; |
|
|
236 | padding-right: 0.5em ; |
|
|
237 | vertical-align: top } |
|
|
238 | |
|
|
239 | td.num { |
|
|
240 | text-align: right } |
|
|
241 | |
|
|
242 | th.field-name { |
|
|
243 | font-weight: bold ; |
|
|
244 | text-align: left ; |
|
|
245 | white-space: nowrap } |
|
|
246 | |
|
|
247 | h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt { |
|
|
248 | font-size: 100% } |
|
|
249 | |
|
|
250 | tt { |
|
|
251 | background-color: #eeeeee } |
|
|
252 | |
|
|
253 | ul.auto-toc { |
|
|
254 | list-style-type: none } |
|
|
255 | |
|
|
256 | </style> |
| 14 | </head> |
257 | </head> |
| 15 | <body bgcolor="white"> |
258 | <body bgcolor="white"> |
| 16 | <table class="navigation" cellpadding="0" cellspacing="0" |
259 | <table class="navigation" cellpadding="0" cellspacing="0" |
| 17 | width="100%" border="0"> |
260 | width="100%" border="0"> |
| 18 | <tr><td class="navicon" width="150" height="35"> |
261 | <tr><td class="navicon" width="150" height="35"> |
| 19 | <a href="http://www.gentoo.org/" title="Gentoo Linux Home Page"> |
262 | <a href="http://www.gentoo.org/" title="Gentoo Linux Home Page"> |
| 20 | <img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]" |
263 | <img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]" |
| 21 | border="0" width="150" height="35" /></a></td> |
264 | border="0" width="150" height="35" /></a></td> |
| 22 | <td class="textlinks" align="left"> |
265 | <td class="textlinks" align="left"> |
| 23 | [<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>] |
266 | [<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>] |
| 24 | [<b><a href="http://www.gentoo.org/proj/en/glep">GLEP Index</a></b>] |
267 | [<b><a href="http://www.gentoo.org/peps">GLEP Index</a></b>] |
| 25 | [<b><a href="http://www.gentoo.org/proj/en/glep/glep-0002.txt">GLEP Source</a></b>] |
268 | [<b><a href="http://www.gentoo.org/proj/en/glep/glep-0002.txt">GLEP Source</a></b>] |
| 26 | </td></tr></table> |
269 | </td></tr></table> |
| 27 | <div class="document"> |
|
|
| 28 | <table class="rfc2822 field-list" frame="void" rules="none"> |
270 | <table class="rfc2822 docutils field-list" frame="void" rules="none"> |
| 29 | <col class="field-name" /> |
271 | <col class="field-name" /> |
| 30 | <col class="field-body" /> |
272 | <col class="field-body" /> |
| 31 | <tbody valign="top"> |
273 | <tbody valign="top"> |
| 32 | <tr class="field"><th class="field-name">GLEP:</th><td class="field-body">2</td> |
274 | <tr class="field"><th class="field-name">GLEP:</th><td class="field-body">2</td> |
| 33 | </tr> |
275 | </tr> |
| 34 | <tr class="field"><th class="field-name">Title:</th><td class="field-body">Sample ReStructuredText GLEP Template</td> |
276 | <tr class="field"><th class="field-name">Title:</th><td class="field-body">Sample ReStructuredText GLEP Template</td> |
| 35 | </tr> |
277 | </tr> |
| 36 | <tr class="field"><th class="field-name">Version:</th><td class="field-body">1.2</td> |
278 | <tr class="field"><th class="field-name">Version:</th><td class="field-body">1.4</td> |
| 37 | </tr> |
279 | </tr> |
| 38 | <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/02 17:37:47</a></td> |
280 | <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> |
| 39 | </tr> |
281 | </tr> |
| 40 | <tr class="field"><th class="field-name">Author:</th><td class="field-body">Grant Goodyear <g2boojum at gentoo.org>,</td> |
282 | <tr class="field"><th class="field-name">Author:</th><td class="field-body">Grant Goodyear <g2boojum at gentoo.org>,</td> |
| 41 | </tr> |
283 | </tr> |
| 42 | <tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td> |
284 | <tr class="field"><th class="field-name">Status:</th><td class="field-body">Active</td> |
| 43 | </tr> |
285 | </tr> |
| 44 | <tr class="field"><th class="field-name">Type:</th><td class="field-body">Informational</td> |
286 | <tr class="field"><th class="field-name">Type:</th><td class="field-body">Informational</td> |
| 45 | </tr> |
287 | </tr> |
| 46 | <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> |
288 | <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 | </tr> |
289 | </tr> |
| 48 | <tr class="field"><th class="field-name">Created:</th><td class="field-body">31 May 2003</td> |
290 | <tr class="field"><th class="field-name">Created:</th><td class="field-body">31 May 2003</td> |
| 49 | </tr> |
291 | </tr> |
| 50 | <tr class="field"><th class="field-name">Post-History:</th><td class="field-body"></td> |
292 | <tr class="field"><th class="field-name">Post-History:</th><td class="field-body">2-Jun-2003</td> |
| 51 | </tr> |
293 | </tr> |
| 52 | </tbody> |
294 | </tbody> |
| 53 | </table> |
295 | </table> |
| 54 | <hr /> |
296 | <hr /> |
| 55 | <div class="contents topic" id="contents"> |
297 | <div class="contents topic"> |
| 56 | <p class="topic-title"><a name="contents">Contents</a></p> |
298 | <p class="topic-title first"><a id="contents" name="contents">Contents</a></p> |
| 57 | <ul class="simple"> |
299 | <ul class="simple"> |
| 58 | <li><a class="reference" href="#credits" id="id23" name="id23">Credits</a></li> |
300 | <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> |
301 | <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> |
302 | <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> |
303 | <li><a class="reference" href="#rationale" id="id26" name="id26">Rationale</a></li> |
| … | |
… | |
| 81 | <li><a class="reference" href="#resources" id="id44" name="id44">Resources</a></li> |
323 | <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> |
324 | <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> |
325 | <li><a class="reference" href="#copyright" id="id46" name="id46">Copyright</a></li> |
| 84 | </ul> |
326 | </ul> |
| 85 | </div> |
327 | </div> |
| 86 | <div class="section" id="credits"> |
328 | <div class="section"> |
| 87 | <h1><a class="toc-backref" href="#id23" name="credits">Credits</a></h1> |
329 | <h1><a class="toc-backref" href="#id23" id="credits" name="credits">Credits</a></h1> |
| 88 | <p>The text of this GLEP was, to a significant extent, stolen from Python's |
330 | <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> |
331 | <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> |
332 | </div> |
| 91 | <div class="section" id="abstract"> |
333 | <div class="section"> |
| 92 | <h1><a class="toc-backref" href="#id24" name="abstract">Abstract</a></h1> |
334 | <h1><a class="toc-backref" href="#id24" id="abstract" name="abstract">Abstract</a></h1> |
| 93 | <p>This GLEP provides a boilerplate or sample template for creating your own |
335 | <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 |
336 | 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 |
337 | <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> |
338 | format outlined below.</p> |
| 97 | <p>Note: if you are reading this GLEP via the web, you should first grab the text |
339 | <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. |
340 | (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> |
341 | <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 |
342 | <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 "GLEP Source".</p> |
343 | click on the link titled "GLEP Source".</p> |
| 102 | </div> |
344 | </div> |
| 103 | <div class="section" id="motivation"> |
345 | <div class="section"> |
| 104 | <h1><a class="toc-backref" href="#id25" name="motivation">Motivation</a></h1> |
346 | <h1><a class="toc-backref" href="#id25" id="motivation" name="motivation">Motivation</a></h1> |
| 105 | <p>Provide adequate motivation here. In this particular case, we need to provide |
347 | <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> |
348 | people with the information necessary to submit GLEPs in the proper form.</p> |
| 107 | </div> |
349 | </div> |
| 108 | <div class="section" id="rationale"> |
350 | <div class="section"> |
| 109 | <h1><a class="toc-backref" href="#id26" name="rationale">Rationale</a></h1> |
351 | <h1><a class="toc-backref" href="#id26" id="rationale" name="rationale">Rationale</a></h1> |
| 110 | <p>GLEP submissions come in a wide variety of forms, not all adhering to the |
352 | <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 |
353 | 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 |
354 | format guidelines below, to ensure that your GLEP submission won't get |
| 113 | automatically rejected because of form.</p> |
355 | automatically rejected because of form.</p> |
| 114 | <p>ReStructuredText is used to allow GLEP authors more functionality and |
356 | <p>ReStructuredText is used to allow GLEP authors more functionality and |
| 115 | expressivity, while maintaining easy readability in the source text. The |
357 | expressivity, while maintaining easy readability in the source text. The |
| 116 | processed HTML form makes the functionality accessible to readers: live |
358 | processed HTML form makes the functionality accessible to readers: live |
| 117 | hyperlinks, styled text, tables, images, and automatic tables of contents, |
359 | hyperlinks, styled text, tables, images, and automatic tables of contents, |
| 118 | among other advantages.</p> |
360 | among other advantages.</p> |
| 119 | </div> |
361 | </div> |
| 120 | <div class="section" id="backwards-compatibility"> |
362 | <div class="section"> |
| 121 | <h1><a class="toc-backref" href="#id27" name="backwards-compatibility">Backwards Compatibility</a></h1> |
363 | <h1><a class="toc-backref" href="#id27" id="backwards-compatibility" 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 |
364 | <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> |
365 | is only to state that there are no backwards compatibility issues.</p> |
| 124 | </div> |
366 | </div> |
| 125 | <div class="section" id="how-to-use-this-template"> |
367 | <div class="section"> |
| 126 | <h1><a class="toc-backref" href="#id28" name="how-to-use-this-template">How to Use This Template</a></h1> |
368 | <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> |
| 127 | <p>To use this template you must first decide whether your GLEP is going to be an |
369 | <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 |
370 | Informational or Standards Track GLEP. Most GLEPs are Standards Track because |
| 129 | they propose new functionality for some aspect of Gentoo Linux. When in |
371 | they propose new functionality for some aspect of Gentoo Linux. When in |
| 130 | doubt, read GLEP 1 for details or contact the GLEP editors <<a class="reference" href="mailto:glep@gentoo.org">glep@gentoo.org</a>>.</p> |
372 | doubt, read GLEP 1 for details or contact the GLEP editors <<a class="reference" href="mailto:glep@gentoo.org">glep@gentoo.org</a>>.</p> |
| 131 | <p>Once you've decided which type of GLEP yours is going to be, follow the |
373 | <p>Once you've decided which type of GLEP yours is going to be, follow the |
| 132 | directions below.</p> |
374 | directions below.</p> |
| 133 | <ul> |
375 | <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 |
376 | <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 |
| 135 | the following edits.</p> |
377 | the following edits.</p> |
| 136 | </li> |
378 | </li> |
| 137 | <li><p class="first">Replace the "GLEP: 2" header with "GLEP: XXX" since you don't yet have |
379 | <li><p class="first">Replace the "GLEP: 2" header with "GLEP: XXX" since you don't yet have |
| 138 | a GLEP number assignment.</p> |
380 | a GLEP number assignment.</p> |
| 139 | </li> |
381 | </li> |
| … | |
… | |
| 147 | appear first, and it must not be contained in parentheses. Your email |
389 | 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 |
390 | address may appear second (or it can be omitted) and if it appears, it must |
| 149 | appear in angle brackets. Your e-mail address |
391 | appear in angle brackets. Your e-mail address |
| 150 | here will e automatically obfuscated.</p> |
392 | here will e automatically obfuscated.</p> |
| 151 | </li> |
393 | </li> |
| 152 | <li><p class="first">If there is a forum thread or a mailing list for discussion |
394 | <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 |
395 | 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 |
396 | 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@gentoo.org">gentoo-dev@gentoo.org</a>, or if discussions should be sent to you |
397 | be used is <a class="reference" href="mailto:gentoo-dev@gentoo.org">gentoo-dev@gentoo.org</a>, or if discussions should be sent to you |
| 156 | directly. Most Informational GLEPs don't have a Discussions-To header.</p> |
398 | directly. Most Informational GLEPs don't have a Discussions-To header.</p> |
| 157 | </li> |
399 | </li> |
| … | |
… | |
| 167 | after the Type header. The value should be the GLEP number of the GLEP |
409 | 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 |
410 | yours depends on. Don't add this header if your dependent feature is |
| 169 | described in a Final GLEP.</p> |
411 | described in a Final GLEP.</p> |
| 170 | </li> |
412 | </li> |
| 171 | <li><p class="first">Change the Created header to today's date. Be sure to follow the |
413 | <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 |
414 | 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 |
| 173 | the 3 English letter month abbreviation, i.e. one of Jan, Feb, Mar, Apr, |
415 | the 3 English letter month abbreviation, i.e. one of Jan, Feb, Mar, Apr, |
| 174 | May, Jun, Jul, Aug, Sep, Oct, Nov, Dec.</p> |
416 | May, Jun, Jul, Aug, Sep, Oct, Nov, Dec.</p> |
| 175 | </li> |
417 | </li> |
| 176 | <li><p class="first">Leave Post-History alone for now; you'll add dates to this header |
418 | <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@gentoo.org">gentoo-dev@gentoo.org</a>. If you posted your |
419 | each time you post your GLEP to <a class="reference" href="mailto:gentoo-dev@gentoo.org">gentoo-dev@gentoo.org</a>. If you posted your |
| … | |
… | |
| 200 | </li> |
442 | </li> |
| 201 | <li><p class="first">Send your GLEP submission to the GLEP editors at <a class="reference" href="mailto:glep@gentoo.org">glep@gentoo.org</a>.</p> |
443 | <li><p class="first">Send your GLEP submission to the GLEP editors at <a class="reference" href="mailto:glep@gentoo.org">glep@gentoo.org</a>.</p> |
| 202 | </li> |
444 | </li> |
| 203 | </ul> |
445 | </ul> |
| 204 | </div> |
446 | </div> |
| 205 | <div class="section" id="restructuredtext-glep-formatting-requirements"> |
447 | <div class="section"> |
| 206 | <h1><a class="toc-backref" href="#id29" name="restructuredtext-glep-formatting-requirements">ReStructuredText GLEP Formatting Requirements</a></h1> |
448 | <h1><a class="toc-backref" href="#id29" id="restructuredtext-glep-formatting-requirements" 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 |
449 | <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 |
450 | 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) |
451 | <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> |
452 | are used for examples throughout, to illustrate the plaintext markup.</p> |
| 211 | <div class="section" id="general"> |
453 | <div class="section"> |
| 212 | <h2><a class="toc-backref" href="#id30" name="general">General</a></h2> |
454 | <h2><a class="toc-backref" href="#id30" id="general" name="general">General</a></h2> |
| 213 | <p>You must adhere to the convention of adding two spaces at the end of every |
455 | <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 |
456 | 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 |
457 | circumstances should your lines extend past column 79. If your code samples |
| 216 | spill over column 79, you should rewrite them.</p> |
458 | spill over column 79, you should rewrite them.</p> |
| 217 | </div> |
459 | </div> |
| 218 | <div class="section" id="section-headings"> |
460 | <div class="section"> |
| 219 | <h2><a class="toc-backref" href="#id31" name="section-headings">Section Headings</a></h2> |
461 | <h2><a class="toc-backref" href="#id31" id="section-headings" name="section-headings">Section Headings</a></h2> |
| 220 | <p>GLEP headings must begin in column zero and the initial letter of each word |
462 | <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. |
463 | 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 |
464 | 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 |
465 | 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 |
466 | far as the right edge of the title text (4 characters minimum). First-level |
| … | |
… | |
| 262 | heading, a single blank line in-between is sufficient.</p> |
504 | 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 |
505 | <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 |
506 | use indentation, as described below. Blank lines are used to separate |
| 265 | constructs.</p> |
507 | constructs.</p> |
| 266 | </div> |
508 | </div> |
| 267 | <div class="section" id="paragraphs"> |
509 | <div class="section"> |
| 268 | <h2><a class="toc-backref" href="#id32" name="paragraphs">Paragraphs</a></h2> |
510 | <h2><a class="toc-backref" href="#id32" id="paragraphs" name="paragraphs">Paragraphs</a></h2> |
| 269 | <p>Paragraphs are left-aligned text blocks separated by blank lines. Paragraphs |
511 | <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 |
512 | are not indented unless they are part of an indented construct (such as a |
| 271 | block quote or a list item).</p> |
513 | block quote or a list item).</p> |
| 272 | </div> |
514 | </div> |
| 273 | <div class="section" id="inline-markup"> |
515 | <div class="section"> |
| 274 | <h2><a class="toc-backref" href="#id33" name="inline-markup">Inline Markup</a></h2> |
516 | <h2><a class="toc-backref" href="#id33" id="inline-markup" name="inline-markup">Inline Markup</a></h2> |
| 275 | <p>Portions of text within paragraphs and other text blocks may be |
517 | <p>Portions of text within paragraphs and other text blocks may be |
| 276 | styled. For example:</p> |
518 | styled. For example:</p> |
| 277 | <pre class="literal-block"> |
519 | <pre class="literal-block"> |
| 278 | Text may be marked as *emphasized* (single asterisk markup, |
520 | Text may be marked as *emphasized* (single asterisk markup, |
| 279 | typically shown in italics) or **strongly emphasized** (double |
521 | typically shown in italics) or **strongly emphasized** (double |
| … | |
… | |
| 281 | backquotes) are typically rendered in a monospaced typeface. No |
523 | backquotes) are typically rendered in a monospaced typeface. No |
| 282 | further markup recognition is done within the double backquotes, |
524 | further markup recognition is done within the double backquotes, |
| 283 | so they're safe for any kind of code snippets. |
525 | so they're safe for any kind of code snippets. |
| 284 | </pre> |
526 | </pre> |
| 285 | </div> |
527 | </div> |
| 286 | <div class="section" id="block-quotes"> |
528 | <div class="section"> |
| 287 | <h2><a class="toc-backref" href="#id34" name="block-quotes">Block Quotes</a></h2> |
529 | <h2><a class="toc-backref" href="#id34" id="block-quotes" name="block-quotes">Block Quotes</a></h2> |
| 288 | <p>Block quotes consist of indented body elements. For example:</p> |
530 | <p>Block quotes consist of indented body elements. For example:</p> |
| 289 | <pre class="literal-block"> |
531 | <pre class="literal-block"> |
| 290 | This is a paragraph. |
532 | This is a paragraph. |
| 291 | |
533 | |
| 292 | This is a block quote. |
534 | This is a block quote. |
| … | |
… | |
| 295 | </pre> |
537 | </pre> |
| 296 | <p>Block quotes are used to quote extended passages from other sources. |
538 | <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 |
539 | Block quotes may be nested inside other body elements. Use a 4-space tab |
| 298 | per indent level.</p> |
540 | per indent level.</p> |
| 299 | </div> |
541 | </div> |
| 300 | <div class="section" id="literal-blocks"> |
542 | <div class="section"> |
| 301 | <h2><a class="toc-backref" href="#id35" name="literal-blocks">Literal Blocks</a></h2> |
543 | <h2><a class="toc-backref" href="#id35" id="literal-blocks" name="literal-blocks">Literal Blocks</a></h2> |
| 302 | <!-- In the text below, double backquotes are used to denote inline |
544 | <!-- In the text below, double backquotes are used to denote inline |
| 303 | literals. "``::``" is written so that the colons will appear in a |
545 | literals. "``::``" is written so that the colons will appear in a |
| 304 | monospaced font; the backquotes (``) are markup, not part of the |
546 | monospaced font; the backquotes (``) are markup, not part of the |
| 305 | text. See "Inline Markup" above. |
547 | text. See "Inline Markup" above. |
| 306 | |
548 | |
| 307 | By the way, this is a comment, described in "Comments" below. --> |
549 | 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 |
550 | <p>Literal blocks are used for code samples or preformatted ASCII art. To |
| 309 | indicate a literal block, preface the indented text block with |
551 | indicate a literal block, preface the indented text block with |
| 310 | "<tt class="literal"><span class="pre">::</span></tt>" (two colons). The literal block continues until the end of |
552 | "<tt class="docutils literal"><span class="pre">::</span></tt>" (two colons). The literal block continues until the end of |
| 311 | the indentation. Indent the text block by a tab. For example:</p> |
553 | the indentation. Indent the text block by a tab. For example:</p> |
| 312 | <pre class="literal-block"> |
554 | <pre class="literal-block"> |
| 313 | This is a typical paragraph. A literal block follows. |
555 | This is a typical paragraph. A literal block follows. |
| 314 | |
556 | |
| 315 | :: |
557 | :: |
| … | |
… | |
| 317 | for a in [5,4,3,2,1]: # this is program code, shown as-is |
559 | for a in [5,4,3,2,1]: # this is program code, shown as-is |
| 318 | print a |
560 | print a |
| 319 | print "it's..." |
561 | print "it's..." |
| 320 | # a literal block continues until the indentation ends |
562 | # a literal block continues until the indentation ends |
| 321 | </pre> |
563 | </pre> |
| 322 | <p>The paragraph containing only "<tt class="literal"><span class="pre">::</span></tt>" will be completely removed from |
564 | <p>The paragraph containing only "<tt class="docutils literal"><span class="pre">::</span></tt>" will be completely removed from |
| 323 | the output; no empty paragraph will remain. "<tt class="literal"><span class="pre">::</span></tt>" is also |
565 | the output; no empty paragraph will remain. "<tt class="docutils literal"><span class="pre">::</span></tt>" is also |
| 324 | recognized at the end of any paragraph. If immediately preceded by |
566 | recognized at the end of any paragraph. If immediately preceded by |
| 325 | whitespace, both colons will be removed from the output. When text |
567 | whitespace, both colons will be removed from the output. When text |
| 326 | immediately precedes the "<tt class="literal"><span class="pre">::</span></tt>", <em>one</em> colon will be removed from |
568 | immediately precedes the "<tt class="docutils literal"><span class="pre">::</span></tt>", <em>one</em> colon will be removed from |
| 327 | the output, leaving only one colon visible (i.e., "<tt class="literal"><span class="pre">::</span></tt>" will be |
569 | the output, leaving only one colon visible (i.e., "<tt class="docutils literal"><span class="pre">::</span></tt>" will be |
| 328 | replaced by "<tt class="literal"><span class="pre">:</span></tt>"). For example, one colon will remain visible |
570 | replaced by "<tt class="docutils literal"><span class="pre">:</span></tt>"). For example, one colon will remain visible |
| 329 | here:</p> |
571 | here:</p> |
| 330 | <pre class="literal-block"> |
572 | <pre class="literal-block"> |
| 331 | Paragraph:: |
573 | Paragraph:: |
| 332 | |
574 | |
| 333 | Literal block |
575 | Literal block |
| 334 | </pre> |
576 | </pre> |
| 335 | </div> |
577 | </div> |
| 336 | <div class="section" id="lists"> |
578 | <div class="section"> |
| 337 | <h2><a class="toc-backref" href="#id36" name="lists">Lists</a></h2> |
579 | <h2><a class="toc-backref" href="#id36" id="lists" name="lists">Lists</a></h2> |
| 338 | <p>Bullet list items begin with one of "-", "*", or "+" (hyphen, |
580 | <p>Bullet list items begin with one of "-", "*", or "+" (hyphen, |
| 339 | asterisk, or plus sign), followed by whitespace and the list item |
581 | asterisk, or plus sign), followed by whitespace and the list item |
| 340 | body. List item bodies must be left-aligned and indented relative to |
582 | body. List item bodies must be left-aligned and indented relative to |
| 341 | the bullet; the text immediately after the bullet determines the |
583 | the bullet; the text immediately after the bullet determines the |
| 342 | indentation. For example:</p> |
584 | indentation. For example:</p> |
| … | |
… | |
| 388 | The term is a one-line phrase, and the definition is one |
630 | The term is a one-line phrase, and the definition is one |
| 389 | or more paragraphs or body elements, indented relative to |
631 | or more paragraphs or body elements, indented relative to |
| 390 | the term. |
632 | the term. |
| 391 | </pre> |
633 | </pre> |
| 392 | </div> |
634 | </div> |
| 393 | <div class="section" id="tables"> |
635 | <div class="section"> |
| 394 | <h2><a class="toc-backref" href="#id37" name="tables">Tables</a></h2> |
636 | <h2><a class="toc-backref" href="#id37" id="tables" name="tables">Tables</a></h2> |
| 395 | <p>Simple tables are easy and compact:</p> |
637 | <p>Simple tables are easy and compact:</p> |
| 396 | <pre class="literal-block"> |
638 | <pre class="literal-block"> |
| 397 | ===== ===== ======= |
639 | ===== ===== ======= |
| 398 | A B A and B |
640 | A B A and B |
| 399 | ===== ===== ======= |
641 | ===== ===== ======= |
| … | |
… | |
| 433 | - Second item in bullet |
675 | - Second item in bullet |
| 434 | list (row 3, column 2). |
676 | list (row 3, column 2). |
| 435 | ===== ========================= |
677 | ===== ========================= |
| 436 | </pre> |
678 | </pre> |
| 437 | </div> |
679 | </div> |
| 438 | <div class="section" id="hyperlinks"> |
680 | <div class="section"> |
| 439 | <h2><a class="toc-backref" href="#id38" name="hyperlinks">Hyperlinks</a></h2> |
681 | <h2><a class="toc-backref" href="#id38" id="hyperlinks" name="hyperlinks">Hyperlinks</a></h2> |
| 440 | <p>When referencing an external web page in the body of a GLEP, you should |
682 | <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 |
683 | include the title of the page in the text, with either an inline |
| 442 | hyperlink reference to the URL or a footnote reference (see |
684 | 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 |
685 | <a class="reference" href="#footnotes">Footnotes</a> below). Do not include the URL in the body text of the |
| 444 | GLEP.</p> |
686 | GLEP.</p> |
| … | |
… | |
| 473 | automatically at the end of the References section of the GLEP, along |
715 | automatically at the end of the References section of the GLEP, along |
| 474 | with footnote references linking the reference text to the footnotes.</p> |
716 | with footnote references linking the reference text to the footnotes.</p> |
| 475 | <p>Text of the form "GLEP x" or "RFC x" (where "x" is a number) will be |
717 | <p>Text of the form "GLEP x" or "RFC x" (where "x" is a number) will be |
| 476 | linked automatically to the appropriate URLs.</p> |
718 | linked automatically to the appropriate URLs.</p> |
| 477 | </div> |
719 | </div> |
| 478 | <div class="section" id="footnotes"> |
720 | <div class="section"> |
| 479 | <h2><a class="toc-backref" href="#id39" name="footnotes">Footnotes</a></h2> |
721 | <h2><a class="toc-backref" href="#id39" id="footnotes" name="footnotes">Footnotes</a></h2> |
| 480 | <p>Footnote references consist of a left square bracket, a number, a |
722 | <p>Footnote references consist of a left square bracket, a number, a |
| 481 | right square bracket, and a trailing underscore:</p> |
723 | right square bracket, and a trailing underscore:</p> |
| 482 | <pre class="literal-block"> |
724 | <pre class="literal-block"> |
| 483 | This sentence ends with a footnote reference [1]_. |
725 | This sentence ends with a footnote reference [1]_. |
| 484 | </pre> |
726 | </pre> |
| … | |
… | |
| 528 | </pre> |
770 | </pre> |
| 529 | <p>Footnotes and footnote references will be numbered automatically, and |
771 | <p>Footnotes and footnote references will be numbered automatically, and |
| 530 | the numbers will always match. Once a GLEP is finalized, auto-numbered |
772 | the numbers will always match. Once a GLEP is finalized, auto-numbered |
| 531 | labels should be replaced by numbers for simplicity.</p> |
773 | labels should be replaced by numbers for simplicity.</p> |
| 532 | </div> |
774 | </div> |
| 533 | <div class="section" id="images"> |
775 | <div class="section"> |
| 534 | <h2><a class="toc-backref" href="#id40" name="images">Images</a></h2> |
776 | <h2><a class="toc-backref" href="#id40" id="images" name="images">Images</a></h2> |
| 535 | <p>If your GLEP contains a diagram, you may include it in the processed |
777 | <p>If your GLEP contains a diagram, you may include it in the processed |
| 536 | output using the "image" directive:</p> |
778 | output using the "image" directive:</p> |
| 537 | <pre class="literal-block"> |
779 | <pre class="literal-block"> |
| 538 | .. image:: diagram.png |
780 | .. image:: diagram.png |
| 539 | </pre> |
781 | </pre> |
| … | |
… | |
| 541 | .tiff, etc.</p> |
783 | .tiff, etc.</p> |
| 542 | <p>Since this image will not be visible to readers of the GLEP in source |
784 | <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 |
785 | text form, you should consider including a description or ASCII art |
| 544 | alternative, using a comment (below).</p> |
786 | alternative, using a comment (below).</p> |
| 545 | </div> |
787 | </div> |
| 546 | <div class="section" id="comments"> |
788 | <div class="section"> |
| 547 | <h2><a class="toc-backref" href="#id41" name="comments">Comments</a></h2> |
789 | <h2><a class="toc-backref" href="#id41" id="comments" name="comments">Comments</a></h2> |
| 548 | <p>A comment block is an indented block of arbitrary text immediately |
790 | <p>A comment block is an indented block of arbitrary text immediately |
| 549 | following an explicit markup start: two periods and whitespace. Leave |
791 | following an explicit markup start: two periods and whitespace. Leave |
| 550 | the ".." on a line by itself to ensure that the comment is not |
792 | the ".." on a line by itself to ensure that the comment is not |
| 551 | misinterpreted as another explicit markup construct. Comments are not |
793 | misinterpreted as another explicit markup construct. Comments are not |
| 552 | visible in the processed document. For the benefit of those reading |
794 | visible in the processed document. For the benefit of those reading |
| … | |
… | |
| 558 | .. |
800 | .. |
| 559 | Data flows from the input module, through the "black box" |
801 | Data flows from the input module, through the "black box" |
| 560 | module, and finally into (and through) the output module. |
802 | module, and finally into (and through) the output module. |
| 561 | </pre> |
803 | </pre> |
| 562 | </div> |
804 | </div> |
| 563 | <div class="section" id="escaping-mechanism"> |
805 | <div class="section"> |
| 564 | <h2><a class="toc-backref" href="#id42" name="escaping-mechanism">Escaping Mechanism</a></h2> |
806 | <h2><a class="toc-backref" href="#id42" id="escaping-mechanism" name="escaping-mechanism">Escaping Mechanism</a></h2> |
| 565 | <p>reStructuredText uses backslashes ("<tt class="literal"><span class="pre">\</span></tt>") to override the special |
807 | <p>reStructuredText uses backslashes ("<tt class="docutils literal"><span class="pre">\</span></tt>") to override the special |
| 566 | meaning given to markup characters and get the literal characters |
808 | meaning given to markup characters and get the literal characters |
| 567 | themselves. To get a literal backslash, use an escaped backslash |
809 | themselves. To get a literal backslash, use an escaped backslash |
| 568 | ("<tt class="literal"><span class="pre">\\</span></tt>"). There are two contexts in which backslashes have no |
810 | ("<tt class="docutils literal"><span class="pre">\\</span></tt>"). 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 |
811 | 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, |
812 | Markup</a> above). In these contexts, no markup recognition is done, |
| 571 | and a single backslash represents a literal backslash, without having |
813 | and a single backslash represents a literal backslash, without having |
| 572 | to double up.</p> |
814 | to double up.</p> |
| 573 | <p>If you find that you need to use a backslash in your text, consider |
815 | <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> |
816 | using inline literals or a literal block instead.</p> |
| 575 | </div> |
817 | </div> |
| 576 | </div> |
818 | </div> |
| 577 | <div class="section" id="habits-to-avoid"> |
819 | <div class="section"> |
| 578 | <h1><a class="toc-backref" href="#id43" name="habits-to-avoid">Habits to Avoid</a></h1> |
820 | <h1><a class="toc-backref" href="#id43" id="habits-to-avoid" name="habits-to-avoid">Habits to Avoid</a></h1> |
| 579 | <p>Many programmers who are familiar with TeX often write quotation marks |
821 | <p>Many programmers who are familiar with TeX often write quotation marks |
| 580 | like this:</p> |
822 | like this:</p> |
| 581 | <pre class="literal-block"> |
823 | <pre class="literal-block"> |
| 582 | `single-quoted' or ``double-quoted'' |
824 | `single-quoted' or ``double-quoted'' |
| 583 | </pre> |
825 | </pre> |
| … | |
… | |
| 587 | above), use double-backquotes:</p> |
829 | above), use double-backquotes:</p> |
| 588 | <pre class="literal-block"> |
830 | <pre class="literal-block"> |
| 589 | ``literal text: in here, anything goes!`` |
831 | ``literal text: in here, anything goes!`` |
| 590 | </pre> |
832 | </pre> |
| 591 | </div> |
833 | </div> |
| 592 | <div class="section" id="resources"> |
834 | <div class="section"> |
| 593 | <h1><a class="toc-backref" href="#id44" name="resources">Resources</a></h1> |
835 | <h1><a class="toc-backref" href="#id44" id="resources" name="resources">Resources</a></h1> |
| 594 | <p>Many other constructs and variations are possible. For more details |
836 | <p>Many other constructs and variations are possible. For more details |
| 595 | about the reStructuredText markup, in increasing order of |
837 | about the reStructuredText markup, in increasing order of |
| 596 | thoroughness, please see:</p> |
838 | thoroughness, please see:</p> |
| 597 | <ul class="simple"> |
839 | <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> |
840 | <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> |
| … | |
… | |
| 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 |
844 | <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 |
845 | you have a question or require assistance with reStructuredText or |
| 604 | Docutils, please <a class="reference" href="mailto:docutils-users@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 |
846 | Docutils, please <a class="reference" href="mailto:docutils-users@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> |
847 | 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> |
848 | </div> |
| 607 | <div class="section" id="references"> |
849 | <div class="section"> |
| 608 | <h1><a class="toc-backref" href="#id45" name="references">References</a></h1> |
850 | <h1><a class="toc-backref" href="#id45" id="references" name="references">References</a></h1> |
| 609 | <table class="footnote" frame="void" id="python" rules="none"> |
851 | <table class="docutils footnote" frame="void" id="python" rules="none"> |
| 610 | <colgroup><col class="label" /><col /></colgroup> |
852 | <colgroup><col class="label" /><col /></colgroup> |
| 611 | <tbody valign="top"> |
853 | <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> |
854 | <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> |
855 | </tbody> |
| 614 | </table> |
856 | </table> |
| 615 | <table class="footnote" frame="void" id="pep12" rules="none"> |
857 | <table class="docutils footnote" frame="void" id="pep12" rules="none"> |
| 616 | <colgroup><col class="label" /><col /></colgroup> |
858 | <colgroup><col class="label" /><col /></colgroup> |
| 617 | <tbody valign="top"> |
859 | <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> |
860 | <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> |
861 | </tbody> |
| 620 | </table> |
862 | </table> |
| 621 | <table class="footnote" frame="void" id="glep1" rules="none"> |
863 | <table class="docutils footnote" frame="void" id="glep1" rules="none"> |
| 622 | <colgroup><col class="label" /><col /></colgroup> |
864 | <colgroup><col class="label" /><col /></colgroup> |
| 623 | <tbody valign="top"> |
865 | <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, |
866 | <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> |
867 | (<a class="reference" href="http://glep.gentoo.org/glep-0001.html">http://glep.gentoo.org/glep-0001.html</a>)</td></tr> |
| 626 | </tbody> |
868 | </tbody> |
| 627 | </table> |
869 | </table> |
| 628 | <table class="footnote" frame="void" id="id8" rules="none"> |
870 | <table class="docutils footnote" frame="void" id="id8" rules="none"> |
| 629 | <colgroup><col class="label" /><col /></colgroup> |
871 | <colgroup><col class="label" /><col /></colgroup> |
| 630 | <tbody valign="top"> |
872 | <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> |
873 | <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> |
874 | </tbody> |
| 633 | </table> |
875 | </table> |
| 634 | <table class="footnote" frame="void" id="id10" rules="none"> |
876 | <table class="docutils footnote" frame="void" id="id10" rules="none"> |
| 635 | <colgroup><col class="label" /><col /></colgroup> |
877 | <colgroup><col class="label" /><col /></colgroup> |
| 636 | <tbody valign="top"> |
878 | <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@lists.sourceforge.net?subject=GLEPs">mailto:docutils-users@lists.sourceforge.net?subject=GLEPs</a></td></tr> |
879 | <tr><td class="label"><a class="fn-backref" href="#id11" name="id10">[5]</a></td><td><a class="reference" href="mailto:docutils-users@lists.sourceforge.net?subject=GLEPs">mailto:docutils-users@lists.sourceforge.net?subject=GLEPs</a></td></tr> |
| 638 | </tbody> |
880 | </tbody> |
| 639 | </table> |
881 | </table> |
| 640 | <table class="footnote" frame="void" id="id12" rules="none"> |
882 | <table class="docutils footnote" frame="void" id="id12" rules="none"> |
| 641 | <colgroup><col class="label" /><col /></colgroup> |
883 | <colgroup><col class="label" /><col /></colgroup> |
| 642 | <tbody valign="top"> |
884 | <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> |
885 | <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> |
886 | </tbody> |
| 645 | </table> |
887 | </table> |
| 646 | <table class="footnote" frame="void" id="id15" rules="none"> |
888 | <table class="docutils footnote" frame="void" id="id15" rules="none"> |
| 647 | <colgroup><col class="label" /><col /></colgroup> |
889 | <colgroup><col class="label" /><col /></colgroup> |
| 648 | <tbody valign="top"> |
890 | <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> |
891 | <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> |
892 | </tbody> |
| 651 | </table> |
893 | </table> |
| 652 | <table class="footnote" frame="void" id="id17" rules="none"> |
894 | <table class="docutils footnote" frame="void" id="id17" rules="none"> |
| 653 | <colgroup><col class="label" /><col /></colgroup> |
895 | <colgroup><col class="label" /><col /></colgroup> |
| 654 | <tbody valign="top"> |
896 | <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> |
897 | <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> |
898 | </tbody> |
| 657 | </table> |
899 | </table> |
| 658 | <table class="footnote" frame="void" id="id19" rules="none"> |
900 | <table class="docutils footnote" frame="void" id="id19" rules="none"> |
| 659 | <colgroup><col class="label" /><col /></colgroup> |
901 | <colgroup><col class="label" /><col /></colgroup> |
| 660 | <tbody valign="top"> |
902 | <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> |
903 | <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> |
904 | </tbody> |
| 663 | </table> |
905 | </table> |
| 664 | <table class="footnote" frame="void" id="id21" rules="none"> |
906 | <table class="docutils footnote" frame="void" id="id21" rules="none"> |
| 665 | <colgroup><col class="label" /><col /></colgroup> |
907 | <colgroup><col class="label" /><col /></colgroup> |
| 666 | <tbody valign="top"> |
908 | <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> |
909 | <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> |
910 | </tbody> |
| 669 | </table> |
911 | </table> |
| 670 | </div> |
912 | </div> |
| 671 | <div class="section" id="copyright"> |
913 | <div class="section"> |
| 672 | <h1><a class="toc-backref" href="#id46" name="copyright">Copyright</a></h1> |
914 | <h1><a class="toc-backref" href="#id46" id="copyright" name="copyright">Copyright</a></h1> |
| 673 | <p>This document has been placed in the public domain.</p> |
915 | <p>This document has been placed in the public domain.</p> |
| 674 | </div> |
916 | </div> |
| 675 | </div> |
|
|
| 676 | |
917 | |
| 677 | <hr class="footer"/> |
918 | </div> |
| 678 | <div class="footer"> |
919 | <div class="footer"> |
|
|
920 | <hr class="footer" /> |
| 679 | <a class="reference" href="glep-0002.txt">View document source</a>. |
921 | <a class="reference" href="glep-0002.txt">View document source</a>. |
| 680 | Generated on: 2003-06-04 19:49 UTC. |
922 | Generated on: 2006-10-10 20:23 UTC. |
| 681 | 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. |
923 | 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. |
|
|
924 | |
| 682 | </div> |
925 | </div> |
| 683 | </body> |
926 | </body> |
| 684 | </html> |
927 | </html> |
| 685 | |
928 | |
Parent Directory
| 
Revision Log
| 
Patch