documentation is placed under it. Replaces the empty FAQ section and the
only partly completed Handbook section. This is because the information
in here applies to all the documentation under doc/, not just the Handbook.
Move the style guide information out of the-handbook/chapter.sgml and in
to writing-style/chapter.sgml. It doesn't really belong here either, but
we don't have a general style chapter (yet).
Update Makefile to know about this, and use the doc.project.mk file.
Update book.sgml to know about the new chapter.
Remove the old chapters.
of the example HTML and DocBook fragments, which are significant.
Explain where to find the FreeBSD DTD that extends DocBook.
Add a section explaining about books and articles, and the differences
between them.
Added an example of <procedure>.
Be consistent with the white space inside <programlisting>. Make sure
that content starts immediately after the opening tag. Shouldn't make
a great deal of difference, but we should practice what we preach.
Remove the information about <informalexample>, as it seems to be
redundant, and we don't use it anymore.
Correct an error ("]]", should be "]") in the example of including the manual
page reference entities.
on by many people, the SGML conversion has been carried out by the new(ish)
committer, John Baldwin. Cheer's John.
Changes from the submission:
1. It's an article, not a book. I originally thought there was going
to be sufficient content (when you include the committers rules
that are being thrashed out at the moment, and Satoshi's ports
committer stuff) to make this worth being a book. After seeing the
content I changed my mind, so it's an article.
2. Various contractions ("you're" and so on) expanded to make life
a little easier for the translators. Kept one ("Who's Who").
was not bumped after the newbus import. :-( [shame on them].
So I moved it to the ceiling of the closest value. What was claimed to be
the __FreeBSD_version for "newbus" is really for "__deregister_frame_info
dynamic linker bug fix" and EGCS import.
Add 3.3 and 3.2 RELEASE's __FreeBSD_version values.
Obtained from: cvs log src/sys/sys/param.h
to both directories, and make it relative, rather than absolute.
This fixes the case where you might install the docs under one directory
/foo/bar/..., and then want to migrate them elsewhere (to /usr/share/).
With the old scheme, the symlink would start /foo/bar/..., and would
therefore be broken.
A good example of this happening is "make release" :-)
Fix up the list of questions and answers as a <qandaset> instead of
an <itemizedlist>. This entails converting the <itemizedlist> element
to a <qandaset>, and wrapping each question paragraph in a <question>
and </question> pair, and each answer in a <answer>...</answer> pair.
Then, search and replace for all the "Q. " and "A. " and remove them,
because the stylesheet adds these for you.
Finally, some of the questions are entered as
<para><anchor id="foo">...
Delete the anchor element, and put the id attribute on the para instead,
so you have
<para id="foo">...
I'm not entirely sure why, but if you have that in the first form then
the stylesheets don't include the links properly in the table of
questions. If you have it in the second form then everything works fine.
The first question in the preface, "What is the purpose of this FAQ"
doesn't need to be there (although the contents of the answer do). Remove
the question, and associated markup, but retain the answer.