[
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
