Annotation of htdocs/developers/htdocs.html, revision 1.2
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>
37: After making any changes you should run your html through an HTML verifier
38: such as <a href="ftp://ftp.netbsd.org/pub/NetBSD/packages/pkgsrc/www/weblint/README.html">weblint</a>.
39:
40: </dd></dl></p>
41: <p><dl><dt>
1.2 ! abs 42: <font face="helvetica, arial, sans-serif"><h3><a name="who-can-edit">Who can edit htdocs</a>
! 43: <font size="-1">(<a href="#top">top</a>)</font></h3></font>
1.1 abs 44: </dt><dd>
45: Anyone with write access to the NetBSD CVS tree can checkout htdocs and
46: make changes, and in fact is encouraged to do so.
47:
48: </dd></dl></p>
49: <p><dl><dt>
1.2 ! abs 50: <font face="helvetica, arial, sans-serif"><h3><a name="dotlist-files">What are .list files, and how to use them</a>
! 51: <font size="-1">(<a href="#top">top</a>)</font></h3></font>
1.1 abs 52: </dt><dd>
53: .list files contain HTML with additional special tags to simplify formatting.
54: There should be a Makefile in each directory which handles processing
55: the .list files into .html, and will recurse into any subdirs
56: containing Makefiles. Continuation lines are understood (useful for the
57: special tags).
58:
59: <p>
60: <table>
61: <tr><th colspan=2>Compulsary tags</th></tr>
62: <tr><th valign=top align=right><LIST>:</th>
63: <td>Include generated list of entries here.</td></tr><tr><th valign=top align=right><SECTION>Text:</th>
64: <td>Introduces new section, before DATE or ENTRY</td></tr><tr><th valign=top align=right><ENDLIST>:</th>
65: <td>Optional tag for end of all special entries</td></tr>
66: <tr><th colspan=2>Optional tags</th></tr>
67: <tr><th valign=top align=right><DATE>tag date Text:</th>
68: <td>Change entry, expanded to title & added to list</td></tr><tr><th valign=top align=right><ENTRY>tag Text:</th>
69: <td>Text expanded to entry title and added to list</td></tr><tr><th valign=top align=right><ENTRYLINK>url Text:</th>
70: <td>Link added to list, removed from main text</td></tr><tr><th valign=top align=right><HEADING>Text:</th>
71: <td>Standard heading at top of document</td></tr><tr><th valign=top align=right><BASELINKS>:</th>
72: <td>Standard links at base of document</td></tr><tr><th valign=top align=right><TROW>Text:</th>
73: <td>Text: Table row, with two text fields</td></tr></table>
74: <p>
75: Additional pattern matches:<br>
76: <table>
77: <tr><th align=left>man pages</th>
78: <td>([a-zA-Z_][-\w.+]*[\w+])\((\d)\)</td><td>eg: <a href="http://www.flame.org/cgi-bin/uncgi/hman?page=ls&sect=1">ls(1)</a></td></tr>
79: <tr><th align=left>email addresses</th>
80: <td><([-\w.]+@[-\w.]+)></td><td>eg: <a href="mailto:abs@netbsd.org"><abs@netbsd.org></a></td></tr>
81: </table>
82:
83: </dd></dl></p>
84: <hr>
85:
86: <a href="index.html">Back to the <em>Main developers</em> page</a>
87:
88: <hr>
89: <table><tr>
90: <td>
91: <a href="../index.html">
92: <img src="../images/NetBSD-banner.gif" alt="NetBSD Home"></a>
93: </td><td>
94: <a href="../index.html">Home Page</a>
95: </td>
96: </tr></table>
97:
98: <hr>
99: <address>
100: <a href="../Misc/feedback.html">(Contact us)</a>
1.2 ! abs 101: $NetBSD: htdocs.list,v 1.1 1999/06/22 17:24:11 abs Exp $<br>
1.1 abs 102: <a href="../Misc/disclaimer.html">Copyright © 1996, 1997, 1998
103: The NetBSD Foundation, Inc. ALL RIGHTS RESERVED.</a>
104: </address>
105:
106: </body>
107: </html>
CVSweb <webmaster@jp.NetBSD.org>