port before telling them how to create a new port.
Belatedly document MLINKS.
Seems billf committed to this under my feet, so I guess we're even, now. :)
Update the __FreeBSD_version table to include latest -current
and the introduction of 3.2-stable.
PR: docs/11740
Submitted by: Chris Costello <chris@calldei.com>
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.
from doc/handbook.
File From -> To Merged to files...
---------------------------------------------------------------
authors.sgml 1.135 -> 1.139 authors.ent
bibliography.sgml 1.38 -> 1.39 bibliography/chapter.sgml
contrib.sgml 1.338 -> 1.341 staff/chapter.sgml
current.sgml 1.25 -> 1.26 cutting-edge/chapter.sgml
cvsup.sgml 1.41 -> 1.45 cutting-edge/chapter.sgml
eresources.sgml 1.53 -> 1.54 eresources/chapter.sgml
handbook.sgml 1.96 -> 1.101 handbook.sgml
install.sgml 1.67 -> 1.72 install/chapter.sgml
lists.sgml 1.8 -> 1.12 mailing-lists.ent
mirrors.sgml 1.101 -> 1.111 mirrors/chapter.sgml
porting.sgml 1.124 -> 1.130 ports/chapter.sgml
stable.sgml 1.19 -> 1.22 cutting-edge/chapter.sgml
submitters.sgml 1.277 -> 1.299 contrib/chapter.sgml[1]
vm.sgml -> 1.3 internals/chapter.sgml
Added
-----
newsgroups.ent
[1] For translators: Due to Eivind's massive update to the "Additional
Contributors" section, I refrained from merging in the changes by
hand. Instead, I took the list of names from submitters.sgml and
did various search/replaces on them.
I strongly suggest you just lift the complete list of names from
contrib/chapter.sgml and paste it in to your translation, since
there shouldn't be any actual translation required.
<informalexample>
<screen>
...
</screen>
</informalexample>
need the <informalexample> element. So remove it. Simple search and
replace does the trick.
* Merged in changes between tags LINUXDOC_2_DOCBOOK and
LINUXDOC_2_DOCBOOK_2. The merges are as follows (if a file isn't listed
here it's because there are no changes to merge since the
LINUXDOC_2_DOCBOOK tag was put down).
File From -> To Merged to files...
---------------------------------------------------------------
authors.sgml 1.118 -> 1.128 authors.ent
boothelp.sgml Added
contrib.sgml 1.312 -> 1.329 staff/chapter.sgml
eresources.sgml 1.50 -> 1.51 eresources/chapter.sgml
handbook.sgml 1.91 -> 1.95 handbook.sgml
mirrors.sgml 1.92 -> 1.99 mirrors/chapter.sgml
porting.sgml 1.112 -> 1.118 [1]
ports.sgml 1.31 -> 1.33 ports/chapter.sgml
printing.sgml 1.22 -> 1.23 printing/chapter.sgml
stable.sgml 1.17 -> 1.18 cutting-edge/chapter.sgml [2]
submitters.sgml 1.246 -> 1.261 contrib/chapter.sgml
[1] Merged changes. Part of these changes are the migration of the
"Making a port" section from contrib/chapter.sgml to
ports/chapter.sgml
[2] Merged some changes. 1.18 demotes some of the section headings so
that the -stable section will appear on one HTML page. This is not
the case with the DocBook stylesheets we're using, so wasn't
necessary. For the time being, the -stable headings will follow
the -current headings. This can be revisited after the migration
is complete.
There will be one more merge pass once the Handbook in doc/handbook/ is
frozen, and then a pass to reformat (refill) most of the lines in the
Handbook so it's more aesthetically pleasing. The SGML parsers don't
care, but it makes it easier to follow the structure when editing the
documents.
* Removed
sgml-shorttag: nil
sgml-minimize-attributes: max
from the Emacs local variables at the bottom of each file. It didn't
do quite what I was expecting.
