/[gentoo]/xml/htdocs/proj/en/glep/README.txt
Gentoo

Diff of /xml/htdocs/proj/en/glep/README.txt

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

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

Legend:
Removed from v.1.1  
changed lines
  Added in v.1.7

  ViewVC Help
Powered by ViewVC 1.1.20