[jira] [Commented] (OFBIZ-11693) Help system using asciidoc files

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

[jira] [Commented] (OFBIZ-11693) Help system using asciidoc files

Nicolas Malin (Jira)

    [ https://issues.apache.org/jira/browse/OFBIZ-11693?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17111069#comment-17111069 ]

Olivier Heintz commented on OFBIZ-11693:
----------------------------------------

[^OFBIZ-11693_0002-Documented-Migrate-AccountingHelData.xml-to-added-so.patch]

This patch contain: Migrate AccountingHelData.xml to added some <set field="helpAnchor" to the correct screens

Now in accounting component only asciidoc documents are used, help link area now link to userDocUri (ci.apache.org/projects/ofbiz/site/ofbizdoc as default value in general.property)

it's generate with git format-patch

Currently, ci.apache.org/projects/ofbiz/site/ofbizdoc is documentation generated with R17 release, so it not contain the last asciidoc help files migrated from docbook, but when there will be doc generate for trunk, it will be a good test for the new help link.

> Help system using asciidoc files
> --------------------------------
>
>                 Key: OFBIZ-11693
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-11693
>             Project: OFBiz
>          Issue Type: Improvement
>          Components: ALL COMPONENTS
>    Affects Versions: Trunk
>            Reporter: Olivier Heintz
>            Priority: Major
>              Labels: documentation, help, help-system
>         Attachments: OFBIZ-11693_0001-Improvement-Help-link-using-asciidoc-files-via-gener.patch, OFBIZ-11693_0002-Documented-Migrate-AccountingHelData.xml-to-added-so.patch
>
>
> a very simple solution which is a link to a documentation site.
> This solution use
>  1. at application level, a default proprety for documentation website uri
>  2. at the screen level
>  * it would be possible to give a other uri (for user documentation)
>  * if the anchor in the user documentation for this screen is put, the new help is used otherwise the older link is used



--
This message was sent by Atlassian Jira
(v8.3.4#803005)