/[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.2
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 # 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 # glep.py glep-0001.txt glep-0001.html
28
29(Incidentally, *glep.py* contains special code to verify that
30the GLEP header is reasonable. This README lacks that header,
31so to convert this file to html using docutils you need to
32use the more generic transformation program::
33
34 # html.py --stylesheet-path=tools/glep.css README.txt README.html
35
36to convert README.txt to README.html.)
37
38Files
39=====
40
41======================== ======================================
42File Purpose
43======================== ======================================
44README.txt This file (duh!)
45docutils.conf Configuration file for GLEP conversion
46 from txt to html
47glep-xxxx.txt GLEPs in text (ReST) form
48tools/glep.css GLEP html stylesheet
49tools/glep-html-template GLEP boilerplate template
50======================== ======================================
51
52
53References
54==========
55
56.. [#ReST] ReStructuredText,
57 http://docutils.sourceforge.net/docs/rst/quickstart.html
58
59.. [#docutils] http://docutils.sourceforge.net/

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

  ViewVC Help
Powered by ViewVC 1.1.20