/[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.4 - (hide annotations) (download)
Mon Mar 14 19:42:31 2005 UTC (9 years, 9 months ago) by g2boojum
Branch: MAIN
Changes since 1.3: +8 -3 lines
File MIME type: text/plain
update

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

  ViewVC Help
Powered by ViewVC 1.1.20