[OGo-Documentation] user documentation & rpm

Chris H documentation@opengroupware.org
Thu, 03 Feb 2005 16:18:39 -0500


G. Roderick Singleton wrote:

>In 1.1.4, docbook is a save as option (simplified) probably the same a
>1.1.3. I cannot get 1.9 to work so don't know whether the export filter
>is better or not.
>  
>
Yes its the 'simplified' part that needs testing and proofing..:)

>If this is the case, them why not html. Under RH docs go
>in /usr/share/doc/ and I am guessing that most rpm based distros do the
>same.
>  
>
Sure that the file system location on RH. However that differs greatly 
per distro. The actual location for such docs and required formats is 
not mine rather Helge's. At this time Im hopping simply to point out 
that inclussion with the app is a good thing. That I think has been 
accomplished.

The next decision is where on the filesystem such doc's are ideally 
placed; in the systems directory structure or the applications directory 
structure. My preferance based on usability would be to place the 
documents in html format in the application's directory structure as a 
prelude to making the docs as part of an online help system in a later 
release version of OGo.

By means of example;

A help button that is WebUI page specific that calls context specific 
help notes.

In order to get there the placement of the documentation via an rpm load 
is critical to the applications design. For now however providing the 
doc in a to be determined format suffices I would say.


/ch