[
https://issues.apache.org/jira/browse/OFBIZ-6450?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14575831#comment-14575831
]
Sharan Foga commented on OFBIZ-6450:
------------------------------------
Hi Taher
I've been looking at the help and all the component documentation help files
seem to use the docbook section (recursive section) tag. I can't find any
chapter tags or even the book tag in any of the files I've looked at. There
must be a book tag somewhere!
When I was doing the HR documentation – (from the Webhelp addon) it had been
written as a complete docbook book with chapters, sect1, sect2 etc.
- I had tried to copy it into the HELP_HR.xml and it didnt work (i.e wouldnt
display)
- I also tried to copy some of the sect1 and sect2 and that didnt work either
(i.e wouldnt display)
I think these could be explained by not being allowed to nest any chapters or
sect1 and sect2 tags into a section tag.
- I also tried to use some of the text formatting commands just as a line
somewhere within the section
eg. <para><emphasis role="bold"> Nodes In the Company Tree</emphasis></para>
but this didnt work either. The text was displayed but it wasn't displayed in
bold.
I also tried some of the <mediaobject> and <screenshot> tags and they didnt
work either.
The only tags that seem to work within a section tag are the following:
<title>
<para>
<itemizedlist>
If I had to guess I would say that it sounds like our docbook structure is
built only on recursive section tags which could explain the limitations I've
experienced.
> Docbook and OFBIz Online Help
> -----------------------------
>
> Key: OFBIZ-6450
> URL: https://issues.apache.org/jira/browse/OFBIZ-6450
> Project: OFBiz
> Issue Type: Bug
> Reporter: Sharan Foga
>
> Jira created based on the steps suggested by Taher as follows:
> - First, we attempt to fix whatever is wrong in DocBook at the moment. If you
> can share exactly what you spotted then this would save us a lot of time in
> trying to dig to the problem. So a repeat process to identify the bugs from
> you would be great.
> - Second, we decide on a category structure for the sections of the
> documentation if we do not like the existing one
> - We also introduce or enforce a workflow that mandates an update of the
> documentation on each JIRA that affects functionality that requires
> documentation. For example, if we add or modify a screen in the party
> component, then we must provide the documentation for that screen before
> closing the JIRA for example.
> - As a last step we decide on the appropriate technology to move forward.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
