documentation help

[Patrick Schweiger]

Bengt Thuree wrote:

> Perhaps you can look at the business chapters?
> Also, if you have any suggestions or additions, please send them to the
> list. 

I'll take on ch_bus_ar.xml, ch_bus_ap.xml and ch_pay.xml.

> Personally, I do the following.
> 
> 1) Ensure you have the latest copy from subversion
> ** svn update
> 
> 2) Update the Wiki, Move the chapter to Ongoing work
> 
> 3) Adding the following to the top of the chapter .xml file, 
>    so external tools handles the xml file better.
> <?xml version="1.0" encoding="UTF-8"?>
> <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
> "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
> 
> 4) Modify the xml file, and check the result with yelp
> ** I am using scite as my editor, a plain editor like gedit, but it can
> "compress" the various tag pairs.
> ** yelp ch_txns.xml
> 
> 5) Clean up docbook tags
> ** Ensure there is no "_" together with the id=" tag
> ** Ensure that there is no "/>", but corresponding ending tag. 
>      <para>....</para> instead
> ** xmllint --valid --noout <chapter xml file>
> 
> 6) Prepare a diff
> ** xmlto -o /tmp txt <Modified chapter xml>.xml
> ** rename /tmp/<chapter xml>.txt to /tmp/<chapter xml>.1.9.txt
> 
> ** xmlto -o /tmp txt <SVN chapter xml>.xml
> ** rename /tmp/<chapter xml>.txt to /tmp/<chapter xml>.svn.txt
> 
> ** diff -u /tmp/<chapter xml>.svn.txt /tmp/<chapter xml>.1.9.txt
> 
> 7) Double check that the svn version has not been modified.
> 
> 8) I send the diff file, together with the XML file to the -devel list,
>    since the pictures would be to large to send to a distribution list.
>    The xml + pictures is send directly to Chris, and other interested
>    parties after some time passed to let comments have a chance to
>    filter back.

thanks for all this info!