Annotation of htdocs/docs/pkgsrc/editing.html, revision 1.4

1.1       dsieger     1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
                      2: <html>
                      3: <head>
                      4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
                      5: <title>Appendix D. Editing guidelines for the pkgsrc guide</title>
1.2       rillig      6: <link rel="stylesheet" href="/global.css" type="text/css">
1.1       dsieger     7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
1.4     ! rillig      8: <link rel="home" href="index.html" title="The pkgsrc guide">
1.1       dsieger     9: <link rel="up" href="index.html" title="The pkgsrc guide">
                     10: <link rel="prev" href="ftp-layout.html" title="Appendix C. Directory layout of the pkgsrc FTP server">
                     11: </head>
                     12: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
                     13: <div class="navheader">
                     14: <table width="100%" summary="Navigation header">
                     15: <tr><th colspan="3" align="center">Appendix D. Editing guidelines for the pkgsrc guide</th></tr>
                     16: <tr>
                     17: <td width="20%" align="left">
                     18: <a accesskey="p" href="ftp-layout.html">Prev</a> </td>
                     19: <th width="60%" align="center"> </th>
                     20: <td width="20%" align="right"> </td>
                     21: </tr>
                     22: </table>
                     23: <hr>
                     24: </div>
                     25: <div class="appendix" lang="en">
                     26: <div class="titlepage"><div><div><h2 class="title">
                     27: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h2></div></div></div>
                     28: <div class="toc">
                     29: <p><b>Table of Contents</b></p>
                     30: <dl>
                     31: <dt><span class="sect1"><a href="editing.html#targets">D.1. Make targets</a></span></dt>
                     32: <dt><span class="sect1"><a href="editing.html#procedure">D.2. Procedure</a></span></dt>
                     33: </dl>
                     34: </div>
                     35: <p>This section contains information on editing the pkgsrc
                     36:        guide itself.</p>
                     37: <div class="sect1" lang="en">
                     38: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                     39: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
                     40: <p>The pkgsrc guide's source code is stored in
                     41:        <code class="filename">pkgsrc/doc/guide/files</code>, and several files
                     42:        are created from it:</p>
                     43: <div class="itemizedlist"><ul type="disc">
                     44: <li><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
                     45: <li><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.3       hubertf    46: <li><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/" target="_top">http://www.NetBSD.org/docs/pkgsrc/</a></p></li>
                     47: <li><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf</a>:
1.1       dsieger    48:        The PDF version of the pkgsrc guide.</p></li>
1.3       hubertf    49: <li><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps</a>:
1.1       dsieger    50:        PostScript version of the pkgsrc guide.</p></li>
                     51: </ul></div>
                     52: </div>
                     53: <div class="sect1" lang="en">
                     54: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                     55: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
                     56: <p>The procedure to edit the pkgsrc guide is:</p>
                     57: <div class="procedure"><ol type="1">
                     58: <li><p>Make sure you have the packages needed to
                     59:        regenerate the pkgsrc guide (and other XML-based NetBSD
                     60:        documentation) installed. These are <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/netbsd-doc/README.html" target="_top"><code class="filename">meta-pkgs/netbsd-doc</code></a> for creating the
                     61:        ASCII and HTML versions, and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/netbsd-doc-print/README.html" target="_top"><code class="filename">meta-pkgs/netbsd-doc-print</code></a> for the
                     62:        PostScript and PDF versions. You will need both packages
                     63:        installed, to make sure documentation is consistent across all
                     64:        formats.</p></li>
1.3       hubertf    65: <li><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.1       dsieger    66:        right directory. All further steps will take place
                     67:        here.</p></li>
                     68: <li><p>Edit the XML file(s) in
                     69:        <code class="filename">files/</code>.</p></li>
1.3       hubertf    70: <li><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.1       dsieger    71:        guide for valid XML and to build the final output files. If you
                     72:        get any errors at this stage, you can just edit the files, as
                     73:        there are only symbolic links in the working directory, pointing
                     74:        to the files in <code class="filename">files/</code>.</p></li>
1.3       hubertf    75: <li><p><span class="command"><strong>(cd files &amp;&amp; cvs
1.1       dsieger    76:        commit)</strong></span></p></li>
1.3       hubertf    77: <li><p>Run <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span> to
1.1       dsieger    78:        regenerate the output files with the proper RCS
                     79:        Ids.</p></li>
                     80: <li>
1.3       hubertf    81: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.1       dsieger    82:        commit the files in both <code class="filename">pkgsrc/doc</code> and
                     83:        <code class="filename">htdocs</code>.</p>
                     84: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                     85: <h3 class="title">Note</h3>
                     86: <p>If you have added, removed or renamed some chapters,
1.3       hubertf    87:        you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
                     88:        <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.1       dsieger    89:        directory.</p>
                     90: </div>
                     91: </li>
                     92: </ol></div>
                     93: </div>
                     94: </div>
                     95: <div class="navfooter">
                     96: <hr>
                     97: <table width="100%" summary="Navigation footer">
                     98: <tr>
                     99: <td width="40%" align="left">
                    100: <a accesskey="p" href="ftp-layout.html">Prev</a> </td>
                    101: <td width="20%" align="center"> </td>
                    102: <td width="40%" align="right"> </td>
                    103: </tr>
                    104: <tr>
                    105: <td width="40%" align="left" valign="top">Appendix C. Directory layout of the pkgsrc FTP server </td>
                    106: <td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td>
                    107: <td width="40%" align="right" valign="top"> </td>
                    108: </tr>
                    109: </table>
                    110: </div>
                    111: </body>
                    112: </html>

CVSweb <webmaster@jp.NetBSD.org>