Redesign of Docbooks in ofbiz

[BJ Freeman]

currently HelpTemplate.ftl will only work with sections and does not
support other elemments as called out in
http://www.docbook.org/tdg5/en/html/pt02.html, such as tip, warings,
info boxes.
It also does not support using the id tag for anchors.

the docbook structure is
Sets
Books
Divisions, which divide books
Components, which divide books or divisions
Sections, which subdivide components
Meta-information elements
Block elements
Inline elements

I am working to make the (ofbizcomponent)/documents have books, with the
sets being called out in the applications/commonext/documents
The (ofbizcomponent)Helpdata/ have top level have Divisions, like the
main that would be accessed when at the top level UI for a ofbizcomponent.
this would include all the lower help files.
The help files would have links to the ofbiz UI page that it talks about
so we have two help. you can go to page and help or you can use the
/cmssite/cms/APACHE_OFBIZ_HTML and go to a function you want.

Each UI page would be a division, and sub menus on the page would be
sections with the id tag for anchors. when a menu is in another compoent
is link, since using a include makes it dependent on location.

I have introduced TECH_ in the (ofbizcomponent)Helpdata/.
This allows information important to a developer but not of use to an
end user like the current
https://demo-trunk.ofbiz.apache.org/projectmgr/control/main Help.

lastly I propose changing the defualt message :
"If you arrived at this page without selecting the index, then a
specific help page was not yet available

This system will provide you context sensitive help throughout the system. "
to add a comment about helping put the documents in ofbiz with a link to
docbook references in /cmssite/cms/APACHE_OFBIZ_HTML#docbook

any thoughts on why this would not work, or a better way to approach this

=========================

BJ Freeman
Strategic Power Office with Supplier Automation  <http://www.businessesnetwork.com/automation/viewforum.php?f=52>
Specialtymarket.com  <http://www.specialtymarket.com/>
Systems Integrator-- Glad to Assist

Chat  Y! messenger: bjfr33man

[BJ Freeman]

forgot would add build scripts target to put the helpfiles shells and
append the (componentname)HelpData.xml

=========================
BJ Freeman
Strategic Power Office with Supplier Automation  <http://www.businessesnetwork.com/automation/viewforum.php?f=52>
Specialtymarket.com  <http://www.specialtymarket.com/>
Systems Integrator-- Glad to Assist

Chat  Y! messenger: bjfr33man


BJ Freeman sent the following on 2/14/2011 7:59 PM:

> currently HelpTemplate.ftl will only work with sections and does not
> support other elemments as called out in
> http://www.docbook.org/tdg5/en/html/pt02.html, such as tip, warings,
> info boxes.
> It also does not support using the id tag for anchors.
>
> the docbook structure is
> Sets
> Books
> Divisions, which divide books
> Components, which divide books or divisions
> Sections, which subdivide components
> Meta-information elements
> Block elements
> Inline elements
>
> I am working to make the (ofbizcomponent)/documents have books, with the
> sets being called out in the applications/commonext/documents
> The (ofbizcomponent)Helpdata/ have top level have Divisions, like the
> main that would be accessed when at the top level UI for a ofbizcomponent.
> this would include all the lower help files.
> The help files would have links to the ofbiz UI page that it talks about
> so we have two help. you can go to page and help or you can use the
> /cmssite/cms/APACHE_OFBIZ_HTML and go to a function you want.
>
> Each UI page would be a division, and sub menus on the page would be
> sections with the id tag for anchors. when a menu is in another compoent
> is link, since using a include makes it dependent on location.
>
> I have introduced TECH_ in the (ofbizcomponent)Helpdata/.
> This allows information important to a developer but not of use to an
> end user like the current
> https://demo-trunk.ofbiz.apache.org/projectmgr/control/main Help.
>
> lastly I propose changing the defualt message :
> "If you arrived at this page without selecting the index, then a
> specific help page was not yet available
>
> This system will provide you context sensitive help throughout the
> system. "
> to add a comment about helping put the documents in ofbiz with a link to
> docbook references in /cmssite/cms/APACHE_OFBIZ_HTML#docbook
>
> any thoughts on why this would not work, or a better way to approach this
>
> =========================
>
> BJ Freeman
> Strategic Power Office with Supplier Automation
> <http://www.businessesnetwork.com/automation/viewforum.php?f=52>
> Specialtymarket.com <http://www.specialtymarket.com/>
> Systems Integrator-- Glad to Assist
>
> Chat Y! messenger: bjfr33man
>
>