doc/en/docproj/handbook3.sgml
Hiroki Sato cfd9e12239 www cleanup mega commit:
- Move includes.nav*.sgml to share/sgml/navibar.ent and
   <lang>/share/sgml/nabibar.l10n.ent.

 - Move includes.sgml and includes.xsl to
   share/sgml/common.ent, share/sgml/header.ent, <lang>/share/sgml/l10n.ent,
   and <lang>?share/sgml/header.l10n.ent.

 - Move most of XSLT libraries to share/sgml/*.xsl and
   <lang>/share/sgml/*.xsl.

 - Move news.xml and other *.xml files for the similar purpose
   to share/sgml/*.xml and <lang>/share/sgml/*.xml.

 - Switch to use a custom DTD for HTML document.  Now we use
   "-//FreeBSD//DTD HTML 4.01 Transitional-Based Extension", which is
   HTML 4.01 + some entities previously pulled via
   "<!ENTITY % includes SYSTEM "includes.sgml"> %includes;" line.
   The location of entity file will be resolved by using catalog file.

 - Add DOCTYPE declearation to XML documents.  This makes the followings
   possible:

   * Use of &foo; entities for SGML in an XML file instead of defining
     {$foo} as the same content.

   * &symbolic; entities for Latin characters.

 - Duplicated information between SGML and XML, or English and
   translated doc, has been removed as much as possible.
2006-08-19 21:20:54 +00:00

299 lines
7.7 KiB
Text

<!DOCTYPE HTML PUBLIC "-//FreeBSD//DTD HTML 4.01 Transitional-Based Extension//EN" [
<!ENTITY base CDATA "..">
<!ENTITY date "$FreeBSD: www/en/docproj/handbook3.sgml,v 1.39 2005/10/04 06:22:24 murray Exp $">
<!ENTITY title "FreeBSD Documentation Project: Handbook 3rd Edition">
<!ENTITY % developers SYSTEM "../developers.sgml"> %developers;
<!ENTITY % navinclude.docs "INCLUDE">
<!ENTITY done "<font color='green'>Done</font>">
<!ENTITY inprogress "<font color='blue'>In Progress</font>">
<!ENTITY notstarted "<font color='red'>Not Started</font>">
]>
<html>
&header;
<h1>FreeBSD Handbook 3rd Edition</h1>
<p>The 3rd Edition FreeBSD Handbook will be published in two
volumes, each over 400 pages. Volume I (User Guide) will cover
the basics, while Volume II (Administrator's Guide) will cover
system administration and more advanced topics.</p>
<p>If you would like to get involved with the production of this
edition, please send email to the -doc mailing list. Thanks!</p>
<table class="tblbasic">
<tr><th>Task</th><th>Responsible</th><th>Last updated</th><th>Status</th></tr>
<tr>
<td>Create new callout images for the numbers 1 - 25 as the default images with the DocBook stylesheets only go from 1-9 and then fall back on text numbers. This looks bad when we have more than 9 callouts in the text, such as the Security Advisories section of the Security chapter. Update: Numbers up to 15 added from DocBook CVS.</td>
<td>&a.murray;</td>
<td>July 12, 2004</td>
<td>&done;</td>
</tr>
<tr>
<td>Rewrite firewall section to cover pf, ipf and ipfw.</td>
<td>&a.trhodes;</td>
<td>July 22, 2004</td>
<td>&inprogress;</td>
</tr>
<tr>
<td>Write a proper synopsis for the Vinum chapter.</td>
<td>&a.ceri;, via a patch from Kevin Kinsey</td>
<td>July 29, 2004</td>
<td>&done;</td>
</tr>
<tr>
<td>Advanced Network Chapter is almost 100 pages and should be split up. Update: new Network Servers chapter split off separately.</td>
<td>&a.murray;</td>
<td>July 13, 2004</td>
<td>&done;</td>
</tr>
<tr>
<td>Review recently added HTTP Server section.</td>
<td>--</td>
<td>July 20, 2004</td>
<td>&notstarted;</td>
</tr>
<tr>
<td>Review recently added FTP Server section.</td>
<td>--</td>
<td>July 20, 2004</td>
<td>&notstarted;</td>
</tr>
<tr>
<td>Add information about setting up a secure web server to the
Apache section. Generating the certificate, getting the
certificate signed, etc..</td>
<td>&a.murray;</td>
<td>July 20, 2004</td>
<td>&notstarted;</td>
</tr>
<tr>
<td>Add a section about running a Windows file server with Samba to Network Servers chapter.</td>
<td>--</td>
<td>July 20, 2004</td>
<td>&notstarted;</td>
</tr>
<tr>
<td>Update the DHCP section of the Network Servers chapter to describe omshell and recent DHCP 3.X features now in the base system. UPDATE: omshell is pretty technical and I don't think we really need to get into it in the Handbook? Thoughts?</td>
<td> --</td>
<td>July 13, 2004</td>
<td>&inprogress;</td>
</tr>
<tr>
<td>Information about running an FTP server should be added to the Network Servers chapter.</td>
<td> &a.murray; </td>
<td>July 21, 2004</td>
<td>&done;</td>
</tr>
<tr>
<td>Add a type attribute to localhost URLs so that these can be
omitted from the printed output.</td>
<td>&a.murray;</td>
<td>May 18, 2003</td>
<td>&done;</td>
</tr>
<tr>
<td>Add &lt;colspecs&gt; to tables as necessary to enhance the print output.</td>
<td>&a.murray;</td>
<td>May 18, 2003</td>
<td>&inprogress;</td>
</tr>
<tr>
<td>Remove all ASCII artwork</td>
<td>&a.murray;</td>
<td>May 18, 2003</td>
<td>&done;</td>
</tr>
<tr>
<td>Update chapter on using modern versions of GNOME</td>
<td>&a.marcus;</td>
<td>May 18, 2003</td>
<td>&done;</td>
</tr>
<tr>
<td>Fix cross-referencing tags to look better in the print
output.</td>
<td>&a.murray;</td>
<td>May 18, 2003</td>
<td>&inprogress;</td>
</tr>
<tr>
<td>Standardize spelling of technical terms</td>
<td>&a.trhodes;</td>
<td>May 18, 2003</td>
<td>&inprogress;</td>
</tr>
<tr>
<td>Make sure all filenames, commands, applications, hostnames, etc
are marked up properly</td>
<td>&a.blackend;</td>
<td>May 18, 2003</td>
<td>&inprogress;</td>
</tr>
<tr>
<td>Update appendix of contributing authors.</td>
<td>&a.chern;</td>
<td>July 20, 2004</td>
<td>&inprogress;</td>
</tr>
<tr>
<td>Update PPP/SLIP chapter</td>
<td>&a.trhodes;</td>
<td>May 18, 2003</td>
<td>&done;</td>
</tr>
<tr>
<td>Clean up the IPSec section</td>
<td>&a.hmp;, &a.chern;</td>
<td>October 26, 2003</td>
<td>&done;</td>
</tr>
<tr>
<td>Add simple illustrations at the beginning of each Part.</td>
<td>&nbsp;</td>
<td>May 18, 2003</td>
<td>&notstarted;</td>
</tr>
<tr>
<td>Add admonition graphics for Note, Caution, Warning, Tip.</td>
<td>&a.hrs;</td>
<td>May 18, 2003</td>
<td>&inprogress;</td>
</tr>
<tr>
<td>Design the cover.</td>
<td>Ben Hansen</td>
<td>July 20, 2004</td>
<td>&done;</td>
</tr>
<tr>
<td>Update content in introduction chapter for post 5.0 world.</td>
<td>&nbsp;</td>
<td>May 18, 2003</td>
<td>&notstarted;</td>
</tr>
<tr>
<td>Make front matter look better</td>
<td>&a.murray;</td>
<td>May 18, 2003</td>
<td>&done;</td>
</tr>
<tr>
<td><strong>Review the book for grammatical errors.</strong></td>
<td>Everyone!</td>
<td>May 18, 2003</td>
<td>&inprogress;</td>
</tr>
<tr>
<td>Implement automated spellchecker for entire Handbook. Chern
wrote some Tcl scripts and posted them to doc@ around the time of
the second edition work. This could be a starting point.</td>
<td>&nbsp;</td>
<td>May 18, 2003</td>
<td>&notstarted;</td>
</tr>
<tr>
<td>Make sure all section titles are capitalized properly</td>
<td>&a.ceri;</td>
<td>May 18, 2003</td>
<td>&done;</td>
</tr>
<tr>
<td>Remove gratuitous Q/A sections in favor of more formal
text. (see the end of the ports/packages chapter)</td>
<td>&a.trhodes;</td>
<td>May 18, 2003</td>
<td>&inprogress;</td>
</tr>
<tr>
<td>Add more information about ACPI.</td>
<td>&a.trhodes; and &a.njl;</td>
<td>May 18, 2003</td>
<td>&done;</td>
</tr>
<tr>
<td>Add information about Kerberos5 and adjust Kerberos4 information
accordingly.</td>
<td>&a.trhodes;</td>
<td>May 18, 2003</td>
<td>&done;</td>
</tr>
<tr>
<td>Update Preface.</td>
<td>&a.murray;</td>
<td>July 20, 2004</td>
<td>&inprogress;</td>
</tr>
<tr>
<td>Update bibliography with newer editions, etc.</td>
<td>&nbsp;</td>
<td>May 18, 2003</td>
<td>&notstarted;</td>
</tr>
<tr>
<td>Add more indexterms throughout the book. Reorganize some
existing indexterms. See the "make indexcheck" functionality for
help finding areas of the book where indexterms are sparse.</td>
<td>&nbsp;</td>
<td>May 18, 2003</td>
<td>&notstarted;</td>
</tr>
<tr>
<td>Write an introduction for the Serial Communications chapter
(note the big "XXX - Write me!" comment). The current Synopsis can
probably be adapted for this.</td>
<td>&nbsp;</td>
<td>May 19, 2003</td>
<td>&notstarted;</td>
</tr>
<tr>
<td>The Mini-Cartridge section in the disks chapter still needs to
be written. Update: section removed.</td>
<td>&a.murray;</td>
<td>July 20, 2004</td>
<td>&done;</td>
</tr>
<tr>
<td>Add information about network configuration to the install chapter.</td>
<td>&a.trhodes;</td>
<td>May 18, 2003</td>
<td>&done;</td>
</tr>
<tr>
<td>Add some documentation on cron(8).</td>
<td>&a.trhodes;</td>
<td>May 18, 2003</td>
<td>&done;</td>
</tr>
<tr>
<td>Fill undefined glossary terms.</td>
<td>Everyone!</td>
<td>August 16, 2004</td>
<td>&notstarted;</td>
</tr>
<tr>
<td>Send everything to the printer.</td>
<td>&a.murray;</td>
<td>&nbsp;</td>
<td>&notstarted;</td>
</tr>
</table>
&footer;
</body>
</html>