diff --git a/docs/asciidoc/_include/OFBizDocumentationSystem.adoc b/docs/asciidoc/_include/OFBizDocumentationSystem.adoc new file mode 100644 index 0000000000..652a6cf641 --- /dev/null +++ b/docs/asciidoc/_include/OFBizDocumentationSystem.adoc @@ -0,0 +1,89 @@ +//// +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. +//// += The Apache OFBiz documentation system + +== Overview +there are two supports for OFbiz documentation, the https://cwiki.apache.org/confluence/display/OFBENDUSER/OFBiz+End+User+Docs+Home[wiki] +and some mains documents (in pdf and html format) + +* user-manual +* developer-manual +* documentation_guidelines +* README + +=== Asciidoc +The OFBiz documents are generated from a number of Asciidoc files. In general the files are stored on each component +in the 'src/docs/asciidoc' directories. + +The general main documents include all files from component. + +The manuals and guidelines documents are located in docs/asciidoc directories, and REAME.adoc is in root directory. + +Help link in the OFBiz user interface, are link to the user-manual generated by buildbot process from Apache OFBiz community. +It’s possible to change a property in OFBiz to have link to your own generation. + +For details about asciidoc rules used in Apache OFBiz have a look to link:documentation_guidelines.html[Documentation Guidelines] + +==== Application components +All main files of each component are included in user-manual.adoc + +==== Framework components +All main files of each component are included in developer-manual.adoc except for webtools which is included in user-manual + +==== Plugins +For the main files of the plugin components, there are two ways to read them. + +On the one hand, the plugin documentation generation process generates one document per plugin, so that you can see +the list of documents in the link:../../pluginsdoc/html5[pluginsdoc directory] and thus read each of them; + +On the other hand, each plugin master file is included in the plugin chapter of the user manual or developer manual, +depending on whether the plugin is "technical" or "functional". + +=== Wiki +Wiki is the second way to contribute to the documentation. +Detail on how to https://cwiki.apache.org/confluence/display/OFBENDUSER/Help+for+providing+help+content[Help for providing help content] +is on the wiki icon:smile-o[] + +Most of wiki page has been or will be migrated to the asciidoc pages, but, as wiki is more easier to be update +(update existing page or create new one) the two system will continue to exist and live. + + +== Contributing a new help screen, a few steps. +link:documentation_guidelines.html[Documentation Guidelines] is the first doc to read to be able to contribute to documentation +and/or help. + +If you are looking for asciidoc files format examples, please look at the following files: + +. An example for a chapter of a component at: applications/humanres/src/docs/asccidoc/_include/hr-intro.adoc +. An example of a help screen: applications/humanres/src/docs/asccidoc/_include/HELP-hr-main.adoc + +=== Screens +If you would like to create a new help for a certain screen, you need to do the following: + +. Write documentation in a functional point of view and in a process perspective. +. Each title (in all level) generate in html an anchor, so starting point of the help should be a title. +. Take the anchor generated (something like _the_title , with only lowercase), for example by looking in the html file generated. +. In the screen add a `