You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ofbiz.apache.org by ha...@apache.org on 2009/08/18 12:01:46 UTC

svn commit: r805338 [1/3] - in /ofbiz/trunk/applications: accounting/data/ accounting/data/helpdata/ content/ content/data/ content/data/helpdata/ content/dtd/ content/entitydef/ content/src/org/ofbiz/content/content/ content/widget/content/ product/da...

Author: hansbak
Date: Tue Aug 18 10:01:45 2009
New Revision: 805338

URL: http://svn.apache.org/viewvc?rev=805338&view=rev
Log:
extended the help template, moved help xmlfiles for easy editing into the file system, started to look at docbook for ofbiz documents

Added:
    ofbiz/trunk/applications/accounting/data/helpdata/
    ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING.xml   (with props)
    ofbiz/trunk/applications/content/data/helpdata/
    ofbiz/trunk/applications/content/data/helpdata/HELP_CONTENT.xml   (with props)
    ofbiz/trunk/applications/content/data/helpdata/HELP_ROOT.xml   (with props)
    ofbiz/trunk/applications/content/data/helpdata/HELP_ROOT_NL.xml   (with props)
    ofbiz/trunk/applications/content/dtd/docbook.xsd   (with props)
    ofbiz/trunk/applications/content/dtd/xlink.xsd   (with props)
    ofbiz/trunk/applications/content/dtd/xml.xsd   (with props)
    ofbiz/trunk/applications/product/data/helpdata/
    ofbiz/trunk/applications/product/data/helpdata/HELP_PRODUCT.xml   (with props)
Modified:
    ofbiz/trunk/applications/accounting/data/AccountingHelpData.xml
    ofbiz/trunk/applications/content/data/ContentHelpData.xml
    ofbiz/trunk/applications/content/data/TemplateData.xml
    ofbiz/trunk/applications/content/entitydef/entitymodel.xml
    ofbiz/trunk/applications/content/ofbiz-component.xml
    ofbiz/trunk/applications/content/src/org/ofbiz/content/content/ContentWorker.java
    ofbiz/trunk/applications/content/widget/content/ContentForms.xml
    ofbiz/trunk/applications/product/data/ProductHelpData.xml

Modified: ofbiz/trunk/applications/accounting/data/AccountingHelpData.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/accounting/data/AccountingHelpData.xml?rev=805338&r1=805337&r2=805338&view=diff
==============================================================================
--- ofbiz/trunk/applications/accounting/data/AccountingHelpData.xml (original)
+++ ofbiz/trunk/applications/accounting/data/AccountingHelpData.xml Tue Aug 18 10:01:45 2009
@@ -18,25 +18,7 @@
 under the License.
 -->
 <entity-engine-xml>
-    <!-- =======Help===========  -->
-    <DataResource dataResourceId="HELP_ACCOUNTING" localeString="en" dataResourceTypeId="ELECTRONIC_TEXT" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS" dataResourceName="Accounting Manager Help" mimeTypeId="text/xml" isPublic="Y" />
-    <ElectronicText dataResourceId="HELP_ACCOUNTING">
-        <textData><![CDATA[
-            <root>
-                <generalTitle>
-                    The Accounting Manager.
-                </generalTitle>
-                <general>
-                <section>
-                  <text>
-                    The Accounting Manager keeps track of financial charges, credit card processes, and receipts of payment. 
-                    The link from the Order Manager to the Accounting Manager is the Invoice Number, generated when the Order is processed.
-                    </text>
-                  </section>
-                </general>
-            </root>
-        ]]></textData>
-    </ElectronicText>
+    <DataResource dataResourceId="HELP_ACCOUNTING" localeString="en" dataResourceTypeId="OFBIZ_FILE" objectInfo="applications/accounting/data/helpdata/HELP_ACCOUNTING.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS" dataResourceName="Accounting Help" mimeTypeId="text/xml" isPublic="Y" />
     <Content contentId="HELP_ACCOUNTING" contentTypeId="DOCUMENT" contentName="Accounting Help" templateDataResourceId="HELP_TEMPL" dataResourceId="HELP_ACCOUNTING" statusId="CTNT_IN_PROGRESS" mimeTypeId="text/html"/>/>
     <ContentAssoc contentId="HELP_ROOT" contentIdTo="HELP_ACCOUNTING" contentAssocTypeId="TREE_CHILD" fromDate="2006-01-12 01:01:01" sequenceNum="000"/>
 </entity-engine-xml>

Added: ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING.xml?rev=805338&view=auto
==============================================================================
--- ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING.xml (added)
+++ ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING.xml Tue Aug 18 10:01:45 2009
@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+    Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+    
+    http://www.apache.org/licenses/LICENSE-2.0
+    
+    Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+-->
+<root>
+    <generalTitle>
+        The Content Manager.
+    </generalTitle>
+    <general>
+        <section>
+            <text>The Content Management System (CMS) is designed to store data once and then allow it to be reused in multiple arrangements.</text>
+        </section>
+    </general>
+</root>
+

Propchange: ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING.xml
------------------------------------------------------------------------------
    svn:keywords = "Date Rev Author URL Id"

Propchange: ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING.xml
------------------------------------------------------------------------------
    svn:mime-type = text/xml

Modified: ofbiz/trunk/applications/content/data/ContentHelpData.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/content/data/ContentHelpData.xml?rev=805338&r1=805337&r2=805338&view=diff
==============================================================================
--- ofbiz/trunk/applications/content/data/ContentHelpData.xml (original)
+++ ofbiz/trunk/applications/content/data/ContentHelpData.xml Tue Aug 18 10:01:45 2009
@@ -18,48 +18,19 @@
 under the License.
 -->
 <entity-engine-xml>
+    <!-- system document root used in content -> navigate -->
     <Content contentId="TREE_ROOT" contentTypeId="DOCUMENT" contentName="ROOT" dataResourceId=""/>
+    <!-- show help on the system document root -->
     <ContentAssoc contentId="TREE_ROOT" contentIdTo="HELP_ROOT" contentAssocTypeId="TREE_CHILD" fromDate="2006-01-12 01:01:01"/>
-    <!-- =======General Help===========  -->
-    <DataResource dataResourceId="HELP_ROOT" localeString="en" dataResourceTypeId="ELECTRONIC_TEXT" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS" dataResourceName="Help system root" mimeTypeId="text/xml" isPublic="Y" />
-    <ElectronicText dataResourceId="HELP_ROOT">
-        <textData><![CDATA[
-            <root>
-                <generalTitle>
-                    Welcome to the Apache OFBiz help system
-                </generalTitle>
-                <general>
-                    <section>
-                        <text>If you arrived at this page without selecting the index, then a specific help page was not yet available</text>
-                    </section>
-                    <section>
-                        <text>This system will provide you context sensitive help throughout the system.</text>
-                    </section>
-                    <section>
-                        <text>For more info on the help system itself check the </text>
-                    </section>
-                </general>
-            </root>
-        ]]></textData>
-    </ElectronicText>
-    <Content contentId="HELP_ROOT" contentTypeId="DOCUMENT" templateDataResourceId="HELP_TEMPL" dataResourceId="HELP_ROOT" statusId="CTNT_IN_PROGRESS" contentName="Help system root" mimeTypeId="text/html"/>
-
+    <DataResource dataResourceId="HELP_ROOT" localeString="en" dataResourceTypeId="OFBIZ_FILE" objectInfo="applications/content/data/helpdata/HELP_ROOT.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS" dataResourceName="Help system root" mimeTypeId="text/xml" isPublic="Y" />
+    <Content contentId="HELP_ROOT" contentTypeId="DOCUMENT" templateDataResourceId="HELP_TEMPL" dataResourceId="HELP_ROOT" localeString="en" statusId="CTNT_IN_PROGRESS" contentName="Help system root" mimeTypeId="text/html"/>
+    <DataResource dataResourceId="HELP_ROOT_NL" localeString="nl" dataResourceTypeId="OFBIZ_FILE" objectInfo="applications/content/data/helpdata/HELP_ROOT_NL.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS" dataResourceName="Help system root" mimeTypeId="text/xml" isPublic="Y" />
+    <!-- how to create alternative locales -->
+    <Content contentId="HELP_ROOT_NL" contentTypeId="DOCUMENT" templateDataResourceId="HELP_TEMPL" dataResourceId="HELP_ROOT_NL" localeString="nl" statusId="CTNT_IN_PROGRESS" contentName="Help system root in dutch" mimeTypeId="text/html"/>
+    <ContentAssoc contentId="HELP_ROOT" contentIdTo="HELP_ROOT_NL" contentAssocTypeId="ALTERNATE_LOCALE" fromDate="2006-01-12 01:01:01"/>
+    
     <!-- Content specific -->
-    <DataResource dataResourceId="HELP_CONTENT" localeString="en" dataResourceTypeId="ELECTRONIC_TEXT" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS" dataResourceName="Content Manager Help" mimeTypeId="text/xml" isPublic="Y" />
-    <ElectronicText dataResourceId="HELP_CONTENT">
-        <textData><![CDATA[
-            <root>
-                <generalTitle>
-                    The Content Manager.
-                </generalTitle>
-                <general>
-                  <section>
-                    <text>The Content Management System (CMS) is designed to store data once and then allow it to be reused in multiple arrangements.</text>
-                    </section>
-                </general>
-            </root>
-        ]]></textData>
-    </ElectronicText>
+    <DataResource dataResourceId="HELP_CONTENT" localeString="en" dataResourceTypeId="OFBIZ_FILE" objectInfo="applications/content/data/helpdata/HELP_CONTENT.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS" dataResourceName="Content Manager Help" mimeTypeId="text/xml" isPublic="Y" />
     <Content contentId="HELP_CONTENT" contentTypeId="DOCUMENT" contentName="Content Manager Help" templateDataResourceId="HELP_TEMPL" dataResourceId="HELP_CONTENT" statusId="CTNT_IN_PROGRESS" mimeTypeId="text/html"/>/>
     <ContentAssoc contentId="HELP_ROOT" contentIdTo="HELP_CONTENT" contentAssocTypeId="TREE_CHILD" fromDate="2006-01-12 01:01:01" sequenceNum="050"/>
 </entity-engine-xml>

Modified: ofbiz/trunk/applications/content/data/TemplateData.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/content/data/TemplateData.xml?rev=805338&r1=805337&r2=805338&view=diff
==============================================================================
--- ofbiz/trunk/applications/content/data/TemplateData.xml (original)
+++ ofbiz/trunk/applications/content/data/TemplateData.xml Tue Aug 18 10:01:45 2009
@@ -468,7 +468,32 @@
 <DataResource dataResourceId="HELP_TEMPL" dataResourceTypeId="ELECTRONIC_TEXT" dataTemplateTypeId="FTL" statusId="CTNT_IN_PROGRESS" dataResourceName="Help template file" mimeTypeId="text/html" isPublic="Y"/>
 <ElectronicText dataResourceId="HELP_TEMPL">
         <textData><![CDATA[
-<#if layoutSettings.VT_NAME[0] == "FLAT_GREY">          
+<#if layoutSettings.VT_NAME[0] == "FLAT_GREY">
+<#--import applications/content/template/documentLib.ftl as doc/-->
+<#macro link text url>
+  <a href="${url}">${text}</a>
+</#macro>
+
+<#macro text section>
+  <#list section.* as t>
+    <#if t?node_name == "text">
+      ${t}
+    <#elseif t?node_name == "link">
+      <a href="${t.@url}">${t}</a>
+    <#elseif t?node_name == "b">
+      <b>${t}</b>
+    <#elseif t?node_name == "ol">
+      <ol>
+      <#list t.* as i>
+        <li class=h2>${i}</li>
+      </#list>
+      </ol><br/>
+    </#if>
+  </#list>
+  <br/>
+</#macro>
+
+
 <div class="contentarea">
   <div id="column-container">
     <div id="content-main-section">
@@ -490,7 +515,7 @@
           <#if doc.root.general?has_content> 
             <h1>${doc.root.generalTitle?if_exists}</h1>
             <#list doc.root.general.section as section>
-              <p class=h2>${section.text}</p>
+              <p class=h2><@text section/></p>
             </#list>
           </#if>
           

Added: ofbiz/trunk/applications/content/data/helpdata/HELP_CONTENT.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/content/data/helpdata/HELP_CONTENT.xml?rev=805338&view=auto
==============================================================================
--- ofbiz/trunk/applications/content/data/helpdata/HELP_CONTENT.xml (added)
+++ ofbiz/trunk/applications/content/data/helpdata/HELP_CONTENT.xml Tue Aug 18 10:01:45 2009
@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+    Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+    
+    http://www.apache.org/licenses/LICENSE-2.0
+    
+    Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+-->
+<root>
+    <generalTitle>
+        The Content Manager.
+    </generalTitle>
+    <general>
+        <section>
+            <text>The Content Management System (CMS) is designed to store data once and then allow it to be reused in multiple arrangements.</text>
+        </section>
+    </general>
+</root>

Propchange: ofbiz/trunk/applications/content/data/helpdata/HELP_CONTENT.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: ofbiz/trunk/applications/content/data/helpdata/HELP_CONTENT.xml
------------------------------------------------------------------------------
    svn:keywords = "Date Rev Author URL Id"

Propchange: ofbiz/trunk/applications/content/data/helpdata/HELP_CONTENT.xml
------------------------------------------------------------------------------
    svn:mime-type = text/xml

Added: ofbiz/trunk/applications/content/data/helpdata/HELP_ROOT.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/content/data/helpdata/HELP_ROOT.xml?rev=805338&view=auto
==============================================================================
--- ofbiz/trunk/applications/content/data/helpdata/HELP_ROOT.xml (added)
+++ ofbiz/trunk/applications/content/data/helpdata/HELP_ROOT.xml Tue Aug 18 10:01:45 2009
@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+    Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+    
+    http://www.apache.org/licenses/LICENSE-2.0
+    
+    Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+-->
+<root>
+    <generalTitle>
+        Welcome to the Apache OFBiz help system
+    </generalTitle>
+    <general>
+        <section>
+            <text>If you arrived at this page </text><b>without</b><text> selecting the index, then a specific help page was </text><b>not</b><text> yet available</text>
+        </section>
+        <section>
+            <text>This system will provide you context sensitive help throughout the system.</text>
+        </section>
+    </general>
+</root>
+

Propchange: ofbiz/trunk/applications/content/data/helpdata/HELP_ROOT.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: ofbiz/trunk/applications/content/data/helpdata/HELP_ROOT.xml
------------------------------------------------------------------------------
    svn:keywords = "Date Rev Author URL Id"

Propchange: ofbiz/trunk/applications/content/data/helpdata/HELP_ROOT.xml
------------------------------------------------------------------------------
    svn:mime-type = text/xml

Added: ofbiz/trunk/applications/content/data/helpdata/HELP_ROOT_NL.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/content/data/helpdata/HELP_ROOT_NL.xml?rev=805338&view=auto
==============================================================================
--- ofbiz/trunk/applications/content/data/helpdata/HELP_ROOT_NL.xml (added)
+++ ofbiz/trunk/applications/content/data/helpdata/HELP_ROOT_NL.xml Tue Aug 18 10:01:45 2009
@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+    Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+    
+    http://www.apache.org/licenses/LICENSE-2.0
+    
+    Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+-->
+<root>
+    <generalTitle>
+        Welkom in het Apache OFBiz help systeem.
+    </generalTitle>
+    <general>
+        <section>
+            <text>Als je op deze pagina beland zonder de index geselecteerd te hebben,wordt veroorzaakt doordat de specifieke help pagina nog niet beschikbaar is.</text>
+        </section>
+        <section>
+            <text>Dit help systeem geeft je scherm afhankelijke informatie.</text>
+        </section>
+    </general>
+</root>
+

Propchange: ofbiz/trunk/applications/content/data/helpdata/HELP_ROOT_NL.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: ofbiz/trunk/applications/content/data/helpdata/HELP_ROOT_NL.xml
------------------------------------------------------------------------------
    svn:keywords = "Date Rev Author URL Id"

Propchange: ofbiz/trunk/applications/content/data/helpdata/HELP_ROOT_NL.xml
------------------------------------------------------------------------------
    svn:mime-type = text/xml