JezK
Edit File: about.html
<?xml version="1.0" encoding="utf-8" standalone="no"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>Chapter 1. About doc-base</title> <meta name="generator" content="DocBook XSL Stylesheets Vsnapshot" /> <link rel="home" href="index.html" title="Debian doc-base Manual" /> <link rel="up" href="index.html" title="Debian doc-base Manual" /> <link rel="prev" href="index.html" title="Debian doc-base Manual" /> <link rel="next" href="interface.html" title="Chapter 2. The packages interface" /> </head> <body> <div class="navheader"> <table width="100%" summary="Navigation header"> <tr> <th colspan="3" align="center">Chapter 1. About <code class="systemitem">doc-base</code></th> </tr> <tr> <td width="20%" align="left"><a accesskey="p" href="index.html">Prev</a> </td> <th width="60%" align="center"> </th> <td width="20%" align="right"> <a accesskey="n" href="interface.html">Next</a></td> </tr> </table> <hr /> </div> <div class="chapter"> <div class="titlepage"> <div> <div> <h1 class="title"><a id="about"></a>Chapter 1. About <code class="systemitem">doc-base</code></h1> </div> </div> </div> <p> Some time ago, there was a big discussion on the Debian mailing lists about the preferred documentation format in Debian. The discussion showed clearly that people have very different opinions on that topic and thus, we'll have to implement a flexible solution. </p> <p> The <code class="systemitem">doc-base</code> package tries to implement such a flexible solution: every Debian package that provides online documentation (other than manual pages) will register these documents to <code class="systemitem">doc-base</code> via the <span class="command"><strong>install-docs</strong></span> script (see <a class="xref" href="interface.html#registering-documents" title="2.4. Registering Documents With doc-base">Section 2.4, “Registering Documents With <span class="command"><strong>doc-base</strong></span>”</a>) at installation time and de-register the manuals again when the package is removed. </p> <p> Since all manuals will eventually be registered, <code class="systemitem">doc-base</code> can also be used to solve another outstanding problem: Debian currently has four different online documentation systems, <code class="systemitem">doc-central</code>, <code class="systemitem">dwww</code>, <code class="systemitem">dochelp</code>, and <code class="systemitem">dhelp</code>. Each system has advantages and disadvantages; thus <code class="systemitem">doc-base</code> supports all of them. The system administrator can choose which implementation he/she prefers. </p> </div> <div class="navfooter"> <hr /> <table width="100%" summary="Navigation footer"> <tr> <td width="40%" align="left"><a accesskey="p" href="index.html">Prev</a> </td> <td width="20%" align="center"> </td> <td width="40%" align="right"> <a accesskey="n" href="interface.html">Next</a></td> </tr> <tr> <td width="40%" align="left" valign="top">Debian <code class="systemitem">doc-base</code> Manual </td> <td width="20%" align="center"> <a accesskey="h" href="index.html">Home</a> </td> <td width="40%" align="right" valign="top"> Chapter 2. The packages interface</td> </tr> </table> </div> </body> </html>