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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.2 - (show annotations) (download)
Mon Jun 2 17:03:08 2003 UTC (11 years, 1 month ago) by g2boojum
Branch: MAIN
Changes since 1.1: +59 -1 lines
File MIME type: text/plain
Bringing up-to-date, if still in need of work.

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

  ViewVC Help
Powered by ViewVC 1.1.20