tar file of the HTML files. Functionality stays the same, but the
method is slightly different.
*.html-split.tar{.gz,.bz2,.zip} now removed on "make clean" as well,
as pointed out by Shadowfax, or Strider, or whatever Satoshi's calling
himself these days. . .
these fixes.
'mary' -> '<username>mary</username>'
Fixed lines that were broken in the wrong place, either too early, or
too late. This made some of the examples look odd, and some of the
code examples were just wrong. These were errors I introduced doing
the DocBook conversion, and weren't in the original LinuxDoc version.
There was TAB damage in some of the examples, causing text that should
line up in real life to not line up. Fixed, by replacing the tabs with
an appropriate number of spaces.
formats and compression schemes to comprehensively list them all,
just point to the /pub/FreeBSD/doc/. There's a README file in there,
which should be sufficient.
It's not technically required, but it keeps things looking nice, and much
easier to understand. This is important if people are going to be able
to learn DocBook by looking at the Handbook. It also makes it easier
to follow the structure if you don't have an SGML savvy editor.
I'm going to be *at least* as anal about this as bde is about style(9).
Sorry folks :-)
tar'ed and installed. Prompted by JKH.
Turn 'distribute' in to a NOP, so that the LinuxDoc Handbook is not
smashed by this one during "make release". We're almost ready to do
the switch. . .
me to *not* copy over his "BEER-WARE LICENSE" from doc/handbook/ctm.sgml
(which has been subsumed in to this file as part of the DocBook conversion).
Thanks Poul.
most of the other spurious comments.
Two comments relating to copyright have *not* been merged in from the
LinuxDoc version yet -- I've contacted the original authors to ask if
they would be willing to assign the copyright to the project. When I
get their response the copyright comments will either be merged in, or
left out, as necessary.
Rationale: All the changes to the DocBook handbook so far have been
careful to keep whitespace changes to a minimum. This is so the
translators have as easy a job as possible in identifying exactly what's
changed.
This has meant the English version has become more and more 'ugly'. Lines
indented by the wrong amount, some lines longer than 130 characters,
others shorter than 20, gaps of 3 or 4 lines between paragraphs (and
sometimes within paragraphs). This makes it difficult to follow the
structure of the document, and needlessly complicates fixing SGML
problems.
It also makes the source practically useless as a teaching aid; the
more baroque the source looks, the less likely people are to dive in and
contribute.
This commit fixes all that -- and boy was it tedious. The snag is, it's
touched almost every line in every file in the Handbook.
Technically, the changes were made by running (in Emacs)
sgml-indent-or-tab (bound to the TAB key) on almost each line (except
those in <programlisting>, <screen>, <literallayout>, and other
verbatim sections), and then running sgml-fill-element (bound to
C-c C-q) on most paragraphs.
FWIW, this is the first, only, and last change of this type contemplated.
The construct:
<citerefentry>
<refentrytitle>foobar</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>
is a pain to type, and messes up the pretty-printing of the source code.
Replace every occurence of a entry like that with:
&man.foobar.1;
Adjusting the manual page name and section number appropriately.
The definitions for these entities are stored in man-refs.ent. This
file is in doc/share/sgml because it is not just specific to the Handbook.
I expect the DocBook'd FAQ and Tutorials (coming RSN) to use them as
well.
A new PUBLIC identifier has been created for these entities, and added to
the catalog file.