[
https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13499415#comment-13499415
]
Jacques Le Roux commented on OFBIZ-4941:
----------------------------------------
Tom,
I'm still not quite sure what you refer too by <<The docbook content files in
data/helpdata/docbookhelp/somecomponent/somecomponent.xml>>. Did you notice
that, in my last OFBIZ-4941.patch, I put the ASL2 header in all XML files under
applications\content\data\helpdata\docbookhelp?
So, with your LicenseFiles.zip, I think we have all the needed now in content
component. I will rebuild the webhelp and handle the rest (mostly in NOTICE
file) in a new, hopefully last, OFBIZ-4941.patch. Then I will ask the community
to review. I want to commit as is and to move later in a new webhelp
specialpurpose component.
I'm just a bit worried by this point from
http://www.apache.org/legal/src-headers.html#3party as I referred above (but
did not put the link in clear):
2. Do ensure that every third-party work includes its associated license, *even
if that requires adding a copy of the license from the third-party download
site into the distribution.
Actually this is not particularly related to webhelp (which have much less
files, pfew... still 293, but most are binaries) but Docboock in a whole. So my
question to the OFBiz team: do we really need to put the Webhelp license header
(see above) in every non modified files if it misses or is a reference enough
(like we have for webhelp in
applications\content\template\docbook\webhelp\LICENSE). Then if we miss that,
it begins to be ridiculous for files like
applications\content\template\docbook\webhelp\template\content\search\default.props...
> Proposal for a new help system
> ------------------------------
>
> Key: OFBIZ-4941
> URL: https://issues.apache.org/jira/browse/OFBIZ-4941
> Project: OFBiz
> Issue Type: Wish
> Components: ALL COMPONENTS
> Affects Versions: SVN trunk
> Reporter: Jacques Le Roux
> Assignee: Jacques Le Roux
> Priority: Minor
> Fix For: SVN trunk
>
> Attachments: content.7z, docbook diff.patch, docbook-xsl-1.77.1.zip,
> HelpAccounting.jpg, help_content.jpg, help_ofbizhelp.jpg, helppdf.zip,
> HelpPerformanceReview1.jpg, HelpPerformanceReview2.jpg, HelpRoadmap.jpg,
> help_webhlep.jpg, jh.jar, LicenseFiles.zip, LICENSE.html, OFBIZ-4941.patch,
> OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941.patch, OFBIZ-4941 POC HR
> Help.patch, WebhelpFiles.zip, WebhelpFiles.zip, WebhelpHRAppDocbook.zip,
> WebhelpHRAppDocbook.zip, webhelp.jpg
>
>
> Quoting Tom Burns at OFBIZ-4869
> {quote}
> This is a status update just to let anyone who is interested know that this
> item is being worked on.
> I started out using the OFBiz structure for help docs but after a while I
> needed/wanted something more expressive.
> Here is what I wound up using for development:
> Java Help System http://java.net/projects/javahelp/content
> DocBook 5: The Definitive Guide
> http://www.docbook.org/tdg5/en/html/docbook.html
> http://www.docbook.org/xml/5.0/
> DocBook XSL: The Complete Guide
> http://www.sagehill.net/docbookxsl/index.html
>
> http://sourceforge.net/projects/docbook/files/docbook-xsl/1.77.1/docbook-xsl-1.77.1.zip
> Help Master - FE for managing java help files. Best feature drag and drop
> TOC creates TOC matching file folder structure. Convenient launcher for
> viewing & testing. http://www.halogenware.com/software/helpmaster.html
> XML Mind XML Editor - Free Personal Edition is far better then editing in
> Eclipse. download from http://www.xmlmind.com/xmleditor/download.shtml
> Tutorial - DocBook editing with XML Mind XML Editor. Worth going through
> http://www.xmlmind.com/xmleditor/tutorial.html
> Read Me First style guide from Sun (cost from Amazon 1 cent + shipping)
> Attached are some screen shots of the results.
> Every screen is/will be documented in a similar structure. This is as much
> for defining requirements and testing as for help. More work but worth it.
> The screenshots show a Java Help format generated using DocBook XSL. This
> will likely not be the final presentation format.
> Note the Performance Review screen shots do not match the trunk. There is a
> bug in update screen and I did some clean up of labels and drop-down list.
> There are issues like this all through the application so I did not want to
> get bogged down with patches at this time.
> {quote}
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
