Jacques, I don't what to say about browserDetect.js, other then that it is part of the webhelp component inside of the docbook-xsl-1.77.1.zip distribution which has hundreds of files.
The ie.css and positioning.css are webhelp files that I modified. Re: ...avoid to create copies when creating the help with the webhelp.* ant targets... If you are talking about the duplication of code in the build.xml for each web app than I agree, it's ugly. I tried various ant techniques to parametrize the code but could not come up with a satisfactory solution. I went with brute force duplication because it worked and I wanted to move on. I'll try to improve the build file in Phase II (documentation for help system and remaining legacy apps) applications/content/template/docbook/webhelp/docs/... is from the webhelp distribution and should be unchanged. Re: ASL2 in generated files: In http://www.apache.org/dev/apply-license.html#license-include there is a line: "Should the license be included in source files for documentation (e.g. XML that is transformed to HTML)? Yes. See the policy for more details." I did not find any details in the policy that address this case.We can (and should) put a copyright notice in the the docbook file, which is a single file, using the docbook copyright tag. The files get chunked, do we really need a notice in each file since they are viewed as a whole? If we do then we need a extension someplace in the xsl to insert ASL2. I'll have a look and let you know if it's doable. I would not spend time manually inserting the header into the HTML. Note that the transformations of the "Apache OFBiz official documentation." do not include any copyright. (I fixed some errors in the docbook files and transformed them, outside of OFBiz, to PDF for validation. The resulting PDF does not have an copyright notice. There is still a problem in the java code, I will post the issue to JIRA when I have a solution.) Tom ________________________________ From: Jacques Le Roux (JIRA) <[email protected]> To: [email protected] Sent: Tuesday, November 13, 2012 3:01 AM Subject: [jira] [Updated] (OFBIZ-4941) Proposal for a new help system [ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Jacques Le Roux updated OFBIZ-4941: ----------------------------------- Attachment: OFBIZ-4941.patch Adds missing ASL2 headers where required. Doing so I stumbled upon browserDetect.js Not sure what to do with it (no license see http://www.quirksmode.org/about/copyright.html) I guess we can use it safely and I will simply put a line in NOTICE file. Tom, for ie.css and positioning.css I added the ASL2 header for files under applications/content/template/docbook/webhelp/template/common/css (I guess there are yours, right?). Can't we avoid to create copies when creating the help with the webhelp.* ant targets? Also why are there duplicates in applications/content/template/docbook/webhelp/docs/common/css (maybe an error of mine when copying ;o)? Also if we deliver OFBiz OOTB with the help deployed we need to put ASL2 headers in all generated HTML files, this begins to be tedious :/ *stemmer.js files are part of webhelp, right? (http://tartarus.org/~martin/PorterStemmer/ => BSD License. => put in NOTICE) > 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, 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
