l3doc/README.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   2                "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml"
   4 lang="en" xml:lang="en">
   5 <head>
   6 <title>l3 README</title>
   7 <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"/>
   8 <meta name="generator" content="Org-mode"/>
   9 <meta name="generated" content="2007/10/16 15:41:26"/>
  10 <meta name="author" content="Michael Hohn"/>
  11 <link rel=stylesheet href="l3style.css" type="text/css">
  12 </head><body>
  13 <h1 class="title">l3 README</h1>
  14
  15
  16
  17 <div id="toc">
  18 <h2>Table of Contents</h2>
  19 <ul>
  20 <li><a href="#sec-1">1 Overview</a></li>
  21 <li><a href="#sec-2">2 Creating documentation in various formats</a></li>
  22 <li><a href="#sec-3">3 Installer</a>
  23 <ul>
  24 <li><a href="#sec-4">3.1 look up documentation</a></li>
  25 </ul>
  26 </li>
  27 <li><a href="#sec-5">4 Produce a python package</a></li>
  28 <li><a href="#sec-6">5 Install a python package</a></li>
  29 </ul>
  30
  31 </div>
  32 <div id="content">
  33
  34
  35
  36 <h2 id="sec-1">1 Overview</h2>
  37
  38 <p>Documentation source is found in the files
  39 <pre>
  40    l3.txt
  41    l3gui.txt
  42    l3lang.txt
  43 </pre>
  44 </p>
  45 <p>
  46 This directory contains all documentation, and code to produce the
  47 web page.
  48 </p>
  49 <p>
  50 Some generated documentation is copied to the doc/ subdirectories of
  51 l3lang / l3gui for completeness.
  52 </p>
  53
  54 <h2 id="sec-2">2 Creating documentation in various formats</h2>
  55
  56 <ul>
  57 <li>
  58 Directly create html 'manpage' via
  59 <pre>
  60    asciidoc -d manpage l3.txt
  61 </pre>
  62 or
  63 <pre>
  64    asciidoc -d manpage -a toc -a numbered l3.txt
  65 </pre>
  66 or
  67 <pre>
  68    asciidoc -d manpage -a toc l3.txt
  69 </pre>
  70
  71
  72 </li>
  73 </ul>
  74 <p>Create and view a man page, via docbook:
  75 <pre>
  76    $SPXROOT/usr/bin/a2x -d manpage -f manpage l3.txt
  77 </pre>
  78 </p>
  79 <p>
  80 Produce the printable version (postscript):
  81 <pre>
  82    groff -man ./l3.1 &gt; l3.ps
  83 </pre>
  84 </p>
  85 <p>
  86 Produce an alternate (nicer?) text form (with escape sequences).
  87 <pre>
  88    groff -mandoc -Tascii ./l3.1 &gt; l3.alt
  89 </pre>
  90 </p>
  91
  92 <p>
  93 Create an alternate text form
  94 <pre>
  95    $SPXROOT/usr/bin/a2x -v  -d manpage -f text l3.txt
  96 </pre>
  97 </p>
  98 <p>
  99 Create pdf via fop
 100 <pre>
 101    $SPXROOT/usr/bin/a2x -v  -d manpage -f pdf l3.txt
 102 </pre>
 103 </p>
 104
 105 <p>
 106 Directly create latex
 107 <pre>
 108    asciidoc --unsafe --backend=latex l3gui.txt
 109 </pre>
 110 or
 111 <pre>
 112    asciidoc -v --unsafe --backend=latex l3gui.txt
 113 </pre>
 114 then
 115 <pre>
 116    pdflatex l3gui.tex
 117 </pre>
 118 </p>
 119 <p>
 120 Adjustments to generated latex may include
 121 <pre>
 122    \documentclass [letter,abstracton,titlepage,10pt]{scrartcl}
 123    \usepackage{arev}
 124 </pre>
 125 </p>
 126
 127
 128 <h2 id="sec-3">3 Installer</h2>
 129
 130
 131 <h3 id="sec-4">3.1 look up documentation</h3>
 132
 133 <p><pre>
 134    sparx.wrap man dblatex
 135 </pre>
 136 </p>
 137
 138 <h2 id="sec-5">4 Produce a python package</h2>
 139
 140 <p><pre>
 141    python setup.py sdist
 142 </pre>
 143 </p>
 144
 145 <h2 id="sec-6">5 Install a python package</h2>
 146
 147 <p><pre>
 148    cd ~/tmp
 149    tar zxvf ~/w/phenix/l3lang/dist/l3lang-0.5.tar.gz
 150    pushd l3lang-0.5/
 151    python setup.py install
 152 </pre>
 153 </p>
 154
 155
 156 </div>
 157
 158 <p class="author"> Author: Michael Hohn
 159 <a href="mailto:mhhohn@lbl.gov">&lt;mhhohn@lbl.gov&gt;</a>
 160 </p>
 161 <p class="date"> Date: 2007/10/16 15:41:26</p>
 162 </body>
 163 </html>