/[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.5
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
24You will also need to have the ``docutils.conf`` file and the ``tools``
25subdirectory (with ``glep.css`` and ``glep-html-template``, all found in the
26same place as this README.txt file) in the directory where you intend to
27process GLEPs.
28
29The Gentoo Linux docutils package includes the *docutils-glep.py* program
30which transforms a GLEP in text form to the equivalent html version::
31
32 # docutils-glep.py glep-0001.txt glep-0001.html
33
34(Incidentally, *docutils-glep.py* contains special code to verify that
35the GLEP header is reasonable. This README lacks that header,
36so to convert this file to html using docutils you need to
37use the more generic transformation program::
38
39 # rst2html.py --stylesheet-path=tools/glep.css README.txt README.html
40
41to convert README.txt to README.html.)
42
43Files
44=====
45
46======================== ======================================
47File Purpose
48======================== ======================================
49README.txt This file (duh!)
50docutils.conf Configuration file for GLEP conversion
51 from txt to html
52glep-xxxx.txt GLEPs in text (ReST) form
53tools/glep.css GLEP html stylesheet
54tools/glep-html-template GLEP boilerplate template
55======================== ======================================
56
57
58References
59==========
60
61.. [#ReST] ReStructuredText,
62 http://docutils.sourceforge.net/docs/rst/quickstart.html
63
64.. [#docutils] http://docutils.sourceforge.net/

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

  ViewVC Help
Powered by ViewVC 1.1.20