ofbiz-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From er...@apache.org
Subject svn commit: r1075151 - in /ofbiz/trunk/applications/commonext: data/CommonExtHelpData.xml data/helpdata/HELP_OFBizDocumentationSystem.xml documents/ApacheOfbizTechnical.xml
Date Sun, 27 Feb 2011 21:27:52 GMT
Author: erwan
Date: Sun Feb 27 21:27:52 2011
New Revision: 1075151

URL: http://svn.apache.org/viewvc?rev=1075151&view=rev
Log:
Extracting help documentation system from OFBiz technical file

Added:
    ofbiz/trunk/applications/commonext/data/helpdata/HELP_OFBizDocumentationSystem.xml
Modified:
    ofbiz/trunk/applications/commonext/data/CommonExtHelpData.xml
    ofbiz/trunk/applications/commonext/documents/ApacheOfbizTechnical.xml

Modified: ofbiz/trunk/applications/commonext/data/CommonExtHelpData.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/commonext/data/CommonExtHelpData.xml?rev=1075151&r1=1075150&r2=1075151&view=diff
==============================================================================
--- ofbiz/trunk/applications/commonext/data/CommonExtHelpData.xml (original)
+++ ofbiz/trunk/applications/commonext/data/CommonExtHelpData.xml Sun Feb 27 21:27:52 2011
@@ -59,4 +59,8 @@ under the License.
     <DataResource dataResourceId="SETUP_profileORG" localeString="en" dataResourceTypeId="OFBIZ_FILE"
objectInfo="applications/commonext/data/helpdata/HELP_SETUP_profileCompany.xml" dataTemplateTypeId="NONE"
statusId="CTNT_IN_PROGRESS" dataResourceName="OFBiz Setup View Organization Profile Help"
mimeTypeId="text/xml" isPublic="Y" />
     <Content contentId="SETUP_profileORG" contentTypeId="DOCUMENT" contentName="View Organization
Profile." templateDataResourceId="HELP_TEMPL" dataResourceId="SETUP_profileORG" statusId="CTNT_IN_PROGRESS"
mimeTypeId="text/html"/>
     <ContentAssoc contentId="HELP_SETUP" contentIdTo="SETUP_profileORG" contentAssocTypeId="TREE_CHILD"
fromDate="2009-09-09 01:01:01" sequenceNum="009" mapKey="SETUP_viewprofile"/>
+
+    <DataResource dataResourceId="DOCUMENTATION_SYSTEM" localeString="en" dataResourceTypeId="OFBIZ_FILE"
objectInfo="applications/commonext/data/helpdata/HELP_OFBizDocumentationSystem.xml" dataTemplateTypeId="NONE"
statusId="CTNT_IN_PROGRESS" dataResourceName="Documentation system" mimeTypeId="text/xml"
isPublic="Y" />
+    <Content contentId="DOCUMENTATION_SYSTEM" contentTypeId="DOCUMENT" templateDataResourceId="HELP_TEMPL"
dataResourceId="DOCUMENTATION_SYSTEM" localeString="en" statusId="CTNT_IN_PROGRESS" contentName="Documentation
system" mimeTypeId="text/html"/>
+    <ContentAssoc contentId="HELP_SETUP" contentIdTo="DOCUMENTATION_SYSTEM" contentAssocTypeId="TREE_CHILD"
fromDate="2009-09-09 01:01:01" sequenceNum="010" mapKey="DOCUMENTATION_SYSTEM"/>
 </entity-engine-xml>

Added: ofbiz/trunk/applications/commonext/data/helpdata/HELP_OFBizDocumentationSystem.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/commonext/data/helpdata/HELP_OFBizDocumentationSystem.xml?rev=1075151&view=auto
==============================================================================
--- ofbiz/trunk/applications/commonext/data/helpdata/HELP_OFBizDocumentationSystem.xml (added)
+++ ofbiz/trunk/applications/commonext/data/helpdata/HELP_OFBizDocumentationSystem.xml Sun
Feb 27 21:27:52 2011
@@ -0,0 +1,147 @@
+<?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.
+-->
+
+<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
+    xsi:schemaLocation="http://docbook.org/ns/docbook"
+    xmlns="http://docbook.org/ns/docbook">
+  <title>The Apache OFBiz documentation system</title>
+    <section>
+      <title>Overview</title>
+      <para>
+          The OFBiz documentation system consist out of a number of DocBook xml
+          files. In general the files are stored within the subject
+          component either in the 'documents' or data/helpdata
+          directories.
+          The 'master' document is stored in the file
+          applications/commonext/documents/ApacheOfbiz.xml. The
+          docbook schemas are stored in the applications/content/dtd
+          directory and the stylesheets are
+          stored in the applications/content/templates/docbook directory.
+      </para>
+      <para>
+          The definition of the content and dataresource records can be found in
+          the application/content/data/ContentType.xml file at the
+          bottom. They are in this file because the documentation and
+          helpfile are considered 'seed' data: essential for the operation of OFBiz.
+      </para>
+      <para>
+          If you are looking for docbook files format examples, please
+          look at the following files:
+          <orderedlist>
+            <listitem><para>The master document at:
+              applications/commonext/documents/ApacheOfbiz.xml</para></listitem>
+            <listitem><para>An example for a chapter of a component at:
+              applications/accounting/documents/Accounting.xml</para></listitem>
+            <listitem><para>An example of a help screen:
+              applications/accounting/data/helpdata/HELP_ACCOUNTING_main.xml</para></listitem>
+            <listitem><para>An example of content creation:
+              applications/accounting/data/AccountingHelpData.xml</para></listitem>
+          </orderedlist>
+      </para>
+    </section>
+
+    <section>
+      <title>Contributing a new help screen, a few steps.</title>
+      <para>
+          There is a difference between portlets and 'normal' screens. If a
+          page contains a portlet, the general help of the myportal component is shown with
+          at the bottom a list of the portlets used at that page. Help can be obtained by
clicking on
+          the relevant portlet.
+      </para>
+      <section>
+        <title>Normal pages.</title>
+        <para>
+            So if you would like to create a new help menu for a certain
+            screen, you need to do the following:
+          <orderedlist>
+            <listitem>
+                <para>In the helplink.ftl un-comment the ${helpTopic} variable so it
will appear at the
+                    top right hand of your screen.
+                </para>
+            </listitem>
+            <listitem>
+                <para>
+                    In the specific component data/helpData create the HELP_${helpTopic}.xml
file. you can find an
+                    example in the HELP_ACCOUNTING_main.xml file.
+                </para>
+            </listitem>
+            <listitem>
+                <para>
+                    Update/create the data/${componentName}HelpData.xml, an example can be
found in the
+                    AccountingHelpData.xml. If new make also an entry in the ofbiz-component.xml
+                </para>
+            </listitem>
+            <listitem>
+                <para>
+                    Load the HelpDataFile and the file should show up when you click on the
help button.
+                </para>
+            </listitem>
+            <listitem>
+                <para>
+                    Submit the change to the svn repository or create a diff file and attach
it to a jira issue.
+                </para>
+            </listitem>
+            <listitem>
+                <para>
+                    If the help text is useful in the ofbiz document include it in the files
in the document directory.
+                </para>
+            </listitem>
+          </orderedlist>
+        </para>
+      </section>
+      <section>
+        <title>Contributing a new Portlet help screen.</title>
+        <para>
+            Portlets are normally defined and explained in the ${component name}PortletData.xml
files. An example
+            of an portlet with an existing help screen have a look at WorkEffortPortletData.xml
+        </para>
+        <para>
+            The content records for the help file is defined together with the portlet definition
and the actual help
+            file is store in the related component /data/helpdata directory wit the nam HELP_PORTLET_${portletId}.xml.
+        </para>
+      </section>
+    </section>
+    <section>
+        <title><anchor xml:id="helpInternationalization"/>Internationalization
of the help system</title>
+        <para>
+            Because the help system is making use of the content component, internationalization
of the help files is very easy because
+            it is a basic function of the content component. If you want to make a translation
of an existing help file, make a copy in the same directory
+            and make it unique by attaching the "_languageCode" at the end.
+        </para>
+        <para>
+            Create, as also was done for the english version a dataresource and content record
in the data/${componentName}HelpData.xml file.
+            Then create an ContentAssoc record in data/${componentName}HelpData.xml file
to associate this new file with the english file with the type
+            ALTERNATE_LOCALE. Please find below an example from the ContentHelpData.xml for
a Dutch version of the root help file.
+            <programlisting>
+    &amp;lt;!-- how to create alternative locales -->
+    &amp;lt;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" />
+    &amp;lt;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"/>
+    &amp;lt;ContentAssoc contentId="HELP_ROOT" contentIdTo="HELP_ROOT_NL"
+        contentAssocTypeId="ALTERNATE_LOCALE" fromDate="2006-01-12 01:01:01"/>
+            </programlisting>
+            The switching between locales is from then on completely automatic.
+        </para>
+    </section>
+</section>

Modified: ofbiz/trunk/applications/commonext/documents/ApacheOfbizTechnical.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/commonext/documents/ApacheOfbizTechnical.xml?rev=1075151&r1=1075150&r2=1075151&view=diff
==============================================================================
--- ofbiz/trunk/applications/commonext/documents/ApacheOfbizTechnical.xml (original)
+++ ofbiz/trunk/applications/commonext/documents/ApacheOfbizTechnical.xml Sun Feb 27 21:27:52
2011
@@ -205,141 +205,7 @@ image=/boot/vmlinuzNew
     <xi:include href="../../../framework/documents/DataFiles.xml"/>
 
     <appendix>
-        <title>The Apache OFBiz documentation system</title>
-
-    <section>
-        <title>Overview.</title>
-        <para>
-            The OFBiz documentation system consist out of a number of DocBook xml
-            files. In general the files are stored within the subject
-            component either in the 'documents' or data/helpdata
-            directories.
-            The 'master' document is stored in the file
-            applications/commonext/documents/ApacheOfbiz.xml. The
-            docbook schemas are stored in the applications/content/dtd
-            directory and the stylesheets are
-            stored in the applications/content/templates/docbook directory.  
-        </para>
-        <para>
-            the definition of the content and dataresource records can be found in
-            the application/content/data/ContentType.xml file at the
-            bottom. They are in this file because the documentation and
-            helpfile
-            are considered 'seed' data: essential for the operation of OFBiz.
-        </para>
-        <para>
-            If you are looking for docbook files format examples, please
-            look at the following files:
-            <orderedlist>
-                <listitem>
-                    <para>The master document at:
-                        applications/commonext/documents/ApacheOfbiz.xml
-                    </para>
-                </listitem>
-                <listitem>
-                    <para>An example for a chapter of a component at:
-                        applications/accounting/documents/Accounting.xml
-                    </para>
-                </listitem>
-                <listitem>
-                    <para>An example of a help screen:
-                        applications/accounting/data/helpdata/HELP_ACCOUNTING_main.xml
-                    </para>
-                </listitem>
-                <listitem>
-                    <para>An example of content creation:
-                        applications/accounting/data/AccountingHelpData.xml
-                    </para>
-                </listitem>
-            </orderedlist>
-        </para>
-    </section>
-
-    <section>
-        <title>Contributing a new help screen, a few steps.</title>
-        <para>
-            There is a difference between portlets and 'normal' screens. If a 
-            page contains a portlet, the general help of the myportal component is shown
with 
-            at the botton a list of the portlets used at that page. Help can be obtained
by clicking on 
-            the relavant portlet.
-        </para>
-        <section>
-            <title>Normal pages.</title>
-            <para>
-                So if you would like to create a new help menu for a certain
-                screen, you need to do the following:
-                <orderedlist>
-                <listitem>
-                    <para>In the helplink.ftl un-comment the
-                        ${helpTopic} variable so it will appear at the
-                        top right hand of your screen</para>
-                </listitem>
-                <listitem>
-                    <para>in the specific component data/helpData create
-                        the HELP_${helpTopic}.xml file. you can find an
-                        example in the HELP_ACCOUNTING_main.xml file.</para>
-                </listitem>
-                <listitem>
-                    <para>Update/create the
-                        data/${componentName}HelpData.xml, an example
-                        can be found in the AccountingHelpData.xml. If
-                        new make also an entry in the
-                        ofbiz-component.xml</para>
-                </listitem>
-                <listitem>
-                    <para>Load the HelpDataFile and the file should
-                        show up when you click on the help button.
-                    </para>
-                </listitem>
-                <listitem>
-                    <para>Submit the change to the svn repository or
-                        create a diff file and attach it to a jira
-                        issue.</para>
-                </listitem>
-                <listitem>
-                    <para>
-                        If the help text is usefull in the ofbiz document include it in the
files in the document directory.
-                    </para>
-                </listitem>
-                </orderedlist>
-            </para>
-            </section>
-        <section>
-            <title>Contributing a new Portlet) help screen.</title>
-            <para>
-                Portlets are normally defined and explained in the ${component name}PortletData.xml
files. An example 
-                of an portlet with an existing help screen have a look at WorkEffortPortletData.xml

-            </para>
-            <para>
-                The content records for the help file is defined together with the portlet
definition and the axual help 
-                file is store in the related component /data/helpdata directory wit the nam
HELP_PORTLET_${portletId}.xml. 
-            </para>
-        </section>
-    </section>
-    <section>
-        <title><anchor xml:id="helpInternationalization"/>Internationalization
of the help system</title>
-        <para>
-            Because the help system is making use of the content component, internationalization
of the help files is very easy because 
-            it is a basic function of the content component. If you want to make a translation
of an existing help file, make a copy in the same directory 
-            and make it unique by attaching the "_languageCode" at he end.
-            Create, as also was done for the english version a dataresource and content record
in the data/${componentName}HelpData.xml file.
-            Then create an ContentAssoc record in data/${componentName}HelpData.xml file
to associate this new file with the english file with the type
-            ALTERNATE_LOCALE. Please find below an example from the ContentHelpData.xml for
a Dutch version of the root help file.
-            <programlisting>
-    &lt;!-- how to create alternative locales --&gt;
-    &lt;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" /&gt;
-    &lt;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"/&gt;
-    &lt;ContentAssoc contentId="HELP_ROOT" contentIdTo="HELP_ROOT_NL" 
-        contentAssocTypeId="ALTERNATE_LOCALE" fromDate="2006-01-12 01:01:01"/&gt;
-            </programlisting> 
-            The switching between locales is from then on completely automatic.
-        </para>
-    </section>
-    
+        <xi:include href="../data/helpdata/HELP_OFBizDocumentationSystem.xml"/>
     </appendix>
     
     <appendix>



Mime
View raw message