[jira] [Created] (OFBIZ-4941) Proposal for a new help system
Locked
1 ...
45678
1 ...
45678
[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=13496897#comment-13496897 ] Jacques Le Roux commented on OFBIZ-4941: ---------------------------------------- Tom on dev ML {quote} 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 {quote} OK, so: * browserDetect.js: part of Docbook => already handled in OFBiz (maybe a line in NOTICE though) * ie.css and positioning.css: part of webhelp => remove the ASL2 headers and replace by Webhelp license header and a line in NOTICE * duplication not a worry, to be addressed later Tom on dev ML {quote} Jacques, We can generate ASL2 in the HTML. I'll upload new copies of the Docbook book files and webhelp modified files with the changes tomorrow. Did not mention before but stemmer.js files are part of webhelp. Tom {quote} * stemmer.js files: part of webhelp => Webhelp license header and a line in NOTICE * following [Treatment of Third-Party Works|http://www.apache.org/legal/src-headers.html#3party] and Webhelp License: <<Any stylesheet derived from this Software that is publicly distributed will be identified with a different name and the version strings in any derived Software will be changed so that no possibility of confusion between the derived package and this Software will exist.>>, we have **2 cases**: ** not stylesheet files and not modified stylesheet files => simply put the Webhelp license header, if it's missing ** modified stylesheet files => put the Webhelp license header, if it's missing + change the name and version strings [Webhelp license header|http://docbook.sourceforge.net/release/xsl/1.76.1/webhelp/docs/content/index.html]: ---- Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. * Except as contained in this notice, the names of individuals credited with contribution to this software shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Software without prior written authorization from the individuals in question. * **Any stylesheet derived from this Software that is publicly distributed will be identified with a different name and the version strings in any derived Software will be changed so that no possibility of confusion between the derived package and this Software will exist.*** Warranty: THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL DAVID CRAMER, KASUN GAJASINGHE, OR ANY OTHER CONTRIBUTOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ---- * jQuery: not a problem already handled in OFBiz * DITA plugin: add a line in NOTICE * Stemmers, ok see above * Apache Lucene: not a problem already handled in OFBiz > 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 |
[jira] [Comment Edited] (OFBIZ-4941) Proposal for a new help system
|
|
In reply to this post by Nicolas Malin (Jira)
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13496897#comment-13496897 ] Jacques Le Roux edited comment on OFBIZ-4941 at 11/14/12 6:30 AM: ------------------------------------------------------------------ == TYPO == Tom on dev ML {quote} 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 {quote} OK, so: * browserDetect.js: part of Docbook => already handled in OFBiz (maybe a line in NOTICE though) * ie.css and positioning.css: part of webhelp => remove the ASL2 headers and replace by Webhelp license header and a line in NOTICE * duplication not a worry, to be addressed later Tom on dev ML {quote} Jacques, We can generate ASL2 in the HTML. I'll upload new copies of the Docbook book files and webhelp modified files with the changes tomorrow. Did not mention before but stemmer.js files are part of webhelp. Tom {quote} * stemmer.js files: part of webhelp => Webhelp license header and a line in NOTICE * following [Treatment of Third-Party Works|http://www.apache.org/legal/src-headers.html#3party] and Webhelp License: <<Any stylesheet derived from this Software that is publicly distributed will be identified with a different name and the version strings in any derived Software will be changed so that no possibility of confusion between the derived package and this Software will exist.>>, we have *2 cases*: ** not stylesheet files and not modified stylesheet files => simply put the Webhelp license header, if it's missing ** modified stylesheet files => put the Webhelp license header, if it's missing + change the name and version strings [Webhelp license header|http://docbook.sourceforge.net/release/xsl/1.76.1/webhelp/docs/content/index.html]: ---- Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. * Except as contained in this notice, the names of individuals credited with contribution to this software shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Software without prior written authorization from the individuals in question. * **Any stylesheet derived from this Software that is publicly distributed will be identified with a different name and the version strings in any derived Software will be changed so that no possibility of confusion between the derived package and this Software will exist.*** Warranty: THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL DAVID CRAMER, KASUN GAJASINGHE, OR ANY OTHER CONTRIBUTOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ---- * jQuery: not a problem already handled in OFBiz * DITA plugin: add a line in NOTICE * Stemmers, ok see above * Apache Lucene: not a problem already handled in OFBiz was (Author: jacques.le.roux): Tom on dev ML {quote} 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 {quote} OK, so: * browserDetect.js: part of Docbook => already handled in OFBiz (maybe a line in NOTICE though) * ie.css and positioning.css: part of webhelp => remove the ASL2 headers and replace by Webhelp license header and a line in NOTICE * duplication not a worry, to be addressed later Tom on dev ML {quote} Jacques, We can generate ASL2 in the HTML. I'll upload new copies of the Docbook book files and webhelp modified files with the changes tomorrow. Did not mention before but stemmer.js files are part of webhelp. Tom {quote} * stemmer.js files: part of webhelp => Webhelp license header and a line in NOTICE * following [Treatment of Third-Party Works|http://www.apache.org/legal/src-headers.html#3party] and Webhelp License: <<Any stylesheet derived from this Software that is publicly distributed will be identified with a different name and the version strings in any derived Software will be changed so that no possibility of confusion between the derived package and this Software will exist.>>, we have **2 cases**: ** not stylesheet files and not modified stylesheet files => simply put the Webhelp license header, if it's missing ** modified stylesheet files => put the Webhelp license header, if it's missing + change the name and version strings [Webhelp license header|http://docbook.sourceforge.net/release/xsl/1.76.1/webhelp/docs/content/index.html]: ---- Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. * Except as contained in this notice, the names of individuals credited with contribution to this software shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Software without prior written authorization from the individuals in question. * **Any stylesheet derived from this Software that is publicly distributed will be identified with a different name and the version strings in any derived Software will be changed so that no possibility of confusion between the derived package and this Software will exist.*** Warranty: THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL DAVID CRAMER, KASUN GAJASINGHE, OR ANY OTHER CONTRIBUTOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ---- * jQuery: not a problem already handled in OFBiz * DITA plugin: add a line in NOTICE * Stemmers, ok see above * Apache Lucene: not a problem already handled in OFBiz > 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 |
[jira] [Updated] (OFBIZ-4941) Proposal for a new help system
|
|
In reply to this post by Nicolas Malin (Jira)
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Tom Burns updated OFBIZ-4941: ----------------------------- Attachment: LicenseFiles.zip Jacques, The attached zip contains webhelp files that were modified for OFBiz. The names of the modified files have been changed to comply with the webhelp license and include ASL2. The original unmodified webhelp files are also included as a convenience. They should be included in the OFBiz distribution of webhelp. The file ofbiz-common.xsl contains a customization to include ASL2 in compiled HTML files. Updates to ASL can be made in this file. Help files will have to be re-compiled to include ASL2. Tom > 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 |
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
|
|
In reply to this post by Nicolas Malin (Jira)
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13497143#comment-13497143 ] Tom Burns commented on OFBIZ-4941: ---------------------------------- Jacques, I can't get to it today but I want to give you update Docbook content files that will include ASF2 in the content and additional book info section to track revisions and versions. Tomorrow... Tom > 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 |
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
|
|
In reply to this post by Nicolas Malin (Jira)
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13497513#comment-13497513 ] Jacques Le Roux commented on OFBIZ-4941: ---------------------------------------- Tom, I did not review yet, sounds good. > 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 |
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
|
|
In reply to this post by Nicolas Malin (Jira)
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13497543#comment-13497543 ] Tom Burns commented on OFBIZ-4941: ---------------------------------- Jacques, I am not going to add ASF2 and revision tags to the Docbook content files at this time. I was not happy with the way the tags rendered and there were significant differences between the renderings in webhelp and PDF. Maybe I'll do it Phase 2. I think you have everything you need for now. If not let me know. Cheers, Tom > 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 |
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
|
|
In reply to this post by Nicolas Malin (Jira)
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13497818#comment-13497818 ] Jacques Le Roux commented on OFBIZ-4941: ---------------------------------------- Tom, Could you please refer to a path for what you call "Docbook content files"? I guess it's the HTML generated file? Why PDF? > 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 |
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
|
|
In reply to this post by Nicolas Malin (Jira)
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13497887#comment-13497887 ] Tom Burns commented on OFBIZ-4941: ---------------------------------- Jacques, The docbook content files in data/helpdata/docbookhelp/somecomponent/somecomponent.xml The docbook separates content from presentation. Having PDF output as an alternate presentation allows off line review by stakeholders. There are examples of webhelp / pdf presentation at: http://docs.rackspace.com/servers/api/v2/cs-gettingstarted/content/overview.html http://docs.openstack.org/ http://docs.rackspace.com/api/ I should not have brought it up here, it's not a requirement in the use cases (helppdf.zip that were attached). Tom > 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 |
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
|
|
In reply to this post by Nicolas Malin (Jira)
[ 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 |
[jira] [Comment Edited] (OFBIZ-4941) Proposal for a new help system
|
|
In reply to this post by Nicolas Malin (Jira)
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13499415#comment-13499415 ] Jacques Le Roux edited comment on OFBIZ-4941 at 11/17/12 1:13 PM: ------------------------------------------------------------------ == MISSED AN ENDING * FOR BOLD (actually removed stupidely while reviewing, doh) == 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... was (Author: jacques.le.roux): 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 |
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
|
|
In reply to this post by Nicolas Malin (Jira)
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13499441#comment-13499441 ] Tom Burns commented on OFBIZ-4941: ---------------------------------- Jacques, 1. Sorry to confuse you with the term content files. I was only referring to the Docbook book files under applications/content/data/helpdata/docbookhelp like accounting_en/accounting.xml. e.g. somecomponent (accounting) somecomponent.xml (accounting.xml). 2. The docbook folder (\applications\content\template\docbook) is not new to OFBiz. The files that were replaced all had their origin in the docbook xsl distribution so I did not expect this to be an issue. Have you seen http://wiki.docbook.org/DocBookLicense 3. I still do not understand the desire to move to specialpurpose. I will need clarification of the requirements and desired deployment of the webhelp artifacts. Will docbook stay in content? Are the "content files" to go to specialpurpose? Is it being moved there to prepare for Slim Down? As soon as you release the next patch I'll apply it to a clean trunk for a smoke test and let you know if I see any issues. The last patch only included the catalog_en webapp and it did not render correctly. Cheers, Tom > 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 |
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
|
|
In reply to this post by Nicolas Malin (Jira)
[ 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} -- 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 |
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
|
|
In reply to this post by Nicolas Malin (Jira)
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13499443#comment-13499443 ] Jacques Le Roux commented on OFBIZ-4941: ---------------------------------------- OK, no worries, Jacopo clarified: I will just put their license in the LICENSE file at root of OFBiz project. > 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 |
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
|
|
In reply to this post by Nicolas Malin (Jira)
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13499446#comment-13499446 ] Jacques Le Roux commented on OFBIZ-4941: ---------------------------------------- Thanks for feedback Anil, >Current implementation and proposed help system have too many touch points with framework and application Could you elaborate, give details and examples of the issues you see? >The proposed solution can be much more easily changed such that, Help documents are rendered by a Ofbiz Help webapplication. How do you envision that technically? It seems to me you just add a new requirement, that I like but I'm not sure the new implementation can *easily* change for that. > 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 |
|
|
In reply to this post by Nicolas Malin (Jira)
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) <[hidden email]> To: [hidden email] 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} -- 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 |
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
|
|
In reply to this post by Nicolas Malin (Jira)
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13499447#comment-13499447 ] Jacques Le Roux commented on OFBIZ-4941: ---------------------------------------- Tom, I think you 3 points are clarified now, or rather the 3rd will hopefully be with the help of the community. I also hope that it will not be a no-no from the community if, in a 1st phase, we can't get it to work as the community would like to have it. This has already required some work, and being stopped at this stage would not be fair. On the other hand, it would be certainly better to have it the way the community envisions it before committing, but that requires more than comments or black-hat answers! > 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 |
Re: [jira] [Commented] (OFBIZ-4941) Proposal for a new help system
Administrator
|
In reply to this post by Tom
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) <[hidden email]> > To: [hidden email] > 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} |
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
|
|
In reply to this post by Nicolas Malin (Jira)
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13499451#comment-13499451 ] Tom Burns commented on OFBIZ-4941: ---------------------------------- 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. 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 > 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 |
[jira] [Updated] (OFBIZ-4941) Proposal for a new help system
|
|
In reply to this post by Nicolas Malin (Jira)
[ 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 Tom, >The last patch only included the catalog_en webapp and it did not render correctly I just created a new complete patch (tested succesfully) but it's too large (25MB) for ASF Jira which allows only 10MB. So I cleaned all generated file but catalog_en in the new attached patch. It's normal that by applying this and previous patch you don't get it working: it does not contains the binary files (images, etc.) Please check that I have not forgotten anything, thanks! > 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.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 |
[jira] [Commented] (OFBIZ-4941) Proposal for a new help system
|
|
In reply to this post by Nicolas Malin (Jira)
[ https://issues.apache.org/jira/browse/OFBIZ-4941?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13499536#comment-13499536 ] Tom Burns commented on OFBIZ-4941: ---------------------------------- Jacques, Testing using latest trunk - 1. Copied missing image files to docbookhelp image folders 2. Built acounting webhelp web apps Build failed - applications/content/template/docbook/webhelp/saxon.jar was missing 3. Built acounting webhelp web apps 4. Build success 5. Opened app from file system 6. App missing logo 7. Added applications/content/template/docbook/webhelp/template/common/images/logo.gif 8. Built acounting webhelp web app 9. Opened app from file system 10. App performed and displayed as expected 11. Ran OFBiz 12. Invoked Accounting app and help - pass 13. Invoked Facility app and help - Expected Facility help in legacy help - Acutal BIRT Help I will have to complete testing tomorrow. Just wanted to let you know what was happening. Should have be able to resolve everything in the morning. Tom > 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.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 |
«
Return to OFBiz - Dev
|
1 view|%1 views
| Free forum by Nabble | Edit this page |