svn commit: r812021 - in /ofbiz/trunk: applications/accounting/data/helpdata/ applications/accounting/documents/ applications/commonext/data/ applications/commonext/documents/ applications/content/data/ framework/documents/ framework/entity/documents/ ...

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

svn commit: r812021 - in /ofbiz/trunk: applications/accounting/data/helpdata/ applications/accounting/documents/ applications/commonext/data/ applications/commonext/documents/ applications/content/data/ framework/documents/ framework/entity/documents/ ...

hansbak-2
Author: hansbak
Date: Mon Sep  7 07:31:11 2009
New Revision: 812021

URL: http://svn.apache.org/viewvc?rev=812021&view=rev
Log:
create a 'set' of documents: a technical and a user guide and added more info

Added:
    ofbiz/trunk/applications/commonext/documents/ApacheOfbizTechnical.xml   (with props)
    ofbiz/trunk/applications/commonext/documents/ApacheOfbizUser.xml   (with props)
    ofbiz/trunk/framework/documents/
    ofbiz/trunk/framework/documents/Framework.xml   (with props)
    ofbiz/trunk/framework/entity/documents/
    ofbiz/trunk/framework/entity/documents/EntityEngine.xml   (with props)
    ofbiz/trunk/framework/minilang/documents/
    ofbiz/trunk/framework/minilang/documents/MiniLang.xml   (with props)
    ofbiz/trunk/framework/service/documents/
    ofbiz/trunk/framework/service/documents/ServiceEngine.xml   (with props)
Modified:
    ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_main.xml
    ofbiz/trunk/applications/accounting/documents/Accounting.xml
    ofbiz/trunk/applications/commonext/data/CommonExtSeedData.xml
    ofbiz/trunk/applications/commonext/documents/ApacheOfbiz.xml
    ofbiz/trunk/applications/content/data/ContentTypeData.xml

Modified: ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_main.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_main.xml?rev=812021&r1=812020&r2=812021&view=diff
==============================================================================
--- ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_main.xml (original)
+++ ofbiz/trunk/applications/accounting/data/helpdata/HELP_ACCOUNTING_main.xml Mon Sep  7 07:31:11 2009
@@ -22,18 +22,11 @@
  xmlns:xi="http://www.w3.org/2001/XInclude"
  xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
  xmlns="http://docbook.org/ns/docbook">
- <title>The Main Accounting help screen</title>
-    <para>Introductory text</para>
+ <title>The Accounting Main help screen.</title>
+    <para>Introduction</para>
     <section>
         <title>subsection heading</title>
         <para>Subsection content</para>
     </section>
- <section>
-        <title>Subsection 2 title</title>
-        <para>
- The Main accounting help screen. For more information please
- see the <link xl:href="http://docs.ofbiz.org">OFBiz documentation site</link> for more info.
-        </para>
-    </section>
 </section>
 

Modified: ofbiz/trunk/applications/accounting/documents/Accounting.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/accounting/documents/Accounting.xml?rev=812021&r1=812020&r2=812021&view=diff
==============================================================================
--- ofbiz/trunk/applications/accounting/documents/Accounting.xml (original)
+++ ofbiz/trunk/applications/accounting/documents/Accounting.xml Mon Sep  7 07:31:11 2009
@@ -21,11 +21,11 @@
  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 ../../content/dtd/docbook.xsd"
  xmlns="http://docbook.org/ns/docbook">
- <title>The Accounting Component Section</title>
+ <title>The Accounting Component.</title>
  <section>
- <title>Introduction Paragraph</title>
+ <title>Introductio</title>
  <para>
- and a introduction paragraph in Accounting
+ Please find here a general introduction to the accounting component (to be continued)
         </para>
  </section>
  <xi:include href="../data/helpdata/HELP_ACCOUNTING_main.xml" />

Modified: ofbiz/trunk/applications/commonext/data/CommonExtSeedData.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/commonext/data/CommonExtSeedData.xml?rev=812021&r1=812020&r2=812021&view=diff
==============================================================================
--- ofbiz/trunk/applications/commonext/data/CommonExtSeedData.xml (original)
+++ ofbiz/trunk/applications/commonext/data/CommonExtSeedData.xml Mon Sep  7 07:31:11 2009
@@ -18,4 +18,21 @@
     under the License.
 -->
 <entity-engine-xml>
+    <Content contentId="DOCUMENTS" contentTypeId="DOCUMENT" contentName="Documents"/>
+    <ContentAssoc contentId="TREE_ROOT" contentIdTo="DOCUMENTS" contentAssocTypeId="TREE_CHILD" fromDate="2006-01-12 01:01:01" sequenceNum=""/>
+
+    <DataResource dataResourceId="APACHE_OFBIZ" localeString="en" dataResourceTypeId="OFBIZ_FILE" objectInfo="applications/commonext/documents/ApacheOfbiz.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS" dataResourceName="Apache OFBiz document" mimeTypeId="text/xml" isPublic="Y" />
+    <Content contentId="APACHE_OFBIZ_HTML" contentTypeId="DOCUMENT" templateDataResourceId="DOCBOOK_HTML_TEMPL" dataResourceId="APACHE_OFBIZ" localeString="en" statusId="CTNT_IN_PROGRESS" contentName="The User &amp; Technical Apache OFBiz document in one page HTML" mimeTypeId="text/html"/>
+    <ContentAssoc contentId="DOCUMENTS" contentIdTo="APACHE_OFBIZ_HTML" contentAssocTypeId="SUB_CONTENT" fromDate="2006-01-12 01:01:01" sequenceNum=""/>
+
+    <Content contentId="APACHE_OFBIZ_PDF" contentTypeId="DOCUMENT" templateDataResourceId="DOCBOOK_PDF_TEMPL" dataResourceId="APACHE_OFBIZ" localeString="en" statusId="CTNT_IN_PROGRESS" contentName="The general Apache document in PDF format" mimeTypeId="application/pdf"/>
+    <ContentAssoc contentId="DOCUMENTS" contentIdTo="APACHE_OFBIZ_PDF" contentAssocTypeId="SUB_CONTENT" fromDate="2006-01-12 01:01:01" sequenceNum=""/>
+
+    <DataResource dataResourceId="APACHE_OFBIZ_TECH" localeString="en" dataResourceTypeId="OFBIZ_FILE" objectInfo="applications/commonext/documents/ApacheOfbizTechnical.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS" dataResourceName="Apache OFBiz document" mimeTypeId="text/xml" isPublic="Y" />
+    <Content contentId="APACHE_OFBIZ_T_HTML" contentTypeId="DOCUMENT" templateDataResourceId="DOCBOOK_HTML_TEMPL" dataResourceId="APACHE_OFBIZ_TECH" localeString="en" statusId="CTNT_IN_PROGRESS" contentName="The Apache OFBiz Technical Guide in one page HTML" mimeTypeId="text/html"/>
+    <ContentAssoc contentId="DOCUMENTS" contentIdTo="APACHE_OFBIZ_T_HTML" contentAssocTypeId="SUB_CONTENT" fromDate="2006-01-12 01:01:01" sequenceNum=""/>
+    <DataResource dataResourceId="APACHE_OFBIZ_USER" localeString="en" dataResourceTypeId="OFBIZ_FILE" objectInfo="applications/commonext/documents/ApacheOfbizTechnical.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS" dataResourceName="Apache OFBiz User document" mimeTypeId="text/xml" isPublic="Y" />
+    <Content contentId="APACHE_OFBIZ_U_HTML" contentTypeId="DOCUMENT" templateDataResourceId="DOCBOOK_HTML_TEMPL" dataResourceId="APACHE_OFBIZ_TECH" localeString="en" statusId="CTNT_IN_PROGRESS" contentName="The Apache OFBizUser Guide in one page HTML" mimeTypeId="text/html"/>
+    <ContentAssoc contentId="DOCUMENTS" contentIdTo="APACHE_OFBIZ_U_HTML" contentAssocTypeId="SUB_CONTENT" fromDate="2006-01-12 01:01:01" sequenceNum=""/>
+
 </entity-engine-xml>

Modified: ofbiz/trunk/applications/commonext/documents/ApacheOfbiz.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/commonext/documents/ApacheOfbiz.xml?rev=812021&r1=812020&r2=812021&view=diff
==============================================================================
--- ofbiz/trunk/applications/commonext/documents/ApacheOfbiz.xml (original)
+++ ofbiz/trunk/applications/commonext/documents/ApacheOfbiz.xml Mon Sep  7 07:31:11 2009
@@ -17,150 +17,18 @@
     specific language governing permissions and limitations
     under the License.
 -->
-<book xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0"
+<set 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 ../../content/dtd/docbook.xsd"
   xmlns="http://docbook.org/ns/docbook">
 
- <info>
-    <title>Apache OFBiz official documentation</title>
-        <copyright><year>2009</year><holder>Apache Foundation</holder></copyright>
- </info>
+    <info>
+        <title>Apache OFBiz official documentation.</title>
+        <copyright><year>2009</year><holder>Apache Foundation.</holder></copyright>
+    </info>
 
-    <preface>
-        <para>
-            This Book is in an experimental stage and acts as a proof of concept. It could be the start of moving the ofbiz documentation from the current
-            <link xl:href="http://docs.ofbiz.org">OFBiz documentation site</link> to the OFBiz content component. It is currently open for discussion by the OFBiz community.
-        </para>
-        <para>
-            The advantages of using it within OFBiz are:
-            <orderedlist>
-                <listitem><para>No external system required for documentation</para></listitem>
-                <listitem><para>The content of the internal help files can be used within the documentation</para></listitem>
-                <listitem><para>The documentation always has the same version as the system (It is part of it)</para></listitem>
-                <listitem><para>The content is stored in a internationally accepted <link xl:href="http://docbook.org">'DocBook'</link> format</para></listitem>
-                <listitem><para>The content can be easily presented in the selected visual schemas (To be implemented)</para></listitem>
-            </orderedlist>
-        </para>
-        <para>
-         If you want to contribute to this document, you are very welcome.
-         Several possibilities exist:
-            <orderedlist>
-                <listitem><para>Convert existing OFBiz documents on the <link xl:href="http://docs.ofbiz.org">OFBiz documentation site to the <link xl:href="http://docbook.org">docbook</link> format</link></para></listitem>
-                <listitem><para>Write new document chapters for an OFBiz component</para></listitem>
-                <listitem><para>Write new Help screens which can be inserted as sections in the document.</para></listitem>
-            </orderedlist>
- How to contribute? It depends if you have a local OFBiz system or not. If you have, check the appendix for an explanation how the document text is stored within the OFBiz system.
- If you do not have a local OFBiz system write your text in an xml editor using the DocBook V5.0 schema's.
- If you have text to contribute create a Jira issue and upload your text to the issue.
-        </para>
-    </preface>
-    
-    <chapter>
-        <title>Introduction</title>
-        <para>
-            Welcome to Apache OFBiz the ready to use open source ERP system.
-        </para>
-    </chapter>
-    <xi:include href="../../../applications/accounting/documents/Accounting.xml"/>
-    <xi:include href="../../../applications/product/documents/Product.xml"/>
-    <xi:include href="../../../applications/content/documents/Content.xml"/>
-    <xi:include href="../../../specialpurpose/myportal/documents/MyPortal.xml"/>
-    
- <anchor/>
-    <appendix>
-     <title>The Apache OFBiz documentation system</title>
+    <xi:include href="ApacheOfbizUser.xml"/>
+    <xi:include href="ApacheOfbizTechnical.xml"/>
 
-    <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>
-            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>
-    </appendix>
-    
-</book>
\ No newline at end of file
+</set>
\ No newline at end of file

Added: ofbiz/trunk/applications/commonext/documents/ApacheOfbizTechnical.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/commonext/documents/ApacheOfbizTechnical.xml?rev=812021&view=auto
==============================================================================
--- ofbiz/trunk/applications/commonext/documents/ApacheOfbizTechnical.xml (added)
+++ ofbiz/trunk/applications/commonext/documents/ApacheOfbizTechnical.xml Mon Sep  7 07:31:11 2009
@@ -0,0 +1,167 @@
+<?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.
+-->
+<book 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 ../../content/dtd/docbook.xsd"
+  xmlns="http://docbook.org/ns/docbook">
+
+    <info>
+        <title>Apache OFBiz Technical documentation.</title>
+        <copyright><year>2009</year><holder>Apache Foundation</holder></copyright>
+    </info>
+
+    <dedication>
+        <para>
+            I was reading the book in development from Norman Walsh called <link xl:href="http://www.docbook.org/tdg5/en/html/docbook.html">DocBook 5.0: The Definitive Guide
+            </link> and found that a book can have a dedication. My first thought was there is only one man to whom this book can be dedicated. Without him I would not have been writing it.
+            Sometimes i talk to other people about my dinners with David Jones in Pucket, Thailand which were very revealing to me. At a relative young age David designed and developed with Andy Zenesky
+            the cornerstones of the OFBiz system called entity engine and recognized that in 2001 SOA (System Oriented Architecture) would be the future.
+            So, David, thank you very much spending your efforts creating this excellent system.
+        </para>
+    </dedication>
+
+    <chapter>
+        <title>Introduction.</title>
+        <para>
+            Welcome to Apache OFBiz the ready to use open source ERP system.
+        </para>
+    
+        <section>
+            <title>The production setup guide.</title>
+            <para>
+                   An excellent guide to configure the system in a production environment, read the document at the <link xl:href="http://docs.ofbiz.org/display/OFBTECH/Apache+OFBiz+Technical+Production+Setup+Guide">OFBiz documentation site</link>
+            </para>
+        </section>
+    
+
+        <xi:include href="../../../framework/documents/Framework.xml"/>
+    
+
+    </chapter>
+    
+
+
+
+    <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>
+            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>
+    </appendix>
+    
+    <appendix>
+        <section>
+            <title>Revisions Requiring Data Migration.</title>
+            <para>
+                   A List of migration actions you need to perform can be found at the <link xl:href="http://docs.ofbiz.org/display/OFBTECH/Revisions+Requiring+Data+Migration">OFBiz documentation site</link>
+            </para>
+        </section>
+    </appendix>
+    
+    
+</book>
\ No newline at end of file

Propchange: ofbiz/trunk/applications/commonext/documents/ApacheOfbizTechnical.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: ofbiz/trunk/applications/commonext/documents/ApacheOfbizTechnical.xml
------------------------------------------------------------------------------
    svn:keywords = "Date Rev Author URL Id"

Propchange: ofbiz/trunk/applications/commonext/documents/ApacheOfbizTechnical.xml
------------------------------------------------------------------------------
    svn:mime-type = text/xml

Added: ofbiz/trunk/applications/commonext/documents/ApacheOfbizUser.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/commonext/documents/ApacheOfbizUser.xml?rev=812021&view=auto
==============================================================================
--- ofbiz/trunk/applications/commonext/documents/ApacheOfbizUser.xml (added)
+++ ofbiz/trunk/applications/commonext/documents/ApacheOfbizUser.xml Mon Sep  7 07:31:11 2009
@@ -0,0 +1,80 @@
+<?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.
+-->
+<book 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 ../../content/dtd/docbook.xsd"
+  xmlns="http://docbook.org/ns/docbook">
+
+ <info>
+    <title>Apache OFBiz User documentation</title>
+        <copyright><year>2009</year><holder>Apache Foundation</holder></copyright>
+ </info>
+
+    <preface>
+        <para>
+            This Book is currently in an experimental stage. It will be the start of moving the OFBiz documentation from the current
+            <link xl:href="http://docs.ofbiz.org">OFBiz documentation site</link> and the old ofbiz website (Entity documents) to the OFBiz content component.
+            The layout is currently open for discussion by the OFBiz community.
+        </para>
+        <para>
+            The advantages of using it within OFBiz are:
+            <orderedlist>
+                <listitem><para>No external system required for documentation</para></listitem>
+                <listitem><para>The content of the internal help files can be used within the documentation</para></listitem>
+                <listitem><para>The documentation always has the same version as the system (It is part of it)</para></listitem>
+                <listitem><para>The content is stored in a internationally accepted <link xl:href="http://docbook.org">'DocBook'</link> format</para></listitem>
+                <listitem><para>The content can be easily presented in the selected visual schemas (To be implemented)</para></listitem>
+            </orderedlist>
+        </para>
+        <para>
+            If you want to contribute to this document, you are very welcome.
+            Several possibilities exist:
+            <orderedlist>
+                <listitem><para>Convert existing OFBiz documents on the <link xl:href="http://docs.ofbiz.org">OFBiz documentation site to the <link xl:href="http://docbook.org">docbook</link> format</link></para></listitem>
+                <listitem><para>Write new document chapters for an OFBiz component</para></listitem>
+                <listitem><para>Write new Help screens which can be inserted as sections in the document.</para></listitem>
+            </orderedlist>
+            How to contribute? It depends if you have a local OFBiz system or not. If you have, check the appendix for an explanation how the document text is stored within the OFBiz system.
+            If you do not have a local OFBiz system write your text in an xml editor using the DocBook V5.0 schema's.
+            If you have text to contribute create a Jira issue and upload your text to the issue.          
+        </para>
+    </preface>
+    
+    <chapter>
+        <title>Introduction</title>
+        <para>
+            Welcome to Apache OFBiz the ready to use open source ERP system.
+            A project introduction can be found at the <link xl:href="http://docs.ofbiz.org/display/OFBADMIN/Apache+OFBiz+Project+Overview">OFBiz documentation site</link>
+        </para>
+    </chapter>
+    <xi:include href="../../../applications/accounting/documents/Accounting.xml"/>
+    <xi:include href="../../../applications/product/documents/Product.xml"/>
+    <xi:include href="../../../applications/content/documents/Content.xml"/>
+    <xi:include href="../../../specialpurpose/myportal/documents/MyPortal.xml"/>
+    
+    <appendix>
+        <title>New features recently added</title>
+        <para>
+           A description of the new features recently added can be found at the <link xl:href="http://docs.ofbiz.org/display/OFBIZ/Main+New+Features">OFBiz documentation site</link>
+        </para>
+    </appendix>
+    
+</book>
\ No newline at end of file

Propchange: ofbiz/trunk/applications/commonext/documents/ApacheOfbizUser.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: ofbiz/trunk/applications/commonext/documents/ApacheOfbizUser.xml
------------------------------------------------------------------------------
    svn:keywords = "Date Rev Author URL Id"

Propchange: ofbiz/trunk/applications/commonext/documents/ApacheOfbizUser.xml
------------------------------------------------------------------------------
    svn:mime-type = text/xml

Modified: ofbiz/trunk/applications/content/data/ContentTypeData.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/applications/content/data/ContentTypeData.xml?rev=812021&r1=812020&r2=812021&view=diff
==============================================================================
--- ofbiz/trunk/applications/content/data/ContentTypeData.xml (original)
+++ ofbiz/trunk/applications/content/data/ContentTypeData.xml Mon Sep  7 07:31:11 2009
@@ -264,13 +264,8 @@
     <Content contentId="TREE_ROOT"/>
     <DataResource dataResourceId="DOCBOOK_HTML_TEMPL" dataResourceTypeId="OFBIZ_FILE" objectInfo="applications/content/template/docbook/html/docbook.xsl" dataTemplateTypeId="XSLT" statusId="CTNT_IN_PROGRESS" dataResourceName="Help template file" mimeTypeId="text/html" isPublic="Y"/>
     <DataResource dataResourceId="DOCBOOK_PDF_TEMPL" dataResourceTypeId="OFBIZ_FILE" objectInfo="applications/content/template/docbook/fo/docbook.xsl" dataTemplateTypeId="XSLT" statusId="CTNT_IN_PROGRESS" dataResourceName="Help template file" mimeTypeId="text/html" isPublic="Y"/>
-    <DataResource dataResourceId="APACHE_OFBIZ" localeString="en" dataResourceTypeId="OFBIZ_FILE" objectInfo="applications/commonext/documents/ApacheOfbiz.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS" dataResourceName="Apache OFBiz document" mimeTypeId="text/xml" isPublic="Y" />
-    <Content contentId="APACHE_OFBIZ_HTML" contentTypeId="DOCUMENT" templateDataResourceId="DOCBOOK_HTML_TEMPL" dataResourceId="APACHE_OFBIZ" localeString="en" statusId="CTNT_IN_PROGRESS" contentName="The general Apache document in one page HTML" mimeTypeId="text/html"/>
-    <Content contentId="APACHE_OFBIZ_PDF" contentTypeId="DOCUMENT" templateDataResourceId="DOCBOOK_PDF_TEMPL" dataResourceId="APACHE_OFBIZ" localeString="en" statusId="CTNT_IN_PROGRESS" contentName="The general Apache document in PDF format" mimeTypeId="application/pdf"/>
+
+    <!-- localization example file -->
     <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" />
-    <Content contentId="DOCUMENTS" contentTypeId="DOCUMENT" contentName="Documents"/>
-    <ContentAssoc contentId="TREE_ROOT" contentIdTo="DOCUMENTS" contentAssocTypeId="TREE_CHILD" fromDate="2006-01-12 01:01:01" sequenceNum=""/>
-    <ContentAssoc contentId="DOCUMENTS" contentIdTo="APACHE_OFBIZ_HTML" contentAssocTypeId="SUB_CONTENT" fromDate="2006-01-12 01:01:01" sequenceNum=""/>
-    <ContentAssoc contentId="DOCUMENTS" contentIdTo="APACHE_OFBIZ_PDF" contentAssocTypeId="SUB_CONTENT" fromDate="2006-01-12 01:01:01" sequenceNum=""/>
     
 </entity-engine-xml>

Added: ofbiz/trunk/framework/documents/Framework.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/documents/Framework.xml?rev=812021&view=auto
==============================================================================
--- ofbiz/trunk/framework/documents/Framework.xml (added)
+++ ofbiz/trunk/framework/documents/Framework.xml Mon Sep  7 07:31:11 2009
@@ -0,0 +1,40 @@
+<?xml version="1.0"?>
+<!--
+    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.
+-->
+<chapter 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 ../../applications/content/dtd/docbook.xsd"
+ xmlns="http://docbook.org/ns/docbook">
+ <title>The OFBiz Framework.</title>
+ <section>
+ <title>Introduction.</title>
+ <para>
+ For a core configuration guide check <link xl:href="http://ofbiz.apache.org/docs/coreconfig.html">the OFBiz website.</link>
+        </para>
+ </section>
+    <xi:include href="../entity/documents/EntityEngine.xml" />
+    <xi:include href="../service/documents/ServiceEngine.xml" />
+
+    <section>
+        <title>The widget system: screens and forms.</title>
+        <para>
+
+        </para>
+    </section>
+</chapter>

Propchange: ofbiz/trunk/framework/documents/Framework.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: ofbiz/trunk/framework/documents/Framework.xml
------------------------------------------------------------------------------
    svn:keywords = "Date Rev Author URL Id"

Propchange: ofbiz/trunk/framework/documents/Framework.xml
------------------------------------------------------------------------------
    svn:mime-type = text/xml

Added: ofbiz/trunk/framework/entity/documents/EntityEngine.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/entity/documents/EntityEngine.xml?rev=812021&view=auto
==============================================================================
--- ofbiz/trunk/framework/entity/documents/EntityEngine.xml (added)
+++ ofbiz/trunk/framework/entity/documents/EntityEngine.xml Mon Sep  7 07:31:11 2009
@@ -0,0 +1,48 @@
+<?xml version="1.0"?>
+<!--
+    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 ../../../applications/content/dtd/docbook.xsd"
+ xmlns="http://docbook.org/ns/docbook">
+ <title>The Entity Engine.</title>
+
+    <section>
+    <title>Entity Engine guide.</title>
+    <para>
+       <link xl:href="http://ofbiz.apache.org/docs/entity.html">Entity engine Guide(to be converted)</link>
+    </para>
+    </section>
+    
+    <section>
+    <title>Entity Engine Configuration Guide.</title>
+    <para>
+          <link xl:href="http://ofbiz.apache.org/docs/entityconfig.html">entity engine configuration guide (to be converted)</link>
+    </para>
+    </section>
+    
+    <section>
+    <title>Entity overview.</title>
+    <para>
+        <link xl:href="http://docs.ofbiz.org/display/OFBTECH/General+Entity+Overview">Entity overview (to be converted)</link>
+    </para>
+        
+    </section>
+
+</section>

Propchange: ofbiz/trunk/framework/entity/documents/EntityEngine.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: ofbiz/trunk/framework/entity/documents/EntityEngine.xml
------------------------------------------------------------------------------
    svn:keywords = "Date Rev Author URL Id"

Propchange: ofbiz/trunk/framework/entity/documents/EntityEngine.xml
------------------------------------------------------------------------------
    svn:mime-type = text/xml

Added: ofbiz/trunk/framework/minilang/documents/MiniLang.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/minilang/documents/MiniLang.xml?rev=812021&view=auto
==============================================================================
--- ofbiz/trunk/framework/minilang/documents/MiniLang.xml (added)
+++ ofbiz/trunk/framework/minilang/documents/MiniLang.xml Mon Sep  7 07:31:11 2009
@@ -0,0 +1,28 @@
+<?xml version="1.0"?>
+<!--
+    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 ../../../applications/content/dtd/docbook.xsd"
+ xmlns="http://docbook.org/ns/docbook">
+ <title>The Entity Engine</title>
+ <para>
+   A description of the Mini Language guide can be found at the <link xl:href="http://docs.ofbiz.org/display/OFBIZ/Mini-Language+Guide">OFBiz documentation site</link>
+ </para>
+</section>

Propchange: ofbiz/trunk/framework/minilang/documents/MiniLang.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: ofbiz/trunk/framework/minilang/documents/MiniLang.xml
------------------------------------------------------------------------------
    svn:keywords = "Date Rev Author URL Id"

Propchange: ofbiz/trunk/framework/minilang/documents/MiniLang.xml
------------------------------------------------------------------------------
    svn:mime-type = text/xml

Added: ofbiz/trunk/framework/service/documents/ServiceEngine.xml
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/service/documents/ServiceEngine.xml?rev=812021&view=auto
==============================================================================
--- ofbiz/trunk/framework/service/documents/ServiceEngine.xml (added)
+++ ofbiz/trunk/framework/service/documents/ServiceEngine.xml Mon Sep  7 07:31:11 2009
@@ -0,0 +1,28 @@
+<?xml version="1.0"?>
+<!--
+    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 ../../../applications/content/dtd/docbook.xsd"
+ xmlns="http://docbook.org/ns/docbook">
+ <title>The Service Engine</title>
+    <para>
+       A description of the service engine can be found at the <link xl:href="http://docs.ofbiz.org/display/OFBTECH/Service+Engine+Guide">OFBiz documentation site</link>
+    </para>
+</section>

Propchange: ofbiz/trunk/framework/service/documents/ServiceEngine.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: ofbiz/trunk/framework/service/documents/ServiceEngine.xml
------------------------------------------------------------------------------
    svn:keywords = "Date Rev Author URL Id"

Propchange: ofbiz/trunk/framework/service/documents/ServiceEngine.xml
------------------------------------------------------------------------------
    svn:mime-type = text/xml