Annotation of htdocs/developers/htdocs.html, revision 1.4

1.1       abs         1: <html>
                      2: <head>
                      3: 
                      4: <!-- DO NOT EDIT THIS FILE. EDIT 'htdocs.list' AND RUN 'make' -->
                      5: 
                      6: <!-- Copyright (c) 1996, 1997, 1998
                      7:        The NetBSD Foundation, Inc.  ALL RIGHTS RESERVED. -->
                      8: <link rev="made" href="mailto:www@NetBSD.ORG">
                      9: <title>Editing htdocs</title>
                     10: </head>
                     11: <body bgcolor="#FFFFFF" text="#000000">
                     12: 
                     13: <table>
                     14: <tr><td width=150><img src="../images/NetBSD-banner.gif" alt="NetBSD"></td>
                     15: <td valign=bottom><h2>Editing htdocs</h2></td></tr>
                     16: </table>
                     17: 
                     18: <p>
                     19: This is intended to become a reference for those wishing to edit htdocs
                     20: (the CVS repository for the NetBSD web server).
                     21: </p>
                     22: 
                     23: <h2>Notes on htdocs</h2>
                     24: <ul>
1.2       abs        25: <li><a href="#validate-html"><font face="helvetica, arial, sans-serif">Validate your HTML</font></a></li>
                     26: <li><a href="#who-can-edit"><font face="helvetica, arial, sans-serif">Who can edit htdocs</font></a></li>
                     27: <li><a href="#dotlist-files"><font face="helvetica, arial, sans-serif">What are .list files, and how to use them</font></a></li>
1.1       abs        28: </ul>
                     29: 
                     30: 
                     31: <hr>
                     32: <h2>Notes on htdocs</h2><hr>
                     33: <p><dl><dt>
1.2       abs        34: <font face="helvetica, arial, sans-serif"><h3><a name="validate-html">Validate your HTML</a>
                     35: <font size="-1">(<a href="#top">top</a>)</font></h3></font>
1.1       abs        36: </dt><dd>
1.4     ! abs        37: After making any changes you should run your html through an HTML
        !            38: verifier such as <a
        !            39: href="ftp://ftp.netbsd.org/pub/NetBSD/packages/pkgsrc/www/weblint/README.html">weblint</a>.
        !            40: If you use weblint you may want to add the following to your
        !            41: <tt>~/.weblintrc</tt>.
        !            42: <pre>  extension Netscape</pre>
1.1       abs        43: 
                     44: </dd></dl></p>
                     45: <p><dl><dt>
1.2       abs        46: <font face="helvetica, arial, sans-serif"><h3><a name="who-can-edit">Who can edit htdocs</a>
                     47: <font size="-1">(<a href="#top">top</a>)</font></h3></font>
1.1       abs        48: </dt><dd>
                     49: Anyone with write access to the NetBSD CVS tree can checkout htdocs and
                     50: make changes, and in fact is encouraged to do so.
                     51: 
                     52: </dd></dl></p>
                     53: <p><dl><dt>
1.2       abs        54: <font face="helvetica, arial, sans-serif"><h3><a name="dotlist-files">What are .list files, and how to use them</a>
                     55: <font size="-1">(<a href="#top">top</a>)</font></h3></font>
1.1       abs        56: </dt><dd>
                     57: .list files contain HTML with additional special tags to simplify formatting.
                     58: There should be a Makefile in each directory which handles processing
                     59: the .list files into .html, and will recurse into any subdirs
                     60: containing Makefiles. Continuation lines are understood (useful for the
1.3       abs        61: special tags). You should run make before committing.
1.1       abs        62: 
                     63: <p>
                     64: <table>
                     65: <tr><th colspan=2>Compulsary tags</th></tr>
                     66: <tr><th valign=top align=right>&lt;LIST&gt;:</th>
                     67:     <td>Include generated list of entries here.</td></tr><tr><th valign=top align=right>&lt;SECTION&gt;Text:</th>
                     68:     <td>Introduces new section, before DATE or ENTRY</td></tr><tr><th valign=top align=right>&lt;ENDLIST&gt;:</th>
                     69:     <td>Optional tag for end of all special entries</td></tr>
                     70: <tr><th colspan=2>Optional tags</th></tr>
                     71: <tr><th valign=top align=right>&lt;DATE&gt;tag date Text:</th>
                     72:     <td>Change entry, expanded to title & added to list</td></tr><tr><th valign=top align=right>&lt;ENTRY&gt;tag Text:</th>
                     73:     <td>Text expanded to entry title and added to list</td></tr><tr><th valign=top align=right>&lt;ENTRYLINK&gt;url Text:</th>
                     74:     <td>Link added to list, removed from main text</td></tr><tr><th valign=top align=right>&lt;HEADING&gt;Text:</th>
                     75:     <td>Standard heading at top of document</td></tr><tr><th valign=top align=right>&lt;BASELINKS&gt;:</th>
                     76:     <td>Standard links at base of document</td></tr><tr><th valign=top align=right>&lt;TROW&gt;Text:</th>
                     77:     <td>Text:    Table row, with two text fields</td></tr></table>
                     78: <p>
                     79: Additional pattern matches:<br>
                     80: <table>
                     81: <tr><th align=left>man pages</th>
                     82:     <td>([a-zA-Z_][-\w.+]*[\w+])\((\d)\)</td><td>eg: <a href="http://www.flame.org/cgi-bin/uncgi/hman?page=ls&amp;sect=1">ls(1)</a></td></tr>
                     83: <tr><th align=left>email addresses</th>
                     84:     <td>&lt;([-\w.]+@[-\w.]+)&gt;</td><td>eg: <a href="mailto:abs@netbsd.org">&lt;abs@netbsd.org&gt;</a></td></tr>
                     85: </table>
                     86: 
                     87: </dd></dl></p>
                     88: <hr>
                     89: 
                     90: <a href="index.html">Back to the <em>Main developers</em> page</a>
                     91: 
                     92: <hr>
                     93: <table><tr>
                     94:   <td>
                     95:     <a href="../index.html">
                     96:     <img src="../images/NetBSD-banner.gif" alt="NetBSD&nbsp;Home"></a>
                     97:   </td><td>
                     98:     <a href="../index.html">Home Page</a>
                     99:   </td>
                    100: </tr></table>
                    101: 
                    102: <hr>
                    103: <address>
                    104:   <a href="../Misc/feedback.html">(Contact us)</a>
1.4     ! abs       105:   $NetBSD: htdocs.list,v 1.2 1999/06/23 03:00:58 abs Exp $<br>
1.1       abs       106:   <a href="../Misc/disclaimer.html">Copyright &copy; 1996, 1997, 1998
                    107:     The NetBSD Foundation, Inc.  ALL RIGHTS RESERVED.</a>
                    108: </address>
                    109: 
                    110: </body>
                    111: </html>

CVSweb <webmaster@jp.NetBSD.org>