| 1 | more coming soon |
1 | Gentoo Linux Enhancement Proposals |
|
|
2 | ================================== |
|
|
3 | |
|
|
4 | This directory contains the official (CVS-controlled) |
|
|
5 | texts of current and past Gentoo Linux Enhancement |
|
|
6 | Proposals (GLEPs), along with some necessary scripts |
|
|
7 | and configuration files to facilitate converting the |
|
|
8 | GLEPs from (really quite readable) raw ASCII text |
|
|
9 | to html or xml. |
|
|
10 | |
|
|
11 | Requirements |
|
|
12 | ============ |
|
|
13 | |
|
|
14 | GLEPs are written in ReStructuredText [#ReST]_, which |
|
|
15 | is text with some minimal markup so that it is still |
|
|
16 | quite readable in source form, yet it can be readily |
|
|
17 | converted to html or xml for viewing with a browser. |
|
|
18 | |
|
|
19 | Converting ReST to html or xml requires the "docutils" python package |
|
|
20 | [#docutils]_:: |
|
|
21 | |
|
|
22 | # USE=glep emerge docutils |
|
|
23 | |
|
|
24 | The Gentoo Linux docutils package includes the *glep.py* program |
|
|
25 | which transforms a GLEP in text form to the equivalent html version:: |
|
|
26 | |
|
|
27 | # glep.py glep-0001.txt glep-0001.html |
|
|
28 | |
|
|
29 | The above usage embeds the CSS stylesheet in the html file. For pages |
|
|
30 | on glep.gentoo.org, it is better to use a link instead:: |
|
|
31 | |
|
|
32 | # glep.py --link-stylesheet --stylesheet-path=tools/glep.css \ |
|
|
33 | > glep-0001.txt glep-0001.html |
|
|
34 | |
|
|
35 | (Incidentally, *glep.py* contains special code to verify that |
|
|
36 | the GLEP header is reasonable. This README lacks that header, |
|
|
37 | so to convert this file to html using docutils you need to |
|
|
38 | use the more generic transformation program:: |
|
|
39 | |
|
|
40 | # rst2html.py --stylesheet-path=tools/glep.css README.txt README.html |
|
|
41 | |
|
|
42 | to convert README.txt to README.html.) |
|
|
43 | |
|
|
44 | Files |
|
|
45 | ===== |
|
|
46 | |
|
|
47 | ======================== ====================================== |
|
|
48 | File Purpose |
|
|
49 | ======================== ====================================== |
|
|
50 | README.txt This file (duh!) |
|
|
51 | docutils.conf Configuration file for GLEP conversion |
|
|
52 | from txt to html |
|
|
53 | glep-xxxx.txt GLEPs in text (ReST) form |
|
|
54 | tools/glep.css GLEP html stylesheet |
|
|
55 | tools/glep-html-template GLEP boilerplate template |
|
|
56 | ======================== ====================================== |
|
|
57 | |
|
|
58 | |
|
|
59 | References |
|
|
60 | ========== |
|
|
61 | |
|
|
62 | .. [#ReST] ReStructuredText, |
|
|
63 | http://docutils.sourceforge.net/docs/rst/quickstart.html |
|
|
64 | |
|
|
65 | .. [#docutils] http://docutils.sourceforge.net/ |
Parent Directory
| 
Revision Log
| 
Patch