CSH books

The Context Sensitive Help (CSH) system uses a different book for each OpenVPMS version.  Each book must have the URL path documentation/csh/V/xxx where V is the version (eg 1.8) and xxx relates to the topic [and for pages to be invoked via Alt-F1] must match that in the help.properties file. The complete URL will be like http://www.openvpms.org/documentation/csh/1.8/topics

When development commences on a new version (say 1.9) then we need to clone the new version's text from the current one (say 1.8).  This is done as follows:

Note that you need the permission to create books - the Documentation Team and administrator roles have this.

Step 1. Make the book that you want to clone part of the Online Documentation book. This is necessary because you cannot use the duplicate operation on a complete book – only part of one. To do this edit its top page and change its outline from:

to

Step 2. Duplicate the book. Do this as follows:

1. Go to http://openvpms.org/admin/content/book
2. For the entry "Online Documentation", select "edit order and titles"
3. Click the hammer and spanner icon (Content operations) next to the documentation you want to copy.  E.g. Online Documentation (1.8)
4. Select Duplicate - a sub-window will show as follows:

5. After a while, you'll see the following:

Typically the duplicated tree will be expanded. To verify, hover the mouse over the page icon to determine which of them is the copy. E.g in the above, the first entry has Nid: 4981, whilst the second has Nid:6284. The second is therefore the copy.

6. Click the hammer and spanner icon (Content operations) on the copy, and select Rename and update the version no.
    E.g. Online Documentation (1.9)

7. Verify you can browse the new documentation. E.g.:
    http://openvpms.org/documentation/csh/1.9/topics

8. SQL verification: you can verify things as follows

select count(*) from url_alias where dst like "documentation/csh/1.8%" and not dst like  "documentation/csh/1.8%/feed";
select count(*) from url_alias where dst like "documentation/csh/1.9%" and not dst like  "documentation/csh/1.9%/feed";

Both queries should return the same number of rows (430 in the above example)

Step 3. Separate the books from the Online Documentation book (ie reverse Step 1 above). Do this by editing the outline of the top page of both the one you cloned (1.8 in the above example) and the cloned one to set the outline to <create new book> as follows:

Step 4. Check the Advanced Book Blocks configuration to make sure the required books are included.  Call up http://www.openvpms.org/admin/settings/advanced-book-blocks/configure/0

The items will be adisplayed with the lowest weight (-15) at the top. The Reset Weight checkbox resets the item's weight to -15. It is easiest just to adjust the weights as needed and press Save.

Note that we do not enable the Site Administration book - simply to hide it to keep normal people out.