Tom, Please keep your comments inside the Jira
Thanks Jacques Tom Burns wrote: > Anil, > ...option of help documents being hosted outside of business application.. > Have you looked at the other open source projects using webhelp? > > I discussed other deployment options in the OFBiz Help Spec.pdf in the > helppdf.zip file attached to 4941. > Please see the following and let me know if this addresses you concerns. > Copied here for convenience from OFBiz Help Spec.pdf . > ... > "OFBiz Help Deployment > Up until this point the focus has been on deploying webhelp as a vehicle for > context sensitive help. A > docbook xsl / webhelp solution is robust and flexible enough for the > deployment in multiple document help > sites that support large and complex software systems. > A good example is Rackspace. See http://docs.rackspace.com/api/ . The Getting > Started Guides, API > Developer Guides, Release Notes and other documentation use docbook webhelp > integrated with other > presentation technologies. > Another example is http://docs.openstack.org/ Administration guides. Each > guide is offered in online > webhelp and PDF generated from a single docbook source. > The site http://fusesource.com/products/fuse-esb-enterprise/#documentation is > another variation that uses > webhelp. Here the docbook transformations into three presentations: 1. > webhelp 2. PDF and 3. Epub are > clearly defined. > These notes on presentation are only suggestive of what could be done to > improve OFBiz help > presentation." > > > Tom > > > ________________________________ > From: Anil K Patel (JIRA) <j...@apache.org> > To: dev@ofbiz.apache.org > Sent: Saturday, November 17, 2012 9:50 AM > Subject: [jira] [Commented] (OFBIZ-4941) Proposal for a new help system > > > [ > https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13499442#comment-13499442 > ] > > Anil K Patel commented on OFBIZ-4941: > ------------------------------------- > > Current implementation and proposed help system have too many touch points > with framework and application. It will be nice if new > help implementation addressed this problem. If it did, we would also make > some more progress in community goal to shave some fat > from Ofbiz framework and applications. > > Both (the current implementation and proposed implementation) don't seem to > support for third party hosted help documents. I > personally like option of help documents being hosted outside of business > application. This option opens business opportunity for > content providers. > > The proposed solution can be much more easily changed such that, Help > documents are rendered by a Ofbiz Help webapplication. The > help document can be accessed using url > https://localhost:8443/ofbizhelp/OrderManager-FindOrder (or similar). This > will also mean > that Ofbiz Help will be a component that can exists in specialpurpose folder. > If we go this route all the End User help content > will live in OfbizHelp component and not in Content application. > > >> 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}
