[CFR] Migrating the documentation to a real XML toolchain

Warren Block wblock at wonkity.com
Wed Feb 27 01:24:34 UTC 2013


On Tue, 26 Feb 2013, Gabor Kovesdan wrote:

> I have some improvements for the doc infrastructures in the xml-tools branch. 
> I think that the changeset is now getting mature enough to be merged back so 
> I'd like to ask for review. It does not affect the web pages, only books and 
> articles. The rendered docs are available at:
> http://people.freebsd.org/~gabor/db45/
>
> For every article/book, you will find there the chunked XHTML docs or if you 
> manually enter the URL, you can access the single XHTML and PDF versions as 
> (article|book)\.(html|pdf).

Thanks for all your work on this!

Noticed when looking at the English version of the Handbook:

Author info is a little off.  Compare the authors at the start of the 
bsdinstall chapter:
http://people.freebsd.org/~gabor/db45/en_US.ISO8859-1/books/handbook/bsdinstall.html
http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/bsdinstall.html

In the standard version, each section is rendered as a sentence, with 
multiple authors separated by commas.

Acronyms don't have any highlights, they just look like normal text.

Table rendering in the new version looks better than the old on the svn 
mirrors.

Notes, tips, and warnings are not shown in color boxes.  Examples are, 
though.

Callout labels are missing, although the explanations below are present. 
See "2.4.1.3. Booting for SPARC64":
http://people.freebsd.org/~gabor/db45/en_US.ISO8859-1/books/handbook/bsdinstall-start.html#bsdinstall-boot-loader-menu
http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/bsdinstall-start.html#bsdinstall-boot-loader-menu

Pictures (screenshots) are missing:
http://people.freebsd.org/~gabor/db45/en_US.ISO8859-1/books/handbook/using-bsdinstall.html
http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/using-bsdinstall.html

Man page entities are not links, just text.

<commands> are rendered in bold.  Just a difference, not necessarily a 
problem:
http://people.freebsd.org/~gabor/db45/en_US.ISO8859-1/books/handbook/GEOM-mirror.html
http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/geom-mirror.html


Thanks again!


More information about the freebsd-doc mailing list