/[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.4 Revision 1.6
16quite readable in source form, yet it can be readily 16quite readable in source form, yet it can be readily
17converted to html or xml for viewing with a browser. 17converted to html or xml for viewing with a browser.
18 18
19Converting ReST to html or xml requires the "docutils" python package 19Converting ReST to html or xml requires the "docutils" python package
20[#docutils]_:: 20[#docutils]_::
21 21
22 # USE=glep emerge docutils 22 # USE=glep emerge docutils
23 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 24The Gentoo Linux docutils package includes the *glep.py* program
30which transforms a GLEP in text form to the equivalent html version:: 25which transforms a GLEP in text form to the equivalent html version::
31 26
32 # docutils-glep.py glep-0001.txt glep-0001.html 27 # glep.py glep-0001.txt glep-0001.html
33 28
29The above usage embeds the CSS stylesheet in the html file. For pages
30on glep.gentoo.org, it is better to use a link instead::
31
32 # glep.py --link-stylesheet --stylesheet-path=tools/glep.css \
33 > glep-0001.txt glep-0001.html
34
34(Incidentally, *docutils-glep.py* contains special code to verify that 35(Incidentally, *glep.py* contains special code to verify that
35the GLEP header is reasonable. This README lacks that header, 36the GLEP header is reasonable. This README lacks that header,
36so to convert this file to html using docutils you need to 37so to convert this file to html using docutils you need to
37use the more generic transformation program:: 38use the more generic transformation program::
38 39
39 # docutils-html.py --stylesheet-path=tools/glep.css README.txt README.html 40 # rst2html.py --stylesheet-path=tools/glep.css README.txt README.html
40 41
41to convert README.txt to README.html.) 42to convert README.txt to README.html.)
42 43
43Files 44Files
44===== 45=====
45 46
46======================== ====================================== 47======================== ======================================
47File Purpose 48File Purpose
48======================== ====================================== 49======================== ======================================
49README.txt This file (duh!) 50README.txt This file (duh!)
50docutils.conf Configuration file for GLEP conversion 51docutils.conf Configuration file for GLEP conversion
51 from txt to html 52 from txt to html
52glep-xxxx.txt GLEPs in text (ReST) form 53glep-xxxx.txt GLEPs in text (ReST) form
53tools/glep.css GLEP html stylesheet 54tools/glep.css GLEP html stylesheet
54tools/glep-html-template GLEP boilerplate template 55tools/glep-html-template GLEP boilerplate template
55======================== ====================================== 56======================== ======================================
56 57
57 58
58References 59References
59========== 60==========
60 61

Legend:
Removed from v.1.4  
changed lines
  Added in v.1.6

  ViewVC Help
Powered by ViewVC 1.1.20