os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Add two new Documentation Projects :

Browse source 
* Improve Index of the Handbook (adding more indexterms, identifying
  misplaced indexterms, etc..)
* Modernize the website with CSS
This commit is contained in:
Murray Stokely 2004-12-04 21:45:15 +00:00
parent b0eff97ba2
commit 54be23902d
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/www/; revision=23122
1 changed files with 54 additions and 2 deletions

56
en/docproj/current.sgml
View file

@ -1,6 +1,6 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" [
<!ENTITY base CDATA "..">
<!ENTITY date "$FreeBSD: www/en/docproj/current.sgml,v 1.74 2004/09/09 23:51:04 brueffer Exp $">
<!ENTITY date "$FreeBSD: www/en/docproj/current.sgml,v 1.75 2004/12/04 21:27:52 murray Exp $">
<!ENTITY stylesheet "&base;/projects/c99/style.css">
<!ENTITY title "FreeBSD Documentation Project: Current projects">
<!ENTITY % includes SYSTEM "../includes.sgml"> %includes;
@ -36,7 +36,10 @@
<ul>
<li><a href="#pr">Open documentation problem reports</a></li>
<li><a href="#handbook3">Handbook 3rd Printed Edition (Completed)</a></li>
<li><a href="#handbook">Handbook 2nd Printed Edition (Completed)</a></li>
<li><a href="#handbook">Handbook 2nd Printed Edition
(Completed)</a></li>
<li><a href="#handbook-index">Improve Handbook Index</a></li>
<li><a href="#website-css">Modernize website with CSS</a></li>
<li><a href="#freebsd4linux">FreeBSD for Linux users</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>
@ -94,6 +97,55 @@
is still archived <a href="handbook.html">here</a> for
posterity.</p>
<a name="handbook-index"></a>
<h3><font color="#660000">Improve Handbook Index</font></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 '???' 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 '???'.</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="website-css"></a>
<h3><font color="#660000">Modernize website with CSS</font></h3>
<p><b>Responsible:</b> FreeBSD-www &lt;<a
href="mailto:FreeBSD-www@FreeBSD.org">FreeBSD-www@FreeBSD.org</a>&gt;</p>
<p><b>Synopsis:</b> Most of the FreeBSD.org website is written in
HTML 3.2. Some of the files have been updated to technically
use the HTML 4 DTD, but in spirit they are still HTML 3.2 files
with very minimal use of CSS and extensive use of hardcoded
presentation tags.</p>
<p>Any redesign of the FreeBSD.org website will be more CSS based.
Moving existing pages to CSS allows us to more quickly modify
the look and feel of the entire website and should preserve
bandwidth. As with DocBook for our technical documentation,
recent CSS and HTML standards allow us to separate presentation
from data and we should be taking better advantage of this with
our website.</p>
<a name="freebsd4linux"></a>
<h3><font color="#660000">FreeBSD for Linux users</font></h3>