Hi all,

Currently OFBiz Online help work with docbook files with html generation done 
by a ftl template.
 Link between screen and file to show is done with some content associated with 
key-word

Decision has been done to no more used docbook format but now use asciidoc 
format.

User-manual.adoc should be the new reference for user help. How to use it for 
online help ?

I think it's important that online help is link to a internal help (which can 
be modified) not to a Apache-OFBiz-website-Help
but this point of view can be discuss.

To be able to have OFBiz internal help, three points should be solved :
1) with asciidoc we have multiple documentations, it seem important to have a 
"website" to be able to access easily all the doc.
   how to "encapsulate" each html documentation generated in a "website"
2) generation doc process put html and pdf files in build directory, how it's 
possible to access them from ofbiz
3) For online help it's necessary to be able to create link between screen and 
html anchor.
   In documentation generate from asciidoc, all title can be used.
   How to to say this screen should go to this documentation at this title.

I suppose content application, can help to solve this points.
I need some help from OFBiz-Content experts.

For point (1) I'm using jBake but maybe it's possible to do something similar 
with templating in Content
Who has some idea ?

For point (2) I suppose it's a "gradle configuration" and "content 
configuration"
Who has some idea ?

For point (3) the more simple solution is to add 1 (or 2) field in context 
which contain help_title,(help_documentation) and
so it will be simple to build the correct help link

Reply via email to