Annotation of htdocs/developers/htdocs.xml, revision 1.41

1.1       jschauma    1: <?xml version="1.0"?>
                      2: <!DOCTYPE webpage
1.23      hrs         3:   PUBLIC "-//NetBSD//DTD Website-based NetBSD Extension//EN"
                      4:     "http://www.NetBSD.org/XML/htdocs/lang/share/xml/website-netbsd.dtd">
1.1       jschauma    5: 
1.26      heinz       6: <webpage id="developers-htdocs">
1.1       jschauma    7: <config param="desc" value="Editing htdocs"/>
1.41    ! daniel      8: <config param="cvstag" value="$NetBSD: htdocs.xml,v 1.40 2006/11/07 23:22:43 kano Exp $"/>
        !             9: <config param="rcsdate" value="$Date: 2006/11/07 23:22:43 $"/>
1.1       jschauma   10: <head>
                     11: <title>Editing htdocs</title>
                     12: </head>
                     13: 
1.10      jschauma   14: <sect1 id="editing-htdocs" role="toc">
1.1       jschauma   15: 
                     16: <sect2 id="general">
                     17: <title>General notes on htdocs</title>
                     18: 
                     19: <sect3 id="who-can-edit">
                     20: <title>Who can edit htdocs</title>
                     21: <para>
                     22:     Anyone with write access to the NetBSD CVS tree can checkout
                     23:     htdocs and make changes, and in fact is encouraged to do so.
                     24:     In particular as developers add features and drivers they should
                     25:     update the appropriate hardware or port homepage. Use your
                     26:     NetBSD.org login against cvs.NetBSD.org and checkout 'htdocs'.
                     27: </para>
                     28: <para>
                     29:     Users without CVS commit access are encouraged to check out htdocs
                     30:     via anoncvs, and mail patches to www@NetBSD.org, see 
                     31:     <ulink url="#dotlist-files">below</ulink>.
                     32: </para>
                     33: </sect3>
                     34: 
                     35: <sect3 id="what-is-required">
                     36: <title>What is required to edit htdocs</title>
                     37: <para>
1.13      jschauma   38:   <itemizedlist>
                     39:     <listitem>Read <ulink url="cvs-repos/cvs_intro.html">the CVS
                     40:       introduction</ulink>.
                     41:     </listitem>
1.27      rpaulo     42:     <listitem>Install <filename role="pkg">meta-pkgs/netbsd-www</filename>, 
                     43:         which provides the tools
1.14      jschauma   44:        required to build the web site.  Please make sure that you have at
1.27      rpaulo     45:        least <filename role="pkg">textproc/docbook-xsl</filename> 
                     46:        &gt;= 1.68.1 and
                     47:        <filename role="pkg">textproc/docbook-website</filename> 
1.29      mishka     48:        &gt;= 2.6.0nb1 (automatically
                     49:        required by <filename role="pkg">meta-pkgs/netbsd-www</filename>
                     50:        1.4, but earlier versions accepted earlier revisions of
1.31      jlam       51:        required tools, which may not appropriate).  Please note that
                     52:        any special LOCALBASE or PKG_SYSCONFBASE settings in
                     53:        <filename>/etc/mk.conf</filename> should <emphasis>not</emphasis>
                     54:        be protected by BSD_PKG_MK as their values are used by the htdocs
                     55:        makefiles.
1.13      jschauma   56:     </listitem>
1.1       jschauma   57:     <listitem>Set your CVSROOT as indicated and run
1.13      jschauma   58:       <para><programlisting>cvs checkout htdocs</programlisting></para>
                     59:     </listitem>
                     60:     <listitem>Edit your preferred file, type
                     61:       <code><emphasis role="bold">make</emphasis></code>
                     62:       to rebuild the output files (if necessary).
                     63:     </listitem>
                     64:     <listitem>Check the results using
                     65:       <code><emphasis role="bold">cvs diff</emphasis></code>, and
                     66:       <code><emphasis role="bold">cvs commit</emphasis></code> if everything
                     67:       is good.
                     68:     </listitem>
                     69:   </itemizedlist>
1.1       jschauma   70: </para>
                     71: </sect3>
                     72: 
                     73: <sect3 id="validate-html">
                     74: <title>Validate your HTML</title>
                     75: <para>
                     76:     After making any changes you should run your html through an HTML
1.27      rpaulo     77:     verifier such as <filename role="pkg">www/weblint</filename>, 
                     78:     or better still <ulink
1.1       jschauma   79:     url="http://validator.w3.org/">http://validator.w3.org/</ulink>.
                     80:     The URL for a link to an index.html file should not include the
                     81:     trailing index.html.
                     82:     If you use weblint you may want to add the following to your
                     83:     <code>~/.weblintrc</code>.
                     84: </para>
                     85: <para>
                     86:     <programlisting>extension Netscape</programlisting>
                     87: </para>
                     88: </sect3>
                     89: 
1.3       symka      90: <sect3 id="NetBSD-org">
1.1       jschauma   91: <title>NetBSD.org naming scheme</title>
                     92: <para>
                     93:     Make sure you use NetBSD.org and not any other scheme (&#78;etbsd.org,
                     94:     &#110;etbsd.org, ...) in links, mailto's or other pointers. 
                     95: </para>
                     96: </sect3>
                     97: 
                     98: <sect3 id="dotlist-files">
                     99: <title>What are .list files?</title>
                    100: <para>
                    101:     <emphasis role="bold">The <code>.list</code> files are
                    102:     obsolete!</emphasis><html:br/>
1.17      jschauma  103:     You should convert any existing <code>.list</code> files to XML.
                    104:     Please see <ulink url="#convert-to-xml">this section</ulink> for details.
1.1       jschauma  105: </para>
                    106: </sect3>
                    107: 
                    108: <sect3 id="convert-to-xml">
                    109: <title>Converting to XML</title>
                    110: <para>
                    111:     In order to facilitate global changes, we are currently converting the
                    112:     NetBSD website to XML (docbook-website).  As of 2004-11-15, any non-XML
                    113:     file that needs to be edited shall be converted to XML at the same time.
1.41    ! daniel    114:     You may find the script <code>htdocs/scripts/list2xml</code> helpful to
1.1       jschauma  115:     initiate the conversion of the old <code>.list</code> as well as plain
1.5       jschauma  116:     <code>.html</code> files.  Please note, however, that this script only
                    117:     does a few simple replacements of tags, and you will need to do a lot by
                    118:     hand after running it.  In particular, you need to make sure that all
                    119:     tags are closed in the proper order.
                    120: </para>
                    121: <para>
                    122:     When creating or converting <code>.xml</code> files, please make sure to
                    123:     add a <quote>id</quote> attribute to each <code>&lt;sect[1-4]&gt;</code>
1.9       jschauma  124:     as well as each <code>&lt;table&gt;</code> tag:  this will prevent
1.8       jschauma  125:     <command>xsltproc</command> to generate an ID
1.5       jschauma  126:     itself, which would require an update of the resulting <code>.html</code>
1.28      rpaulo    127:     file after each regeneration. Also remember to replace each
                    128:     <quote>&amp;</quote> with <quote>&amp;amp;</quote> and
                    129:     <filename>/sys</filename> with <filename>/usr/src/sys</filename>
                    130:     where applicable.
1.5       jschauma  131: </para>
                    132: <para>
                    133:     If you are unsure how to convert a given HTML tag to the XML equivalent,
                    134:     you may find some useful examples installed as part of the
1.27      rpaulo    135:     <filename role="pkg">textproc/docbook-website</filename> on your system.
                    136:     And of course you can
1.5       jschauma  137:     feel free to ask on the www@ list for help.
1.1       jschauma  138: </para>
                    139: <para>
1.10      jschauma  140:     If you want an autogenerated TOC, you will need to include the following
                    141:     code:
                    142:     <programlisting>&lt;sect1 role="toc"&gt;</programlisting>
                    143:     This will generate a TOC listing all <code>&lt;sect2&gt;</code>s with a
                    144:     bulleted list of its <code>&lt;sect3&gt;</code>s.
1.7       jschauma  145: </para>
                    146: <para>
1.1       jschauma  147:     After converting a file to XML, remember to add it to the
1.5       jschauma  148:     <code>htdocs/layout.xml</code> file and regenerate the website.  See
                    149:     <ulink url="#dotxml-files">below</ulink> for details.
1.1       jschauma  150: </para>
1.19      jschauma  151: <!--
                    152: XXX: put back when we do switch
1.17      jschauma  153: <para>
                    154:     Finally, remember that as of 2005-02-05 file generated
                    155:     <emphasis>from</emphasis> XML need no longer be added to CVS, as these
                    156:     files are generated <ulink url="#webserver">on nbwww</ulink>.  In fact,
                    157:     these <quote>object files</quote> will likely be removed from CVS control
                    158:     altogether.
                    159: </para>
1.19      jschauma  160: -->
1.1       jschauma  161: </sect3>
                    162: 
                    163: <sect3 id="dotxml-files">
                    164: <title>Processing .xml (docbook-website) files</title>
                    165: <para>
                    166:     In order to build .html files from .xml files, you will need at
1.27      rpaulo    167:     least <filename role="pkg">textproc/libxslt</filename> and 
                    168:     <filename role="pkg">textproc/docbook-website</filename>
                    169:     installed. These are installed as part of <filename
                    170:     role="pkg">meta-pkgs/netbsd-www</filename>.
                    171:     Please make sure that you have <filename 
                    172:     role="pkg">meta-pkgs/netbsd-www</filename> version
1.29      mishka    173:     1.4.
1.1       jschauma  174: </para>
                    175: <para>
1.20      jschauma  176:     To regenerate, just run
1.25      darcy     177:     <code><emphasis role="bold">make</emphasis></code> in the target directory.
                    178:     You must do this after committing the .xml file so that the .html file
                    179:     will include the proper "Generated from" statement.
1.13      jschauma  180: </para>
                    181: <para>
1.20      jschauma  182:     If you added a new file to <filename>layout.xml</filename>,
1.13      jschauma  183:     then you do need to run <command>make</command> in the htdocs top level.
1.1       jschauma  184: </para>
                    185: </sect3>
                    186: 
                    187: <sect3 id="moving-files">
                    188: <title>Renaming or moving files</title>
                    189: <para>
                    190: In order to move or rename files within htdocs, the following procedure is
                    191: recommended:
                    192: 
                    193: <itemizedlist>
                    194:  <listitem>copy the file from the original location to new location</listitem>
                    195:  <listitem>modify html of the original file:
                    196:    <itemizedlist>
                    197:      <listitem>include a
                    198:          <code>&lt;META HTTP-EQUIV=Refresh CONTENT="5; URL=new-location"&gt;</code>
                    199:          tag in the header</listitem>
                    200:      <listitem>remove all content except the header and the footer</listitem>
1.13      jschauma  201:      <listitem>add a sentence saying that the page moved and hyperlink it to
                    202:          the new location</listitem>
1.1       jschauma  203:    </itemizedlist></listitem>
                    204:   <listitem>cvs add the new file</listitem>
1.16      jschauma  205:   <listitem>add a note to <filename>htdocs/errors/index.xml</filename>, linking
1.13      jschauma  206:       to the new location
                    207:   </listitem>
1.1       jschauma  208:   <listitem>cvs commit the new file and the changes of the old file at the same
1.13      jschauma  209:       time, so we have some cvs reference of when and why
                    210:       things moved.
                    211:   </listitem>
1.1       jschauma  212: </itemizedlist>
                    213: </para>
                    214: </sect3>
                    215: 
                    216: <sect3 id="flaglinks">
                    217: <title>What is the reasoning behind the flag links with empty.gif?</title>
                    218: <para>
                    219:     Each NetBSD 'flag' links at the base of each page has:
                    220:     <itemizedlist>
                    221:     <listitem>href containing netbsd-banner with no alt tag</listitem>
                    222:     <listitem>href containing empty gif with "NetBSD" alt tag and the
                    223:         words "Home Page"</listitem>
                    224:     </itemizedlist>
                    225:     This has the effect of:
                    226:     <itemizedlist>
                    227:     <listitem>Making the "NetBSD Home Page" link a single link in lynx,
                    228:        i.e. not a NetBSD link and a Home Page link.</listitem>
                    229:     <listitem>In netscape, causing the additional text to be centered and
                    230:         aligned "better" w.r.t the graphic.  Without it, at least
                    231:         in netscape, they show up at the bottom not centered
                    232:         vertically, and abut the graphic (or, if you include spaces,
                    233:         include nasty underlined blanks which looks broken).</listitem>
                    234:     </itemizedlist>
                    235:     It's a grotty hack, but it makes things look right.
                    236: </para>
                    237: </sect3>
                    238: 
1.35      jschauma  239:   <sect3 id="templates">
                    240:     <title>XML template files</title>
                    241: 
                    242:     <para>
                    243:       There are a few template files in <filename>htutils/templates</filename>
                    244:       to get you started with XML.  Please compare to existing pages in use
                    245:       when you add new content.
                    246:     </para>
                    247:   </sect3>
                    248: 
1.1       jschauma  249: <sect3 id="webserver">
                    250: <title>How do the pages get to the web server, and when?</title>
                    251: <para>
                    252:     The NetBSD webpages are stored in CVS in the "htdocs" repository.
                    253:     For security reasons, the htdocs repository is copied (via rsync)
1.24      jschauma  254:     to www.NetBSD.org each hour, and then a local checkout is done from
                    255:     that copy of the repository.  <!-- As of 2005-02-05, nbwww builds the
1.17      jschauma  256:     website from the CVS checkout in a staging directory, then copies any
                    257:     modified files into the live website under
1.24      jschauma  258:     <quote><code>/NetBSD-www</code></quote>. -->The script performing this
1.17      jschauma  259:     functionality is <filename>htutils/scripts/update.http</filename> and it
                    260:     is run about 40 minutes after the full hour (*:40). If you
1.1       jschauma  261:     make a commit to htdocs, it will take up to an hour before the
                    262:     changes show up.
                    263: </para>
                    264: <para>
                    265:     Note that there are several files like the Gnats database
                    266:     (<ulink url="http://www.NetBSD.org/Gnats/"/>), the pkgsrc and source changes
                    267:     in Changes/changes*.html and Changes/pkg-changes*.html, the RSS
                    268:     files in Changes/rss-*.xml etc. that are not part of htdocs but
                    269:     that get generated by various scripts out of cron jobs directly on
                    270:     the web server. Check out "htutils/changes/*" to get access to the
                    271:     scripts.
                    272: </para>
                    273: </sect3>
                    274: 
                    275: </sect2>
                    276: 
1.32      rillig    277: <sect2 id="structure">
                    278: <title>How is the whole web site structured?</title>
                    279: 
                    280: <sect3 id="structure-overview">
                    281: <title>Overview</title>
                    282: 
                    283:        <para></para>
                    284: 
                    285: </sect3>
                    286: 
                    287: <sect3 id="structure-directories">
                    288: <title>What are the individual directories for?</title>
                    289: 
                    290:        <variablelist>
                    291: 
                    292:        <varlistentry><term><filename>share/mk</filename></term>
                    293:        <listitem><para>Contains the &man.make.1; infrastructure to
                    294:        automatize the generation of the web pages from the source
                    295:        files.</para></listitem></varlistentry>
                    296: 
                    297:        <varlistentry><term><filename>share/xml</filename></term>
                    298:        <listitem><para>[TODO]</para></listitem></varlistentry>
                    299: 
                    300:        <varlistentry><term><filename>share/xsl</filename></term>
                    301:        <listitem><para>[TODO]</para></listitem></varlistentry>
                    302: 
                    303:        <varlistentry><term><filename></filename></term>
                    304:        <listitem><para></para></listitem></varlistentry>
                    305: 
                    306:        <varlistentry><term><filename></filename></term>
                    307:        <listitem><para></para></listitem></varlistentry>
                    308: 
                    309:        <varlistentry><term><filename></filename></term>
                    310:        <listitem><para></para></listitem></varlistentry>
                    311: 
                    312:        <varlistentry><term><filename></filename></term>
                    313:        <listitem><para></para></listitem></varlistentry>
                    314: 
                    315:        <varlistentry><term><filename></filename></term>
                    316:        <listitem><para></para></listitem></varlistentry>
                    317: 
                    318:        <varlistentry><term><filename></filename></term>
                    319:        <listitem><para></para></listitem></varlistentry>
                    320: 
                    321:        <varlistentry><term><filename></filename></term>
                    322:        <listitem><para></para></listitem></varlistentry>
                    323: 
                    324:        </variablelist>
                    325: 
                    326: </sect3>
                    327: 
                    328: <sect3 id="structure-files">
                    329: <title>What are the individual files for?</title>
                    330: 
                    331:        <variablelist>
                    332: 
                    333:        <varlistentry><term><filename>Makefile</filename></term>
                    334:        <listitem><para>Contains a description of the directory's
                    335:        contents. Usually it suffers to define the variables
                    336:        <varname>SUBDIR</varname> and <varname>XMLDOCS</varname>, and
                    337:        then <command>.include</command> the file
                    338:        <filename>htdocs/share/mk/web.site.mk</filename> using the
1.38      rillig    339:        appropriate relative path. The files in the
                    340:        <filename>share/mk</filename> contain large comments at the top
                    341:        that describe what you can do in the
                    342:        <filename>Makefile</filename>.</para></listitem></varlistentry>
1.32      rillig    343: 
                    344:        <varlistentry><term><filename>*.xml</filename></term>
1.39      rillig    345:        <listitem><para>XML files contain the source code for a single
                    346:        HTML page, in the <quote>DocBook Website</quote>
1.32      rillig    347:        format.</para></listitem></varlistentry>
                    348: 
                    349:        <varlistentry><term><filename>layout.xml</filename></term>
                    350:        <listitem><para>[TODO]</para></listitem></varlistentry>
                    351: 
                    352:        <varlistentry><term><filename>autolayout.xml</filename></term>
                    353:        <listitem><para>[TODO]</para></listitem></varlistentry>
                    354: 
1.39      rillig    355:        <varlistentry><term><filename>languages</filename></term>
                    356:        <listitem><para>This file contains the list of languages that
                    357:        the NetBSD website is translated
                    358:        to.</para></listitem></varlistentry>
1.32      rillig    359: 
                    360:        <varlistentry><term><filename></filename></term>
                    361:        <listitem><para></para></listitem></varlistentry>
                    362: 
                    363:        <varlistentry><term><filename></filename></term>
                    364:        <listitem><para></para></listitem></varlistentry>
                    365: 
                    366:        <varlistentry><term><filename></filename></term>
                    367:        <listitem><para></para></listitem></varlistentry>
                    368: 
                    369:        </variablelist>
                    370: 
                    371: </sect3>
                    372: 
                    373: </sect2>
                    374: 
1.1       jschauma  375: <sect2 id="specific">
                    376: <title>Adding to specific areas</title>
                    377: 
                    378: <sect3 id="adding-gallery-entries">
1.30      daniel    379: <title>Adding to the <quote>Sites running NetBSD</quote> gallery</title>
1.1       jschauma  380: <para>
                    381: If you have a <code>NETBSD GALLERY ADDITION</code> email from the <ulink
                    382: url="../gallery/addsite.html">htdocs/gallery/addsite.html</ulink> page:
                    383: <orderedlist>
1.13      jschauma  384:   <listitem>Verify that the remote site has a link back to www.NetBSD.org.
                    385:     If they do not link back, contact them to ask for a link back and add
                    386:     the information once the link is provided.</listitem>
                    387:   <listitem>Ensure you have perl installed</listitem>
                    388:   <listitem>Save the message in your copy/paste buffer </listitem>
                    389:   <listitem><code>cd htdocs/gallery</code></listitem>
                    390:   <listitem><code>./addsite.pl</code>, paste the buffer, add a ^D, and answer
                    391:       '<code>y</code>' if it parsed OK.</listitem>
                    392:   <listitem><code>cvs commit</code></listitem>
1.1       jschauma  393: </orderedlist>
                    394: Alternatively you can manually edit <code>htdocs/gallery/sites.data</code>, and
                    395: run <code>make</code>.
                    396: </para>
                    397: </sect3>
                    398: 
1.30      daniel    399: <sect3 id="adding-gallery-screenshots">
                    400: <title>Adding to the <quote>NetBSD in action</quote> gallery</title>
                    401: <para>
                    402: If possible, a screenshot should contain some easily recognizable visual
                    403: indication that it was made on a &os; system. A common way to do this is
                    404: by showing an X terminal that displays the output of the
                    405: <command>uname -a</command> command.
                    406: </para>
                    407: </sect3>
                    408: 
1.1       jschauma  409: <sect3 id="adding-news-items">
                    410: <title>Adding News Items</title>
                    411: <para>
                    412: Most news items go into <ulink
1.4       jschauma  413: url="../Changes/">htdocs/Changes/index.xml</ulink> (see note on
                    414: <ulink url="#dotxml-files">.xml files</ulink>).  Changes affecting a
1.1       jschauma  415: specific port should also be linked to from their htdocs/Port/*/ news section.
                    416: </para>
                    417: <para>
                    418: Important code news items should also be noted in the text
1.6       jschauma  419: <currentsrc>src/doc/CHANGES</currentsrc>
1.1       jschauma  420: file.
                    421: </para>
                    422: <para>Quick ``howto'' for the impatient (but please do read on for details):
                    423: <itemizedlist>
1.13      jschauma  424:   <listitem>cd htdocs/Changes</listitem>
                    425:   <listitem>make update</listitem>
                    426:   <listitem>${EDITOR} index.xml</listitem>
                    427:   <listitem>make</listitem>
                    428:   <listitem>make MSG="I added important NEWS!" commit</listitem>
1.1       jschauma  429: </itemizedlist>
                    430: </para>
                    431: 
                    432: <sect4 id="before-anything">
                    433: <title>Before you do anything with htdocs:</title>
                    434: <orderedlist>
1.27      rpaulo    435:   <listitem>Ensure you have <filename 
                    436:     role="pkg">meta-pkgs/netbsd-www</filename> installed.
1.18      jschauma  437:     Also, see <ulink url="#what-is-required">above</ulink>.</listitem>
1.13      jschauma  438:   <listitem>Check out <code>htdocs</code> from the CVS repository.</listitem>
                    439:   <listitem>If you already have a copy of htdocs in your tree, make sure you
                    440:     update it regularly.  In particular, when adding news items, make sure that
                    441:     gallery/events.* is up to date as well, as the events are pulled in from
                    442:     there!  This is best done by running
                    443:     <programlisting>
1.5       jschauma  444:   $ cd htdocs
                    445:   $ make update</programlisting>
1.13      jschauma  446:   </listitem>
1.1       jschauma  447: </orderedlist>
                    448: </sect4>
                    449: 
                    450: <sect4 id="change-entry">
                    451: <title>To add a change entry:</title>
                    452: <orderedlist>
1.13      jschauma  453:   <listitem>Edit htdocs/Changes/index.xml</listitem>
                    454:   <listitem>In the right section, add the entry of the form
                    455:     <programlisting>
1.5       jschauma  456:   &lt;sect3 id="link-name&gt;
1.11      jschauma  457:   &lt;title&gt;XX Mon XXX - FREEFORM TITLE&lt;/title&gt;
1.5       jschauma  458:   &lt;para&gt;
1.34      kano      459:     Entry text goes here.  Manual pages can be referred to as <quote>&amp;man.command.X;</quote>,
1.5       jschauma  460:     email addresses as &lt;email&gt;full@address&lt;/email&gt;.
                    461:   &lt;para&gt;
                    462:   &lt;/sect3&gt;</programlisting>
                    463:   </listitem>
1.13      jschauma  464:   <listitem>Run '<code>make</code>'</listitem>
1.1       jschauma  465: </orderedlist>
                    466: </sect4>
                    467: 
                    468: <sect4 id="adding-links">
                    469: <title>Adding links from the main pages:</title>
                    470: <para>
                    471: By running <code>make</code> from within htdocs/Changes, you will automatically 
1.13      jschauma  472: update <ulink url="../">htdocs/index.html</ulink> and the index pages of all
                    473: supported translations.  No further action on your part is required.
1.1       jschauma  474: </para>
                    475: <para>
1.40      kano      476: Alternatively, you can run <code>make regenerate-index</code> from the htdocs toplevel
1.1       jschauma  477: directory.
                    478: </para>
                    479: </sect4>
                    480: 
                    481: <sect4 id="link-specific">
                    482: <title>If you want to add a link from a port specific page:</title>
                    483: <orderedlist>
1.13      jschauma  484:   <listitem>Edit htdocs/Ports/<emphasis>arch</emphasis>/index.html, and search
                    485:     for the '&lt;!-- news --&gt;' block.</listitem>
                    486:   <listitem>Add a new entry to the subsequent list in the form:
                    487:     <para>
                    488:     <programlisting>&lt;dt&gt;&lt;b&gt;<emphasis>date</emphasis>:&lt;/b&gt; <emphasis>title</emphasis>
1.1       jschauma  489:     &lt;dd&gt;<emphasis>body of item</emphasis>
                    490:     &lt;p&gt;</programlisting>
1.13      jschauma  491:     </para>
1.1       jschauma  492:     where
                    493:     <itemizedlist>
                    494:     <listitem><emphasis>date</emphasis> - Normally as YEAR.MONTH.DATE</listitem>
                    495:     <listitem><emphasis>title</emphasis> - Freeform (short) text title</listitem>
1.13      jschauma  496:     <listitem><emphasis>body of item</emphasis> - Freeform text for the entry.
1.33      kano      497:         Can span multiple lines and may use HTML tags and links.</listitem>
1.1       jschauma  498:     </itemizedlist>
                    499: </listitem>
                    500: </orderedlist>
                    501: </sect4>
                    502: 
                    503: <sect4 id="finally">
                    504: <title>Finally:</title>
                    505: <orderedlist>
1.13      jschauma  506:   <listitem>You may want to <ulink url="#validate-html">validate the
                    507:     HTML</ulink> in your modified files.</listitem>
1.18      jschauma  508:   <listitem>Check in the files.  The command 'make commit', when
1.13      jschauma  509:     issued from the htdocs toplevel directory, will commit the main
                    510:     index-page, Changes/index.* and all the translations index pages with
                    511:     a default message of "NEWS; regen".  If you would like to add a more
                    512:     specific message, use 'MSG="Added News regarding FooBar" make
                    513:     commit'.</listitem>
                    514:   <listitem>If the news is noteworthy it is a good idea to submit it to some
                    515:     news sites, like 
1.1       jschauma  516:     <ulink url="http://daily.daemonnews.org/add_story.php3">Daily Daemonnews</ulink>,
                    517:     <ulink url="http://www.osnews.com/submit.php">OSNews</ulink>,
                    518:     <ulink url="http://slashdot.org/submit.pl">Slashdot</ulink>,
                    519:     <ulink url="http://www.newsforge.com/submit.pl">Newsforge</ulink> and
1.13      jschauma  520:     <ulink url="http://www.bsdforums.org/submitnews.php">BSDForums</ulink>.
                    521:    </listitem>
1.1       jschauma  522: </orderedlist>
                    523: </sect4>
                    524: 
                    525: </sect3>
                    526: 
                    527: <sect3 id="adding-events">
                    528: <title>Adding Events</title>
                    529: <para>
                    530: The main index page also contains links to "Upcoming Events".  These links are
                    531: updated much like the <ulink url="#adding-news-items">News entries</ulink>:
                    532: </para>
                    533: <para>
                    534:   <programlisting>
                    535: cd .../htdocs/gallery
1.5       jschauma  536: $EDITOR events.xml
1.40      kano      537: make events.html</programlisting>
1.1       jschauma  538: </para>
                    539: 
                    540: <para>
                    541: Since the events are included on all the translations index pages, all these
                    542: pages need to be generated and committed as well.  This can be achieved by
1.40      kano      543: issuing the 'make regenerate-index' command from the htdocs directory. 
1.1       jschauma  544: </para>
                    545: <para>
                    546:   <programlisting>
                    547: cd .../htdocs
1.40      kano      548: make regenerate-index
1.1       jschauma  549: MSG="Added Event Foo" make commit</programlisting>
                    550: </para>
                    551: </sect3>
                    552: 
                    553: <sect3 id="adding-mailinglists">
                    554: <title>Adding to/editing the MailingLists page </title>
                    555: <para>
                    556: If a mailing-list is missing from the
                    557: <ulink url="../MailingLists/">MailingLists</ulink> page:
                    558: <orderedlist>
1.36      kano      559:   <listitem>Edit the htdocs/MailingLists/index.xml and htdocs/MailingLists/list2group.xsl files</listitem>
1.13      jschauma  560:   <listitem>Run the makefile in htdocs/MailingLists, it will generate the
                    561:     index.html</listitem>
                    562:   <listitem>Confirm the generated html is good.</listitem>
1.36      kano      563:   <listitem>commit the index.xml and list2group.xsl files.</listitem>
                    564:   <listitem>Regenerate the index.html file to include the proper "Generated from" statement.</listitem>
                    565:   <listitem>commit the generated index.html file.</listitem>
1.1       jschauma  566: </orderedlist>
                    567: </para>
                    568: </sect3>
                    569: 
                    570: <sect3 id="consultants">
                    571: <title>Consultants for hire</title>
                    572: <para>
                    573: Before adding an entry to the ``Consultants for hire'' page (<ulink
                    574: url="../gallery/consultants.html">gallery/consultants.html</ulink>), please ask
                    575: that the person in question provides a link back to our homepage and/or
                    576: mentions NetBSD on their website.  Needless to say that you should make sure
                    577: that the URL given is active and accessible.
                    578: </para>
                    579: 
                    580: </sect3>
                    581: </sect2>
                    582: </sect1>
                    583: </webpage>

CVSweb <webmaster@jp.NetBSD.org>