<!DOCTYPE HTML PUBLIC "-//FreeBSD//DTD HTML 4.01 Transitional-Based Extension//EN" [
<!ENTITY base CDATA "..">
<!ENTITY date "$FreeBSD$">
<!ENTITY title "FreeBSD Documentation Project: Current projects">
<!ENTITY % navinclude.docs "INCLUDE">
<!ENTITY % developers PUBLIC "-//FreeBSD//ENTITIES FreeBSD Developers Entities//EN"> %developers;

<!ENTITY imagebase "&base;/gifs">

<!-- Status levels -->
<!ENTITY status.blank "&nbsp;">
<!ENTITY status.blocked "<img src='&imagebase;/blocked.png' width='22' height='22' alt='Blocked'>">
<!ENTITY status.done "<img src='&imagebase;/done.png' width='22' height='22' alt='Done'>">
<!ENTITY status.new "<img src='&imagebase;/not_started.png' width='22' height='22' alt='Not Started'>">
<!ENTITY status.n-a "<img src='&imagebase;/not_planned.png' width='22' height='22' alt='Not Planned'>">
<!ENTITY status.wip "<img src='&imagebase;/in_progress.png' width='22' height='22' alt='In progress'>">
]>

<html>
    &header;
    
    <p>Here are the projects currently under way (or being actively
      contemplated on the freebsd-doc mailing list).</p>

    <p>If you think you can contribute to any of these, please do not
      hesitate to stand up and be counted. You should talk to the
      person responsible for that particular project, who can then bring you
      up to speed on what is happening.  If you have any ideas for a new
      project then please email <a href="mailto:FreeBSD-doc@FreeBSD.org">
      FreeBSD-doc@FreeBSD.org</a>.</p>

    <ul>
    <li><a href="#todo">Documentation TODO list</a></li>
    <li><a href="#pr">Open documentation problem reports</a></li>
    <li><a href="#handbook-index">Improve Handbook Index</a></li>
    <li><a href="#slides">Contribute Advocacy Slides/Presentations</a></li>
    <li><a href="#handbooksection">Write a section in the Handbook and/or FAQ</a></li>
    <li><a href="#newpapers">Write some new Papers</a></li>
    <li><a href="#cgiscripts">CGI Scripts</a></li>
    <li><a href="#multilingualwebscripts">Multilingual Web scripts</a></li>
    <li><a href="#translations">Translations of the FreeBSD Documentation</a></li>
    <li><a href="#search-enhancements">Search engine enhancements</a></li>

    </ul>

    <a name="todo"></a>
    <h3>Documentation TODO list</h3>

    <p>The Documentation <a href="todo.html">TODO</a> list is an
      up-to-date list of documentation issues that should be resolved.
      This list is posted every month on the <a
      href="mailto:FreeBSD-doc@FreeBSD.org">FreeBSD-doc@FreeBSD.org</a>
      mailing list.  If you wish to help us to improve the FreeBSD
      documentation set you should, at first, choose to work on one of
      the TODO list items.</p>

    <a name="pr"></a>  
    <h3>Open documentation problem reports</h3>

    <p>Current FreeBSD problems reports are tracked using the GNATS
    database.

    You can <a
    href="http://www.FreeBSD.org/cgi/query-pr-summary.cgi?category=docs&amp;responsible=.">view</a>
    the open documentation problem reports.</p>

    <a name="handbook-index"></a>  
    <h3>Improve Handbook Index</h3>

    <p><b>Responsible:</b> FreeBSD-doc &lt;<a
    href="mailto:FreeBSD-doc@FreeBSD.org">FreeBSD-doc@FreeBSD.org</a>&gt;</p>

    <p><b>Synopsis:</b> Many new sections have been added to the
      FreeBSD Handbook without index terms, others have been added
      under inappropriate primary or secondary indexterms that do not
      fit the existing scheme.  Some indexterms have been added inside
      list items or other areas where they are not allowed by our
      stylesheets, causing <tt>???</tt> to be printed in the index instead of
      a real page number.</p>

    <p>Index work requires experience and anyone who works on this
      task is highly encouraged to carefully read through the existing
      (print-output) index, and to have read the Chicago Manual of
      Style or other style books that deal with indexing.  Please see
      the CVS history of some of the chapter.sgml files to see some of
      the indexing errors that have been corrected in the past.
      It is imperative to view the PostScript version of the Handbook
      after making any changes to indexterms as many errors, such as
      long words or deeply nested indexterms will break the two column
      output there, or cause the page number to be listed as <tt>???</tt>.</p>

    <p>There is a script <tt>doc/share/misc/indexreport.pl</tt> which
      can be used to find areas of an SGML file where
      &lt;indexterms&gt; are sparse.</p>

    <a name="slides"></a>  
    <h3>Contribute Advocacy Slides/Presentations</h3>

    <p><b>Responsible:</b> FreeBSD-doc
    &lt;<a
    href="mailto:FreeBSD-doc@FreeBSD.org">FreeBSD-doc@FreeBSD.org</a>&gt;,
    Murray Stokely &lt;<a
    href="mailto:murray@FreeBSD.org">murray@FreeBSD.org</a>&gt;</p>

    <p><b>Synopsis:</b> Presentations marked up in the DocBook-slides
      DTD have recently been added to the documentation set in
      <tt>doc/en_US.ISO8859-1/slides</tt>.  More advocacy content is
      needed, and additional stylesheet work is needed to pull in
      content from the release notes and other XML content in our
      documentation set to build up-to-date slides with 'make'.  A
      simple example presentation was committed with some of this
      functionality, but there is more work to be done!  Also, the
      stylesheets for print/PDF output (using the Java based XSLT
      processors, PassiveTeX is too limiting for slides) could be
      improved as the default DocBook Slides XSL-FO stylesheets
      produce very spartan slides.</p>

    <a name="handbooksection"></a>  
    <h3>Write a section in the Handbook and/or FAQ</h3>

    <p><b>Responsible:</b> No one</p>

    <p><b>Synopsis:</b> Chunks of the FAQ and Handbook have empty sections in
      them. They need filling. If you have just had to use one of
      these documents to complete a task, and found them lacking,
      please find the time to write up your experiences as a
      possible replacement.</p>
      
    <p>Alternatively, if you have just had to do something that had no
      entry in the FAQ and/or Handbook, please consider writing a
      new section. Then submit it as outlined above.</p>
      
<a name="newpapers"></a>  
<h3>Write some new Papers</h3>

    <h4><font color="#660000">The New SCSI layer for FreeBSD (CAM)</font></h4>
    <p><b>Responsible:</b>
    &lt;<a href="mailto:doc@FreeBSD.org">doc@FreeBSD.org</a>&gt;, 
    &lt;<a href="mailto:scsi@FreeBSD.org">scsi@FreeBSD.org</a>&gt;</p>
    <p><b>Synopsis:</b> See <a href="http://www.FreeBSD.org/~gibbs/">
    The Design and Implementation of the FreeBSD SCSI Subsystem</a>
    for a first snapshot.</p>

<a name="cgiscripts"></a>  
<h3>CGI Scripts</h3>
    <p><b>Responsible:</b> 
     &lt;<a href="mailto:doc@FreeBSD.org">doc@FreeBSD.org</a>&gt;,
     Wolfram Schneider &lt;<a href="mailto:wosch@FreeBSD.org">wosch@FreeBSD.org</a>&gt;</p>

    <p><b>Synopsis:</b> Modify the CGI scripts url.cgi, ports.cgi,
     pds.cgi and the script portindex to use the Perl <a
     href="http://people.FreeBSD.org/~tom/portpm/">FreeBSD::Ports</a>
     modules.  These modules also need thorough testing.</p>

<a name="multilingualwebscripts"></a>  
<h3>Multilingual Web scripts</h3>

    <p><b>Responsible:</b> 
    &lt;<a href="mailto:doc@FreeBSD.org">doc@FreeBSD.org</a>&gt;</p>
    <p></p>

    <p><b>Synopsis:</b></p>

    <p>
      Our main Web pages are written in (American) English.  The <a
      href="translations.html">FreeBSD Translations Projects</a>
      translate the web pages, Handbook and FAQ to other languages.</p>

      <p>
      We must translate the cgi scripts and web build scripts too. The
      scripts should support multiple languages, not only one.
      Most scripts are written in perl.</p>

      <ul>
      <li>Merge the perl scripts <a
      href="ftp://ftp.FreeBSD.org/pub/FreeBSD/FreeBSD-current/www/en/ports/portindex">www/en/ports/portindex</a>
      and <a
      href="ftp://ftp.FreeBSD.org/pub/FreeBSD/FreeBSD-current/www/ja/ports/portindex">www/ja/ports/portindex</a>
      into one script. Add an option for English and Japanese output.
      </li>
      </ul>

      
<a name="translations"></a>  
<h3>Translations of the FreeBSD Documentation</h3>
    <p><b>Responsible:</b> 
    &lt;<a href="mailto:doc@FreeBSD.org">doc@FreeBSD.org</a>&gt;</p>
    <p>
    Translate the FreeBSD documentation (Web pages, FAQ,
    Handbook, Manual pages) into other languages. See the
    <a href="translations.html">FreeBSD translations projects</a></p>

<a name="search-enhancements"></a>
<h3>Search engine enhancements</h3>
    <p><b>Responsible:</b>Eric Anderson &lt;<a href="mailto:anderson@centtech.com">anderson@centtech.com</a>&gt;</p>

    <p>When searching the website, the output from the search engine includes
    the filename that was found, which might be something like
    <tt>FAQ34.html</tt>.</p>

    <p>It would be more useful if the results included the question text,
    allowing the user to see whether or not the result was relevant.</p>

&footer;
  </body>
</html>
