Annotation of htdocs/developers/htdocs.html, revision 1.151
1.82 jschauma 1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
1.122 kano 2: <html>
1.1 abs 3: <head>
1.82 jschauma 4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
1.115 heinz 5: <meta name="generator" content="Website XSL Stylesheet V2.6.0">
1.102 jschauma 6: <link rel="home" href="../." title="Welcome to The NetBSD Project: Of course it runs NetBSD.">
7: <link rel="up" href="../developers/." title="NetBSD Developer Documentation">
8: <link rel="previous" href="../developers/de-lint.html" title="How to de-lint files">
1.141 kano 9: <link rel="next" href="../developers/PR.html" title="Resolving Problem Reports">
1.115 heinz 10: <link rel="first" href="../developers/announce.html" title="NetBSD Developer Documentation: News story guidelines">
11: <link rel="last" href="../developers/www.html" title="NetBSD Developer Documentation: Information about the www
12: mailing list">
1.144 dsieger 13: <link rel="stylesheet" href="../global.css" type="text/css">
1.1 abs 14: <title>Editing htdocs</title>
15: </head>
1.115 heinz 16: <body class="website"><div class="webpage">
1.133 dsieger 17: <a name="developers-htdocs"></a><div id="top"><a href="#mainContent" class="doNotDisplay doNotPrint">Skip to main content.</a></div>
18: <div id="header">
19: <div class="topNavigation">
1.136 dsieger 20: <span>» </span><a href="../docs/guide/en/">
21: The Guide</a> |
1.133 dsieger 22: <a href="http://man.NetBSD.org/">Manual pages</a> |
1.138 kano 23: <a href="../mailinglists/">
1.136 dsieger 24: Mailing lists</a> and
1.133 dsieger 25: <a href="http://mail-index.NetBSD.org/">Archives</a> |
26: <a href="http://cvsweb.NetBSD.org/">CVS repository</a> |
1.136 dsieger 27: <a href="http://www.NetBSD.org/cgi-bin/sendpr.cgi?gndb=netbsd">Report</a>
28: or
1.142 kano 29: <a href="../support/query-pr.html">
30: query</a> a bug |
1.136 dsieger 31: <a href="../docs/software/packages.html">
32: Software Packages
33: </a>
1.133 dsieger 34: </div>
35: <div class="centralHeader">
1.136 dsieger 36: <a href="../"><img alt="[NetBSD Logo]" width="506" height="90" src="../images/NetBSD-headerlogo.png"></a><div class="headerTools"><div id="headerSearch"><form method="get" action="http://www.google.com/custom">
1.134 dsieger 37: <input class="whiteOnBlack" type="text" name="q" onfocus="if(this.value==this.defaultValue ) this.value='';" size="12" maxlength="255" value="Search"><input type="hidden" name="cof" value="L:http://www.NetBSD.org/images/NetBSD-smaller.png;LH:200;LW:200;AH:center;AWFID:4f6b0499f0f58d2c;"><input type="hidden" name="domains" value="NetBSD.org"><input type="hidden" name="sitesearch" value="www.NetBSD.org"><input type="submit" value="Search">
1.133 dsieger 38: </form></div></div>
39: </div>
40: <div class="navBar">
1.136 dsieger 41: <span class="doNotDisplay">
42: Navigation:
43: </span><a href="../">
44: Home</a> |
45: <a href="../about/">
46: About</a> |
1.146 hubertf 47: <a href="../gallery/">
48: Gallery</a> |
1.136 dsieger 49: <a href="../releases/">
50: Download</a> |
51: <a href="../docs/">
52: Documentation</a> |
53: <a href="../support/">
54: Support</a> |
55: <a href="../community/">
56: Community</a> |
57: <a href="../ports/">
58: Ports</a>
1.133 dsieger 59: </div>
60: </div>
61: <div id="content"><div class="fullWidth"><div class="rowOfBoxes">
62: <h1>Editing htdocs</h1>
1.108 wiz 63: <h3 class="title"><a name="general">General notes on htdocs</a></h3>
1.94 jschauma 64: <ul>
65: <li><a href="#who-can-edit">Who can edit htdocs</a></li>
66: <li><a href="#what-is-required">What is required to edit htdocs</a></li>
67: <li><a href="#validate-html">Validate your HTML</a></li>
68: <li><a href="#NetBSD-org">NetBSD.org naming scheme</a></li>
69: <li><a href="#dotlist-files">What are .list files?</a></li>
70: <li><a href="#convert-to-xml">Converting to XML</a></li>
71: <li><a href="#dotxml-files">Processing .xml (docbook-website) files</a></li>
72: <li><a href="#moving-files">Renaming or moving files</a></li>
73: <li><a href="#flaglinks">What is the reasoning behind the flag links with empty.gif?</a></li>
1.125 jschauma 74: <li><a href="#templates">XML template files</a></li>
1.94 jschauma 75: <li><a href="#webserver">How do the pages get to the web server, and when?</a></li>
76: </ul>
1.121 rillig 77: <h3 class="title"><a name="structure">How is the whole web site structured?</a></h3>
78: <ul>
79: <li><a href="#structure-overview">Overview</a></li>
80: <li><a href="#structure-directories">What are the individual directories for?</a></li>
81: <li><a href="#structure-files">What are the individual files for?</a></li>
82: </ul>
1.108 wiz 83: <h3 class="title"><a name="specific">Adding to specific areas</a></h3>
1.94 jschauma 84: <ul>
1.118 daniel 85: <li><a href="#adding-gallery-entries">Adding to the Sites running NetBSD gallery</a></li>
86: <li><a href="#adding-gallery-screenshots">Adding to the NetBSD in action gallery</a></li>
1.94 jschauma 87: <li><a href="#adding-news-items">Adding News Items</a></li>
88: <li><a href="#adding-events">Adding Events</a></li>
89: <li><a href="#adding-mailinglists">Adding to/editing the MailingLists page </a></li>
90: <li><a href="#consultants">Consultants for hire</a></li>
91: </ul>
92: <hr>
93: <h3 class="title">General notes on htdocs</h3>
94: <h4 class="title">
95: <a name="who-can-edit"></a>Who can edit htdocs (<a href="#general">top</a>)
96: </h4>
1.82 jschauma 97: <p>
1.16 abs 98: Anyone with write access to the NetBSD CVS tree can checkout
99: htdocs and make changes, and in fact is encouraged to do so.
100: In particular as developers add features and drivers they should
101: update the appropriate hardware or port homepage. Use your
1.70 keihan 102: NetBSD.org login against cvs.NetBSD.org and checkout 'htdocs'.
1.82 jschauma 103: </p>
104: <p>
1.79 hubertf 105: Users without CVS commit access are encouraged to check out htdocs
106: via anoncvs, and mail patches to www@NetBSD.org, see
1.144 dsieger 107: <a class="ulink" href="#dotlist-files" target="_top">below</a>.
1.82 jschauma 108: </p>
109:
1.94 jschauma 110: <h4 class="title">
111: <a name="what-is-required"></a>What is required to edit htdocs (<a href="#general">top</a>)
112: </h4>
1.82 jschauma 113: <p>
1.99 jschauma 114: </p>
1.82 jschauma 115: <div class="itemizedlist"><ul type="disc">
1.144 dsieger 116: <li>Read <a class="ulink" href="cvs-repos/cvs_intro.html" target="_top">the CVS
1.99 jschauma 117: introduction</a>.
118: </li>
1.127 jschauma 119: <li>Install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/netbsd-www/README.html" target="_top"><code class="filename">meta-pkgs/netbsd-www</code></a>,
1.116 rpaulo 120: which provides the tools
1.100 jschauma 121: required to build the web site. Please make sure that you have at
1.127 jschauma 122: least <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/docbook-xsl/README.html" target="_top"><code class="filename">textproc/docbook-xsl</code></a>
1.116 rpaulo 123: >= 1.68.1 and
1.127 jschauma 124: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/docbook-website/README.html" target="_top"><code class="filename">textproc/docbook-website</code></a>
1.117 mishka 125: >= 2.6.0nb1 (automatically
1.127 jschauma 126: required by <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/netbsd-www/README.html" target="_top"><code class="filename">meta-pkgs/netbsd-www</code></a>
1.117 mishka 127: 1.4, but earlier versions accepted earlier revisions of
1.120 jlam 128: required tools, which may not appropriate). Please note that
129: any special LOCALBASE or PKG_SYSCONFBASE settings in
130: <code class="filename">/etc/mk.conf</code> should <span class="emphasis"><em>not</em></span>
131: be protected by BSD_PKG_MK as their values are used by the htdocs
132: makefiles.
1.99 jschauma 133: </li>
1.145 tsutsui 134: <li>Also install
135: <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>
136: to regenerate <a class="ulink" href="../docs/guide/en/" target="_top">The NetBSD guide</a>
137: and some other pages which depend on the guide.
138: </li>
1.82 jschauma 139: <li>Set your CVSROOT as indicated and run
1.129 kano 140: <pre class="programlisting">cvs checkout htdocs</pre>
1.99 jschauma 141: </li>
142: <li>Edit your preferred file, type
143: <code class="code"><span class="bold"><strong>make</strong></span></code>
144: to rebuild the output files (if necessary).
145: </li>
146: <li>Check the results using
147: <code class="code"><span class="bold"><strong>cvs diff</strong></span></code>, and
148: <code class="code"><span class="bold"><strong>cvs commit</strong></span></code> if everything
149: is good.
150: </li>
1.82 jschauma 151: </ul></div>
152: <p>
153: </p>
154:
1.94 jschauma 155: <h4 class="title">
156: <a name="validate-html"></a>Validate your HTML (<a href="#general">top</a>)
157: </h4>
1.82 jschauma 158: <p>
1.25 abs 159: After making any changes you should run your html through an HTML
1.127 jschauma 160: verifier such as <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/weblint/README.html" target="_top"><code class="filename">www/weblint</code></a>,
1.144 dsieger 161: or better still <a class="ulink" href="http://validator.w3.org/" target="_top">http://validator.w3.org/</a>.
1.25 abs 162: The URL for a link to an index.html file should not include the
163: trailing index.html.
164: If you use weblint you may want to add the following to your
1.91 wiz 165: <code class="code">~/.weblintrc</code>.
1.82 jschauma 166: </p>
167: <p>
168: </p>
1.129 kano 169: <pre class="programlisting">extension Netscape</pre>
1.82 jschauma 170: <p>
171: </p>
1.1 abs 172:
1.94 jschauma 173: <h4 class="title">
174: <a name="NetBSD-org"></a>NetBSD.org naming scheme (<a href="#general">top</a>)
175: </h4>
1.82 jschauma 176: <p>
177: Make sure you use NetBSD.org and not any other scheme (Netbsd.org,
178: netbsd.org, ...) in links, mailto's or other pointers.
179: </p>
180:
1.94 jschauma 181: <h4 class="title">
182: <a name="dotlist-files"></a>What are .list files? (<a href="#general">top</a>)
183: </h4>
1.82 jschauma 184: <p>
1.91 wiz 185: <span class="bold"><strong>The <code class="code">.list</code> files are
1.124 mishka 186: obsolete!</strong></span><br>
1.106 jschauma 187: You should convert any existing <code class="code">.list</code> files to XML.
1.144 dsieger 188: Please see <a class="ulink" href="#convert-to-xml" target="_top">this section</a> for details.
1.82 jschauma 189: </p>
1.41 dent 190:
1.94 jschauma 191: <h4 class="title">
192: <a name="convert-to-xml"></a>Converting to XML (<a href="#general">top</a>)
193: </h4>
1.82 jschauma 194: <p>
195: In order to facilitate global changes, we are currently converting the
196: NetBSD website to XML (docbook-website). As of 2004-11-15, any non-XML
197: file that needs to be edited shall be converted to XML at the same time.
1.130 daniel 198: You may find the script <code class="code">htdocs/scripts/list2xml</code> helpful to
1.91 wiz 199: initiate the conversion of the old <code class="code">.list</code> as well as plain
200: <code class="code">.html</code> files. Please note, however, that this script only
1.90 jschauma 201: does a few simple replacements of tags, and you will need to do a lot by
202: hand after running it. In particular, you need to make sure that all
203: tags are closed in the proper order.
204: </p>
205: <p>
1.91 wiz 206: When creating or converting <code class="code">.xml</code> files, please make sure to
207: add a “<span class="quote">id</span>” attribute to each <code class="code"><sect[1-4]></code>
1.93 jschauma 208: as well as each <code class="code"><table></code> tag: this will prevent
1.144 dsieger 209: <span class="command"><strong>xsltproc</strong></span> to generate an ID
1.91 wiz 210: itself, which would require an update of the resulting <code class="code">.html</code>
1.116 rpaulo 211: file after each regeneration. Also remember to replace each
212: “<span class="quote">&</span>” with “<span class="quote">&amp;</span>” and
213: <code class="filename">/sys</code> with <code class="filename">/usr/src/sys</code>
214: where applicable.
1.90 jschauma 215: </p>
216: <p>
217: If you are unsure how to convert a given HTML tag to the XML equivalent,
218: you may find some useful examples installed as part of the
1.127 jschauma 219: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/docbook-website/README.html" target="_top"><code class="filename">textproc/docbook-website</code></a> on your system.
1.116 rpaulo 220: And of course you can
1.90 jschauma 221: feel free to ask on the www@ list for help.
1.82 jschauma 222: </p>
223: <p>
1.94 jschauma 224: If you want an autogenerated TOC, you will need to include the following
225: code:
1.93 jschauma 226: </p>
1.129 kano 227: <pre class="programlisting"><sect1 role="toc"></pre>
1.93 jschauma 228: <p>
1.94 jschauma 229: This will generate a TOC listing all <code class="code"><sect2></code>s with a
230: bulleted list of its <code class="code"><sect3></code>s.
1.93 jschauma 231: </p>
232: <p>
1.82 jschauma 233: After converting a file to XML, remember to add it to the
1.91 wiz 234: <code class="code">htdocs/layout.xml</code> file and regenerate the website. See
1.144 dsieger 235: <a class="ulink" href="#dotxml-files" target="_top">below</a> for details.
1.82 jschauma 236: </p>
1.37 dent 237:
1.106 jschauma 238:
1.94 jschauma 239: <h4 class="title">
240: <a name="dotxml-files"></a>Processing .xml (docbook-website) files (<a href="#general">top</a>)
241: </h4>
1.82 jschauma 242: <p>
1.76 grant 243: In order to build .html files from .xml files, you will need at
1.127 jschauma 244: least <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/libxslt/README.html" target="_top"><code class="filename">textproc/libxslt</code></a> and
245: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/docbook-website/README.html" target="_top"><code class="filename">textproc/docbook-website</code></a>
246: installed. These are installed as part of <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/netbsd-www/README.html" target="_top"><code class="filename">meta-pkgs/netbsd-www</code></a>.
247: Please make sure that you have <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/netbsd-www/README.html" target="_top"><code class="filename">meta-pkgs/netbsd-www</code></a> version
1.117 mishka 248: 1.4.
1.82 jschauma 249: </p>
250: <p>
1.107 jschauma 251: To regenerate, just run
1.114 darcy 252: <code class="code"><span class="bold"><strong>make</strong></span></code> in the target directory.
253: You must do this after committing the .xml file so that the .html file
254: will include the proper "Generated from" statement.
1.99 jschauma 255: </p>
256: <p>
1.107 jschauma 257: If you added a new file to <code class="filename">layout.xml</code>,
1.144 dsieger 258: then you do need to run <span class="command"><strong>make</strong></span> in the htdocs top level.
1.82 jschauma 259: </p>
1.66 jschauma 260:
1.94 jschauma 261: <h4 class="title">
262: <a name="moving-files"></a>Renaming or moving files (<a href="#general">top</a>)
263: </h4>
1.82 jschauma 264: <p>
1.66 jschauma 265: In order to move or rename files within htdocs, the following procedure is
266: recommended:
267:
1.82 jschauma 268: </p>
269: <div class="itemizedlist"><ul type="disc">
270: <li>copy the file from the original location to new location</li>
1.151 ! dsieger 271: <li>cvs add the new file and cvs rm the old file</li>
1.105 jschauma 272: <li>add a note to <code class="filename">htdocs/errors/index.xml</code>, linking
1.99 jschauma 273: to the new location
274: </li>
1.151 ! dsieger 275: <li>cvs commit the new file and the old file at the same
1.99 jschauma 276: time, so we have some cvs reference of when and why
277: things moved.
278: </li>
1.82 jschauma 279: </ul></div>
280: <p>
281: </p>
1.66 jschauma 282:
1.94 jschauma 283: <h4 class="title">
284: <a name="flaglinks"></a>What is the reasoning behind the flag links with empty.gif? (<a href="#general">top</a>)
285: </h4>
1.82 jschauma 286: <p>
1.21 abs 287: Each NetBSD 'flag' links at the base of each page has:
1.82 jschauma 288: </p>
289: <div class="itemizedlist"><ul type="disc">
290: <li>href containing netbsd-banner with no alt tag</li>
291: <li>href containing empty gif with "NetBSD" alt tag and the
292: words "Home Page"</li>
293: </ul></div>
294: <p>
1.21 abs 295: This has the effect of:
1.82 jschauma 296: </p>
297: <div class="itemizedlist"><ul type="disc">
298: <li>Making the "NetBSD Home Page" link a single link in lynx,
299: i.e. not a NetBSD link and a Home Page link.</li>
300: <li>In netscape, causing the additional text to be centered and
1.21 abs 301: aligned "better" w.r.t the graphic. Without it, at least
302: in netscape, they show up at the bottom not centered
1.65 jschauma 303: vertically, and abut the graphic (or, if you include spaces,
1.82 jschauma 304: include nasty underlined blanks which looks broken).</li>
305: </ul></div>
306: <p>
1.21 abs 307: It's a grotty hack, but it makes things look right.
1.82 jschauma 308: </p>
309:
1.125 jschauma 310: <h4 class="title">
311: <a name="templates"></a>XML template files (<a href="#general">top</a>)
312: </h4>
313:
314: <p>
315: There are a few template files in <code class="filename">htutils/templates</code>
316: to get you started with XML. Please compare to existing pages in use
317: when you add new content.
318: </p>
319:
1.94 jschauma 320: <h4 class="title">
321: <a name="webserver"></a>How do the pages get to the web server, and when? (<a href="#general">top</a>)
322: </h4>
1.82 jschauma 323: <p>
1.47 hubertf 324: The NetBSD webpages are stored in CVS in the "htdocs" repository.
325: For security reasons, the htdocs repository is copied (via rsync)
1.113 jschauma 326: to www.NetBSD.org each hour, and then a local checkout is done from
327: that copy of the repository. The script performing this
1.106 jschauma 328: functionality is <code class="filename">htutils/scripts/update.http</code> and it
329: is run about 40 minutes after the full hour (*:40). If you
1.47 hubertf 330: make a commit to htdocs, it will take up to an hour before the
331: changes show up.
1.82 jschauma 332: </p>
333: <p>
1.47 hubertf 334: Note that there are several files like the Gnats database
1.144 dsieger 335: (<a class="ulink" href="http://www.NetBSD.org/Gnats/" target="_top">http://www.NetBSD.org/Gnats/</a>), the pkgsrc and source changes
1.139 kano 336: in changes/changes*.html and changes/pkg-changes*.html, the RSS
337: files in changes/rss-*.xml etc. that are not part of htdocs but
1.47 hubertf 338: that get generated by various scripts out of cron jobs directly on
339: the web server. Check out "htutils/changes/*" to get access to the
340: scripts.
1.82 jschauma 341: </p>
1.94 jschauma 342: <hr>
1.121 rillig 343: <h3 class="title">How is the whole web site structured?</h3>
344: <h4 class="title">
345: <a name="structure-overview"></a>Overview (<a href="#structure">top</a>)
346: </h4>
347:
348: <p></p>
349:
350:
351: <h4 class="title">
352: <a name="structure-directories"></a>What are the individual directories for? (<a href="#structure">top</a>)
353: </h4>
354:
355: <div class="variablelist"><dl>
1.122 kano 356: <dt><span class="term"><code class="filename">share/mk</code></span></dt>
1.121 rillig 357: <dd><p>Contains the <a href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current">make(1)</a> infrastructure to
358: automatize the generation of the web pages from the source
359: files.</p></dd>
1.122 kano 360: <dt><span class="term"><code class="filename">share/xml</code></span></dt>
1.121 rillig 361: <dd><p>[TODO]</p></dd>
1.122 kano 362: <dt><span class="term"><code class="filename">share/xsl</code></span></dt>
1.121 rillig 363: <dd><p>[TODO]</p></dd>
1.122 kano 364: <dt><span class="term"><code class="filename"></code></span></dt>
1.121 rillig 365: <dd><p></p></dd>
1.122 kano 366: <dt><span class="term"><code class="filename"></code></span></dt>
1.121 rillig 367: <dd><p></p></dd>
1.122 kano 368: <dt><span class="term"><code class="filename"></code></span></dt>
1.121 rillig 369: <dd><p></p></dd>
1.122 kano 370: <dt><span class="term"><code class="filename"></code></span></dt>
1.121 rillig 371: <dd><p></p></dd>
1.122 kano 372: <dt><span class="term"><code class="filename"></code></span></dt>
1.121 rillig 373: <dd><p></p></dd>
1.122 kano 374: <dt><span class="term"><code class="filename"></code></span></dt>
1.121 rillig 375: <dd><p></p></dd>
1.122 kano 376: <dt><span class="term"><code class="filename"></code></span></dt>
1.121 rillig 377: <dd><p></p></dd>
378: </dl></div>
379:
380:
381: <h4 class="title">
382: <a name="structure-files"></a>What are the individual files for? (<a href="#structure">top</a>)
383: </h4>
384:
385: <div class="variablelist"><dl>
1.122 kano 386: <dt><span class="term"><code class="filename">Makefile</code></span></dt>
1.121 rillig 387: <dd><p>Contains a description of the directory's
388: contents. Usually it suffers to define the variables
389: <code class="varname">SUBDIR</code> and <code class="varname">XMLDOCS</code>, and
1.144 dsieger 390: then <span class="command"><strong>.include</strong></span> the file
1.121 rillig 391: <code class="filename">htdocs/share/mk/web.site.mk</code> using the
1.128 rillig 392: appropriate relative path. The files in the
393: <code class="filename">share/mk</code> contain large comments at the top
394: that describe what you can do in the
395: <code class="filename">Makefile</code>.</p></dd>
1.122 kano 396: <dt><span class="term"><code class="filename">*.xml</code></span></dt>
1.129 kano 397: <dd><p>XML files contain the source code for a single
398: HTML page, in the “<span class="quote">DocBook Website</span>”
1.121 rillig 399: format.</p></dd>
1.122 kano 400: <dt><span class="term"><code class="filename">layout.xml</code></span></dt>
1.121 rillig 401: <dd><p>[TODO]</p></dd>
1.122 kano 402: <dt><span class="term"><code class="filename">autolayout.xml</code></span></dt>
1.121 rillig 403: <dd><p>[TODO]</p></dd>
404: </dl></div>
405:
406: <hr>
1.94 jschauma 407: <h3 class="title">Adding to specific areas</h3>
408: <h4 class="title">
1.118 daniel 409: <a name="adding-gallery-entries"></a>Adding to the “<span class="quote">Sites running NetBSD</span>” gallery (<a href="#specific">top</a>)
1.94 jschauma 410: </h4>
1.82 jschauma 411: <p>
1.144 dsieger 412: If you have a <code class="code">NETBSD GALLERY ADDITION</code> email from the <a class="ulink" href="../gallery/addsite.html" target="_top">htdocs/gallery/addsite.html</a> page:
1.82 jschauma 413: </p>
414: <div class="orderedlist"><ol type="1">
1.99 jschauma 415: <li>Verify that the remote site has a link back to www.NetBSD.org.
416: If they do not link back, contact them to ask for a link back and add
417: the information once the link is provided.</li>
1.82 jschauma 418: <li>Ensure you have perl installed</li>
419: <li>Save the message in your copy/paste buffer </li>
1.91 wiz 420: <li><code class="code">cd htdocs/gallery</code></li>
1.82 jschauma 421: <li>
1.99 jschauma 422: <code class="code">./addsite.pl</code>, paste the buffer, add a ^D, and answer
423: '<code class="code">y</code>' if it parsed OK.</li>
1.91 wiz 424: <li><code class="code">cvs commit</code></li>
1.82 jschauma 425: </ol></div>
426: <p>
1.91 wiz 427: Alternatively you can manually edit <code class="code">htdocs/gallery/sites.data</code>, and
428: run <code class="code">make</code>.
1.82 jschauma 429: </p>
430:
1.94 jschauma 431: <h4 class="title">
1.118 daniel 432: <a name="adding-gallery-screenshots"></a>Adding to the “<span class="quote">NetBSD in action</span>” gallery (<a href="#specific">top</a>)
433: </h4>
434: <p>
435: If possible, a screenshot should contain some easily recognizable visual
1.120 jlam 436: indication that it was made on a NetBSD system. A common way to do this is
1.118 daniel 437: by showing an X terminal that displays the output of the
1.144 dsieger 438: <span class="command"><strong>uname -a</strong></span> command.
1.118 daniel 439: </p>
440:
441: <h4 class="title">
1.94 jschauma 442: <a name="adding-news-items"></a>Adding News Items (<a href="#specific">top</a>)
443: </h4>
1.82 jschauma 444: <p>
1.144 dsieger 445: Most news items go into <a class="ulink" href="../changes/" target="_top">htdocs/changes/index.xml</a> (see note on
446: <a class="ulink" href="#dotxml-files" target="_top">.xml files</a>). Changes affecting a
1.143 kano 447: specific port should also be linked to from their htdocs/ports/*/ news section.
1.82 jschauma 448: </p>
1.6 abs 449: <p>
450: Important code news items should also be noted in the text
1.93 jschauma 451: <a href="http://cvsweb.NetBSD.org/bsdweb.cgi/src/doc/CHANGES?rev=HEAD&content-type=text/x-cvsweb-markup">src/doc/CHANGES</a>
1.17 abs 452: file.
1.82 jschauma 453: </p>
1.69 jschauma 454: <p>Quick ``howto'' for the impatient (but please do read on for details):
1.82 jschauma 455: </p>
456: <div class="itemizedlist"><ul type="disc">
1.139 kano 457: <li>cd htdocs/changes</li>
1.69 jschauma 458: <li>make update</li>
1.89 jschauma 459: <li>${EDITOR} index.xml</li>
1.69 jschauma 460: <li>make</li>
461: <li>make MSG="I added important NEWS!" commit</li>
1.82 jschauma 462: </ul></div>
463: <p>
464: </p>
465:
466: <div class="sect4" lang="en">
1.91 wiz 467: <div class="titlepage"><div><div><h5 class="title">
468: <a name="before-anything"></a>Before you do anything with htdocs:</h5></div></div></div>
1.6 abs 469:
1.82 jschauma 470: <div class="orderedlist"><ol type="1">
1.127 jschauma 471: <li>Ensure you have <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/netbsd-www/README.html" target="_top"><code class="filename">meta-pkgs/netbsd-www</code></a> installed.
1.144 dsieger 472: Also, see <a class="ulink" href="#what-is-required" target="_top">above</a>.</li>
1.91 wiz 473: <li>Check out <code class="code">htdocs</code> from the CVS repository.</li>
1.99 jschauma 474: <li>If you already have a copy of htdocs in your tree, make sure you
475: update it regularly. In particular, when adding news items, make sure that
476: gallery/events.* is up to date as well, as the events are pulled in from
477: there! This is best done by running
1.129 kano 478: <pre class="programlisting">
1.90 jschauma 479: $ cd htdocs
1.129 kano 480: $ make update</pre>
1.99 jschauma 481: </li>
1.82 jschauma 482: </ol></div>
483: </div>
484:
485: <div class="sect4" lang="en">
1.91 wiz 486: <div class="titlepage"><div><div><h5 class="title">
487: <a name="change-entry"></a>To add a change entry:</h5></div></div></div>
1.6 abs 488:
1.82 jschauma 489: <div class="orderedlist"><ol type="1">
1.132 dsieger 490: <li>Edit htdocs/changes/index.xml</li>
1.94 jschauma 491: <li>In the right section, add the entry of the form
1.129 kano 492: <pre class="programlisting">
1.90 jschauma 493: <sect3 id="link-name>
1.94 jschauma 494: <title>XX Mon XXX - FREEFORM TITLE</title>
1.90 jschauma 495: <para>
1.123 kano 496: Entry text goes here. Manual pages can be referred to as “<span class="quote">&man.command.X;</span>”,
1.90 jschauma 497: email addresses as <email>full@address</email>.
498: <para>
1.129 kano 499: </sect3></pre>
1.90 jschauma 500: </li>
1.91 wiz 501: <li>Run '<code class="code">make</code>'</li>
1.82 jschauma 502: </ol></div>
503: </div>
504:
505: <div class="sect4" lang="en">
1.91 wiz 506: <div class="titlepage"><div><div><h5 class="title">
507: <a name="adding-links"></a>Adding links from the main pages:</h5></div></div></div>
1.82 jschauma 508:
509: <p>
1.139 kano 510: By running <code class="code">make</code> from within htdocs/changes, you will automatically
1.149 jschauma 511: update <a class="ulink" href="../" target="_top">htdocs/index.html</a>. No further action on your part
512: is required.
1.82 jschauma 513: </p>
1.53 jschauma 514: <p>
1.149 jschauma 515: Alternatively, you can run <code class="code">make index.html</code> from the htdocs toplevel
1.53 jschauma 516: directory.
1.82 jschauma 517: </p>
518: </div>
519:
520: <div class="sect4" lang="en">
1.91 wiz 521: <div class="titlepage"><div><div><h5 class="title">
522: <a name="link-specific"></a>If you want to add a link from a port specific page:</h5></div></div></div>
1.82 jschauma 523:
524: <div class="orderedlist"><ol type="1">
1.132 dsieger 525: <li>Edit htdocs/ports/<span class="emphasis"><em>arch</em></span>/index.html, and search
1.99 jschauma 526: for the '<!-- news -->' block.</li>
1.82 jschauma 527: <li>Add a new entry to the subsequent list in the form:
1.99 jschauma 528: <p>
529: </p>
1.129 kano 530: <pre class="programlisting"><dt><b><span class="emphasis"><em>date</em></span>:</b> <span class="emphasis"><em>title</em></span>
1.82 jschauma 531: <dd><span class="emphasis"><em>body of item</em></span>
1.129 kano 532: <p></pre>
1.6 abs 533: <p>
1.99 jschauma 534: </p>
1.6 abs 535: where
1.82 jschauma 536: <div class="itemizedlist"><ul type="disc">
537: <li>
538: <span class="emphasis"><em>date</em></span> - Normally as YEAR.MONTH.DATE</li>
539: <li>
540: <span class="emphasis"><em>title</em></span> - Freeform (short) text title</li>
541: <li>
1.99 jschauma 542: <span class="emphasis"><em>body of item</em></span> - Freeform text for the entry.
1.122 kano 543: Can span multiple lines and may use HTML tags and links.</li>
1.82 jschauma 544: </ul></div>
545: </li>
546: </ol></div>
547: </div>
548:
549: <div class="sect4" lang="en">
1.91 wiz 550: <div class="titlepage"><div><div><h5 class="title">
551: <a name="finally"></a>Finally:</h5></div></div></div>
1.82 jschauma 552:
553: <div class="orderedlist"><ol type="1">
1.144 dsieger 554: <li>You may want to <a class="ulink" href="#validate-html" target="_top">validate the
1.99 jschauma 555: HTML</a> in your modified files.</li>
1.106 jschauma 556: <li>Check in the files. The command 'make commit', when
1.99 jschauma 557: issued from the htdocs toplevel directory, will commit the main
1.149 jschauma 558: index-page with a default message of "NEWS; regen". If you would
559: like to add a more specific message, use 'MSG="Added News regarding FooBar" make
1.99 jschauma 560: commit'.</li>
561: <li>If the news is noteworthy it is a good idea to submit it to some
562: news sites, like
1.144 dsieger 563: <a class="ulink" href="http://daily.daemonnews.org/add_story.php3" target="_top">Daily Daemonnews</a>,
564: <a class="ulink" href="http://www.osnews.com/submit.php" target="_top">OSNews</a>,
565: <a class="ulink" href="http://slashdot.org/submit.pl" target="_top">Slashdot</a>,
566: <a class="ulink" href="http://www.newsforge.com/submit.pl" target="_top">Newsforge</a> and
567: <a class="ulink" href="http://www.bsdforums.org/submitnews.php" target="_top">BSDForums</a>.
1.99 jschauma 568: </li>
1.82 jschauma 569: </ol></div>
570: </div>
571:
1.57 jschauma 572:
1.94 jschauma 573: <h4 class="title">
574: <a name="adding-events"></a>Adding Events (<a href="#specific">top</a>)
575: </h4>
1.82 jschauma 576: <p>
1.57 jschauma 577: The main index page also contains links to "Upcoming Events". These links are
1.144 dsieger 578: updated much like the <a class="ulink" href="#adding-news-items" target="_top">News entries</a>:
1.82 jschauma 579: </p>
580: <p>
581: </p>
1.129 kano 582: <pre class="programlisting">
1.82 jschauma 583: cd .../htdocs/gallery
1.90 jschauma 584: $EDITOR events.xml
1.129 kano 585: make events.html</pre>
1.82 jschauma 586: <p>
587: </p>
1.58 jschauma 588:
1.82 jschauma 589: <p>
590: </p>
1.129 kano 591: <pre class="programlisting">
1.82 jschauma 592: cd .../htdocs
1.149 jschauma 593: make index.html
1.129 kano 594: MSG="Added Event Foo" make commit</pre>
1.82 jschauma 595: <p>
596: </p>
1.57 jschauma 597:
1.94 jschauma 598: <h4 class="title">
599: <a name="adding-mailinglists"></a>Adding to/editing the MailingLists page (<a href="#specific">top</a>)
600: </h4>
1.82 jschauma 601: <p>
1.33 david 602: If a mailing-list is missing from the
1.144 dsieger 603: <a class="ulink" href="../mailinglists/" target="_top">MailingLists</a> page:
1.82 jschauma 604: </p>
605: <div class="orderedlist"><ol type="1">
1.132 dsieger 606: <li>Edit the htdocs/mailinglists/index.xml and htdocs/mailinglists/list2group.xsl files</li>
1.140 kano 607: <li>Run the makefile in htdocs/mailinglists, it will generate the
1.99 jschauma 608: index.html</li>
1.82 jschauma 609: <li>Confirm the generated html is good.</li>
1.126 kano 610: <li>commit the index.xml and list2group.xsl files.</li>
611: <li>Regenerate the index.html file to include the proper "Generated from" statement.</li>
612: <li>commit the generated index.html file.</li>
1.82 jschauma 613: </ol></div>
614: <p>
615: </p>
616:
1.94 jschauma 617: <h4 class="title">
618: <a name="consultants"></a>Consultants for hire (<a href="#specific">top</a>)
619: </h4>
1.82 jschauma 620: <p>
1.144 dsieger 621: Before adding an entry to the ``Consultants for hire'' page (<a class="ulink" href="../gallery/consultants.html" target="_top">gallery/consultants.html</a>), please ask
1.62 jschauma 622: that the person in question provides a link back to our homepage and/or
623: mentions NetBSD on their website. Needless to say that you should make sure
624: that the URL given is active and accessible.
1.82 jschauma 625: </p>
1.62 jschauma 626:
1.133 dsieger 627: </div></div></div>
628: <div class="navfoot"></div>
1.147 mishka 629: <div id="footer"><div id="footerContent"><center>
1.133 dsieger 630: <span class="footfeed"><a href="http://www.NetBSD.org/cgi-bin/feedback.cgi">
631: Contact</a> |
1.142 kano 632: </span><span class="footcopy"><a href="../about/disclaimer.html">
1.133 dsieger 633: Disclaimer</a> |
634:
1.150 tonnerre 635: <span class="copyright">Copyright © 1994-2010 The NetBSD Foundation, Inc. </span>ALL RIGHTS RESERVED.<br>NetBSD<sup>®</sup> is a registered trademark of The NetBSD
1.133 dsieger 636: Foundation, Inc.</span>
1.147 mishka 637: </center></div></div>
1.82 jschauma 638: </div></body>
1.1 abs 639: </html>
CVSweb <webmaster@jp.NetBSD.org>