[ofbiz-framework] branch trunk updated: Documented: Synchronize wiki page End User Documentation (OFBIZ-12059)

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

[ofbiz-framework] branch trunk updated: Documented: Synchronize wiki page End User Documentation (OFBIZ-12059)

holivier
This is an automated email from the ASF dual-hosted git repository.

holivier pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git


The following commit(s) were added to refs/heads/trunk by this push:
     new 9863177  Documented: Synchronize wiki page End User Documentation (OFBIZ-12059)
9863177 is described below

commit 98631771aa884ca573f8ad99b820dc8252024a11
Author: holivier <[hidden email]>
AuthorDate: Mon Nov 16 17:00:48 2020 +0100

    Documented: Synchronize wiki page End User Documentation (OFBIZ-12059)
   
    - Add facility.adoc with only overview
    - Correction for Content Management title
    - in General glossary, add link to main components
    - Complete Order management overview
    - Add a short overview for Party
    - Ordered applications in user-manual in alphabetic order
---
 .../content/src/docs/asciidoc/content.adoc         |  2 +-
 applications/order/src/docs/asciidoc/order.adoc    |  2 ++
 applications/party/src/docs/asciidoc/party.adoc    | 11 ++++++-
 .../src/docs/asciidoc/facility.adoc}               | 34 +++++++---------------
 .../product/widget/facility/CommonScreens.xml      |  2 +-
 docs/asciidoc/_include/ofbiz-glossary.adoc         | 16 +++++-----
 docs/asciidoc/user-manual.adoc                     |  8 +++--
 7 files changed, 38 insertions(+), 37 deletions(-)

diff --git a/applications/content/src/docs/asciidoc/content.adoc b/applications/content/src/docs/asciidoc/content.adoc
index e5fa40c..b4b2214 100644
--- a/applications/content/src/docs/asciidoc/content.adoc
+++ b/applications/content/src/docs/asciidoc/content.adoc
@@ -16,7 +16,7 @@ KIND, either express or implied.  See the License for the
 specific language governing permissions and limitations
 under the License.
 ////
-= Content Management Overview
+= Content Management
 The Document Content Management System (DMS/CMS) is designed to store data once and then allow it to be reused
  in multiple arrangements.
 
diff --git a/applications/order/src/docs/asciidoc/order.adoc b/applications/order/src/docs/asciidoc/order.adoc
index 4a2e9c4..197fba9 100644
--- a/applications/order/src/docs/asciidoc/order.adoc
+++ b/applications/order/src/docs/asciidoc/order.adoc
@@ -20,6 +20,8 @@ under the License.
 
 The order manager allows you to enter and maintain orders, quotes, requests and report on them.
 
+It allow to manage purchase and sales orders from the creation and approval to the goods packing and shipping.
+
 == Overview
 TODO
 
diff --git a/applications/party/src/docs/asciidoc/party.adoc b/applications/party/src/docs/asciidoc/party.adoc
index 853ca78..a406115 100644
--- a/applications/party/src/docs/asciidoc/party.adoc
+++ b/applications/party/src/docs/asciidoc/party.adoc
@@ -21,7 +21,16 @@ under the License.
 The Party Manager application is used to manage the parties, i.e any legal entity your company has to deal with.
 
 == Overview
-TODO
+A party can be a person or a company (or a group of parties).
+
+Party application can be use to manage:
+
+* customer
+* supplier
+* employee
+* ...
+
+This application is used to manage profile, contact information, relationship, role, communication, classification, ...
 
 == Parties management
 
diff --git a/applications/order/src/docs/asciidoc/order.adoc b/applications/product/src/docs/asciidoc/facility.adoc
similarity index 65%
copy from applications/order/src/docs/asciidoc/order.adoc
copy to applications/product/src/docs/asciidoc/facility.adoc
index 4a2e9c4..01d5e65 100644
--- a/applications/order/src/docs/asciidoc/order.adoc
+++ b/applications/product/src/docs/asciidoc/facility.adoc
@@ -16,29 +16,17 @@ KIND, either express or implied.  See the License for the
 specific language governing permissions and limitations
 under the License.
 ////
-= Order
+= Facility
 
-The order manager allows you to enter and maintain orders, quotes, requests and report on them.
+The Facility Manager is used to manage a warehouse, a store with related inventory.
 
-== Overview
-TODO
+All operations relating to stock:
 
-== Orders management
-
-=== Main screen
-To select Sales and/or Purchase orders
-
-=== Order View
-This screen allow not only to view an order but also to change it
-
-include::_include/order_report.adoc[leveloffset=+1]
-
-== Requests
-
-== Quotes
-
-== Returns
-
-== Requirements
-
-== Stats
\ No newline at end of file
+* defining locations (in a hierarchical and multi-level ways)
+* receiving
+* picking, packing
+* shipping
+* transfer
+* return
+* physical inventory
+* ...
diff --git a/applications/product/widget/facility/CommonScreens.xml b/applications/product/widget/facility/CommonScreens.xml
index b584eac..0f0043a 100644
--- a/applications/product/widget/facility/CommonScreens.xml
+++ b/applications/product/widget/facility/CommonScreens.xml
@@ -42,7 +42,7 @@ under the License.
                 <set field="activeApp" value="facilitymgr" global="true"/>
                 <set field="applicationMenuName" value="FacilityAppBar" global="true"/>
                 <set field="applicationMenuLocation" value="component://product/widget/facility/FacilityMenus.xml" global="true"/>
-                <set field="helpAnchor" from-field="helpAnchor" default-value="_core_business_applications"/>
+                <set field="helpAnchor" from-field="helpAnchor" default-value="_facility"/>
                 <set field="applicationTitle" from-field="uiLabelMap.ProductFacilityManagerApplication" global="true"/>
             </actions>
             <widgets>
diff --git a/docs/asciidoc/_include/ofbiz-glossary.adoc b/docs/asciidoc/_include/ofbiz-glossary.adoc
index 57d5755..0eeaa54 100644
--- a/docs/asciidoc/_include/ofbiz-glossary.adoc
+++ b/docs/asciidoc/_include/ofbiz-glossary.adoc
@@ -61,24 +61,24 @@ They are included in the ofbiz-framework and each one has one (or more) menu ent
 Currently there are :
 * <<_accounting>>, +
   menu entries: Accounting, Accounting-AP, Accounting-AR
-* Product management, to manage products, prices, promotion rules, categories, catalogs, stores and more. +
+* <<_catalog>>, to manage products, prices, promotion rules, categories, catalogs, stores and more. +
   menu entry: Catalog
-* Content management,
-* Wharehouse management, to manage facilities, inventory, physical inventory, in and out shipment, and more. +
+* <<_content_management>>,
+* <<_facility>>: Wharehouse management, to manage facilities, inventory, physical inventory, in and out shipment, and more. +
   menu entry: Facility
 * <<_human_resources>> management, +
   menu entry: HR
-* Manufacturing management: Materials Resource Planning, define production schemas and tasks, Bill of Materials, Equipment allocation,
+* <<_manufacturing>>: Materials Resource Planning, define production schemas and tasks, Bill of Materials, Equipment allocation,
 Workers assignment, Job Shop
-* Marketing management: Marketing Communications Management and Sales Force Automation +
-  menu entry: Marketing, SFA
-* Order management: Fully featured sales and purchase order management module, including
+* <<_marketing>>: Marketing Communications Management and Sales Force Automation +
+  menu entry: Marketing, <<_sfa>>
+* <<_order>>: Fully featured sales and purchase order management module, including
   ** request
   ** requirements
   ** quote
   ** order
   ** statistics
-* Party management, enables organizations to maintain parties (human and other legal entities), their roles and user accounts, and lots more.
+* <<_party>>, enables organizations to maintain parties (human and other legal entities), their roles and user accounts, and lots more.
 * Work Effort Management, to manage work efforts, tasks, calendar, maintenance assignments and more.
 
 With these core applications multiple others can be build. In ofbiz-plugin you can find some.
diff --git a/docs/asciidoc/user-manual.adoc b/docs/asciidoc/user-manual.adoc
index a77d70e..fd06274 100644
--- a/docs/asciidoc/user-manual.adoc
+++ b/docs/asciidoc/user-manual.adoc
@@ -158,21 +158,23 @@ of how to achieve common tasks.
 
 include::../../applications/accounting/src/docs/asciidoc/accounting.adoc[leveloffset=+2]
 
+include::../../applications/product/src/docs/asciidoc/product.adoc[leveloffset=+2]
+
 include::../../applications/content/src/docs/asciidoc/content.adoc[leveloffset=+2]
 
+include::../../applications/product/src/docs/asciidoc/facility.adoc[leveloffset=+2]
+
 include::../../applications/humanres/src/docs/asciidoc/humanres.adoc[leveloffset=+2]
 
 include::../../applications/manufacturing/src/docs/asciidoc/manufacturing.adoc[leveloffset=+2]
 
 include::../../applications/marketing/src/docs/asciidoc/marketing.adoc[leveloffset=+2]
 
-include::../../applications/marketing/src/docs/asciidoc/sfa.adoc[leveloffset=+2]
-
 include::../../applications/order/src/docs/asciidoc/order.adoc[leveloffset=+2]
 
 include::../../applications/party/src/docs/asciidoc/party.adoc[leveloffset=+2]
 
-include::../../applications/product/src/docs/asciidoc/product.adoc[leveloffset=+2]
+include::../../applications/marketing/src/docs/asciidoc/sfa.adoc[leveloffset=+2]
 
 ////
 webtools help should be remove when global glossary exist, and contain a link to developer-manual#webtools