Annotation of htdocs/developers/htdocs.html, revision 1.78
1.37 dent 1: <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2:
1.1 abs 3: <html>
4: <head>
5:
6: <!-- DO NOT EDIT THIS FILE. EDIT 'htdocs.list' AND RUN 'make' -->
7:
1.63 jschauma 8: <!-- Copyright (c) 1994-2003
1.1 abs 9: The NetBSD Foundation, Inc. ALL RIGHTS RESERVED. -->
1.72 keihan 10: <link rev="made" href="mailto:www@NetBSD.org">
1.1 abs 11: <title>Editing htdocs</title>
12: </head>
13: <body bgcolor="#FFFFFF" text="#000000">
14:
1.34 dent 15: <table><tr><td>
1.54 jschauma 16: <a href="../Misc/disclaimer.html#bsd-daemon"><img
1.40 dent 17: align="middle" src="../images/BSD-daemon.jpg" border="0"
18: width=146 height=129 alt="BSD daemon"></a>
19: </td><td align=center>
20: <h1>NetBSD Developer Documentation:</h1>
21: <h1>Editing htdocs</h1>
1.34 dent 22: </td></tr></table>
23: <p>
24:
1.1 abs 25: This is intended to become a reference for those wishing to edit htdocs
26: (the CVS repository for the NetBSD web server).
27:
1.49 dent 28: <h2><a name="top">General notes on htdocs</a></h2>
29: <ul>
30: <li><font face="helvetica, arial, sans-serif">
31: <a href="#who-can-edit">Who can edit htdocs</a></font></li>
32: <li><font face="helvetica, arial, sans-serif">
33: <a href="#what-is-required">What is required to edit htdocs</a></font></li>
34: <li><font face="helvetica, arial, sans-serif">
35: <a href="#validate-html">Validate your HTML</a></font></li>
36: <li><font face="helvetica, arial, sans-serif">
1.73 mike 37: <a href="#netbsd-org">NetBSD.org naming scheme</a></font></li>
1.71 keihan 38: <li><font face="helvetica, arial, sans-serif">
1.49 dent 39: <a href="#dotlist-files">What are .list files, and how to use them</a></font></li>
40: <li><font face="helvetica, arial, sans-serif">
1.73 mike 41: <a href="#dotxml-files">Processing .xml (docbook-website) files</a></font></li>
42: <li><font face="helvetica, arial, sans-serif">
1.66 jschauma 43: <a href="#moving-files">Renaming or moving files</a></font></li>
44: <li><font face="helvetica, arial, sans-serif">
1.49 dent 45: <a href="#flaglinks">What is the reasoning behind the flag links with empty.gif?</a></font></li>
46: <li><font face="helvetica, arial, sans-serif">
47: <a href="#webserver">How do the pages get to the web server, and when?</a></font></li>
48: </ul>
49: <h2>Adding to specific areas</h2>
50: <ul>
51: <li><font face="helvetica, arial, sans-serif">
52: <a href="#adding-gallery-entries">Adding to the 'Sites running NetBSD' gallery</a></font></li>
53: <li><font face="helvetica, arial, sans-serif">
54: <a href="#adding-news-items">Adding news items</a></font></li>
55: <li><font face="helvetica, arial, sans-serif">
1.57 jschauma 56: <a href="#adding-events">Adding Events</a></font></li>
57: <li><font face="helvetica, arial, sans-serif">
1.49 dent 58: <a href="#adding-mailinglists">Adding to/editing the MailingLists page</a></font></li>
1.62 jschauma 59: <li><font face="helvetica, arial, sans-serif">
60: <a href="#consultants">Consultants for hire</a></font></li>
1.49 dent 61: </ul>
62:
1.1 abs 63:
1.29 dent 64: <h2>Related documentation</h2>
65:
66: <ul>
67: <li><a href="announce.html">News story guidelines</a>
1.52 jschauma 68: <li><a href="translate.html">Translating htdocs</a>
1.29 dent 69: </ul>
70:
1.1 abs 71: <hr>
1.8 abs 72: <h2>General notes on htdocs</h2><hr>
1.35 dent 73: <p><h3>
74: <font face="helvetica, arial, sans-serif"><a name="who-can-edit">Who can edit htdocs</a></font>
75: <font size="-1">(<a href="#top">top</a>)</font>
76: </h3><dl><dt><dd>
1.16 abs 77: Anyone with write access to the NetBSD CVS tree can checkout
78: htdocs and make changes, and in fact is encouraged to do so.
79: In particular as developers add features and drivers they should
80: update the appropriate hardware or port homepage. Use your
1.70 keihan 81: NetBSD.org login against cvs.NetBSD.org and checkout 'htdocs'.
1.8 abs 82:
1.35 dent 83: </dd></dl>
84: <p><h3>
85: <font face="helvetica, arial, sans-serif"><a name="what-is-required">What is required to edit htdocs</a></font>
86: <font size="-1">(<a href="#top">top</a>)</font>
87: </h3><dl><dt><dd>
1.25 abs 88: <ul>
89: <li>Read <a href="cvs-repos/cvs_intro.html">the CVS introduction</a>.
1.75 grant 90: <li>Install <a href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/meta-pkgs/netbsd-www/README.html">netbsd-www</a>, which provides the tools
91: required to build the web site.
92: <li>Set your CVSROOT as indicated and '<tt><b>cvs checkout htdocs</b></tt>.
93: <li>Edit your preferred file, type <tt><b>make</b></tt> to rebuild
94: the output files (if necessary).
95: <li>Check the results using <tt><b>cvs diff</b></tt>, and <tt><b>cvs
96: commit</b></tt> if everything is good.
1.25 abs 97: </ul>
1.23 abs 98:
1.35 dent 99: </dd></dl>
100: <p><h3>
101: <font face="helvetica, arial, sans-serif"><a name="validate-html">Validate your HTML</a></font>
102: <font size="-1">(<a href="#top">top</a>)</font>
103: </h3><dl><dt><dd>
1.25 abs 104: After making any changes you should run your html through an HTML
1.70 keihan 105: verifier such as <a href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/www/weblint/README.html">weblint</a>, or better still <a
1.25 abs 106: href="http://validator.w3.org/">http://validator.w3.org/</a>.
107: The URL for a link to an index.html file should not include the
108: trailing index.html.
109: If you use weblint you may want to add the following to your
110: <tt>~/.weblintrc</tt>.
111: <pre> extension Netscape</pre>
1.1 abs 112:
1.35 dent 113: </dd></dl>
114: <p><h3>
1.73 mike 115: <font face="helvetica, arial, sans-serif"><a name="netbsd-org">NetBSD.org naming scheme</a></font>
1.71 keihan 116: <font size="-1">(<a href="#top">top</a>)</font>
117: </h3><dl><dt><dd>
118: Make sure you use NetBSD.org and not any other scheme in links, mailto's
119: or other pointers.
120:
121: </dd></dl>
122: <p><h3>
1.35 dent 123: <font face="helvetica, arial, sans-serif"><a name="dotlist-files">What are .list files, and how to use them</a></font>
124: <font size="-1">(<a href="#top">top</a>)</font>
125: </h3><dl><dt><dd>
1.25 abs 126: A <tt>.list</tt> file contains standard HTML with additional special
127: tags to simplify formatting. It is processed by <tt><a
128: href="../list2html.pl">list2html.pl</a></tt> into the desired .html
129: file.
130: <p>
131: There should be a Makefile in each directory which handles processing
132: the .list files into .html, and will recurse into any subdirs
133: containing Makefiles.
134: <p>
135: Continuation lines are understood (useful for the special tags).
136: <p>
1.51 abs 137: If you do not have CVS access and wish to submit changes, you
138: can check out htdocs via anonymous CVS (see the <a
139: href="cvs-repos/cvs_intro.html">NetBSD CVS HOWTO</a>). The best
140: approach is usually to:
1.25 abs 141: <ol>
1.51 abs 142: <li>Checkout the <em>htdocs</em> module<br>
143: <tt>'<b>cvs checkout htdocs</b>'</tt>
144: <li>Edit the desired file. Most FAQ-style documents are
145: generated from <tt>.list</tt> files, so it is best to check
146: before editing.
147: <li>Run 'make' if you have edited .list or similar files.
1.25 abs 148: <li><a href="#validate-html">Validate</a> the HTML. (Repeat
149: these three steps as necessary).
1.75 grant 150: <li>Submit a diff to <<a href="mailto:www@NetBSD.org">www@NetBSD.org</a>>
151: using <b>cvs diff</b>, eg.<br>
1.51 abs 152: <tt>'<b>cvs diff -u <em>htdocs/path/to/file.list</em></b>'</tt>
1.25 abs 153: </ol>
154: <p>
1.51 abs 155: You should run <b>make</b> before committing. You will need
1.70 keihan 156: <a href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/lang/perl5/README.html">perl5</a> installed.
1.9 abs 157:
1.1 abs 158: <p>
1.37 dent 159:
160: <center>
161:
162: <table border=0 cellpadding=1 cellspacing=0><tr><td bgcolor="#d8d8d8">
163:
164: <table border=0 cellpadding=4 cellspacing=0 width="550"><tr>
165:
166: <td colspan=2 align=right bgcolor="#f5f5f5"><big><b>Compulsory
167: tags </b></big></td>
168: </tr><tr bgcolor="#ffffff">
169:
170: <td align=right valign=top><b><LIST>:</b></td>
171: <td>Include generated list of entries here.</td>
172: </tr><tr bgcolor="#ffffff">
173:
174: <td align=right valign=top><b><SECTION>Text:</b></td>
175: <td>Introduces new section, before DATE or ENTRY</td>
176: </tr><tr bgcolor="#ffffff">
177:
178: <td align=right valign=top><b></LIST>:</b></td>
179: <td>Tag for end of all special entries<br> <br></td>
180: </tr><tr>
181:
182: <td colspan=2 align=right bgcolor="#f5f5f5"><big><b>Optional
183: tags </b></big></td>
184: </tr><tr bgcolor="#ffffff">
185:
186: <td align=right valign=top><b><DATE>tag date Text:</b></td>
1.77 jrf 187: <td>Changes entry, expanded to title & added to list</td>
1.37 dent 188: </tr><tr bgcolor="#ffffff">
189:
190: <td align=right valign=top><b><ENTRY>tag Text:</b></td>
191: <td>Text expanded to entry title and added to list</td>
192: </tr><tr bgcolor="#ffffff">
193:
194: <td align=right valign=top><b><LISTLINK>url Text:</b></td>
195: <td>Link added to TOC, removed from main text</td>
196: </tr><tr bgcolor="#ffffff">
197:
198: <td align=right valign=top><b><ENTRYLINK>url Text:</b></td>
199: <td>Link added to list and main text</td>
200: </tr><tr bgcolor="#ffffff">
201:
202: <td align=right valign=top><b><HEADING>Text:</b></td>
203: <td>Standard heading at top of document</td>
204: </tr><tr bgcolor="#ffffff">
205:
206: <td align=right valign=top><b><DEVHEADING>Text:</b></td>
207: <td>Standard heading at top of developer docs</td>
208: </tr><tr bgcolor="#ffffff">
209:
210: <td align=right valign=top><b><TROW>Text: Text:</b></td>
211: <td>Table row, with two text fields - <b>Note: <TROW> will
212: automatically continue until a line containing </table></b></td>
213: </tr><tr bgcolor="#ffffff">
214:
215: <td align=right valign=top><b><HOMELINK>:</b></td>
216: <td>Standard flag link to home page at base of document</td>
217: </tr><tr bgcolor="#ffffff">
218:
219: <td align=right valign=top><b><DOCLINK>:</b></td>
220: <td>Standard flag links to home page and Documentation top level at base
221: of document</td>
222: </tr><tr bgcolor="#ffffff">
223:
224: <td align=right valign=top><b><DEVLINK>:</b></td>
225: <td>Standard flag links to home page and Developers Documentation at base
226: of document</td>
227: </tr><tr bgcolor="#ffffff">
228:
229: <td align=right valign=top><b><PORTLINK>:</b></td>
230: <td>Standard flag links to home page and Supported Architectures top level
231: at base of document</td>
232: </tr><tr bgcolor="#ffffff">
233:
234: <td align=right valign=top><b><GALLINK>:</b></td>
235: <td>Standard flag links to home page and Gallery page at base of document<br>
236: <br></td>
237: </tr><tr>
238:
239: <td colspan=2 align=right bgcolor="#f5f5f5"><big><b>Additional pattern
240: matches </b></big></td>
241: </tr><tr bgcolor="#ffffff">
242:
243: <td align=right valign=top><b>man pages:</b></td>
1.70 keihan 244: <td>([a-zA-Z_][-\w.+]*[\w+])\((\d)(|\.(\w+))(|\+(\W+))\)<br>eg: <a href="http://man.NetBSD.org/man/ls+1+NetBSD-current">ls(1)</a><p>
1.48 dent 245: <i>Note: Can also handle specific architectures and collections</i><br>
246: eg: (8.pmax), (8+1.4.3), (8.pmax+1.4.3)<p>
247: <i>Default collection is NetBSD-current. Available collections are:
1.50 dent 248: "1.3.3", "1.4.3", "1.5", "1.5.1", "current".</i></td>
1.37 dent 249: </tr><tr bgcolor="#ffffff">
250:
251: <td align=right valign=top><b>email addresses:</b></td>
1.70 keihan 252: <td><([-\w.]+@[-\w.]+)><br>eg: <a href="mailto:abs@NetBSD.org"><abs@NetBSD.org></a></td>
1.37 dent 253: </tr><tr bgcolor="#ffffff">
254:
255: <td align=right valign=top><b>pkgsrc references:</b></td>
256: <td><PKGSRC>((\w+/|)([^\s<>]+\w))<br>
1.70 keihan 257: eg: <a href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/editors/vilearn/README.html">vilearn</a></td>
1.37 dent 258: </tr><tr bgcolor="#ffffff">
259:
260: <td align=right valign=top><b>-current source:</b></td>
1.70 keihan 261: <td><CURRENTSRC>(path)<br>eg: <a href="http://cvsweb.NetBSD.org/bsdweb.cgi/src/Makefile?rev=HEAD&content-type=text/x-cvsweb-markup">Makefile</a><p>
1.37 dent 262: <em>Note: Works with files or directories</em></td>
263: </tr><tr bgcolor="#ffffff">
264:
265: <td align=right valign=top><b>literal URLs:</b></td>
1.70 keihan 266: <td><URL>(url)<br>eg: <a href="http://www.NetBSD.org/">http://www.NetBSD.org/</a></td>
1.41 dent 267: </tr><tr bgcolor="#ffffff">
268:
269: <td align=right valign=top><b>RFCs:</b></td>
270: <td><RFC>([^\s<>]+\w)<br>eg: <a href="http://www.normos.org/ietf/rfc/rfc2795.txt">RFC2795</a></td>
1.37 dent 271:
272: </tr></table>
273:
274: </td></tr></table>
275:
276: </center>
1.6 abs 277:
1.35 dent 278: </dd></dl>
279: <p><h3>
1.73 mike 280: <font face="helvetica, arial, sans-serif"><a name="dotxml-files">Processing .xml (docbook-website) files</a></font>
281: <font size="-1">(<a href="#top">top</a>)</font>
282: </h3><dl><dt><dd>
1.76 grant 283: In order to build .html files from .xml files, you will need at
284: least <a href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/textproc/libxslt/README.html">libxslt</a> and <a href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/textproc/docbook-website/README.html">docbook-website</a>
285: installed. These are installed as part of <a href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc/meta-pkgs/netbsd-www/README.html">netbsd-www</a>
286: <p/>
287: To regenerate, cd to htdocs/ and run<br/>
288: <tt>'<b>make ./autolayout.xml</b>'</tt>.<br/>
289: Then run <tt><b>make</b></tt> in the target directory.
1.73 mike 290:
291: </dd></dl>
292: <p><h3>
1.66 jschauma 293: <font face="helvetica, arial, sans-serif"><a name="moving-files">Renaming or moving files</a></font>
294: <font size="-1">(<a href="#top">top</a>)</font>
295: </h3><dl><dt><dd>
296:
297: In order to move or rename files within htdocs, the following procedure is
298: recommended:
299:
300: <ul>
301: <li>copy the file from the original location to new location</li>
302: <li>modify html of the original file:
303: <ul>
304: <li>include a
305: <code><META HTTP-EQUIV=Refresh CONTENT="5; URL=new-location"></code>
306: tag in the header</li>
307: <li>remove all content except the header and the footer</li>
308: <li>add a sentence saying that the page moved and hyperlink it to the new
309: location</li>
310: </ul>
311: <li>cvs add the new file</li>
312: <li>cvs commit the new file and the changes of the old file at the same
313: time, so we have some cvs reference of when and why things moved</li>
314: </ul>
315:
316: </dd></dl>
317: <p><h3>
1.35 dent 318: <font face="helvetica, arial, sans-serif"><a name="flaglinks">What is the reasoning behind the flag links with empty.gif?</a></font>
319: <font size="-1">(<a href="#top">top</a>)</font>
320: </h3><dl><dt><dd>
1.21 abs 321: Each NetBSD 'flag' links at the base of each page has:
322: <ul>
323: <li>href containing netbsd-banner with no alt tag
324: <li>href containing empty gif with "NetBSD" alt tag and the
325: words "Home Page"
326: </ul>
327: This has the effect of:
328: <ul>
329: <li>Making the "NetBSD Home Page" link a single link in lynx,
330: i.e. not a NetBSD link and a Home Page link.
331: <li>In netscape, causing the additional text to be centered and
332: aligned "better" w.r.t the graphic. Without it, at least
333: in netscape, they show up at the bottom not centered
1.65 jschauma 334: vertically, and abut the graphic (or, if you include spaces,
1.21 abs 335: include nasty underlined blanks which looks broken to me).
336: </ul>
337: It's a grotty hack, but it makes things look right.
338:
1.35 dent 339: </dd></dl>
1.47 hubertf 340: <p><h3>
341: <font face="helvetica, arial, sans-serif"><a name="webserver">How do the pages get to the web server, and when?</a></font>
342: <font size="-1">(<a href="#top">top</a>)</font>
343: </h3><dl><dt><dd>
344: The NetBSD webpages are stored in CVS in the "htdocs" repository.
345: For security reasons, the htdocs repository is copied (via rsync)
1.70 keihan 346: to www.NetBSD.org each hour, and the a local checkout is done from
1.47 hubertf 347: that copy of the repository. The checked out tree can be found in
348: "<tt>/NetBSD-www</tt>". The repository is updated and checked out
349: every hour, about 40 minutes after the full hour (*:40). If you
350: make a commit to htdocs, it will take up to an hour before the
351: changes show up.
352: <p>
353:
354: Note that there are several files like the Gnats database
1.70 keihan 355: (<a href="http://www.NetBSD.org/Gnats/),">http://www.NetBSD.org/Gnats/),</a> the pkgsrc and source changes
1.47 hubertf 356: in Changes/changes*.html and Changes/pkg-changes*.html, the RSS
357: files in Changes/rss-*.xml etc. that are not part of htdocs but
358: that get generated by various scripts out of cron jobs directly on
359: the web server. Check out "htutils/changes/*" to get access to the
360: scripts.
361: <p>
362:
363: </dd></dl>
1.8 abs 364: <hr>
365: <h2>Adding to specific areas</h2><hr>
1.35 dent 366: <p><h3>
367: <font face="helvetica, arial, sans-serif"><a name="adding-gallery-entries">Adding to the 'Sites running NetBSD' gallery</a></font>
368: <font size="-1">(<a href="#top">top</a>)</font>
369: </h3><dl><dt><dd>
1.8 abs 370: If you have a <tt>NETBSD GALLERY ADDITION</tt> email from the <a
371: href="../gallery/addsite.html">htdocs/gallery/addsite.html</a> page:
372: <ol>
373: <li>Ensure you have perl installed
1.27 david 374: <li>Save the message in your copy/paste buffer
1.8 abs 375: <li><tt>cd htdocs/gallery</tt>
1.28 dent 376: <li><tt>./addsite.pl</tt>, paste the buffer, add a ^D, and answer '<tt>y</tt>' if it parsed OK.
1.8 abs 377: <li><tt>cvs commit</tt>
378: </ol>
379: Alternatively you can manually edit <tt>htdocs/gallery/sites.data</tt>, and
380: run <tt>make</tt>.
381:
1.35 dent 382: </dd></dl>
383: <p><h3>
384: <font face="helvetica, arial, sans-serif"><a name="adding-news-items">Adding news items</a></font>
385: <font size="-1">(<a href="#top">top</a>)</font>
386: </h3><dl><dt><dd>
1.6 abs 387: Most news items go into <a
1.45 hubertf 388: href="../Changes/">htdocs/Changes/index.list</a> (see note on
1.53 jschauma 389: <a href="#dotlist-files">.list files</a>). Changes affecting a
390: specific port should also be linked to from their htdocs/Port/*/ news section.
1.6 abs 391: <p>
392: Important code news items should also be noted in the text
1.70 keihan 393: <a href="http://cvsweb.NetBSD.org/bsdweb.cgi/src/doc/CHANGES?rev=HEAD&content-type=text/x-cvsweb-markup">doc/CHANGES</a>
1.17 abs 394: file.
1.69 jschauma 395: <p>Quick ``howto'' for the impatient (but please do read on for details):
396: <ul>
397: <li>cd htdocs/Changes</li>
398: <li>make update</li>
399: <li>${EDITOR} index.list</li>
400: <li>make</li>
401: <li>make MSG="I added important NEWS!" commit</li>
402: </ul>
1.6 abs 403:
404: <p>
405: <h4>Before you do anything with htdocs:</h4>
406: <ol>
407: <li>Ensure you have perl installed for the <a href="#dotlist-files">.list
1.68 jschauma 408: files</a>.</li>
409: <li>Check out <tt>htdocs</tt> from the CVS repository.</li>
410: <li>If you already have a copy of htdocs in your tree, make sure you update it
411: regularly. In particular, when adding news items, make sure that
412: gallery/events.* is up to date as well, as the events are pulled in from
413: there!</li>
1.6 abs 414: </ol>
415:
416: <p>
417: <h4>To add a change entry:</h4>
418: <ol>
419: <li>Edit htdocs/Changes/index.list and search for the first line
420: starting <DATE>.
421: <li>Insert a new line of the form<br>
422: <tt><DATE><em>tag</em> <em>date</em> - <em>title</em></tt><br>
423: where
424: <ul>
425: <li><em>tag</em> - A lowercase/number/hyphen identifier. eg: 'new-xx-driver'
426: <li><em>date</em> - In the form DAY MONTH YEAR. eg: '23 Jan 1999'
427: <li><em>title</em> - Freeform text for the entry title - can use \ to
428: escape the end of line.
429: </ul>
1.70 keihan 430: <li>Add the body of the item. manual pages (eg: <a href="http://man.NetBSD.org/man/ls+1+NetBSD-current">ls(1)</a>), and email
1.6 abs 431: addresses (eg: <a href="mailto:user@domain"><user@domain></a>) will be automatically expanded. Feel
432: free to use HTML tags, though this is not compulsory.
433: <li>Run '<tt>make</tt>'
434: </ol>
435:
436: <p>
1.53 jschauma 437: <h4>Adding links from the main pages:</h4>
438: By running <tt>make</tt> from within htdocs/Changes, you will automatically
439: update <a href="../">htdocs/index.html</a> and the index pages of all supported
440: translations. No further action on your part is required.
441: <p>
442: Alternatively, you can run <tt>make index</tt> from the htdocs toplevel
443: directory.
1.6 abs 444: <p>
445: <h4>If you want to add a link from a port specific page:</h4>
446: <ol>
1.46 hubertf 447: <li>Edit htdocs/Ports/<em>arch</em>/index.html, and search for the
1.61 jschauma 448: '<!-- news -->' block.
1.16 abs 449: <li>Add a new entry to the subsequent list in the form:
1.43 dent 450: <pre><dt><b><em>date</em>:</b> <em>title</em>
451: <dd><em>body of item</em>
452: <p></pre>
1.6 abs 453: where
454: <ul>
1.43 dent 455: <li><em>date</em> - Normally as YEAR.MONTH.DATE
1.6 abs 456: <li><em>title</em> - Freeform (short) text title
1.43 dent 457: <li><em>body of item</em> - Freeform text for the entry. Can span mutltiple
1.6 abs 458: lines and may use HTML tags and links.
459: </ul>
460: </ol>
461:
462: <p>
463: <h4>Finally:</h4>
464: <ol>
465: <li>You may want to <a href="#validate-html">validate the HTML</a> in
466: your modified files.
1.58 jschauma 467: <li>Check in the files - do not forget any <tt>.list</tt> files will
468: update the matching <tt>.html</tt>. The command 'make commit', when
469: issued from the htdocs toplevel directory, will commit the main
470: index-page, Changes/index.* and all the translations index pages with
471: a default message of "NEWS; regen". If you would like to add a more
472: specific message, use 'MSG="Added News regarding FooBar" make
473: commit'.</li>
1.78 ! daniel 474: <li>If the news is noteworthy it is a good idea to submit it to some news
! 475: sites, like
! 476: <a href="http://daily.daemonnews.org/add_story.php3">Daily Daemonnews</a>,
! 477: <a href="http://www.osnews.com/submit.php">OSNews</a>,
! 478: <a href="http://slashdot.org/submit.pl">Slashdot</a>,
! 479: <a href="http://www.newsforge.com/submit.pl">Newsforge</a> and
! 480: <a href="http://www.bsdforums.org/submitnews.php">BSDForums</a>.</li>
1.6 abs 481: </ol>
1.1 abs 482:
1.35 dent 483: </dd></dl>
484: <p><h3>
1.57 jschauma 485: <font face="helvetica, arial, sans-serif"><a name="adding-events">Adding Events</a></font>
486: <font size="-1">(<a href="#top">top</a>)</font>
487: </h3><dl><dt><dd>
488:
489: The main index page also contains links to "Upcoming Events". These links are
490: updated much like the <a href="#adding-news-items">News entries</a>:
491:
492: <ul>
493: <li>cd .../htdocs/gallery</li>
494: <li>$EDITOR events.list</li>
495: <li>make events</li>
496: </ul>
1.58 jschauma 497:
498: Since the events are included on all the translations index pages, all these
499: pages need to be generated and committed as well. This can be achieved by
500: issuing the 'make index' command from the htdocs directory.
1.57 jschauma 501:
502: <ul>
503: <li>cd .../htdocs</li>
1.58 jschauma 504: <li>make index</li>
505: <li>MSG="Added Event Foo" make commit</li>
1.57 jschauma 506: </ul>
507:
508: </dd></dl>
509: <p><h3>
1.35 dent 510: <font face="helvetica, arial, sans-serif"><a name="adding-mailinglists">Adding to/editing the MailingLists page</a></font>
511: <font size="-1">(<a href="#top">top</a>)</font>
512: </h3><dl><dt><dd>
1.33 david 513: If a mailing-list is missing from the
1.38 dent 514: <a href="../MailingLists/">MailingLists</a> page:
1.33 david 515: <ol>
516: <li>Edit the htdocs/MailingLists/index.m4 file
517: <li>Run the makefile in htdocs/MailingLists, it will generate the index.html
518: <li>Confirm the generated html is good.
519: <li>commit the index.m4 and index.html files.
520: </ol>
521:
1.35 dent 522: </dd></dl>
1.62 jschauma 523: <p><h3>
524: <font face="helvetica, arial, sans-serif"><a name="consultants">Consultants for hire</a></font>
525: <font size="-1">(<a href="#top">top</a>)</font>
526: </h3><dl><dt><dd>
527:
528: Before adding an entry to the ``Consultants for hire'' page (<a
529: href="../gallery/consultants.html">gallery/consultants.html</a>), please ask
530: that the person in question provides a link back to our homepage and/or
531: mentions NetBSD on their website. Needless to say that you should make sure
532: that the URL given is active and accessible.
533:
534: </dd></dl>
1.1 abs 535: <hr>
536:
1.35 dent 537: <table width="100%"><tr><td>
538: <table><tr><td>
539: <a href="../"><img
1.36 dent 540: src="../images/NetBSD-flag.gif" border="0"
1.35 dent 541: width="91" height="42" alt=""></a>
1.28 dent 542: </td><td>
1.35 dent 543: <a href="../"><img
544: src="../images/empty.gif" border="0"
545: width="1" height="1" alt="NetBSD ">Home Page</a>
546: </td></tr></table>
1.28 dent 547: </td><td>
1.35 dent 548: <table><tr><td>
549: <a href="../developers/"><img
1.36 dent 550: src="../images/NetBSD-flag.gif" border="0"
1.35 dent 551: width="91" height="42" alt=""></a>
1.28 dent 552: </td><td>
1.35 dent 553: <a href="../developers/"><img
554: src="../images/empty.gif" border="0"
555: width="1" height="1" alt="NetBSD ">Developer Documentation</a>
556: </td></tr></table>
557: </td></tr></table>
1.28 dent 558:
1.1 abs 559: <hr>
560: <address>
1.34 dent 561: <small>
1.70 keihan 562: <a href="http://www.NetBSD.org/cgi-bin/feedback.cgi">(Contact us)</a>
1.78 ! daniel 563: $NetBSD: htdocs.html,v 1.77 2004/03/01 18:55:18 jrf Exp $<br>
1.63 jschauma 564: <a href="../Misc/disclaimer.html">Copyright © 1994-2003
1.40 dent 565: The NetBSD Foundation, Inc. ALL RIGHTS RESERVED.</a>
1.34 dent 566: </small>
1.1 abs 567: </address>
568:
569: </body>
570: </html>
CVSweb <webmaster@jp.NetBSD.org>