/[gentoo]/xml/htdocs/proj/en/glep/glep-0002.html
Gentoo

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.8 - (show annotations) (download) (as text)
Thu Jan 25 03:27:08 2007 UTC (7 years, 2 months ago) by antarus
Branch: MAIN
Changes since 1.7: +3 -3 lines
File MIME type: text/html
Fix headers in all current gleps

1 <?xml version="1.0" encoding="utf-8" ?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4 <!--
5 This HTML is auto-generated. DO NOT EDIT THIS FILE! If you are writing a new
6 PEP, see http://www.python.org/peps/pep-0001.html for instructions and links
7 to templates. DO NOT USE THIS HTML FILE AS YOUR TEMPLATE!
8 -->
9 <head>
10 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
11 <meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
12 <title>GLEP 2 -- Sample ReStructuredText GLEP Template</title>
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>
257 </head>
258 <body bgcolor="white">
259 <table class="navigation" cellpadding="0" cellspacing="0"
260 width="100%" border="0">
261 <tr><td class="navicon" width="150" height="35">
262 <a href="http://www.gentoo.org/" title="Gentoo Linux Home Page">
263 <img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]"
264 border="0" width="150" height="35" /></a></td>
265 <td class="textlinks" align="left">
266 [<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>]
267 [<b><a href="http://www.gentoo.org/proj/en/glep/">GLEP Index</a></b>]
268 [<b><a href="http://www.gentoo.org/proj/en/glep/glep-0002.txt">GLEP Source</a></b>]
269 </td></tr></table>
270 <table class="rfc2822 docutils field-list" frame="void" rules="none">
271 <col class="field-name" />
272 <col class="field-body" />
273 <tbody valign="top">
274 <tr class="field"><th class="field-name">GLEP:</th><td class="field-body">2</td>
275 </tr>
276 <tr class="field"><th class="field-name">Title:</th><td class="field-body">Sample ReStructuredText GLEP Template</td>
277 </tr>
278 <tr class="field"><th class="field-name">Version:</th><td class="field-body">1.4</td>
279 </tr>
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>
281 </tr>
282 <tr class="field"><th class="field-name">Author:</th><td class="field-body">Grant Goodyear &lt;g2boojum&#32;&#97;t&#32;gentoo.org&gt;,</td>
283 </tr>
284 <tr class="field"><th class="field-name">Status:</th><td class="field-body">Active</td>
285 </tr>
286 <tr class="field"><th class="field-name">Type:</th><td class="field-body">Informational</td>
287 </tr>
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>
289 </tr>
290 <tr class="field"><th class="field-name">Created:</th><td class="field-body">31 May 2003</td>
291 </tr>
292 <tr class="field"><th class="field-name">Post-History:</th><td class="field-body">2-Jun-2003</td>
293 </tr>
294 </tbody>
295 </table>
296 <hr />
297 <div class="contents topic">
298 <p class="topic-title first"><a id="contents" name="contents">Contents</a></p>
299 <ul class="simple">
300 <li><a class="reference" href="#credits" id="id23" name="id23">Credits</a></li>
301 <li><a class="reference" href="#abstract" id="id24" name="id24">Abstract</a></li>
302 <li><a class="reference" href="#motivation" id="id25" name="id25">Motivation</a></li>
303 <li><a class="reference" href="#rationale" id="id26" name="id26">Rationale</a></li>
304 <li><a class="reference" href="#backwards-compatibility" id="id27" name="id27">Backwards Compatibility</a></li>
305 <li><a class="reference" href="#how-to-use-this-template" id="id28" name="id28">How to Use This Template</a></li>
306 <li><a class="reference" href="#restructuredtext-glep-formatting-requirements" id="id29" name="id29">ReStructuredText GLEP Formatting Requirements</a><ul>
307 <li><a class="reference" href="#general" id="id30" name="id30">General</a></li>
308 <li><a class="reference" href="#section-headings" id="id31" name="id31">Section Headings</a></li>
309 <li><a class="reference" href="#paragraphs" id="id32" name="id32">Paragraphs</a></li>
310 <li><a class="reference" href="#inline-markup" id="id33" name="id33">Inline Markup</a></li>
311 <li><a class="reference" href="#block-quotes" id="id34" name="id34">Block Quotes</a></li>
312 <li><a class="reference" href="#literal-blocks" id="id35" name="id35">Literal Blocks</a></li>
313 <li><a class="reference" href="#lists" id="id36" name="id36">Lists</a></li>
314 <li><a class="reference" href="#tables" id="id37" name="id37">Tables</a></li>
315 <li><a class="reference" href="#hyperlinks" id="id38" name="id38">Hyperlinks</a></li>
316 <li><a class="reference" href="#footnotes" id="id39" name="id39">Footnotes</a></li>
317 <li><a class="reference" href="#images" id="id40" name="id40">Images</a></li>
318 <li><a class="reference" href="#comments" id="id41" name="id41">Comments</a></li>
319 <li><a class="reference" href="#escaping-mechanism" id="id42" name="id42">Escaping Mechanism</a></li>
320 </ul>
321 </li>
322 <li><a class="reference" href="#habits-to-avoid" id="id43" name="id43">Habits to Avoid</a></li>
323 <li><a class="reference" href="#resources" id="id44" name="id44">Resources</a></li>
324 <li><a class="reference" href="#references" id="id45" name="id45">References</a></li>
325 <li><a class="reference" href="#copyright" id="id46" name="id46">Copyright</a></li>
326 </ul>
327 </div>
328 <div class="section">
329 <h1><a class="toc-backref" href="#id23" id="credits" name="credits">Credits</a></h1>
330 <p>The text of this GLEP was, to a significant extent, stolen from Python's
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>
332 </div>
333 <div class="section">
334 <h1><a class="toc-backref" href="#id24" id="abstract" name="abstract">Abstract</a></h1>
335 <p>This GLEP provides a boilerplate or sample template for creating your own
336 reStructuredText GLEPs. In conjunction with the content guidelines in GLEP 1
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
338 format outlined below.</p>
339 <p>Note: if you are reading this GLEP via the web, you should first grab the text
340 (reStructuredText) source of this GLEP in order to complete the steps below.
341 <strong>DO NOT USE THE HTML FILE AS YOUR TEMPLATE!</strong></p>
342 <p>To get the source of this (or any) GLEP, look at the top of the HTML page and
343 click on the link titled &quot;GLEP Source&quot;.</p>
344 </div>
345 <div class="section">
346 <h1><a class="toc-backref" href="#id25" id="motivation" name="motivation">Motivation</a></h1>
347 <p>Provide adequate motivation here. In this particular case, we need to provide
348 people with the information necessary to submit GLEPs in the proper form.</p>
349 </div>
350 <div class="section">
351 <h1><a class="toc-backref" href="#id26" id="rationale" name="rationale">Rationale</a></h1>
352 <p>GLEP submissions come in a wide variety of forms, not all adhering to the
353 format guidelines set forth below. Use this template, in conjunction with the
354 format guidelines below, to ensure that your GLEP submission won't get
355 automatically rejected because of form.</p>
356 <p>ReStructuredText is used to allow GLEP authors more functionality and
357 expressivity, while maintaining easy readability in the source text. The
358 processed HTML form makes the functionality accessible to readers: live
359 hyperlinks, styled text, tables, images, and automatic tables of contents,
360 among other advantages.</p>
361 </div>
362 <div class="section">
363 <h1><a class="toc-backref" href="#id27" id="backwards-compatibility" name="backwards-compatibility">Backwards Compatibility</a></h1>
364 <p>Not a problem for this GLEP. This section should be included <em>even</em> when it
365 is only to state that there are no backwards compatibility issues.</p>
366 </div>
367 <div class="section">
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>
369 <p>To use this template you must first decide whether your GLEP is going to be an
370 Informational or Standards Track GLEP. Most GLEPs are Standards Track because
371 they propose new functionality for some aspect of Gentoo Linux. When in
372 doubt, read GLEP 1 for details or contact the GLEP editors &lt;<a class="reference" href="mailto:glep&#64;gentoo.org">glep&#64;gentoo.org</a>&gt;.</p>
373 <p>Once you've decided which type of GLEP yours is going to be, follow the
374 directions below.</p>
375 <ul>
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
377 the following edits.</p>
378 </li>
379 <li><p class="first">Replace the &quot;GLEP: 2&quot; header with &quot;GLEP: XXX&quot; since you don't yet have
380 a GLEP number assignment.</p>
381 </li>
382 <li><p class="first">Change the Title header to the title of your GLEP.</p>
383 </li>
384 <li><p class="first">Leave the Version and Last-Modified headers alone; we'll take care
385 of those when we check your GLEP into CVS.</p>
386 </li>
387 <li><p class="first">Change the Author header to include your name, and optionally your
388 email address. Be sure to follow the format carefully: your name must
389 appear first, and it must not be contained in parentheses. Your email
390 address may appear second (or it can be omitted) and if it appears, it must
391 appear in angle brackets. Your e-mail address
392 here will e automatically obfuscated.</p>
393 </li>
394 <li><p class="first">If there is a forum thread or a mailing list for discussion
395 of your new feature, add a Discussions-To header right after the Author
396 header. You should not add a Discussions-To header if the mailing list to
397 be used is <a class="reference" href="mailto:gentoo-dev&#64;gentoo.org">gentoo-dev&#64;gentoo.org</a>, or if discussions should be sent to you
398 directly. Most Informational GLEPs don't have a Discussions-To header.</p>
399 </li>
400 <li><p class="first">Change the Status header to &quot;Draft&quot;.</p>
401 </li>
402 <li><p class="first">For Standards Track GLEPs, change the Type header to &quot;Standards
403 Track&quot;.</p>
404 </li>
405 <li><p class="first">For Informational GLEPs, change the Type header to &quot;Informational&quot;.</p>
406 </li>
407 <li><p class="first">For Standards Track GLEPs, if your feature depends on the acceptance
408 of some other currently in-development GLEP, add a Requires header right
409 after the Type header. The value should be the GLEP number of the GLEP
410 yours depends on. Don't add this header if your dependent feature is
411 described in a Final GLEP.</p>
412 </li>
413 <li><p class="first">Change the Created header to today's date. Be sure to follow the
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
415 the 3 English letter month abbreviation, i.e. one of Jan, Feb, Mar, Apr,
416 May, Jun, Jul, Aug, Sep, Oct, Nov, Dec.</p>
417 </li>
418 <li><p class="first">Leave Post-History alone for now; you'll add dates to this header
419 each time you post your GLEP to <a class="reference" href="mailto:gentoo-dev&#64;gentoo.org">gentoo-dev&#64;gentoo.org</a>. If you posted your
420 GLEP to the list on August 14, 2003 and September 3, 2003, the Post-History
421 header would look like:</p>
422 <pre class="literal-block">
423 Post-History: 14-Aug-2003, 03-Sept-2003
424 </pre>
425 <p>You must manually add new dates and check them in. If you don't have
426 check-in privileges, send your changes to the GLEP editors.</p>
427 </li>
428 <li><p class="first">Add a Replaces header if your GLEP obsoletes an earlier GLEP. The
429 value of this header is the number of the GLEP that your new GLEP is
430 replacing. Only add this header if the older GLEP is in &quot;final&quot; form, i.e.
431 is either Accepted, Final, or Rejected. You aren't replacing an older open
432 GLEP if you're submitting a competing idea.</p>
433 </li>
434 <li><p class="first">Now write your Abstract, Rationale, and other content for your GLEP,
435 replacing all of this gobbledygook with your own text. Be sure to adhere to
436 the format guidelines below, specifically on the indentation requirements.</p>
437 </li>
438 <li><p class="first">Update your References and Copyright section. Usually you'll place
439 your GLEP into the public domain, in which case just leave the Copyright
440 section alone. Alternatively, you can use the <a class="reference" href="http://www.opencontent.org/openpub/">Open Publication License</a> <a class="footnote-reference" href="#id15" id="id16" name="id16">[7]</a>,
441 but public domain is still strongly preferred.</p>
442 </li>
443 <li><p class="first">Send your GLEP submission to the GLEP editors at <a class="reference" href="mailto:glep&#64;gentoo.org">glep&#64;gentoo.org</a>.</p>
444 </li>
445 </ul>
446 </div>
447 <div class="section">
448 <h1><a class="toc-backref" href="#id29" id="restructuredtext-glep-formatting-requirements" name="restructuredtext-glep-formatting-requirements">ReStructuredText GLEP Formatting Requirements</a></h1>
449 <p>The following is a GLEP-specific summary of reStructuredText syntax. For the
450 sake of simplicity and brevity, much detail is omitted. For more detail, see
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)
452 are used for examples throughout, to illustrate the plaintext markup.</p>
453 <div class="section">
454 <h2><a class="toc-backref" href="#id30" id="general" name="general">General</a></h2>
455 <p>You must adhere to the convention of adding two spaces at the end of every
456 sentence. You should fill your paragraphs to column 70, but under no
457 circumstances should your lines extend past column 79. If your code samples
458 spill over column 79, you should rewrite them.</p>
459 </div>
460 <div class="section">
461 <h2><a class="toc-backref" href="#id31" id="section-headings" name="section-headings">Section Headings</a></h2>
462 <p>GLEP headings must begin in column zero and the initial letter of each word
463 must be capitalized as in book titles. Acronyms should be in all capitals.
464 Section titles must be adorned with an underline, a single repeated
465 punctuation character, which begins in column zero and must extend at least as
466 far as the right edge of the title text (4 characters minimum). First-level
467 section titles are underlined with &quot;=&quot; (equals signs), second-level section
468 titles with &quot;-&quot; (hyphens), and third-level section titles with &quot;'&quot; (single
469 quotes or apostrophes). For example:</p>
470 <pre class="literal-block">
471 First-Level Title
472 =================
473
474 Second-Level Title
475 ------------------
476
477 Third-Level Title
478 '''''''''''''''''
479 </pre>
480 <p>If there are more than three levels of sections in your GLEP, you may insert
481 overline/underline-adorned titles for the first and second levels as follows:</p>
482 <pre class="literal-block">
483 ============================
484 First-Level Title (optional)
485 ============================
486
487 -----------------------------
488 Second-Level Title (optional)
489 -----------------------------
490
491 Third-Level Title
492 =================
493
494 Fourth-Level Title
495 ------------------
496
497 Fifth-Level Title
498 '''''''''''''''''
499 </pre>
500 <p>You shouldn't have more than five levels of sections in your GLEP. If you do,
501 you should consider rewriting it.</p>
502 <p>You must use two blank lines between the last line of a section's body and the
503 next section heading. If a subsection heading immediately follows a section
504 heading, a single blank line in-between is sufficient.</p>
505 <p>The body of each section is not normally indented, although some constructs do
506 use indentation, as described below. Blank lines are used to separate
507 constructs.</p>
508 </div>
509 <div class="section">
510 <h2><a class="toc-backref" href="#id32" id="paragraphs" name="paragraphs">Paragraphs</a></h2>
511 <p>Paragraphs are left-aligned text blocks separated by blank lines. Paragraphs
512 are not indented unless they are part of an indented construct (such as a
513 block quote or a list item).</p>
514 </div>
515 <div class="section">
516 <h2><a class="toc-backref" href="#id33" id="inline-markup" name="inline-markup">Inline Markup</a></h2>
517 <p>Portions of text within paragraphs and other text blocks may be
518 styled. For example:</p>
519 <pre class="literal-block">
520 Text may be marked as *emphasized* (single asterisk markup,
521 typically shown in italics) or **strongly emphasized** (double
522 asterisks, typically boldface). ``Inline literals`` (using double
523 backquotes) are typically rendered in a monospaced typeface. No
524 further markup recognition is done within the double backquotes,
525 so they're safe for any kind of code snippets.
526 </pre>
527 </div>
528 <div class="section">
529 <h2><a class="toc-backref" href="#id34" id="block-quotes" name="block-quotes">Block Quotes</a></h2>
530 <p>Block quotes consist of indented body elements. For example:</p>
531 <pre class="literal-block">
532 This is a paragraph.
533
534 This is a block quote.
535
536 A block quote may contain many paragraphs.
537 </pre>
538 <p>Block quotes are used to quote extended passages from other sources.
539 Block quotes may be nested inside other body elements. Use a 4-space tab
540 per indent level.</p>
541 </div>
542 <div class="section">
543 <h2><a class="toc-backref" href="#id35" id="literal-blocks" name="literal-blocks">Literal Blocks</a></h2>
544 <!-- In the text below, double backquotes are used to denote inline
545 literals. "``::``" is written so that the colons will appear in a
546 monospaced font; the backquotes (``) are markup, not part of the
547 text. See "Inline Markup" above.
548
549 By the way, this is a comment, described in "Comments" below. -->
550 <p>Literal blocks are used for code samples or preformatted ASCII art. To
551 indicate a literal block, preface the indented text block with
552 &quot;<tt class="docutils literal"><span class="pre">::</span></tt>&quot; (two colons). The literal block continues until the end of
553 the indentation. Indent the text block by a tab. For example:</p>
554 <pre class="literal-block">
555 This is a typical paragraph. A literal block follows.
556
557 ::
558
559 for a in [5,4,3,2,1]: # this is program code, shown as-is
560 print a
561 print &quot;it's...&quot;
562 # a literal block continues until the indentation ends
563 </pre>
564 <p>The paragraph containing only &quot;<tt class="docutils literal"><span class="pre">::</span></tt>&quot; will be completely removed from
565 the output; no empty paragraph will remain. &quot;<tt class="docutils literal"><span class="pre">::</span></tt>&quot; is also
566 recognized at the end of any paragraph. If immediately preceded by
567 whitespace, both colons will be removed from the output. When text
568 immediately precedes the &quot;<tt class="docutils literal"><span class="pre">::</span></tt>&quot;, <em>one</em> colon will be removed from
569 the output, leaving only one colon visible (i.e., &quot;<tt class="docutils literal"><span class="pre">::</span></tt>&quot; will be
570 replaced by &quot;<tt class="docutils literal"><span class="pre">:</span></tt>&quot;). For example, one colon will remain visible
571 here:</p>
572 <pre class="literal-block">
573 Paragraph::
574
575 Literal block
576 </pre>
577 </div>
578 <div class="section">
579 <h2><a class="toc-backref" href="#id36" id="lists" name="lists">Lists</a></h2>
580 <p>Bullet list items begin with one of &quot;-&quot;, &quot;*&quot;, or &quot;+&quot; (hyphen,
581 asterisk, or plus sign), followed by whitespace and the list item
582 body. List item bodies must be left-aligned and indented relative to
583 the bullet; the text immediately after the bullet determines the
584 indentation. For example:</p>
585 <pre class="literal-block">
586 This paragraph is followed by a list.
587
588 * This is the first bullet list item. The blank line above the
589 first list item is required; blank lines between list items
590 (such as below this paragraph) are optional.
591
592 * This is the first paragraph in the second item in the list.
593
594 This is the second paragraph in the second item in the list.
595 The blank line above this paragraph is required. The left edge
596 of this paragraph lines up with the paragraph above, both
597 indented relative to the bullet.
598
599 - This is a sublist. The bullet lines up with the left edge of
600 the text blocks above. A sublist is a new list so requires a
601 blank line above and below.
602
603 * This is the third item of the main list.
604
605 This paragraph is not part of the list.
606 </pre>
607 <p>Enumerated (numbered) list items are similar, but use an enumerator
608 instead of a bullet. Enumerators are numbers (1, 2, 3, ...), letters
609 (A, B, C, ...; uppercase or lowercase), or Roman numerals (i, ii, iii,
610 iv, ...; uppercase or lowercase), formatted with a period suffix
611 (&quot;1.&quot;, &quot;2.&quot;), parentheses (&quot;(1)&quot;, &quot;(2)&quot;), or a right-parenthesis
612 suffix (&quot;1)&quot;, &quot;2)&quot;). For example:</p>
613 <pre class="literal-block">
614 1. As with bullet list items, the left edge of paragraphs must
615 align.
616
617 2. Each list item may contain multiple paragraphs, sublists, etc.
618
619 This is the second paragraph of the second list item.
620
621 a) Enumerated lists may be nested.
622 b) Blank lines may be omitted between list items.
623 </pre>
624 <p>Definition lists are written like this:</p>
625 <pre class="literal-block">
626 what
627 Definition lists associate a term with a definition.
628
629 how
630 The term is a one-line phrase, and the definition is one
631 or more paragraphs or body elements, indented relative to
632 the term.
633 </pre>
634 </div>
635 <div class="section">
636 <h2><a class="toc-backref" href="#id37" id="tables" name="tables">Tables</a></h2>
637 <p>Simple tables are easy and compact:</p>
638 <pre class="literal-block">
639 ===== ===== =======
640 A B A and B
641 ===== ===== =======
642 False False False
643 True False False
644 False True False
645 True True True
646 ===== ===== =======
647 </pre>
648 <p>There must be at least two columns in a table (to differentiate from
649 section titles). Column spans use underlines of hyphens (&quot;Inputs&quot;
650 spans the first two columns):</p>
651 <pre class="literal-block">
652 ===== ===== ======
653 Inputs Output
654 ------------ ------
655 A B A or B
656 ===== ===== ======
657 False False False
658 True False True
659 False True True
660 True True True
661 ===== ===== ======
662 </pre>
663 <p>Text in a first-column cell starts a new row. No text in the first
664 column indicates a continuation line; the rest of the cells may
665 consist of multiple lines. For example:</p>
666 <pre class="literal-block">
667 ===== =========================
668 col 1 col 2
669 ===== =========================
670 1 Second column of row 1.
671 2 Second column of row 2.
672 Second line of paragraph.
673 3 - Second column of row 3.
674
675 - Second item in bullet
676 list (row 3, column 2).
677 ===== =========================
678 </pre>
679 </div>
680 <div class="section">
681 <h2><a class="toc-backref" href="#id38" id="hyperlinks" name="hyperlinks">Hyperlinks</a></h2>
682 <p>When referencing an external web page in the body of a GLEP, you should
683 include the title of the page in the text, with either an inline
684 hyperlink reference to the URL or a footnote reference (see
685 <a class="reference" href="#footnotes">Footnotes</a> below). Do not include the URL in the body text of the
686 GLEP.</p>
687 <p>Hyperlink references use backquotes and a trailing underscore to mark
688 up the reference text; backquotes are optional if the reference text
689 is a single word. For example:</p>
690 <pre class="literal-block">
691 In this paragraph, we refer to the `Python web site`_.
692 </pre>
693 <p>An explicit target provides the URL. Put targets in a References
694 section at the end of the GLEP, or immediately after the reference.
695 Hyperlink targets begin with two periods and a space (the &quot;explicit
696 markup start&quot;), followed by a leading underscore, the reference text,
697 a colon, and the URL (absolute or relative):</p>
698 <pre class="literal-block">
699 .. _Python web site: http://www.python.org/
700 </pre>
701 <p>The reference text and the target text must match (although the match
702 is case-insensitive and ignores differences in whitespace). Note that
703 the underscore trails the reference text but precedes the target text.
704 If you think of the underscore as a right-pointing arrow, it points
705 <em>away</em> from the reference and <em>toward</em> the target.</p>
706 <p>The same mechanism can be used for internal references. Every unique
707 section title implicitly defines an internal hyperlink target. We can
708 make a link to the Abstract section like this:</p>
709 <pre class="literal-block">
710 Here is a hyperlink reference to the `Abstract`_ section. The
711 backquotes are optional since the reference text is a single word;
712 we can also just write: Abstract_.
713 </pre>
714 <p>Footnotes containing the URLs from external targets will be generated
715 automatically at the end of the References section of the GLEP, along
716 with footnote references linking the reference text to the footnotes.</p>
717 <p>Text of the form &quot;GLEP x&quot; or &quot;RFC x&quot; (where &quot;x&quot; is a number) will be
718 linked automatically to the appropriate URLs.</p>
719 </div>
720 <div class="section">
721 <h2><a class="toc-backref" href="#id39" id="footnotes" name="footnotes">Footnotes</a></h2>
722 <p>Footnote references consist of a left square bracket, a number, a
723 right square bracket, and a trailing underscore:</p>
724 <pre class="literal-block">
725 This sentence ends with a footnote reference [1]_.
726 </pre>
727 <p>Whitespace must precede the footnote reference. Leave a space between
728 the footnote reference and the preceding word.</p>
729 <p>When referring to another GLEP, include the GLEP number in the body
730 text, such as &quot;GLEP 1&quot;. The title may optionally appear. Add a
731 footnote reference following the title. For example:</p>
732 <pre class="literal-block">
733 Refer to GLEP 1 [2]_ for more information.
734 </pre>
735 <p>Add a footnote that includes the GLEP's title and author. It may
736 optionally include the explicit URL on a separate line, but only in
737 the References section. Footnotes begin with &quot;.. &quot; (the explicit
738 markup start), followed by the footnote marker (no underscores),
739 followed by the footnote body. For example:</p>
740 <pre class="literal-block">
741 References
742 ==========
743
744 .. [2] GLEP 1, &quot;GLEP Purpose and Guidelines&quot;, Goodyear, Warsaw, Hylton
745 (http://glep.gentoo.org/glep-0001.html)
746 </pre>
747 <p>If you decide to provide an explicit URL for a GLEP, please use this as
748 the URL template:</p>
749 <pre class="literal-block">
750 http://glep.gentoo.org/glep-xxxx.html
751 </pre>
752 <p>GLEP numbers in URLs must be padded with zeros from the left, so as to
753 be exactly 4 characters wide, however GLEP numbers in the text are
754 never padded.</p>
755 <p>During the course of developing your GLEP, you may have to add, remove,
756 and rearrange footnote references, possibly resulting in mismatched
757 references, obsolete footnotes, and confusion. Auto-numbered
758 footnotes allow more freedom. Instead of a number, use a label of the
759 form &quot;#word&quot;, where &quot;word&quot; is a mnemonic consisting of alphanumerics
760 plus internal hyphens, underscores, and periods (no whitespace or
761 other characters are allowed). For example:</p>
762 <pre class="literal-block">
763 Refer to GLEP 1 [#GLEP-1]_ for more information.
764
765 References
766 ==========
767
768 .. [#GLEP-1] GLEP 1, &quot;GLEP Purpose and Guidelines&quot;, Goodyear
769 http://glep.gentoo.org/glep-0001.html
770 </pre>
771 <p>Footnotes and footnote references will be numbered automatically, and
772 the numbers will always match. Once a GLEP is finalized, auto-numbered
773 labels should be replaced by numbers for simplicity.</p>
774 </div>
775 <div class="section">
776 <h2><a class="toc-backref" href="#id40" id="images" name="images">Images</a></h2>
777 <p>If your GLEP contains a diagram, you may include it in the processed
778 output using the &quot;image&quot; directive:</p>
779 <pre class="literal-block">
780 .. image:: diagram.png
781 </pre>
782 <p>Any browser-friendly graphics format is possible: .png, .jpeg, .gif,
783 .tiff, etc.</p>
784 <p>Since this image will not be visible to readers of the GLEP in source
785 text form, you should consider including a description or ASCII art
786 alternative, using a comment (below).</p>
787 </div>
788 <div class="section">
789 <h2><a class="toc-backref" href="#id41" id="comments" name="comments">Comments</a></h2>
790 <p>A comment block is an indented block of arbitrary text immediately
791 following an explicit markup start: two periods and whitespace. Leave
792 the &quot;..&quot; on a line by itself to ensure that the comment is not
793 misinterpreted as another explicit markup construct. Comments are not
794 visible in the processed document. For the benefit of those reading
795 your GLEP in source form, please consider including a descriptions of
796 or ASCII art alternatives to any images you include. For example:</p>
797 <pre class="literal-block">
798 .. image:: dataflow.png
799
800 ..
801 Data flows from the input module, through the &quot;black box&quot;
802 module, and finally into (and through) the output module.
803 </pre>
804 </div>
805 <div class="section">
806 <h2><a class="toc-backref" href="#id42" id="escaping-mechanism" name="escaping-mechanism">Escaping Mechanism</a></h2>
807 <p>reStructuredText uses backslashes (&quot;<tt class="docutils literal"><span class="pre">\</span></tt>&quot;) to override the special
808 meaning given to markup characters and get the literal characters
809 themselves. To get a literal backslash, use an escaped backslash
810 (&quot;<tt class="docutils literal"><span class="pre">\\</span></tt>&quot;). There are two contexts in which backslashes have no
811 special meaning: <a class="reference" href="#literal-blocks">literal blocks</a> and inline literals (see <a class="reference" href="#inline-markup">Inline
812 Markup</a> above). In these contexts, no markup recognition is done,
813 and a single backslash represents a literal backslash, without having
814 to double up.</p>
815 <p>If you find that you need to use a backslash in your text, consider
816 using inline literals or a literal block instead.</p>
817 </div>
818 </div>
819 <div class="section">
820 <h1><a class="toc-backref" href="#id43" id="habits-to-avoid" name="habits-to-avoid">Habits to Avoid</a></h1>
821 <p>Many programmers who are familiar with TeX often write quotation marks
822 like this:</p>
823 <pre class="literal-block">
824 `single-quoted' or ``double-quoted''
825 </pre>
826 <p>Backquotes are significant in reStructuredText, so this practice
827 should be avoided. For ordinary text, use ordinary 'single-quotes' or
828 &quot;double-quotes&quot;. For inline literal text (see <a class="reference" href="#inline-markup">Inline Markup</a>
829 above), use double-backquotes:</p>
830 <pre class="literal-block">
831 ``literal text: in here, anything goes!``
832 </pre>
833 </div>
834 <div class="section">
835 <h1><a class="toc-backref" href="#id44" id="resources" name="resources">Resources</a></h1>
836 <p>Many other constructs and variations are possible. For more details
837 about the reStructuredText markup, in increasing order of
838 thoroughness, please see:</p>
839 <ul class="simple">
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>
841 <li><a class="reference" href="http://docutils.sourceforge.net/docs/rst/quickref.html">Quick reStructuredText</a> <a class="footnote-reference" href="#id19" id="id20" name="id20">[9]</a>, a users' quick reference.</li>
842 <li><a class="reference" href="http://docutils.sourceforge.net/spec/rst/reStructuredText.html">reStructuredText Markup Specification</a> <a class="footnote-reference" href="#id21" id="id22" name="id22">[10]</a>, the final authority.</li>
843 </ul>
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
845 you have a question or require assistance with reStructuredText or
846 Docutils, please <a class="reference" href="mailto:docutils-users&#64;lists.sourceforge.net?subject=GLEPs">post a message</a> <a class="footnote-reference" href="#id10" id="id11" name="id11">[5]</a> to the <a class="reference" href="http://lists.sourceforge.net/lists/listinfo/docutils-users">Docutils-Users mailing
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>
848 </div>
849 <div class="section">
850 <h1><a class="toc-backref" href="#id45" id="references" name="references">References</a></h1>
851 <table class="docutils footnote" frame="void" id="python" rules="none">
852 <colgroup><col class="label" /><col /></colgroup>
853 <tbody valign="top">
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>
855 </tbody>
856 </table>
857 <table class="docutils footnote" frame="void" id="pep12" rules="none">
858 <colgroup><col class="label" /><col /></colgroup>
859 <tbody valign="top">
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>
861 </tbody>
862 </table>
863 <table class="docutils footnote" frame="void" id="glep1" rules="none">
864 <colgroup><col class="label" /><col /></colgroup>
865 <tbody valign="top">
866 <tr><td class="label"><a class="fn-backref" href="#id3" name="glep1">[3]</a></td><td>GLEP 1, GLEP Purpose and Guidelines, Goodyear,
867 (<a class="reference" href="http://glep.gentoo.org/glep-0001.html">http://glep.gentoo.org/glep-0001.html</a>)</td></tr>
868 </tbody>
869 </table>
870 <table class="docutils footnote" frame="void" id="id8" rules="none">
871 <colgroup><col class="label" /><col /></colgroup>
872 <tbody valign="top">
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>
874 </tbody>
875 </table>
876 <table class="docutils footnote" frame="void" id="id10" rules="none">
877 <colgroup><col class="label" /><col /></colgroup>
878 <tbody valign="top">
879 <tr><td class="label"><a class="fn-backref" href="#id11" name="id10">[5]</a></td><td><a class="reference" href="mailto:docutils-users&#64;lists.sourceforge.net?subject=GLEPs">mailto:docutils-users&#64;lists.sourceforge.net?subject=GLEPs</a></td></tr>
880 </tbody>
881 </table>
882 <table class="docutils footnote" frame="void" id="id12" rules="none">
883 <colgroup><col class="label" /><col /></colgroup>
884 <tbody valign="top">
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>
886 </tbody>
887 </table>
888 <table class="docutils footnote" frame="void" id="id15" rules="none">
889 <colgroup><col class="label" /><col /></colgroup>
890 <tbody valign="top">
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>
892 </tbody>
893 </table>
894 <table class="docutils footnote" frame="void" id="id17" rules="none">
895 <colgroup><col class="label" /><col /></colgroup>
896 <tbody valign="top">
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>
898 </tbody>
899 </table>
900 <table class="docutils footnote" frame="void" id="id19" rules="none">
901 <colgroup><col class="label" /><col /></colgroup>
902 <tbody valign="top">
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>
904 </tbody>
905 </table>
906 <table class="docutils footnote" frame="void" id="id21" rules="none">
907 <colgroup><col class="label" /><col /></colgroup>
908 <tbody valign="top">
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>
910 </tbody>
911 </table>
912 </div>
913 <div class="section">
914 <h1><a class="toc-backref" href="#id46" id="copyright" name="copyright">Copyright</a></h1>
915 <p>This document has been placed in the public domain.</p>
916 </div>
917
918 </div>
919 <div class="footer">
920 <hr class="footer" />
921 <a class="reference" href="glep-0002.txt">View document source</a>.
922 Generated on: 2006-10-10 20:23 UTC.
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
925 </div>
926 </body>
927 </html>

  ViewVC Help
Powered by ViewVC 1.1.20