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

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

CVSweb <webmaster@jp.NetBSD.org>