/[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.8 - (hide annotations) (download)
Tue Oct 2 10:31:39 2007 UTC (6 years, 11 months ago) by vapier
Branch: MAIN
CVS Tags: HEAD
Changes since 1.7: +2 -2 lines
File MIME type: text/plain
docutils-glep.py was renamed to just glep.py

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 g2boojum 1.6
22     # USE=glep emerge docutils
23 g2boojum 1.2
24 g2boojum 1.6 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 vapier 1.8 # glep.py glep-0001.txt glep-0001.html
28 g2boojum 1.4
29 g2boojum 1.6 The above usage embeds the CSS stylesheet in the html file. For pages
30     on glep.gentoo.org, it is better to use a link instead::
31 g2boojum 1.2
32 vapier 1.8 # glep.py --link-stylesheet --stylesheet-path=tools/glep.css \
33 g2boojum 1.6 > glep-0001.txt glep-0001.html
34 g2boojum 1.2
35 g2boojum 1.6 (Incidentally, *glep.py* contains special code to verify that
36 g2boojum 1.2 the GLEP header is reasonable. This README lacks that header,
37     so to convert this file to html using docutils you need to
38     use the more generic transformation program::
39    
40 g2boojum 1.6 # rst2html.py --stylesheet-path=tools/glep.css README.txt README.html
41 g2boojum 1.2
42     to convert README.txt to README.html.)
43    
44     Files
45     =====
46    
47 g2boojum 1.6 ======================== ======================================
48     File Purpose
49     ======================== ======================================
50     README.txt This file (duh!)
51     docutils.conf Configuration file for GLEP conversion
52     from txt to html
53     glep-xxxx.txt GLEPs in text (ReST) form
54     tools/glep.css GLEP html stylesheet
55     tools/glep-html-template GLEP boilerplate template
56     ======================== ======================================
57 g2boojum 1.2
58    
59     References
60     ==========
61    
62     .. [#ReST] ReStructuredText,
63     http://docutils.sourceforge.net/docs/rst/quickstart.html
64    
65     .. [#docutils] http://docutils.sourceforge.net/

  ViewVC Help
Powered by ViewVC 1.1.20