/usr/share/doc/lire/dev-manual/ch21s03.html is in lire-devel-doc 2:2.1.1-2.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Docbook XML: Reference Books and Extensive User Manuals</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"><link rel="home" href="index.html" title="Lire Developer's Manual"><link rel="up" href="ch21.html" title="Chapter 21. Writing Documentation"><link rel="prev" href="ch21s02.html" title="Perl's Plain Old Documentation: maintaining manpages"><link rel="next" href="pt05.html" title="Part V. Implementation Details"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Docbook XML: Reference Books and Extensive User Manuals</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch21s02.html">Prev</a> </td><th width="60%" align="center">Chapter 21. Writing Documentation</th><td width="20%" align="right"> <a accesskey="n" href="pt05.html">Next</a></td></tr></table><hr></div><div class="section" title="Docbook XML: Reference Books and Extensive User Manuals"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sect:docbook-xml"></a>Docbook XML: Reference Books and Extensive User Manuals</h2></div></div></div><p>The main documentation of the <span class="application">Lire</span> project is done in DocBook
XML 4.1.2. E.g. this document is maintained in DocBook XML, as is the
<em class="citetitle"><span class="application">Lire</span> User's Manual</em>. The <em class="citetitle"><span class="application">Lire</span> User's Manual</em> has more information
about DocBook.</p><p>After editing the <em class="citetitle"><span class="application">Lire</span> Developer's Manual</em> or the <em class="citetitle"><span class="application">Lire</span> User's Manual</em>,
you should run <strong class="userinput"><code>make check-xml</code></strong> to
make sure the document is still a valid DocBook document. You
should fix any errors before committing your changes.
</p><p>If everything went right, documentation is built in txt,
tex, html and pdf format by running
<strong class="userinput"><code>make dist</code></strong>, or just
<strong class="userinput"><code>make</code></strong> in
<code class="filename">doc/</code>. We give some hints
which might be helpful in
case you have to build the documentation manually.
</p><p>To generate PDF:
</p><pre class="programlisting">
<code class="prompt">$ </code>jade -t tex -d /path/to/DSSSL/docbook/print/docbook.dsl roadmap.xml
<code class="prompt">$ </code>pdfjadetex roadmap.tex
</pre><p>
The last step is actually done two or three times to resolve
page numbers.
</p><p>
To generate HTML:
</p><pre class="programlisting">
<code class="prompt">$ </code>jade -t sgml -d html.dsl roadmap.xml
</pre><p>
And now you can use the <code class="filename">html.dsl</code> in the
<code class="filename">doc/source</code> directory. (If
necessary, adjust it to reflect the location of your DSSSL
stylesheets). Use lynx to generate TXT output from HTML with:
</p><pre class="programlisting">
<code class="prompt">$ </code>lynx -nolist -dump roadmap.html > roadmap.txt
</pre><p>
</p></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch21s02.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch21.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="pt05.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Perl's Plain Old Documentation: maintaining manpages </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Part V. Implementation Details</td></tr></table></div></body></html>
|