[ofbiz-framework] branch trunk updated: Fixed: online help links don't get where they should (OFBIZ-12328)
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 874e2dd Fixed: online help links don't get where they should (OFBIZ-12328) 874e2dd is described below commit 874e2dd03c5d55205d2b230107662e2bd4e61812 Author: holivier AuthorDate: Tue Sep 28 20:54:13 2021 +0200 Fixed: online help links don't get where they should (OFBIZ-12328) Correction for content and accounting AR & AP --- applications/accounting/widget/ap/CommonScreens.xml | 2 +- applications/accounting/widget/ar/CommonScreens.xml | 2 +- applications/content/widget/CommonScreens.xml | 6 +++--- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/applications/accounting/widget/ap/CommonScreens.xml b/applications/accounting/widget/ap/CommonScreens.xml index 0e1561c..eff29ff 100644 --- a/applications/accounting/widget/ap/CommonScreens.xml +++ b/applications/accounting/widget/ap/CommonScreens.xml @@ -30,7 +30,7 @@ under the License. - + diff --git a/applications/accounting/widget/ar/CommonScreens.xml b/applications/accounting/widget/ar/CommonScreens.xml index 7e2a552..3273b30 100644 --- a/applications/accounting/widget/ar/CommonScreens.xml +++ b/applications/accounting/widget/ar/CommonScreens.xml @@ -33,7 +33,7 @@ under the License. - + diff --git a/applications/content/widget/CommonScreens.xml b/applications/content/widget/CommonScreens.xml index 85a91fe..54a1f4e 100644 --- a/applications/content/widget/CommonScreens.xml +++ b/applications/content/widget/CommonScreens.xml @@ -37,7 +37,7 @@ under the License. - + @@ -503,7 +503,7 @@ under the License. - + @@ -542,5 +542,5 @@ under the License. - +
[ofbiz-framework] branch trunk updated (edcaf9d -> a81d011)
This is an automated email from the ASF dual-hosted git repository.
holivier pushed a change to branch trunk
in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git.
from edcaf9d Improvement: label OrderAdjustmentType (OFBIZ-12234) (#295)
new e5cab60 Documented: Order online Documentation and help (OFBIZ-12224)
new d1d30be Documented: Order online Documentation and help (OFBIZ-12224)
new a81d011 Documented: Order online Documentation and help (OFBIZ-12224)
The 3 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../src/docs/asciidoc/_include/acc-payments.adoc | 7 +
.../_include/Help-order-bill-settings.adoc | 27 +++
.../asciidoc/_include/order-payment-diagrams.adoc | 47 +
.../{order_report.adoc => order-report.adoc} | 0
.../src/docs/asciidoc/_include/order-return.adoc | 189 +
.../_include/order-update-order-diagrams.adoc | 40 +
.../docs/asciidoc/images/order/billing-account.png | Bin 0 -> 26058 bytes
.../src/docs/asciidoc/images/order/credit-card.png | Bin 0 -> 19337 bytes
.../images/order/order-return-create_level3.png| Bin 0 -> 53752 bytes
.../images/order/order-return-update_level2.png| Bin 0 -> 18488 bytes
.../images/order/order-return-update_level3.png| Bin 0 -> 47554 bytes
.../asciidoc/images/order/payment-terms_level2.png | Bin 0 -> 14841 bytes
.../asciidoc/images/order/update-order_level1.png | Bin 0 -> 17180 bytes
.../asciidoc/images/order/update-order_level3.png | Bin 0 -> 73706 bytes
applications/order/src/docs/asciidoc/order.adoc| 12 +-
.../order/widget/ordermgr/OrderReturnScreens.xml | 10 +-
.../product/src/docs/asciidoc/facility.adoc| 15 ++
.../product/widget/facility/FacilityScreens.xml| 5 +-
18 files changed, 347 insertions(+), 5 deletions(-)
create mode 100644
applications/order/src/docs/asciidoc/_include/order-payment-diagrams.adoc
rename applications/order/src/docs/asciidoc/_include/{order_report.adoc =>
order-report.adoc} (100%)
create mode 100644
applications/order/src/docs/asciidoc/_include/order-return.adoc
create mode 100644
applications/order/src/docs/asciidoc/_include/order-update-order-diagrams.adoc
create mode 100644
applications/order/src/docs/asciidoc/images/order/billing-account.png
create mode 100644
applications/order/src/docs/asciidoc/images/order/credit-card.png
create mode 100644
applications/order/src/docs/asciidoc/images/order/order-return-create_level3.png
create mode 100644
applications/order/src/docs/asciidoc/images/order/order-return-update_level2.png
create mode 100644
applications/order/src/docs/asciidoc/images/order/order-return-update_level3.png
create mode 100644
applications/order/src/docs/asciidoc/images/order/payment-terms_level2.png
create mode 100644
applications/order/src/docs/asciidoc/images/order/update-order_level1.png
create mode 100644
applications/order/src/docs/asciidoc/images/order/update-order_level3.png
[ofbiz-framework] 03/03: Documented: Order online Documentation and help (OFBIZ-12224)
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
commit a81d0111c13a463ce5cbcef032eb8dd964ca3a2b
Author: holivier
AuthorDate: Tue May 18 11:59:51 2021 +0200
Documented: Order online Documentation and help (OFBIZ-12224)
just rename two adoc files, change from _ to -
---
.../docs/asciidoc/_include/{order_report.adoc => order-report.adoc} | 0
.../docs/asciidoc/_include/{order_return.adoc => order-return.adoc} | 0
applications/order/src/docs/asciidoc/order.adoc | 4 ++--
3 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/applications/order/src/docs/asciidoc/_include/order_report.adoc
b/applications/order/src/docs/asciidoc/_include/order-report.adoc
similarity index 100%
rename from applications/order/src/docs/asciidoc/_include/order_report.adoc
rename to applications/order/src/docs/asciidoc/_include/order-report.adoc
diff --git a/applications/order/src/docs/asciidoc/_include/order_return.adoc
b/applications/order/src/docs/asciidoc/_include/order-return.adoc
similarity index 100%
rename from applications/order/src/docs/asciidoc/_include/order_return.adoc
rename to applications/order/src/docs/asciidoc/_include/order-return.adoc
diff --git a/applications/order/src/docs/asciidoc/order.adoc
b/applications/order/src/docs/asciidoc/order.adoc
index 7e5a782..dd590cb 100644
--- a/applications/order/src/docs/asciidoc/order.adoc
+++ b/applications/order/src/docs/asciidoc/order.adoc
@@ -171,13 +171,13 @@ and have a look at <>
include::_include/order-ecommerce-entry-path.adoc[leveloffset=+3]
-include::_include/order_report.adoc[leveloffset=+1]
+include::_include/order-report.adoc[leveloffset=+1]
== Requests
== Quotes
-include::_include/order_return.adoc[leveloffset=+1]
+include::_include/order-return.adoc[leveloffset=+1]
== Requirements
[ofbiz-framework] 01/03: Documented: Order online Documentation and help (OFBIZ-12224)
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 commit e5cab600b20c9e41e5e1354845ca252b61c9463c Author: holivier AuthorDate: Tue May 11 17:44:14 2021 +0200 Documented: Order online Documentation and help (OFBIZ-12224) In order - order documentation add * payment term diagram and help about order-bill-setting, * order update diagrams most of content and diagram is coming from wiki page https://cwiki.apache.org/confluence/display/OFBIZ/Sales+Order+Management+Process+Overview many thanks to Shivangi Tanwar and some complement from Order Management PDF from David Jones --- .../src/docs/asciidoc/_include/acc-payments.adoc | 7 +++ .../_include/Help-order-bill-settings.adoc | 27 .../asciidoc/_include/order-payment-diagrams.adoc | 47 + .../_include/order-update-order-diagrams.adoc | 40 ++ .../docs/asciidoc/images/order/billing-account.png | Bin 0 -> 26058 bytes .../src/docs/asciidoc/images/order/credit-card.png | Bin 0 -> 19337 bytes .../asciidoc/images/order/payment-terms_level2.png | Bin 0 -> 14841 bytes .../asciidoc/images/order/update-order_level1.png | Bin 0 -> 17180 bytes .../asciidoc/images/order/update-order_level3.png | Bin 0 -> 73706 bytes applications/order/src/docs/asciidoc/order.adoc| 8 10 files changed, 129 insertions(+) diff --git a/applications/accounting/src/docs/asciidoc/_include/acc-payments.adoc b/applications/accounting/src/docs/asciidoc/_include/acc-payments.adoc index d610575..fc9bfd9 100644 --- a/applications/accounting/src/docs/asciidoc/_include/acc-payments.adoc +++ b/applications/accounting/src/docs/asciidoc/_include/acc-payments.adoc @@ -24,6 +24,13 @@ They can be incoming or outgoing. Incoming payments are normally from customers and outgoing ones to suppliers. +the Payment screen contains a lot of information not normally at your fingertips. The screen for creating a Payment looks very +similar to the View Payment screen: you have drop-down boxes for Payment Type, Payment Method Type, and Status. +The other fields are asking for ID numbers which may be more difficult to obtain. + +For the above reasons, it is probably quicker and easier to click on the [Receive Payment] link from the View Order screen +than to try to create a Payment from the Accounting Manager. + == Payments management in User Interface include::HELP_findPayments.adoc[leveloffset=+2] diff --git a/applications/order/src/docs/asciidoc/_include/Help-order-bill-settings.adoc b/applications/order/src/docs/asciidoc/_include/Help-order-bill-settings.adoc index 7860417..a5b9053 100644 --- a/applications/order/src/docs/asciidoc/_include/Help-order-bill-settings.adoc +++ b/applications/order/src/docs/asciidoc/_include/Help-order-bill-settings.adoc @@ -20,11 +20,38 @@ under the License. If there are multiple "payment" term, it's the place to enter them. It's optional and you can enter as many as you want. +Various payment terms in OFBiz are: + +* Financial +* Payment Net Days +* Late Fee (percent) +* Penalty for Collection Agency +* Non-compete etc. + = Payment setting +*Payment method* How will the customer pay ? Select the radio button to correspond with he payment method preferred by the customer. + Billing information is to completed when credit card or eft payments are not used. +Various payment methods in OFBiz are: + +* Billing Account +* Cash +* Cash on Delivery +* Certified Check +* Company Account +* Company Check +* Credit Card +* Electronic Fund Transfer +* Financial Account +* Gift Card +* Gift Certificate +* Money Order +* Offline Payment +* Paypal +* Personal Check etc. + = Additional Party Entry There may be reasons for associating another Party or Group with the order. For example, the person placing the order diff --git a/applications/order/src/docs/asciidoc/_include/order-payment-diagrams.adoc b/applications/order/src/docs/asciidoc/_include/order-payment-diagrams.adoc new file mode 100644 index 000..e3d6bfc --- /dev/null +++ b/applications/order/src/docs/asciidoc/_include/order-payment-diagrams.adoc @@ -0,0 +1,47 @@ + +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
[ofbiz-framework] 02/03: Documented: Order online Documentation and help (OFBIZ-12224)
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 commit d1d30be6583144558cbe7374a641ffb0af67bc50 Author: holivier AuthorDate: Tue May 11 17:47:27 2021 +0200 Documented: Order online Documentation and help (OFBIZ-12224) Add Return documentation, diagrams content is coming from wiki page https://cwiki.apache.org/confluence/display/OFBIZ/Sales+Order+Management+Process+Overview many thanks to Shivangi Tanwar some complement and help for UI from Order Management PDF from David Jones --- .../src/docs/asciidoc/_include/order_return.adoc | 189 + .../images/order/order-return-create_level3.png| Bin 0 -> 53752 bytes .../images/order/order-return-update_level2.png| Bin 0 -> 18488 bytes .../images/order/order-return-update_level3.png| Bin 0 -> 47554 bytes applications/order/src/docs/asciidoc/order.adoc| 2 +- .../order/widget/ordermgr/OrderReturnScreens.xml | 10 +- .../product/src/docs/asciidoc/facility.adoc| 15 ++ .../product/widget/facility/FacilityScreens.xml| 5 +- 8 files changed, 217 insertions(+), 4 deletions(-) diff --git a/applications/order/src/docs/asciidoc/_include/order_return.adoc b/applications/order/src/docs/asciidoc/_include/order_return.adoc new file mode 100644 index 000..6b05897 --- /dev/null +++ b/applications/order/src/docs/asciidoc/_include/order_return.adoc @@ -0,0 +1,189 @@ + +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. + += Returns + +== Return Process Overview +Sales Return is merchandise returned back to the seller by a customer. Sales return is a common concept used in sales and +purchase terminology. The main purpose of the sales return is to provide easy returns to the customers to maintain long +relationships with them. + +While viewing an existing order, you can create a return from that order by clicking on the [Create Return] +button (in Action section). That will take you to the quickreturn screen, from where +you identify which item(s) the customers wants to return. + +A sales return can be created for one of the following Reasons: + +* Excess quantity shipped +* Excess quantity ordered +* Defective Goods +* Goods shipped too late +* Product specifications are incorrect +* Wrong items shipped + +Sales Return types can be: + +* Store credit +* Refund +* Exchange +* Store credit replacement + +When a product is returned, the process impacts many different components of your business. Consider: + +. Customer must coordinate the physical return of the item(s) with your company. + This is controlled by the document called the 'Return'. + Be sure the Customer encloses a copy of the Return with his package or at least includes the Return ID on the shipping label + and documents. +. Your Facility needs to be alerted that the item(s) will be coming in from a source other than a regular supplier. +. The value of the returned item(s) must be credited back to the Customer. +. Taxes credited to taxing authorities must be reversed. +. Costs for shipping, handling, perhaps re-shelving, must all be accounted for. +. Possible replacement of the item must go through the entire Order Fulfillment chain. +. The returned item(s) must be inspected with a determination made whether to: + .. place an item back into Inventory for re-sale; OR + .. repair/ re-furbish/ re-packag before return to Inventory; OR + .. return a defective product to YOUR supplier for credit or refund; OR + .. dispose of it with a loss write-off. +. Adjustments must be made to Inventory, Sales Figures, perhaps to Sales Commissions, and other records within the company. + +As you scroll through the screens, try to envision how each of these areas are impacted within the Company. +Realize that the Order Manager, Work Effort Manager, Accounting Manager, and Facility Manager are primary players. +The Marketing Manager and perhaps the Manufacturing Manager might be involved if some adjustments are needed. + +Fortunately, the systems set up within Open For Business have automated much of this for you. +However, by understanding the e
[ofbiz-framework] branch trunk updated: Documented: Order online Documentation and help (OFBIZ-12224)
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 af335df Documented: Order online Documentation and help (OFBIZ-12224) af335df is described below commit af335df8d177ab054fb6b050f23790b3d725b17c Author: holivier AuthorDate: Tue May 11 17:37:54 2021 +0200 Documented: Order online Documentation and help (OFBIZ-12224) Correction on helpAnchor in OrderScreens to put value directly not as default-value. --- .../order/widget/ordermgr/OrderEntryCartScreens.xml | 2 +- .../order/widget/ordermgr/OrderEntryOrderScreens.xml | 16 applications/order/widget/ordermgr/OrderEntryScreens.xml | 4 ++-- applications/order/widget/ordermgr/OrderViewScreens.xml | 8 4 files changed, 15 insertions(+), 15 deletions(-) diff --git a/applications/order/widget/ordermgr/OrderEntryCartScreens.xml b/applications/order/widget/ordermgr/OrderEntryCartScreens.xml index b80b5d4..ef446d0 100644 --- a/applications/order/widget/ordermgr/OrderEntryCartScreens.xml +++ b/applications/order/widget/ordermgr/OrderEntryCartScreens.xml @@ -76,7 +76,7 @@ under the License. - + diff --git a/applications/order/widget/ordermgr/OrderEntryOrderScreens.xml b/applications/order/widget/ordermgr/OrderEntryOrderScreens.xml index a2ed643..20f4be7 100644 --- a/applications/order/widget/ordermgr/OrderEntryOrderScreens.xml +++ b/applications/order/widget/ordermgr/OrderEntryOrderScreens.xml @@ -50,7 +50,7 @@ under the License. - + @@ -92,7 +92,7 @@ under the License. - + @@ -139,7 +139,7 @@ under the License. - + @@ -159,7 +159,7 @@ under the License. - + @@ -188,7 +188,7 @@ under the License. - + @@ -209,7 +209,7 @@ under the License. - +
[ofbiz-framework] branch trunk updated: Documented: Order online Documentation and help (OFBIZ-12224)
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 59e5088 Documented: Order online Documentation and help (OFBIZ-12224) 59e5088 is described below commit 59e50880e9b1a403ae4410ff225e0c96e663d97c Author: holivier AuthorDate: Tue May 4 16:14:27 2021 +0200 Documented: Order online Documentation and help (OFBIZ-12224) forgot image about order-status-change in the previous commit --- .../docs/asciidoc/images/order/manage-order-status.png | Bin 0 -> 44527 bytes 1 file changed, 0 insertions(+), 0 deletions(-) diff --git a/applications/order/src/docs/asciidoc/images/order/manage-order-status.png b/applications/order/src/docs/asciidoc/images/order/manage-order-status.png new file mode 100644 index 000..1ee9477 Binary files /dev/null and b/applications/order/src/docs/asciidoc/images/order/manage-order-status.png differ
[ofbiz-framework] branch trunk updated: Documented: Order online Documentation and help (OFBIZ-12224)
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 462b871 Documented: Order online Documentation and help (OFBIZ-12224)
462b871 is described below
commit 462b871f186d0fc9623bc9f059ca5e5ddf1f9907
Author: holivier
AuthorDate: Thu Apr 15 15:21:52 2021 +0200
Documented: Order online Documentation and help (OFBIZ-12224)
Migration of OFBiz wiki 3.1-3.2-3.3 Order Entry page and Sales Order
Management page
Create Order Diagrams
Order Status Diagrams
Add link from screen to help
---
.../_include/Help-order-bill-settings.adoc | 36
.../asciidoc/_include/Help-order-check-inits.adoc | 49 ++
.../docs/asciidoc/_include/Help-order-confirm.adoc | 34
.../docs/asciidoc/_include/Help-order-entry.adoc | 56 +++
.../_include/Help-order-option-settings.adoc | 45 +
.../Help-order-ship-setting.adoc} | 32 +---
.../asciidoc/_include/Help-order-show-cart.adoc| 135 +++
.../docs/asciidoc/_include/Help-order-view.adoc| 186 +
.../_include/order-create-order-diagrams.adoc | 65 +++
.../_include/order-ecommerce-entry-path.adoc | 154 +
.../{order.adoc => _include/order-glossary.adoc} | 33 +---
.../asciidoc/_include/order-status-diagrams.adoc | 48 ++
.../images/order/create-sales-order_level1.png | Bin 0 -> 16673 bytes
.../images/order/create-sales-order_level2.png | Bin 0 -> 56915 bytes
.../images/order/create-sales-order_level3.png | Bin 0 -> 81329 bytes
applications/order/src/docs/asciidoc/order.adoc| 146 +++-
.../widget/ordermgr/OrderEntryCartScreens.xml | 1 +
.../widget/ordermgr/OrderEntryOrderScreens.xml | 12 +-
.../order/widget/ordermgr/OrderEntryScreens.xml| 2 +
.../order/widget/ordermgr/OrderViewScreens.xml | 4 +
applications/party/src/docs/asciidoc/party.adoc| 13 ++
21 files changed, 993 insertions(+), 58 deletions(-)
diff --git
a/applications/order/src/docs/asciidoc/_include/Help-order-bill-settings.adoc
b/applications/order/src/docs/asciidoc/_include/Help-order-bill-settings.adoc
new file mode 100644
index 000..7860417
--- /dev/null
+++
b/applications/order/src/docs/asciidoc/_include/Help-order-bill-settings.adoc
@@ -0,0 +1,36 @@
+
+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.
+
+= Order Term
+
+If there are multiple "payment" term, it's the place to enter them. It's
optional and you can enter as many as you want.
+
+= Payment setting
+
+How will the customer pay ? Select the radio button to correspond with he
payment method preferred by the customer. +
+Billing information is to completed when credit card or eft payments are not
used.
+
+= Additional Party Entry
+
+There may be reasons for associating another Party or Group with the order.
For example, the person placing the order
+might be an member of an existing customer group, such as a shopping club, or
they might be a purchasing agent for
+a company and need to be identified with that company.
+
+When you select to identify another group or individual for association, a
process will be followed. +
+Select a Party (use the lookup or auto-completion in field) and after the
apply button you have to select which role for this
+party for this order. Only Existing role associated with the party selected
appear.
\ No newline at end of file
diff --git
a/applications/order/src/docs/asciidoc/_include/Help-order-check-inits.adoc
b/applications/order/src/docs/asciidoc/_include/Help-order-check-inits.adoc
new file mode 100644
index 000..7825b52
--- /dev/null
+++ b/applications/order/src/docs/asciidoc/_include/Help-order-check-inits.adoc
@@ -0,0 +1,49 @@
+
+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
+&q
[ofbiz-framework] branch trunk updated: Documented:migrated Wiki How to Create the main Company in Party Manager to user-manual (OFBIZ-12065)
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 64ce92b Documented:migrated Wiki How to Create the main Company in Party Manager to user-manual (OFBIZ-12065) 64ce92b is described below commit 64ce92baa79f0fcd25532fda9973574c2ca0c45f Author: holivier AuthorDate: Wed Mar 17 16:24:31 2021 +0100 Documented:migrated Wiki How to Create the main Company in Party Manager to user-manual (OFBIZ-12065) Add a link to the video of the tutorial running Thanks to Aditya Sharma for put it on Youtube --- .../src/docs/asciidoc/_include/party-howto-create-mainCompany.adoc | 5 + 1 file changed, 5 insertions(+) diff --git a/applications/party/src/docs/asciidoc/_include/party-howto-create-mainCompany.adoc b/applications/party/src/docs/asciidoc/_include/party-howto-create-mainCompany.adoc index 28076ac..6742168 100644 --- a/applications/party/src/docs/asciidoc/_include/party-howto-create-mainCompany.adoc +++ b/applications/party/src/docs/asciidoc/_include/party-howto-create-mainCompany.adoc @@ -29,6 +29,11 @@ NOTE: Party Manager is the application where we create all the entities This tutorial is quite simple, only 4 step. +This process is running automatically every day in Apache OFBiz demo (trunk) as a GUI process test. + +The associated video (showing all the actions described in this tutorial) can be visualize at +https://youtu.be/G3GSXNvxe0M[How to Create the main Company] + + == step Party 1. Login to OFBiz 2. Create Party
[ofbiz-plugins] branch trunk updated: Documented: ordered component documentation in the same order than application menu (OFBIZ-12166)
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-plugins.git The following commit(s) were added to refs/heads/trunk by this push: new 32508bd Documented: ordered component documentation in the same order than application menu (OFBIZ-12166) 32508bd is described below commit 32508bd437d964f14ef7dd64f19fa57f173c6f8d Author: holivier AuthorDate: Wed Mar 10 18:38:33 2021 +0100 Documented: ordered component documentation in the same order than application menu (OFBIZ-12166) --- docs/asciidoc/plugins-user-manual.adoc | 12 ++-- 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/asciidoc/plugins-user-manual.adoc b/docs/asciidoc/plugins-user-manual.adoc index 8147173..571b961 100644 --- a/docs/asciidoc/plugins-user-manual.adoc +++ b/docs/asciidoc/plugins-user-manual.adoc @@ -27,8 +27,14 @@ endif::[] :toc: :sectnums: +include::../../projectmgr/src/docs/asciidoc/project-mgr.adoc[leveloffset=+1] + +include::../../myportal/src/docs/asciidoc/my-portal.adoc[leveloffset=+1] + include::../../assetmaint/src/docs/asciidoc/assetm.adoc[leveloffset=+1] +include::../../scrum/src/docs/asciidoc/scrum.adoc[leveloffset=+1] + include::../../birt/src/docs/asciidoc/birt.adoc[leveloffset=+1] include::../../ebay/src/docs/asciidoc/ebay.adoc[leveloffset=+1] @@ -36,9 +42,3 @@ include::../../ebay/src/docs/asciidoc/ebay.adoc[leveloffset=+1] include::../../ebaystore/src/docs/asciidoc/ebay-store.adoc[leveloffset=+1] include::../../example/src/docs/asciidoc/example.adoc[leveloffset=+1] - -include::../../myportal/src/docs/asciidoc/my-portal.adoc[leveloffset=+1] - -include::../../projectmgr/src/docs/asciidoc/project-mgr.adoc[leveloffset=+1] - -include::../../scrum/src/docs/asciidoc/scrum.adoc[leveloffset=+1] \ No newline at end of file
[ofbiz-framework] branch trunk updated: Documented: ordered component documentation in the same order than application menu (OFBIZ-12166)
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 4da21cc Documented: ordered component documentation in the same order than application menu (OFBIZ-12166) 4da21cc is described below commit 4da215e887ff23df930eacaa0e92bebb3bd3 Author: holivier AuthorDate: Wed Mar 10 18:36:05 2021 +0100 Documented: ordered component documentation in the same order than application menu (OFBIZ-12166) --- docs/asciidoc/user-manual.adoc | 18 +- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/asciidoc/user-manual.adoc b/docs/asciidoc/user-manual.adoc index 00e7ff1..10fffde 100644 --- a/docs/asciidoc/user-manual.adoc +++ b/docs/asciidoc/user-manual.adoc @@ -157,26 +157,26 @@ This section of the manual will describe each core business application starting with a high level overview of design and purpose down to the details of how to achieve common tasks. -include::../../applications/accounting/src/docs/asciidoc/accounting.adoc[leveloffset=+1] +include::../../applications/party/src/docs/asciidoc/party.adoc[leveloffset=+1] include::../../applications/product/src/docs/asciidoc/product.adoc[leveloffset=+1] -include::../../applications/content/src/docs/asciidoc/content.adoc[leveloffset=+1] - include::../../applications/product/src/docs/asciidoc/facility.adoc[leveloffset=+1] -include::../../applications/humanres/src/docs/asciidoc/humanres.adoc[leveloffset=+1] - -include::../../applications/manufacturing/src/docs/asciidoc/manufacturing.adoc[leveloffset=+1] +include::../../applications/order/src/docs/asciidoc/order.adoc[leveloffset=+1] -include::../../applications/marketing/src/docs/asciidoc/marketing.adoc[leveloffset=+1] +include::../../applications/accounting/src/docs/asciidoc/accounting.adoc[leveloffset=+1] -include::../../applications/order/src/docs/asciidoc/order.adoc[leveloffset=+1] +include::../../applications/content/src/docs/asciidoc/content.adoc[leveloffset=+1] -include::../../applications/party/src/docs/asciidoc/party.adoc[leveloffset=+1] +include::../../applications/manufacturing/src/docs/asciidoc/manufacturing.adoc[leveloffset=+1] include::../../applications/marketing/src/docs/asciidoc/sfa.adoc[leveloffset=+1] +include::../../applications/humanres/src/docs/asciidoc/humanres.adoc[leveloffset=+1] + +include::../../applications/marketing/src/docs/asciidoc/marketing.adoc[leveloffset=+1] + webtools help should be remove when global glossary exist, and contain a link to developer-manual#webtools
[ofbiz-framework] branch trunk updated: Documented: put end of quote block on a newline
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 5933087 Documented: put end of quote block on a newline 5933087 is described below commit 5933087a7e5afec14635a9bd0f522adb4b1658a1 Author: holivier AuthorDate: Wed Mar 3 14:08:58 2021 +0100 Documented: put end of quote block on a newline after commit 8e9cbde Documented: issue on Windows when OFBiz home dir has space/s in it there was an error unterminated quote block on asciidoc generation --- README.adoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.adoc b/README.adoc index 817c331..23863ff 100644 --- a/README.adoc +++ b/README.adoc @@ -69,7 +69,8 @@ you can download from the below link. Make sure of setting the $JAVA_HOME environment variable. __ -_Note_: Warning: on Windows don't put OFBiz in a directory with space/s in the path.__ +_Note_: Warning: on Windows don't put OFBiz in a directory with space/s in the path. +__ https://adoptopenjdk.net/[JDK download]
[ofbiz-framework] branch trunk updated: Documented:migrated Wiki How to Create the main Company in Party Manager to user-manual (OFBIZ-12065)
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 5781f08 Documented:migrated Wiki How to Create the main Company in Party Manager to user-manual (OFBIZ-12065) 5781f08 is described below commit 5781f08ff6f5b51c526750a8aff049591ef85780 Author: holivier AuthorDate: Mon Nov 30 12:07:07 2020 +0100 Documented:migrated Wiki How to Create the main Company in Party Manager to user-manual (OFBIZ-12065) Add section Parties Processes and as first process How To Create Main Company --- .../_include/party-howto-create-mainCompany.adoc | 93 ++ applications/party/src/docs/asciidoc/party.adoc| 6 +- 2 files changed, 98 insertions(+), 1 deletion(-) diff --git a/applications/party/src/docs/asciidoc/_include/party-howto-create-mainCompany.adoc b/applications/party/src/docs/asciidoc/_include/party-howto-create-mainCompany.adoc new file mode 100644 index 000..28076ac --- /dev/null +++ b/applications/party/src/docs/asciidoc/_include/party-howto-create-mainCompany.adoc @@ -0,0 +1,93 @@ + +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. + += How to Create the main Company + +OFBiz needs to have at least on main company set up that will represent the main business or organization. + +If you have installed OFBiz with the demo data then the main company already exists. + +If you have installed OFBiz without the demo data then it will not exist so you will need to create it. + +This is is done in Party Manager. + +NOTE: Party Manager is the application where we create all the entities + (companies, people, groups, departments) that we deal with in the course of doing business. + +This tutorial is quite simple, only 4 step. + +== step Party +1. Login to OFBiz +2. Create Party + * Select “Party” from the Applications drop down menu if you are not already in + * Click “Create New Party Group” + + The company we are creating is not an individual (person, customer, prospect or employee). + It is an organization and in OFBiz this is called a "party group" (a group of people) +3. fill in the form fields + * Party ID (e.g COMPANY) + +(NOTE: that you can enter the Party ID manually. If it is not entered OFBiz will auto generate an ID. + If you enter the ID it will make it easier to locate it quickly in future; + but it’s dangerous to create wrong ID, in ID only standard characters and without space are authorized. ID length must be less than 20 characters. + Best practice is to use only UpperCase.) + + * Group Name (e.g “My OFBiz Main Company”). This will be the name of your company) + * it's possible to leave al other field blank +4. Click “Save” + +You are now on profile page. + +== step Address +Next we need to enter some contact details. Find the "Contact Information" section (box) + +1. Click "Create" on the screenlet title +2. Select "Postal Address" +3. Click "Create" +4. fill in the form fields + * Address Line 1 + * Address Line 2 (not mandatory) + * City + * State / Province (not mandatory) + * Zip / Postal Code + * Country +5. Click Save + +The address is added - but - there is still some missing setup. + +== step Address purpose +We need to include a purpose (or use) for the address. + +1. Click “Update” next to the address details +2. Select "Primary Address" and Click "Add Purpose +3. Select "Shipping Origin Address" and Click "Add Purpose" +4. Select "Shipping Destination Address" and Click "Add Purpose" +5. click to GoBack or on Profile in the screen-sub-menu + +The address purpose is be updated. + +== step role +We now need to add a specific role to this party group to let OFBiz know that is an organization +that will have an accounting setup. + +1. Click "Roles" in screen-sub-menu +2. In the 'Add to Role : view All' section, use the dropdown box to: + * Select the Role Type Id "Internal Organization" +3. Click &q
[ofbiz-framework] branch trunk updated: Documented: User Manual : change the level of from 2 to 1 (OFBIZ-11036)
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 1ddf7f5 Documented: User Manual : change the level of from 2 to 1 (OFBIZ-11036) 1ddf7f5 is described below commit 1ddf7f5a41dfaada3e189953a99d77a41100a21a Author: holivier AuthorDate: Sat Sep 12 10:03:35 2020 +0200 Documented: User Manual : change the level of from 2 to 1 (OFBIZ-11036) --- docs/asciidoc/user-manual.adoc | 25 + 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/docs/asciidoc/user-manual.adoc b/docs/asciidoc/user-manual.adoc index fd06274..00e7ff1 100644 --- a/docs/asciidoc/user-manual.adoc +++ b/docs/asciidoc/user-manual.adoc @@ -18,6 +18,7 @@ under the License. = Apache OFBiz User Manual The Apache OFBiz Project +:doctype: book :imagesdir: ./images ifdef::backend-pdf[] :title-logo-image: image::OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=4.25in, align=center] @@ -142,7 +143,7 @@ include::../../README.adoc[tags=quickstart] include::../../applications/commonext/src/docs/asciidoc/ofbiz-setup.adoc[leveloffset=+1] -== Core Business Applications += Core Business Applications Most businesses share universal needs. They require accounting functionality, managing customers, placing orders, book-keeping, invoicing and so on. @@ -156,25 +157,25 @@ This section of the manual will describe each core business application starting with a high level overview of design and purpose down to the details of how to achieve common tasks. -include::../../applications/accounting/src/docs/asciidoc/accounting.adoc[leveloffset=+2] +include::../../applications/accounting/src/docs/asciidoc/accounting.adoc[leveloffset=+1] -include::../../applications/product/src/docs/asciidoc/product.adoc[leveloffset=+2] +include::../../applications/product/src/docs/asciidoc/product.adoc[leveloffset=+1] -include::../../applications/content/src/docs/asciidoc/content.adoc[leveloffset=+2] +include::../../applications/content/src/docs/asciidoc/content.adoc[leveloffset=+1] -include::../../applications/product/src/docs/asciidoc/facility.adoc[leveloffset=+2] +include::../../applications/product/src/docs/asciidoc/facility.adoc[leveloffset=+1] -include::../../applications/humanres/src/docs/asciidoc/humanres.adoc[leveloffset=+2] +include::../../applications/humanres/src/docs/asciidoc/humanres.adoc[leveloffset=+1] -include::../../applications/manufacturing/src/docs/asciidoc/manufacturing.adoc[leveloffset=+2] +include::../../applications/manufacturing/src/docs/asciidoc/manufacturing.adoc[leveloffset=+1] -include::../../applications/marketing/src/docs/asciidoc/marketing.adoc[leveloffset=+2] +include::../../applications/marketing/src/docs/asciidoc/marketing.adoc[leveloffset=+1] -include::../../applications/order/src/docs/asciidoc/order.adoc[leveloffset=+2] +include::../../applications/order/src/docs/asciidoc/order.adoc[leveloffset=+1] -include::../../applications/party/src/docs/asciidoc/party.adoc[leveloffset=+2] +include::../../applications/party/src/docs/asciidoc/party.adoc[leveloffset=+1] -include::../../applications/marketing/src/docs/asciidoc/sfa.adoc[leveloffset=+2] +include::../../applications/marketing/src/docs/asciidoc/sfa.adoc[leveloffset=+1] webtools help should be remove when global glossary exist, and contain a link to developer-manual#webtools @@ -185,6 +186,6 @@ The Webtools application is the UI-gateway to all the framework functions. include::../../framework/webtools/src/docs/asciidoc/_include/webtools-main.adoc[leveloffset=+3] // Plugins Business Applications -include::../../plugins/docs/asciidoc/plugins-user-manual.adoc[leveloffset=+1] +include::../../plugins/docs/asciidoc/plugins-user-manual.adoc[leveloffset=+0] include::_include/ofbiz-glossary.adoc[leveloffset=+1]
[ofbiz-framework] branch trunk updated: Documented: add simple remark about Glossary and move keyboard shortcuts and using icons in Text formatting
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 fa11e7d Documented: add simple remark about Glossary and move keyboard shortcuts and using icons in Text formatting fa11e7d is described below commit fa11e7ddc7024fea185a84147230fa541b1a2bfe Author: holivier AuthorDate: Wed Nov 18 17:24:33 2020 +0100 Documented: add simple remark about Glossary and move keyboard shortcuts and using icons in Text formatting --- docs/asciidoc/documentation_guidelines.adoc | 86 +++-- 1 file changed, 46 insertions(+), 40 deletions(-) diff --git a/docs/asciidoc/documentation_guidelines.adoc b/docs/asciidoc/documentation_guidelines.adoc index cc4ce09..61dffe5 100644 --- a/docs/asciidoc/documentation_guidelines.adoc +++ b/docs/asciidoc/documentation_guidelines.adoc @@ -363,6 +363,46 @@ This is the text for the simple description headline Just a simple block example. +=== Keyboard shortcuts + +You can also define keyboard shortcuts with the `kbd` macro. + + kbd:[Alt+F11] - Toggle Full Screen Mode in the Eclipse IDE + +The result is the following: + +kbd:[Alt+F11] - Toggle Full Screen Mode in the Eclipse IDE + +The result will be different depending on the rendering (PDF, HTML). + +=== Using inline icons + +You can also add the `:icons: font` directive to the top of your document, which allows you to use the icons +from http://fortawesome.github.io/Font-Awesome/icons/ directory via a macro using any of the following icon sets: + +* fa - https://fontawesome.com/v4.7.0/icons (default) +* fas - https://fontawesome.com/icons?d=gallery=solid[Font Awesome - Solid] +* fab - https://fontawesome.com/icons?d=gallery=brands[Font Awesome - Brands] +* far - https://fontawesome.com/icons?d=gallery=regular[Font Awesome - Regular] +* fi - http://zurb.com/playground/foundation-icon-fonts-3[Foundation Icons] +* pf - https://paymentfont.com/[Payment font] + +The fa icon set is deprecated. Please use one of the other three FontAwesome icon sets. + +when icon is not available in fa icon set but in an other, it's possible to give the correct set. + +The generate Document process generate a INFOS message, if icon is available in an other set and it is not given. + +icon:comment[set=far] This is a comment icon +icon:file[set=far] And a file icon +icon:battery-full[set=fas] And a battery icon + + +.The output looks like the following +[example] +icon:comment[set=far] This is a comment icon + +icon:file[set=far] And a file icon + +icon:battery-full[set=fas] And a battery icon + == Code formatting @@ -579,46 +619,6 @@ Result: This is just a text image:OFBiz-Logo.svg[Apache OFBiz Logo, width=40%] to show inline images. -=== Keyboard shortcuts - -You can also define keyboard shortcuts with the `kbd` macro. - - kbd:[Alt+F11] - Toggle Full Screen Mode in the Eclipse IDE - -The result is the following: - -kbd:[Alt+F11] - Toggle Full Screen Mode in the Eclipse IDE - -The result will be different depending on the rendering (PDF, HTML). - -=== Using inline icons - -You can also add the `:icons: font` directive to the top of your document, which allows you to use the icons -from http://fortawesome.github.io/Font-Awesome/icons/ directory via a macro using any of the following icon sets: - -* fa - https://fontawesome.com/v4.7.0/icons (default) -* fas - https://fontawesome.com/icons?d=gallery=solid[Font Awesome - Solid] -* fab - https://fontawesome.com/icons?d=gallery=brands[Font Awesome - Brands] -* far - https://fontawesome.com/icons?d=gallery=regular[Font Awesome - Regular] -* fi - http://zurb.com/playground/foundation-icon-fonts-3[Foundation Icons] -* pf - https://paymentfont.com/[Payment font] - -The fa icon set is deprecated. Please use one of the other three FontAwesome icon sets. + -when icon is not available in fa icon set but in an other, it's possible to give the correct set. - -The generate Document process generate a INFOS message, if icon is available in an other set and it is not given. - -icon:comment[set=far] This is a comment icon -icon:file[set=far] And a file icon -icon:battery-full[set=fas] And a battery icon - - -.The output looks like the following -[example] -icon:comment[set=far] This is a comment icon + -icon:file[set=far] And a file icon + -icon:battery-full[set=fas] And a battery icon - == How to write a... @@ -654,6 +654,12 @@ This is entry #1 in our example FAQ. FAQ entry 2:: This is entry #2 in our example FAQ. + Glossary + +There is one Glossary per Component and a General Glossary in user-manual. + +For glossary entries ID should be in Uppercase with space replace by "_" + == Asciidoc FAQ
[ofbiz-framework] branch trunk updated: Documented: migrated Wiki Glossary to glossary asciidoc files (OFBIZ-12060)
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 c2c1eae Documented: migrated Wiki Glossary to glossary asciidoc files (OFBIZ-12060) c2c1eae is described below commit c2c1eae612932fe54f9dbc3040c108f21e920c41 Author: holivier AuthorDate: Tue Nov 17 18:13:07 2020 +0100 Documented: migrated Wiki Glossary to glossary asciidoc files (OFBIZ-12060) - Accounting Glossary, - declare it as glossary - re-order existing items - add a comment at beginning about importance of order items - correction for some ID: change space to _ - add some items coming from wiki glossary - Facility - add glossary directly in facility.adoc - Human Resource Glossary - re-order existing items - add a comment at beginning about importance of order items - move some items to Party Glossary or global Glossary - HR appendix: add link to wiki OFBiz related book for Data Model Reference Book - Add Party Glossary and included it in party.adoc - add some items coming from wiki glossary and HR glossary - General Glossary - add a comment at beginning about importance of order items - add some items coming from wiki glossary and HR glossary --- .../src/docs/asciidoc/_include/acc-glossary.adoc | 241 +++-- .../src/docs/asciidoc/_include/hr-appendix.adoc| 4 +- .../src/docs/asciidoc/_include/hr-glossary.adoc| 80 +++ .../humanres/src/docs/asciidoc/humanres.adoc | 4 +- .../src/docs/asciidoc/_include/party-glossary.adoc | 51 + applications/party/src/docs/asciidoc/party.adoc| 4 +- .../product/src/docs/asciidoc/facility.adoc| 12 + docs/asciidoc/_include/ofbiz-glossary.adoc | 61 +- 8 files changed, 332 insertions(+), 125 deletions(-) diff --git a/applications/accounting/src/docs/asciidoc/_include/acc-glossary.adoc b/applications/accounting/src/docs/asciidoc/_include/acc-glossary.adoc index 9c9f68e..538f63e 100644 --- a/applications/accounting/src/docs/asciidoc/_include/acc-glossary.adoc +++ b/applications/accounting/src/docs/asciidoc/_include/acc-glossary.adoc @@ -16,101 +16,144 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. +[glossary] = Accounting Glossary -[#ANNUAL_REVENUE] -Annual Revenue:: -Annual revenue is the amount of revenue for a group that is reported in the Party -Group Information screenlet of the groups profile (visit Party Profile screen). +[comment] +It's important to sort glossary entries in alphabetic order to avoid duplication or search failing. -[#ACCOUNTS PAYABLE] +[#ACCOUNTS_PAYABLE] Accounts Payable:: -The debts owed by a business, usually in relation to goods or services, inventory, or supplies. +These are the debts that your business owes to suppliers, usually in relation to goods or services, inventory, or supplies. It is also called 'A/P' for short or 'Creditors'. -[#ACCOUNT PAYABLE INVOICE] +[#ACCOUNT_PAYABLE_INVOICE] Accounts Payable Invoice:: AP invoice is a document raised by the customer and sent to the company with the details of the items sent, qty sent, price and other details. The company will enter this invoice details in the Payable module and then pay the customer according to the credit terms. This invoice may come along with the consignment or may be sent to the company separately. -[#ACCOUNTS RECEIVABLE] +[#ACCOUNTS_RECEIVABLE] Accounts Receivable:: -The money owed to a business by its customers for products and services delivered to a customer. +These are the outstanding debts that your customers owe to your business, +for products and services delivered. It is also called 'A/R' for short or Debtors. -[#ACCOUNT RECEIVABLE INVOICE] + +[#ACCOUNT_RECEIVABLE_INVOICE] Accounts Receivable Invoice:: AR Invoice is a document raised by the company and sent to the customer with the details of items sold, qty sold, price, tax and other details. Based on this invoice, the customer will send the payment in case of credit sales. -[#ACCOUNT TYPE] +[#ACCOUNT_TYPE] Account Type:: A key that specifies the accounting area to which an account belongs. The account type is required in addition to the account number to identify an account, because the same account number can be used for each account type. +[#ACCRUAL_BASED_ACCOUNTING] +Accrual Based Accounting:: This is a method where you record the income when the sale occurs and not necessarily +when you receive the payment. Also you record an expense when you receive goods or services, even though you may +not pay for them until later. + [#ACQUISITION] Acquisition:: The process of identifying the requirement for a certain good or material item
[ofbiz-framework] branch trunk updated: Documented: User Manual : change the level of from 2 to 1 (OFBIZ-11036)
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 1ddf7f5 Documented: User Manual : change the level of from 2 to 1 (OFBIZ-11036) 1ddf7f5 is described below commit 1ddf7f5a41dfaada3e189953a99d77a41100a21a Author: holivier AuthorDate: Sat Sep 12 10:03:35 2020 +0200 Documented: User Manual : change the level of from 2 to 1 (OFBIZ-11036) --- docs/asciidoc/user-manual.adoc | 25 + 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/docs/asciidoc/user-manual.adoc b/docs/asciidoc/user-manual.adoc index fd06274..00e7ff1 100644 --- a/docs/asciidoc/user-manual.adoc +++ b/docs/asciidoc/user-manual.adoc @@ -18,6 +18,7 @@ under the License. = Apache OFBiz User Manual The Apache OFBiz Project +:doctype: book :imagesdir: ./images ifdef::backend-pdf[] :title-logo-image: image::OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=4.25in, align=center] @@ -142,7 +143,7 @@ include::../../README.adoc[tags=quickstart] include::../../applications/commonext/src/docs/asciidoc/ofbiz-setup.adoc[leveloffset=+1] -== Core Business Applications += Core Business Applications Most businesses share universal needs. They require accounting functionality, managing customers, placing orders, book-keeping, invoicing and so on. @@ -156,25 +157,25 @@ This section of the manual will describe each core business application starting with a high level overview of design and purpose down to the details of how to achieve common tasks. -include::../../applications/accounting/src/docs/asciidoc/accounting.adoc[leveloffset=+2] +include::../../applications/accounting/src/docs/asciidoc/accounting.adoc[leveloffset=+1] -include::../../applications/product/src/docs/asciidoc/product.adoc[leveloffset=+2] +include::../../applications/product/src/docs/asciidoc/product.adoc[leveloffset=+1] -include::../../applications/content/src/docs/asciidoc/content.adoc[leveloffset=+2] +include::../../applications/content/src/docs/asciidoc/content.adoc[leveloffset=+1] -include::../../applications/product/src/docs/asciidoc/facility.adoc[leveloffset=+2] +include::../../applications/product/src/docs/asciidoc/facility.adoc[leveloffset=+1] -include::../../applications/humanres/src/docs/asciidoc/humanres.adoc[leveloffset=+2] +include::../../applications/humanres/src/docs/asciidoc/humanres.adoc[leveloffset=+1] -include::../../applications/manufacturing/src/docs/asciidoc/manufacturing.adoc[leveloffset=+2] +include::../../applications/manufacturing/src/docs/asciidoc/manufacturing.adoc[leveloffset=+1] -include::../../applications/marketing/src/docs/asciidoc/marketing.adoc[leveloffset=+2] +include::../../applications/marketing/src/docs/asciidoc/marketing.adoc[leveloffset=+1] -include::../../applications/order/src/docs/asciidoc/order.adoc[leveloffset=+2] +include::../../applications/order/src/docs/asciidoc/order.adoc[leveloffset=+1] -include::../../applications/party/src/docs/asciidoc/party.adoc[leveloffset=+2] +include::../../applications/party/src/docs/asciidoc/party.adoc[leveloffset=+1] -include::../../applications/marketing/src/docs/asciidoc/sfa.adoc[leveloffset=+2] +include::../../applications/marketing/src/docs/asciidoc/sfa.adoc[leveloffset=+1] webtools help should be remove when global glossary exist, and contain a link to developer-manual#webtools @@ -185,6 +186,6 @@ The Webtools application is the UI-gateway to all the framework functions. include::../../framework/webtools/src/docs/asciidoc/_include/webtools-main.adoc[leveloffset=+3] // Plugins Business Applications -include::../../plugins/docs/asciidoc/plugins-user-manual.adoc[leveloffset=+1] +include::../../plugins/docs/asciidoc/plugins-user-manual.adoc[leveloffset=+0] include::_include/ofbiz-glossary.adoc[leveloffset=+1]
[ofbiz-framework] branch trunk updated: Documented: add simple remark about Glossary and move keyboard shortcuts and using icons in Text formatting
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 fa11e7d Documented: add simple remark about Glossary and move keyboard shortcuts and using icons in Text formatting fa11e7d is described below commit fa11e7ddc7024fea185a84147230fa541b1a2bfe Author: holivier AuthorDate: Wed Nov 18 17:24:33 2020 +0100 Documented: add simple remark about Glossary and move keyboard shortcuts and using icons in Text formatting --- docs/asciidoc/documentation_guidelines.adoc | 86 +++-- 1 file changed, 46 insertions(+), 40 deletions(-) diff --git a/docs/asciidoc/documentation_guidelines.adoc b/docs/asciidoc/documentation_guidelines.adoc index cc4ce09..61dffe5 100644 --- a/docs/asciidoc/documentation_guidelines.adoc +++ b/docs/asciidoc/documentation_guidelines.adoc @@ -363,6 +363,46 @@ This is the text for the simple description headline Just a simple block example. +=== Keyboard shortcuts + +You can also define keyboard shortcuts with the `kbd` macro. + + kbd:[Alt+F11] - Toggle Full Screen Mode in the Eclipse IDE + +The result is the following: + +kbd:[Alt+F11] - Toggle Full Screen Mode in the Eclipse IDE + +The result will be different depending on the rendering (PDF, HTML). + +=== Using inline icons + +You can also add the `:icons: font` directive to the top of your document, which allows you to use the icons +from http://fortawesome.github.io/Font-Awesome/icons/ directory via a macro using any of the following icon sets: + +* fa - https://fontawesome.com/v4.7.0/icons (default) +* fas - https://fontawesome.com/icons?d=gallery=solid[Font Awesome - Solid] +* fab - https://fontawesome.com/icons?d=gallery=brands[Font Awesome - Brands] +* far - https://fontawesome.com/icons?d=gallery=regular[Font Awesome - Regular] +* fi - http://zurb.com/playground/foundation-icon-fonts-3[Foundation Icons] +* pf - https://paymentfont.com/[Payment font] + +The fa icon set is deprecated. Please use one of the other three FontAwesome icon sets. + +when icon is not available in fa icon set but in an other, it's possible to give the correct set. + +The generate Document process generate a INFOS message, if icon is available in an other set and it is not given. + +icon:comment[set=far] This is a comment icon +icon:file[set=far] And a file icon +icon:battery-full[set=fas] And a battery icon + + +.The output looks like the following +[example] +icon:comment[set=far] This is a comment icon + +icon:file[set=far] And a file icon + +icon:battery-full[set=fas] And a battery icon + == Code formatting @@ -579,46 +619,6 @@ Result: This is just a text image:OFBiz-Logo.svg[Apache OFBiz Logo, width=40%] to show inline images. -=== Keyboard shortcuts - -You can also define keyboard shortcuts with the `kbd` macro. - - kbd:[Alt+F11] - Toggle Full Screen Mode in the Eclipse IDE - -The result is the following: - -kbd:[Alt+F11] - Toggle Full Screen Mode in the Eclipse IDE - -The result will be different depending on the rendering (PDF, HTML). - -=== Using inline icons - -You can also add the `:icons: font` directive to the top of your document, which allows you to use the icons -from http://fortawesome.github.io/Font-Awesome/icons/ directory via a macro using any of the following icon sets: - -* fa - https://fontawesome.com/v4.7.0/icons (default) -* fas - https://fontawesome.com/icons?d=gallery=solid[Font Awesome - Solid] -* fab - https://fontawesome.com/icons?d=gallery=brands[Font Awesome - Brands] -* far - https://fontawesome.com/icons?d=gallery=regular[Font Awesome - Regular] -* fi - http://zurb.com/playground/foundation-icon-fonts-3[Foundation Icons] -* pf - https://paymentfont.com/[Payment font] - -The fa icon set is deprecated. Please use one of the other three FontAwesome icon sets. + -when icon is not available in fa icon set but in an other, it's possible to give the correct set. - -The generate Document process generate a INFOS message, if icon is available in an other set and it is not given. - -icon:comment[set=far] This is a comment icon -icon:file[set=far] And a file icon -icon:battery-full[set=fas] And a battery icon - - -.The output looks like the following -[example] -icon:comment[set=far] This is a comment icon + -icon:file[set=far] And a file icon + -icon:battery-full[set=fas] And a battery icon - == How to write a... @@ -654,6 +654,12 @@ This is entry #1 in our example FAQ. FAQ entry 2:: This is entry #2 in our example FAQ. + Glossary + +There is one Glossary per Component and a General Glossary in user-manual. + +For glossary entries ID should be in Uppercase with space replace by "_" + == Asciidoc FAQ
[ofbiz-framework] branch trunk updated: Documented: migrated Wiki Glossary to glossary asciidoc files (OFBIZ-12060)
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 c2c1eae Documented: migrated Wiki Glossary to glossary asciidoc files (OFBIZ-12060) c2c1eae is described below commit c2c1eae612932fe54f9dbc3040c108f21e920c41 Author: holivier AuthorDate: Tue Nov 17 18:13:07 2020 +0100 Documented: migrated Wiki Glossary to glossary asciidoc files (OFBIZ-12060) - Accounting Glossary, - declare it as glossary - re-order existing items - add a comment at beginning about importance of order items - correction for some ID: change space to _ - add some items coming from wiki glossary - Facility - add glossary directly in facility.adoc - Human Resource Glossary - re-order existing items - add a comment at beginning about importance of order items - move some items to Party Glossary or global Glossary - HR appendix: add link to wiki OFBiz related book for Data Model Reference Book - Add Party Glossary and included it in party.adoc - add some items coming from wiki glossary and HR glossary - General Glossary - add a comment at beginning about importance of order items - add some items coming from wiki glossary and HR glossary --- .../src/docs/asciidoc/_include/acc-glossary.adoc | 241 +++-- .../src/docs/asciidoc/_include/hr-appendix.adoc| 4 +- .../src/docs/asciidoc/_include/hr-glossary.adoc| 80 +++ .../humanres/src/docs/asciidoc/humanres.adoc | 4 +- .../src/docs/asciidoc/_include/party-glossary.adoc | 51 + applications/party/src/docs/asciidoc/party.adoc| 4 +- .../product/src/docs/asciidoc/facility.adoc| 12 + docs/asciidoc/_include/ofbiz-glossary.adoc | 61 +- 8 files changed, 332 insertions(+), 125 deletions(-) diff --git a/applications/accounting/src/docs/asciidoc/_include/acc-glossary.adoc b/applications/accounting/src/docs/asciidoc/_include/acc-glossary.adoc index 9c9f68e..538f63e 100644 --- a/applications/accounting/src/docs/asciidoc/_include/acc-glossary.adoc +++ b/applications/accounting/src/docs/asciidoc/_include/acc-glossary.adoc @@ -16,101 +16,144 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. +[glossary] = Accounting Glossary -[#ANNUAL_REVENUE] -Annual Revenue:: -Annual revenue is the amount of revenue for a group that is reported in the Party -Group Information screenlet of the groups profile (visit Party Profile screen). +[comment] +It's important to sort glossary entries in alphabetic order to avoid duplication or search failing. -[#ACCOUNTS PAYABLE] +[#ACCOUNTS_PAYABLE] Accounts Payable:: -The debts owed by a business, usually in relation to goods or services, inventory, or supplies. +These are the debts that your business owes to suppliers, usually in relation to goods or services, inventory, or supplies. It is also called 'A/P' for short or 'Creditors'. -[#ACCOUNT PAYABLE INVOICE] +[#ACCOUNT_PAYABLE_INVOICE] Accounts Payable Invoice:: AP invoice is a document raised by the customer and sent to the company with the details of the items sent, qty sent, price and other details. The company will enter this invoice details in the Payable module and then pay the customer according to the credit terms. This invoice may come along with the consignment or may be sent to the company separately. -[#ACCOUNTS RECEIVABLE] +[#ACCOUNTS_RECEIVABLE] Accounts Receivable:: -The money owed to a business by its customers for products and services delivered to a customer. +These are the outstanding debts that your customers owe to your business, +for products and services delivered. It is also called 'A/R' for short or Debtors. -[#ACCOUNT RECEIVABLE INVOICE] + +[#ACCOUNT_RECEIVABLE_INVOICE] Accounts Receivable Invoice:: AR Invoice is a document raised by the company and sent to the customer with the details of items sold, qty sold, price, tax and other details. Based on this invoice, the customer will send the payment in case of credit sales. -[#ACCOUNT TYPE] +[#ACCOUNT_TYPE] Account Type:: A key that specifies the accounting area to which an account belongs. The account type is required in addition to the account number to identify an account, because the same account number can be used for each account type. +[#ACCRUAL_BASED_ACCOUNTING] +Accrual Based Accounting:: This is a method where you record the income when the sale occurs and not necessarily +when you receive the payment. Also you record an expense when you receive goods or services, even though you may +not pay for them until later. + [#ACQUISITION] Acquisition:: The process of identifying the requirement for a certain good or material item
[ofbiz-framework] branch trunk updated: Documented: add simple remark about Glossary and move keyboard shortcuts and using icons in Text formatting
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 fa11e7d Documented: add simple remark about Glossary and move keyboard shortcuts and using icons in Text formatting fa11e7d is described below commit fa11e7ddc7024fea185a84147230fa541b1a2bfe Author: holivier AuthorDate: Wed Nov 18 17:24:33 2020 +0100 Documented: add simple remark about Glossary and move keyboard shortcuts and using icons in Text formatting --- docs/asciidoc/documentation_guidelines.adoc | 86 +++-- 1 file changed, 46 insertions(+), 40 deletions(-) diff --git a/docs/asciidoc/documentation_guidelines.adoc b/docs/asciidoc/documentation_guidelines.adoc index cc4ce09..61dffe5 100644 --- a/docs/asciidoc/documentation_guidelines.adoc +++ b/docs/asciidoc/documentation_guidelines.adoc @@ -363,6 +363,46 @@ This is the text for the simple description headline Just a simple block example. +=== Keyboard shortcuts + +You can also define keyboard shortcuts with the `kbd` macro. + + kbd:[Alt+F11] - Toggle Full Screen Mode in the Eclipse IDE + +The result is the following: + +kbd:[Alt+F11] - Toggle Full Screen Mode in the Eclipse IDE + +The result will be different depending on the rendering (PDF, HTML). + +=== Using inline icons + +You can also add the `:icons: font` directive to the top of your document, which allows you to use the icons +from http://fortawesome.github.io/Font-Awesome/icons/ directory via a macro using any of the following icon sets: + +* fa - https://fontawesome.com/v4.7.0/icons (default) +* fas - https://fontawesome.com/icons?d=gallery=solid[Font Awesome - Solid] +* fab - https://fontawesome.com/icons?d=gallery=brands[Font Awesome - Brands] +* far - https://fontawesome.com/icons?d=gallery=regular[Font Awesome - Regular] +* fi - http://zurb.com/playground/foundation-icon-fonts-3[Foundation Icons] +* pf - https://paymentfont.com/[Payment font] + +The fa icon set is deprecated. Please use one of the other three FontAwesome icon sets. + +when icon is not available in fa icon set but in an other, it's possible to give the correct set. + +The generate Document process generate a INFOS message, if icon is available in an other set and it is not given. + +icon:comment[set=far] This is a comment icon +icon:file[set=far] And a file icon +icon:battery-full[set=fas] And a battery icon + + +.The output looks like the following +[example] +icon:comment[set=far] This is a comment icon + +icon:file[set=far] And a file icon + +icon:battery-full[set=fas] And a battery icon + == Code formatting @@ -579,46 +619,6 @@ Result: This is just a text image:OFBiz-Logo.svg[Apache OFBiz Logo, width=40%] to show inline images. -=== Keyboard shortcuts - -You can also define keyboard shortcuts with the `kbd` macro. - - kbd:[Alt+F11] - Toggle Full Screen Mode in the Eclipse IDE - -The result is the following: - -kbd:[Alt+F11] - Toggle Full Screen Mode in the Eclipse IDE - -The result will be different depending on the rendering (PDF, HTML). - -=== Using inline icons - -You can also add the `:icons: font` directive to the top of your document, which allows you to use the icons -from http://fortawesome.github.io/Font-Awesome/icons/ directory via a macro using any of the following icon sets: - -* fa - https://fontawesome.com/v4.7.0/icons (default) -* fas - https://fontawesome.com/icons?d=gallery=solid[Font Awesome - Solid] -* fab - https://fontawesome.com/icons?d=gallery=brands[Font Awesome - Brands] -* far - https://fontawesome.com/icons?d=gallery=regular[Font Awesome - Regular] -* fi - http://zurb.com/playground/foundation-icon-fonts-3[Foundation Icons] -* pf - https://paymentfont.com/[Payment font] - -The fa icon set is deprecated. Please use one of the other three FontAwesome icon sets. + -when icon is not available in fa icon set but in an other, it's possible to give the correct set. - -The generate Document process generate a INFOS message, if icon is available in an other set and it is not given. - -icon:comment[set=far] This is a comment icon -icon:file[set=far] And a file icon -icon:battery-full[set=fas] And a battery icon - - -.The output looks like the following -[example] -icon:comment[set=far] This is a comment icon + -icon:file[set=far] And a file icon + -icon:battery-full[set=fas] And a battery icon - == How to write a... @@ -654,6 +654,12 @@ This is entry #1 in our example FAQ. FAQ entry 2:: This is entry #2 in our example FAQ. + Glossary + +There is one Glossary per Component and a General Glossary in user-manual. + +For glossary entries ID should be in Uppercase with space replace by "_" + == Asciidoc FAQ
[ofbiz-framework] branch trunk updated: Documented: migrated Wiki Glossary to glossary asciidoc files (OFBIZ-12060)
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 c2c1eae Documented: migrated Wiki Glossary to glossary asciidoc files (OFBIZ-12060) c2c1eae is described below commit c2c1eae612932fe54f9dbc3040c108f21e920c41 Author: holivier AuthorDate: Tue Nov 17 18:13:07 2020 +0100 Documented: migrated Wiki Glossary to glossary asciidoc files (OFBIZ-12060) - Accounting Glossary, - declare it as glossary - re-order existing items - add a comment at beginning about importance of order items - correction for some ID: change space to _ - add some items coming from wiki glossary - Facility - add glossary directly in facility.adoc - Human Resource Glossary - re-order existing items - add a comment at beginning about importance of order items - move some items to Party Glossary or global Glossary - HR appendix: add link to wiki OFBiz related book for Data Model Reference Book - Add Party Glossary and included it in party.adoc - add some items coming from wiki glossary and HR glossary - General Glossary - add a comment at beginning about importance of order items - add some items coming from wiki glossary and HR glossary --- .../src/docs/asciidoc/_include/acc-glossary.adoc | 241 +++-- .../src/docs/asciidoc/_include/hr-appendix.adoc| 4 +- .../src/docs/asciidoc/_include/hr-glossary.adoc| 80 +++ .../humanres/src/docs/asciidoc/humanres.adoc | 4 +- .../src/docs/asciidoc/_include/party-glossary.adoc | 51 + applications/party/src/docs/asciidoc/party.adoc| 4 +- .../product/src/docs/asciidoc/facility.adoc| 12 + docs/asciidoc/_include/ofbiz-glossary.adoc | 61 +- 8 files changed, 332 insertions(+), 125 deletions(-) diff --git a/applications/accounting/src/docs/asciidoc/_include/acc-glossary.adoc b/applications/accounting/src/docs/asciidoc/_include/acc-glossary.adoc index 9c9f68e..538f63e 100644 --- a/applications/accounting/src/docs/asciidoc/_include/acc-glossary.adoc +++ b/applications/accounting/src/docs/asciidoc/_include/acc-glossary.adoc @@ -16,101 +16,144 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. +[glossary] = Accounting Glossary -[#ANNUAL_REVENUE] -Annual Revenue:: -Annual revenue is the amount of revenue for a group that is reported in the Party -Group Information screenlet of the groups profile (visit Party Profile screen). +[comment] +It's important to sort glossary entries in alphabetic order to avoid duplication or search failing. -[#ACCOUNTS PAYABLE] +[#ACCOUNTS_PAYABLE] Accounts Payable:: -The debts owed by a business, usually in relation to goods or services, inventory, or supplies. +These are the debts that your business owes to suppliers, usually in relation to goods or services, inventory, or supplies. It is also called 'A/P' for short or 'Creditors'. -[#ACCOUNT PAYABLE INVOICE] +[#ACCOUNT_PAYABLE_INVOICE] Accounts Payable Invoice:: AP invoice is a document raised by the customer and sent to the company with the details of the items sent, qty sent, price and other details. The company will enter this invoice details in the Payable module and then pay the customer according to the credit terms. This invoice may come along with the consignment or may be sent to the company separately. -[#ACCOUNTS RECEIVABLE] +[#ACCOUNTS_RECEIVABLE] Accounts Receivable:: -The money owed to a business by its customers for products and services delivered to a customer. +These are the outstanding debts that your customers owe to your business, +for products and services delivered. It is also called 'A/R' for short or Debtors. -[#ACCOUNT RECEIVABLE INVOICE] + +[#ACCOUNT_RECEIVABLE_INVOICE] Accounts Receivable Invoice:: AR Invoice is a document raised by the company and sent to the customer with the details of items sold, qty sold, price, tax and other details. Based on this invoice, the customer will send the payment in case of credit sales. -[#ACCOUNT TYPE] +[#ACCOUNT_TYPE] Account Type:: A key that specifies the accounting area to which an account belongs. The account type is required in addition to the account number to identify an account, because the same account number can be used for each account type. +[#ACCRUAL_BASED_ACCOUNTING] +Accrual Based Accounting:: This is a method where you record the income when the sale occurs and not necessarily +when you receive the payment. Also you record an expense when you receive goods or services, even though you may +not pay for them until later. + [#ACQUISITION] Acquisition:: The process of identifying the requirement for a certain good or material item
[ofbiz-framework] branch trunk updated: Documented: HR Doc drive by process (OFBIZ-11026)
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 5e6f537 Documented: HR Doc drive by process (OFBIZ-11026) 5e6f537 is described below commit 5e6f5377087457b434a28c0b78643ab3ad1f9eac Author: holivier AuthorDate: Mon Sep 14 17:04:59 2020 +0200 Documented: HR Doc drive by process (OFBIZ-11026) - Re-organize sub-chapter to have a process vision of HR component - Add hr-data-model sub-chapter - Add hr-appendix which list some bug or WIP development --- .../src/docs/asciidoc/_include/hr-appendix.adoc| 77 + .../src/docs/asciidoc/_include/hr-data-model.adoc | 123 + .../asciidoc/_include/hr-employee-positions.adoc | 31 -- .../src/docs/asciidoc/_include/hr-employments.adoc | 5 +- .../docs/asciidoc/_include/hr-global-settings.adoc | 50 + .../src/docs/asciidoc/_include/hr-glossary.adoc| 28 ++--- .../src/docs/asciidoc/_include/hr-intro.adoc | 108 ++ .../humanres/src/docs/asciidoc/humanres.adoc | 48 +--- .../asciidoc/images/hr-data-model/EmplPosition.png | Bin 0 -> 124686 bytes .../images/hr-data-model/EmplPositionDetail.png| Bin 0 -> 74561 bytes docs/asciidoc/images/hr-data-model/Employment.png | Bin 0 -> 108260 bytes .../images/hr-data-model/EmploymentApp.png | Bin 0 -> 94205 bytes .../images/hr-data-model/PartyHumanRes.png | Bin 0 -> 148349 bytes docs/asciidoc/images/hr-data-model/PerfReview.png | Bin 0 -> 64103 bytes docs/asciidoc/images/hr-data-model/ability.png | Bin 0 -> 93714 bytes 15 files changed, 386 insertions(+), 84 deletions(-) diff --git a/applications/humanres/src/docs/asciidoc/_include/hr-appendix.adoc b/applications/humanres/src/docs/asciidoc/_include/hr-appendix.adoc new file mode 100644 index 000..90c5b6c --- /dev/null +++ b/applications/humanres/src/docs/asciidoc/_include/hr-appendix.adoc @@ -0,0 +1,77 @@ + +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. + + +[appendix] += HR Data Model Resource Book Difference + +PayHistory:: it's not really a difference, more a not explicit detail about fromDate field. + +PayHistory is a detail of Employment entity (Composition in UML language) and Employment entity has a fromDate field +(as one of the keyField), and we need fromDate field for information about PayHistory, so it's needed to have one named +emplFromDate (coming from Employment) and one classical fromDate to be able to have multiple PayHistory for one Employment. + +PartyBenefit:: It's exactly the same problem or case than PayHistory, currently in Apache OFBiz entity is exactly the same +as in Data Model Resource Book Difference (only one fromDate field), so it's not possible to have a correct User Interface +as an Employment subOption. + +So correct solution should be to have one more field: emplFromDate (coming from Employment). + +Resume:: entity in Apache OFBiz is a simplification of the concept explain in the Book + +[appendix] += HR Enhancement & Bug +== Functional bug +This section explain current "Bug" which are waiting some developpment. + +=== CreateEmployee +Currently create an employee should create a Party Relationship between Employer and Employee(cf <<_employments, documentation>>), +it's not working because a parameters if forgot in service but it's not the major "Bug", and the main question is : + +create an employee should create a Party Relationship or a Employment (which is a subtype of PartyRelationship) ? + +If the create Employee screen is used from HR, it's to use HR functions and for HR component, an employee has an Employment +(which is a subtype of PartyRelationship), so create an Employee should create an Employment (and so the first PayHistory). + +Screen and Service should corrected to do these points. + + + +== Functional Enhancement +This section explain which developpment should be done to add some features which should be in Apache OFBiz + +=== Valid Responsibility +Entity ValidResponsibi
[ofbiz-plugins] branch trunk updated: Documented: Synchronize wiki page End User Documentation (OFBIZ-12059)
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-plugins.git The following commit(s) were added to refs/heads/trunk by this push: new cf28c48 Documented: Synchronize wiki page End User Documentation (OFBIZ-12059) cf28c48 is described below commit cf28c487ba4e9949bb97197af01303c056c6907c Author: holivier AuthorDate: Mon Nov 16 17:06:03 2020 +0100 Documented: Synchronize wiki page End User Documentation (OFBIZ-12059) - Add assetm.adoc with only overview for plugin assetmaint - Completed projectmgr overview --- .../src/docs/asciidoc/assetm.adoc | 25 +++--- assetmaint/widget/CommonScreens.xml| 2 +- docs/asciidoc/plugins-user-manual.adoc | 2 ++ .../src/docs/asciidoc/_include/prjm_intro.adoc | 1 + 4 files changed, 7 insertions(+), 23 deletions(-) diff --git a/docs/asciidoc/plugins-user-manual.adoc b/assetmaint/src/docs/asciidoc/assetm.adoc similarity index 51% copy from docs/asciidoc/plugins-user-manual.adoc copy to assetmaint/src/docs/asciidoc/assetm.adoc index 1a3ea4c..9b87200 100644 --- a/docs/asciidoc/plugins-user-manual.adoc +++ b/assetmaint/src/docs/asciidoc/assetm.adoc @@ -16,27 +16,8 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -= Apache OFBiz Plugins -The Apache OFBiz Project += Asset Maintenance plugin -:imagesdir: ./images -ifdef::backend-pdf[] -:title-logo-image: image::OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=4.25in, align=center] -:source-highlighter: rouge -endif::[] -:toc: -:sectnums: +Assets are items of value that are owned by the business. -include::../../birt/src/docs/asciidoc/birt.adoc[leveloffset=+1] - -include::../../ebay/src/docs/asciidoc/ebay.adoc[leveloffset=+1] - -include::../../ebaystore/src/docs/asciidoc/ebay-store.adoc[leveloffset=+1] - -include::../../example/src/docs/asciidoc/example.adoc[leveloffset=+1] - -include::../../myportal/src/docs/asciidoc/my-portal.adoc[leveloffset=+1] - -include::../../projectmgr/src/docs/asciidoc/project-mgr.adoc[leveloffset=+1] - -include::../../scrum/src/docs/asciidoc/scrum.adoc[leveloffset=+1] \ No newline at end of file +The Asset Maintenance application is used to schedule and trace all maintenance activities on assets. diff --git a/assetmaint/widget/CommonScreens.xml b/assetmaint/widget/CommonScreens.xml index 2c0d44f..fdca884 100644 --- a/assetmaint/widget/CommonScreens.xml +++ b/assetmaint/widget/CommonScreens.xml @@ -39,7 +39,7 @@ under the License. - + diff --git a/docs/asciidoc/plugins-user-manual.adoc b/docs/asciidoc/plugins-user-manual.adoc index 1a3ea4c..8147173 100644 --- a/docs/asciidoc/plugins-user-manual.adoc +++ b/docs/asciidoc/plugins-user-manual.adoc @@ -27,6 +27,8 @@ endif::[] :toc: :sectnums: +include::../../assetmaint/src/docs/asciidoc/assetm.adoc[leveloffset=+1] + include::../../birt/src/docs/asciidoc/birt.adoc[leveloffset=+1] include::../../ebay/src/docs/asciidoc/ebay.adoc[leveloffset=+1] diff --git a/projectmgr/src/docs/asciidoc/_include/prjm_intro.adoc b/projectmgr/src/docs/asciidoc/_include/prjm_intro.adoc index f705fce..a6147b4 100644 --- a/projectmgr/src/docs/asciidoc/_include/prjm_intro.adoc +++ b/projectmgr/src/docs/asciidoc/_include/prjm_intro.adoc @@ -24,6 +24,7 @@ A task always has a single parentPhase. + Time registration is only done on a task level. Estimated and actual dates are only maintained at the task level. + +Assign tasks to team members; report project activities with timesheets and calendars. + For reporting they are calculated to the higher levels. + Project views are created to support this.
[ofbiz-framework] branch trunk updated: Documented: Synchronize wiki page End User Documentation (OFBIZ-12059)
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 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. - + diff --git
[ofbiz-framework] branch trunk updated: fixed: spelling correction in a link to pluginsdoc document
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 e6dbed5 fixed: spelling correction in a link to pluginsdoc document e6dbed5 is described below commit e6dbed5fd62a9486daf50969b2f82c94c5b6c286 Author: holivier AuthorDate: Sun Nov 15 10:44:31 2020 +0100 fixed: spelling correction in a link to pluginsdoc document --- docs/asciidoc/_include/OFBizDocumentationSystem.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/asciidoc/_include/OFBizDocumentationSystem.adoc b/docs/asciidoc/_include/OFBizDocumentationSystem.adoc index 652a6cf..b3e2503 100644 --- a/docs/asciidoc/_include/OFBizDocumentationSystem.adoc +++ b/docs/asciidoc/_include/OFBizDocumentationSystem.adoc @@ -49,7 +49,7 @@ All main files of each component are included in developer-manual.adoc except fo 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; +the list of documents in the link:../../pluginsdoc[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".
[ofbiz-framework] branch trunk updated: Documented: Add a Global Glossary for user-documentation (OFBIZ-10303)
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 c218926 Documented: Add a Global Glossary for user-documentation (OFBIZ-10303) c218926 is described below commit c21892609ba593193055bc2350e1e44b602d687b Author: holivier AuthorDate: Mon Sep 14 15:09:43 2020 +0200 Documented: Add a Global Glossary for user-documentation (OFBIZ-10303) --- .../humanres/src/docs/asciidoc/humanres.adoc | 4 +- docs/asciidoc/_include/ofbiz-glossary.adoc | 115 + docs/asciidoc/user-manual.adoc | 8 +- 3 files changed, 122 insertions(+), 5 deletions(-) diff --git a/applications/humanres/src/docs/asciidoc/humanres.adoc b/applications/humanres/src/docs/asciidoc/humanres.adoc index 37b631f..fc8ef2b 100644 --- a/applications/humanres/src/docs/asciidoc/humanres.adoc +++ b/applications/humanres/src/docs/asciidoc/humanres.adoc @@ -18,8 +18,8 @@ under the License. = Human Resources -The OFBiz Human Resources system is one of the core application components and has -all of the functionality you need to manage your business employees as well as the +The OFBiz Human Resources system is one of the <> and has +all of the functionality you need to manage your business <> as well as the recruitment process. It is well integrated with other components especially Accounting to manage Payroll and any specific employee agreements. diff --git a/docs/asciidoc/_include/ofbiz-glossary.adoc b/docs/asciidoc/_include/ofbiz-glossary.adoc new file mode 100644 index 000..57d5755 --- /dev/null +++ b/docs/asciidoc/_include/ofbiz-glossary.adoc @@ -0,0 +1,115 @@ + +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. + +[glossary] += General Glossary + +[glossary] +[#APPLICATION] +Application:: +. **for end users** , an application is a top level menu entry, it's for managing a business object: +order, accounting GL, accounting AP, facility, project, + +An application can be dedicated for a specifics business and can use part of other applications. + +With Apache OFBiz OOTB (Out Of The Box) you will find the main application (the <>) +and with OFBIZ plugins you can find application more business specifics. +. **technicaly** , an application is a part of <> beginning with the ~webapp directory. + +A single component may contain several applications each mounted on a unique URL. +Within each component, the "ofbiz-component.xml" file defines the available applications and how those applications shall be mounted on URLs. + +[#COMPONENT] +Component:: +. **for end users** , an OFBiz component, is an <> or a group of <>. + +Knowing which component is used by a application can be useful for "key users" to be able to set application parameters or modify configuration files. +. **technically** , An OFBiz component is a directory used by the OFBiz framework to specify and load application server resources necessary to execute an OFBiz instance. + +Each OFBiz component must have a unique name (typically the name of the root directory for the component) and +a configuration file called: "ofbiz-component.xml". + +Component resources may include, but are not limited to: +* webapps, +* Java source/classes, +* classpath resources, +* scripts, entity definitions, +* entity data files, +* service definitions, +* service and entity ECA rules, +* test suites, +* encryption keystores. + +A component contains applications and/or the lower level tools and definitions needed by applications. + +A component can be used for self-contained extensions, including applications and logic/data modifications, +to the suite of tools and applications that come with OFBiz. + +For more detail look at developer-manual. + +[#CORE_APPLICATION_COMPONENTS] +core application components:: The core applications in Apache OFBiz are web applications that serve common +business needs found in most enterprises. + +They are included in the ofbiz-framework and each one has one (or more) menu entry. + +
[ofbiz-framework] branch trunk updated: Documented: OFBizDocumentationSystem migration to Asciidoc and Review (OFBIZ-11364)
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 ac6964e Documented: OFBizDocumentationSystem migration to Asciidoc and Review (OFBIZ-11364) ac6964e is described below commit ac6964e8eba64c8a84a5954e2e2fead0e434fbb0 Author: holivier AuthorDate: Sat Nov 14 16:55:31 2020 +0100 Documented: OFBizDocumentationSystem migration to Asciidoc and Review (OFBIZ-11364) Rewrite the document, add a part in documentation guidline. Add a include for OFBizDocumentationSystem document in user manual and developer-manual. --- .../_include/OFBizDocumentationSystem.adoc | 89 ++ docs/asciidoc/developer-manual.adoc| 2 + docs/asciidoc/documentation_guidelines.adoc| 40 +- docs/asciidoc/user-manual.adoc | 2 + 4 files changed, 129 insertions(+), 4 deletions(-) diff --git a/docs/asciidoc/_include/OFBizDocumentationSystem.adoc b/docs/asciidoc/_include/OFBizDocumentationSystem.adoc new file mode 100644 index 000..652a6cf --- /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:
[ofbiz-framework] branch trunk updated: Documented: migration to help system using asciidoc files (OFBIZ-11587)
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 4a41f0f Documented: migration to help system using asciidoc files (OFBIZ-11587) 4a41f0f is described below commit 4a41f0fde5a2a2a988caef4cd5a899bcdc84c799 Author: holivier AuthorDate: Tue Oct 27 11:20:09 2020 +0100 Documented: migration to help system using asciidoc files (OFBIZ-11587) commit correction for * reAdd a contentDocData for main contentId and portletCategory * remove from ofbiz-component of each application line about helpData which are removed --- applications/accounting/ofbiz-component.xml| 1 - applications/commonext/ofbiz-component.xml | 1 - applications/content/data/ContentDocData.xml | 27 ++ applications/content/ofbiz-component.xml | 4 +--- applications/humanres/ofbiz-component.xml | 1 - applications/manufacturing/ofbiz-component.xml | 2 -- applications/marketing/ofbiz-component.xml | 3 +-- applications/order/ofbiz-component.xml | 5 ++-- applications/product/ofbiz-component.xml | 3 +-- .../workeffort/data/WorkEffortPortletData.xml | 9 +--- 10 files changed, 33 insertions(+), 23 deletions(-) diff --git a/applications/accounting/ofbiz-component.xml b/applications/accounting/ofbiz-component.xml index 31692c8..ced2e50 100644 --- a/applications/accounting/ofbiz-component.xml +++ b/applications/accounting/ofbiz-component.xml @@ -26,7 +26,6 @@ under the License. - diff --git a/applications/commonext/ofbiz-component.xml b/applications/commonext/ofbiz-component.xml index 60c7bbc..4593c9a 100644 --- a/applications/commonext/ofbiz-component.xml +++ b/applications/commonext/ofbiz-component.xml @@ -25,7 +25,6 @@ under the License. - diff --git a/applications/content/data/ContentDocData.xml b/applications/content/data/ContentDocData.xml new file mode 100644 index 000..bb9f5af --- /dev/null +++ b/applications/content/data/ContentDocData.xml @@ -0,0 +1,27 @@ + + + + + + + + + + \ No newline at end of file diff --git a/applications/content/ofbiz-component.xml b/applications/content/ofbiz-component.xml index 03d7cf8..1a19a78 100644 --- a/applications/content/ofbiz-component.xml +++ b/applications/content/ofbiz-component.xml @@ -26,11 +26,9 @@ under the License. - + - - diff --git a/applications/humanres/ofbiz-component.xml b/applications/humanres/ofbiz-component.xml index 9526ef5..1c291c5 100644 --- a/applications/humanres/ofbiz-component.xml +++ b/applications/humanres/ofbiz-component.xml @@ -24,7 +24,6 @@ under the License. - diff --git a/applications/manufacturing/ofbiz-component.xml b/applications/manufacturing/ofbiz-component.xml index 737d5b3..5568447 100644 --- a/applications/manufacturing/ofbiz-component.xml +++ b/applications/manufacturing/ofbiz-component.xml @@ -29,8 +29,6 @@ under the License. - - diff --git a/applications/marketing/ofbiz-component.xml b/applications/marketing/ofbiz-component.xml index b5cdcea..9151748 100644 --- a/applications/marketing/ofbiz-component.xml +++ b/applications/marketing/ofbiz-component.xml @@ -23,9 +23,8 @@ under the License. xsi:noNamespaceSchemaLocation="http://ofbiz.apache.org/dtds/ofbiz-component.xsd;> - + - diff --git a/applications/order/ofbiz-component.xml b/applications/order/ofbiz-component.xml index 7222034..1cad626 100644 --- a/applications/order/ofbiz-component.xml +++ b/applications/order/ofbiz-component.xml @@ -26,12 +26,11 @@ under the License. - + - - + diff --git a/applications/product/ofbiz-component.xml b/applications/product/ofbiz-component.xml index bd9870c..0ed83be 100644 --- a/applications/product/ofbiz-component.xml +++ b/applications/product/ofbiz-component.xml @@ -26,8 +26,7 @@ under the License. - - + diff --git a/applications/workeffort/data/WorkEffortPortletData.xml b/applications/workeffort/data/WorkEffortPortletData.xml index ab41475..2cc2ea8 100644 --- a/applications/workeffort/data/WorkEffortPortletData.xml +++ b/applications/workeffort/data/WorkEffortPortletData.xml @@ -19,7 +19,7 @@ --> - + - - - - -
[ofbiz-plugins] branch trunk updated: Documented: remove from plugin cmssite link to document genereted from docbook help files
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-plugins.git The following commit(s) were added to refs/heads/trunk by this push: new 2f6b0f1 Documented: remove from plugin cmssite link to document genereted from docbook help files 2f6b0f1 is described below commit 2f6b0f19a3fe320339659580e7b1e1f2dbd6c617 Author: holivier AuthorDate: Mon Oct 26 18:45:19 2020 +0100 Documented: remove from plugin cmssite link to document genereted from docbook help files --- cmssite/data/CmsSiteDemoData.xml | 22 --- cmssite/documents/ApacheOfbiz.xml | 62 cmssite/documents/ApacheOfbizTechnical.xml | 219 - cmssite/documents/ApacheOfbizUser.xml | 64 - cmssite/widget/CmssiteScreens.xml | 18 --- 5 files changed, 385 deletions(-) diff --git a/cmssite/data/CmsSiteDemoData.xml b/cmssite/data/CmsSiteDemoData.xml index 2c2067b..ba6ebde 100644 --- a/cmssite/data/CmsSiteDemoData.xml +++ b/cmssite/data/CmsSiteDemoData.xml @@ -114,7 +114,6 @@ under the License. Demo Page with screen widget and screen decorator Demo Page with blog using screen decorator Demo Page with an xml resource formatted with a template ftl resource -The ofbiz public documents WebSite 1 WebSite 2 @@ -229,26 +228,5 @@ under the License. - - - - - -/> - - -/> - - - -/> - - -/> - - - - - diff --git a/cmssite/documents/ApacheOfbiz.xml b/cmssite/documents/ApacheOfbiz.xml deleted file mode 100644 index f6dbe61..000 --- a/cmssite/documents/ApacheOfbiz.xml +++ /dev/null @@ -1,62 +0,0 @@ - - -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;> - - -Apache OFBiz official documentation. - - -This Book is currently in an experimental stage. It will be the start of moving the OFBiz documentation from the current -https://cwiki.apache.org/confluence/display/OFBIZ/Home;>OFBiz documentation site and the old ofbiz website (Entity documents) to the OFBiz content component. -The layout is currently open for discussion by the OFBiz community. - - -The advantages of using it within OFBiz are: - -No external system required for documentation -The content of the internal help files can be used within the documentation -The documentation always has the same version as the system (It is part of it) -The content is stored in a internationally accepted http://docbook.org;>'DocBook' format -The content can be easily presented in the selected visual schemas (To be implemented) - - - -If you want to contribute to this document, you are very welcome. -Several possibilities exist: - -Convert existing OFBiz documents on the https://cwiki.apache.org/confluence/display/OFBIZ/Documentation;>OFBiz documentation site to the http://docbook.org;>docbookformat -Write new document chapters for an OFBiz component -Write new Help screens which can be inserted as sections in the document. - -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. - - - - - - - - diff --git a/cmssite/documents/ApacheOfbizTechnical.xml b/cmssite/documents/ApacheOfbizTechnical.xml deleted file mode 100644 index a52a779..000 --- a/cmssite/documents/ApacheOfbizTechnical.xml +++ /dev/null @@ -1,219 +0,0 @@ - - -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;> - - -Apache OFBiz Technical documentation. -
[ofbiz-framework] 01/04: Documented: migration to help system using asciidoc files (OFBIZ-11587)
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 commit 302bc0eb154203682aee53d1d4bf2bfa5be1599c Author: holivier AuthorDate: Mon Oct 26 17:10:58 2020 +0100 Documented: migration to help system using asciidoc files (OFBIZ-11587) Remove all related help docbook files --- .../accounting/data/AccountingHelpData.xml | 29 -- applications/accounting/data/HELP_ACCOUNTING.xml | 30 --- applications/commonext/data/CommonExtHelpData.xml | 34 applications/content/data/ContentHelpData.xml | 62 -- applications/content/data/PartyHelpData.xml| 29 -- applications/content/data/WebtoolsHelpData.xml | 29 -- .../content/data/helpdata/HELP_CONTENT.xml | 32 --- .../content/data/helpdata/HELP_CONTENT_IT.xml | 28 -- applications/content/data/helpdata/HELP_ROOT.xml | 36 - .../content/data/helpdata/HELP_ROOT_FR.xml | 39 -- .../content/data/helpdata/HELP_ROOT_IT.xml | 31 --- .../content/data/helpdata/HELP_ROOT_NL.xml | 37 - applications/humanres/data/HELP_HR.xml | 28 -- applications/humanres/data/HumanResHelpData.xml| 28 -- applications/manufacturing/data/Help_MFG.xml | 33 .../data/ManufacturingHelpData_EN.xml | 30 --- applications/marketing/data/HELP_MARKETING.xml | 38 - applications/marketing/data/HELP_SFA.xml | 35 applications/marketing/data/MarketingHelpData.xml | 37 - applications/order/data/HELP_ORDERMGR.xml | 27 -- applications/order/data/OrderHelpData.xml | 28 -- applications/party/data/HELP_PARTY.xml | 33 applications/product/data/HELP_PRODUCT.xml | 30 --- applications/product/data/ProductHelpData.xml | 25 - framework/webtools/data/HELP_WEBTOOLS.xml | 24 - 25 files changed, 812 deletions(-) diff --git a/applications/accounting/data/AccountingHelpData.xml b/applications/accounting/data/AccountingHelpData.xml deleted file mode 100644 index 8928b1f..000 --- a/applications/accounting/data/AccountingHelpData.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - - - - diff --git a/applications/accounting/data/HELP_ACCOUNTING.xml b/applications/accounting/data/HELP_ACCOUNTING.xml deleted file mode 100644 index e5703b7..000 --- a/applications/accounting/data/HELP_ACCOUNTING.xml +++ /dev/null @@ -1,30 +0,0 @@ - - -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;> -Accounting help screen redirection -Accounting Help has been migrated to a new system, you can access it by using - https://ci.apache.org/projects/ofbiz/site/trunk/ofbizdoc/html5/user-manual.html#_accounting;>OFBiz user documentation site / accounting - - - diff --git a/applications/commonext/data/CommonExtHelpData.xml b/applications/commonext/data/CommonExtHelpData.xml deleted file mode 100644 index a535de5..000 --- a/applications/commonext/data/CommonExtHelpData.xml +++ /dev/null @@ -1,34 +0,0 @@ - - - - - - - - - - - - - - - - - diff --git a/applications/content/data/ContentHelpData.xml b/applications/content/data/ContentHelpData.xml deleted file mode 100644 index a2030e3..000 --- a/applications/content/data/ContentHelpData.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/applications/content/data/PartyHelpData.xml b/applications/content/data/PartyHelpData.xml deleted file mode 100644 index d0bccca..000 --- a/applications/content/data/PartyHelpData.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - - - - \ No newline at end of file diff --git a/applications/content/data/WebtoolsHelpData.xml b/applications/content/data/WebtoolsHelpData.xml deleted file mode 100644 index d688aab..000 --- a/applications/content/data/WebtoolsHelpData.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - - - - \ No newline at end of file diff --git a/applications/content/data/helpdata/HELP_CONTENT.xml b/applications/content/data/helpdata/HELP_CONTENT.xml deleted file mode 100644 index 20132d7..000 --- a/applications/content/data/helpdata/HELP_CONTENT.xml +++ /dev/null @@ -1
[ofbiz-framework] 02/04: Documented: migration to help system using asciidoc files (OFBIZ-11587)
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
commit 37c075b1f5d5e73e46cd2f15d24926416fd3abbe
Author: holivier
AuthorDate: Mon Oct 26 17:12:52 2020 +0100
Documented: migration to help system using asciidoc files (OFBIZ-11587)
remove in plugin creation gradle task, files related to docbook help
---
build.gradle | 4 +---
framework/resources/templates/HELP.xml | 29 -
framework/resources/templates/document.xml | 35 --
3 files changed, 1 insertion(+), 67 deletions(-)
diff --git a/build.gradle b/build.gradle
index 3013b75..2c1edbc 100644
--- a/build.gradle
+++ b/build.gradle
@@ -722,7 +722,7 @@ task createPlugin(group: ofbizPlugin, description: 'create
a new plugin componen
def templateDir = "${rootDir}/framework/resources/templates"
def pluginDir = "${pluginsDir}/${pluginId}"
-['config', 'data/helpdata', 'dtd', 'documents', 'entitydef', 'lib',
'patches/test', 'patches/qa',
+['config', 'dtd', 'entitydef', 'lib', 'patches/test', 'patches/qa',
'patches/production', 'groovyScripts', 'minilang',
'servicedef', 'src/main/java', 'src/test/java', 'testdef',
'widget', "webapp/${webappName}/error",
"webapp/${webappName}/WEB-INF"].each {
mkdir pluginDir+'/'+it
@@ -734,10 +734,8 @@ task createPlugin(group: ofbizPlugin, description: 'create
a new plugin componen
[tempName:'SecurityPermissionSeedData.xml',
newName:"${pluginResourceName}SecurityPermissionSeedData.xml", location:'data'],
[tempName:'SecurityGroupDemoData.xml',
newName:"${pluginResourceName}SecurityGroupDemoData.xml", location:'data'],
[tempName:'DemoData.xml',
newName:"${pluginResourceName}DemoData.xml", location:'data'],
-[tempName:'HELP.xml', newName:"HELP_${pluginResourceName}.xml",
location:'data/helpdata'],
[tempName:'HELP.adoc', newName:'HELP.adoc', location:''],
[tempName:'README.adoc', newName:'README.adoc', location:''],
-[tempName:'document.xml', newName:"${pluginResourceName}.xml",
location:'documents'],
[tempName:'entitymodel.xml', newName:'entitymodel.xml',
location:'entitydef'],
[tempName:'services.xml', newName:'services.xml',
location:'servicedef'],
[tempName:'Tests.xml', newName:"${pluginResourceName}Tests.xml",
location:'testdef'],
diff --git a/framework/resources/templates/HELP.xml
b/framework/resources/templates/HELP.xml
deleted file mode 100644
index 4b0d5f7..000
--- a/framework/resources/templates/HELP.xml
+++ /dev/null
@@ -1,29 +0,0 @@
-
-
-
-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;>
-@component-resource-name@ Overview
-The @component-resource-name@ Help file template.
-
-
diff --git a/framework/resources/templates/document.xml
b/framework/resources/templates/document.xml
deleted file mode 100644
index 63ec73c..000
--- a/framework/resources/templates/document.xml
+++ /dev/null
@@ -1,35 +0,0 @@
-
-
-
-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;>
-
-The
@component-resource-name@ Component
-
-Introduction
-
-
-
-
-
-
[ofbiz-framework] branch trunk updated (d56e397 -> e6d77fd)
This is an automated email from the ASF dual-hosted git repository. holivier pushed a change to branch trunk in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git. from d56e397 Improved: Upgrade Gradle to V6.5.1 (OFBIZ-11946) new 302bc0e Documented: migration to help system using asciidoc files (OFBIZ-11587) new 37c075b Documented: migration to help system using asciidoc files (OFBIZ-11587) new 19d5435 fixed: duplicate webtools include help from developer-manual to user-manual for help link work new e6d77fd Documented: Help system using asciidoc files (OFBIZ-11693) The 4 revisions listed above as "new" are entirely new to this repository and will be described in separate emails. The revisions listed as "add" were already present in the repository and have only been added to this reference. Summary of changes: .../accounting/data/AccountingHelpData.xml | 29 -- applications/accounting/data/HELP_ACCOUNTING.xml | 30 --- applications/commonext/data/CommonExtHelpData.xml | 34 applications/content/data/ContentHelpData.xml | 62 -- applications/content/data/PartyHelpData.xml| 29 -- applications/content/data/WebtoolsHelpData.xml | 29 -- .../content/data/helpdata/HELP_CONTENT.xml | 32 --- .../content/data/helpdata/HELP_CONTENT_IT.xml | 28 -- applications/content/data/helpdata/HELP_ROOT.xml | 36 - .../content/data/helpdata/HELP_ROOT_FR.xml | 39 -- .../content/data/helpdata/HELP_ROOT_IT.xml | 31 --- .../content/data/helpdata/HELP_ROOT_NL.xml | 37 - applications/humanres/data/HELP_HR.xml | 28 -- applications/humanres/data/HumanResHelpData.xml| 28 -- applications/manufacturing/data/Help_MFG.xml | 33 .../data/ManufacturingHelpData_EN.xml | 30 --- applications/marketing/data/HELP_MARKETING.xml | 38 - applications/marketing/data/HELP_SFA.xml | 35 applications/marketing/data/MarketingHelpData.xml | 37 - applications/order/data/HELP_ORDERMGR.xml | 27 -- applications/order/data/OrderHelpData.xml | 28 -- applications/party/data/HELP_PARTY.xml | 33 applications/product/data/HELP_PRODUCT.xml | 30 --- applications/product/data/ProductHelpData.xml | 25 - build.gradle | 4 +- docs/asciidoc/user-manual.adoc | 7 +++ framework/resources/templates/HELP.xml | 29 -- framework/resources/templates/document.xml | 35 framework/webtools/data/HELP_WEBTOOLS.xml | 24 - themes/bluelight/template/Header.ftl | 10 +--- themes/flatgrey/template/Header.ftl| 10 +--- .../rainbowstone/template/includes/TopAppBar.ftl | 8 +-- themes/tomahawk/template/AppBarClose.ftl | 10 +--- 33 files changed, 12 insertions(+), 913 deletions(-) delete mode 100644 applications/accounting/data/AccountingHelpData.xml delete mode 100644 applications/accounting/data/HELP_ACCOUNTING.xml delete mode 100644 applications/commonext/data/CommonExtHelpData.xml delete mode 100644 applications/content/data/ContentHelpData.xml delete mode 100644 applications/content/data/PartyHelpData.xml delete mode 100644 applications/content/data/WebtoolsHelpData.xml delete mode 100644 applications/content/data/helpdata/HELP_CONTENT.xml delete mode 100644 applications/content/data/helpdata/HELP_CONTENT_IT.xml delete mode 100644 applications/content/data/helpdata/HELP_ROOT.xml delete mode 100644 applications/content/data/helpdata/HELP_ROOT_FR.xml delete mode 100644 applications/content/data/helpdata/HELP_ROOT_IT.xml delete mode 100644 applications/content/data/helpdata/HELP_ROOT_NL.xml delete mode 100644 applications/humanres/data/HELP_HR.xml delete mode 100644 applications/humanres/data/HumanResHelpData.xml delete mode 100644 applications/manufacturing/data/Help_MFG.xml delete mode 100644 applications/manufacturing/data/ManufacturingHelpData_EN.xml delete mode 100644 applications/marketing/data/HELP_MARKETING.xml delete mode 100644 applications/marketing/data/HELP_SFA.xml delete mode 100644 applications/marketing/data/MarketingHelpData.xml delete mode 100644 applications/order/data/HELP_ORDERMGR.xml delete mode 100644 applications/order/data/OrderHelpData.xml delete mode 100644 applications/party/data/HELP_PARTY.xml delete mode 100644 applications/product/data/HELP_PRODUCT.xml delete mode 100644 applications/product/data/ProductHelpData.xml delete mode 100644 framework/resources/templates/HELP.xml delete mode 100644 framework/resources/templates/document.xml delete mode 100644 framework/webtools/data/HELP_WEBTOOLS.xml
[ofbiz-framework] 04/04: Documented: Help system using asciidoc files (OFBIZ-11693)
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
commit e6d77fdaa31dc5361184594c04bfdbf930926cd5
Author: holivier
AuthorDate: Mon Oct 26 17:33:05 2020 +0100
Documented: Help system using asciidoc files (OFBIZ-11693)
now OFBiz uses only help link to asciidoc user-manual (no more using
docbook files)
---
themes/bluelight/template/Header.ftl| 10 +-
themes/flatgrey/template/Header.ftl | 10 +-
themes/rainbowstone/template/includes/TopAppBar.ftl | 8 +---
themes/tomahawk/template/AppBarClose.ftl| 10 +-
4 files changed, 4 insertions(+), 34 deletions(-)
diff --git a/themes/bluelight/template/Header.ftl
b/themes/bluelight/template/Header.ftl
index 9460fed..6ff5e16 100644
--- a/themes/bluelight/template/Header.ftl
+++ b/themes/bluelight/template/Header.ftl
@@ -195,15 +195,7 @@ under the License.
<#else>
${uiLabelMap.CommonLogin}
-<#if helpAnchor??>
-
-<#else>
- <#--if webSiteId?? && requestAttributes._CURRENT_VIEW_?? &&
helpTopic??-->
- <#if parameters.componentName?? &&
requestAttributes._CURRENT_VIEW_?? && helpTopic??>
-<#include
"component://common-theme/template/includes/HelpLink.ftl" />
-
-
-
+#${helpAnchor}" target="help"
title="${uiLabelMap.CommonHelp}">
<#if userLogin??>
<#if "Y" == (userPreferences.COMPACT_HEADER)?default("N")>
diff --git a/themes/flatgrey/template/Header.ftl
b/themes/flatgrey/template/Header.ftl
index 97e20f0..a24bbe3 100644
--- a/themes/flatgrey/template/Header.ftl
+++ b/themes/flatgrey/template/Header.ftl
@@ -157,15 +157,7 @@ under the License.
<#else>
${uiLabelMap.CommonWelcome}! ${uiLabelMap.CommonLogin}
- <#if helpAnchor??>
-${uiLabelMap.CommonHelp}
- <#else>
- <#---if webSiteId?? && requestAttributes._CURRENT_VIEW_?? &&
helpTopic??-->
- <#if parameters.componentName?? &&
requestAttributes._CURRENT_VIEW_?? && helpTopic??>
-<#include
"component://common-theme/template/includes/HelpLink.ftl" />
-class="alert"
href="javascript:lookup_popup1('<@ofbizUrl>showHelp?helpTopic=${helpTopic}portalPageId=${(parameters.portalPageId!)?html}','help'
,500,500);">${uiLabelMap.CommonHelp}
-
-
+ #${helpAnchor}"
target="help">${uiLabelMap.CommonHelp}
diff --git a/themes/rainbowstone/template/includes/TopAppBar.ftl
b/themes/rainbowstone/template/includes/TopAppBar.ftl
index a6936dd..318c0fa 100644
--- a/themes/rainbowstone/template/includes/TopAppBar.ftl
+++ b/themes/rainbowstone/template/includes/TopAppBar.ftl
@@ -237,13 +237,7 @@ under the License.
-<#if helpAnchor??>
- ${uiLabelMap.CommonHelp}
-<#else>
- <#if parameters.componentName?exists &&
requestAttributes._CURRENT_VIEW_?exists && helpTopic?exists>
-
-
-
+#${helpAnchor}"
target="help">${uiLabelMap.CommonHelp}
<#include "component://rainbowstone/template/includes/Avatar.ftl"/>
diff --git a/themes/tomahawk/template/AppBarClose.ftl
b/themes/tomahawk/template/AppBarClose.ftl
index 0467bad..a3c0a64 100644
--- a/themes/tomahawk/template/AppBarClose.ftl
+++ b/themes/tomahawk/template/AppBarClose.ftl
@@ -72,15 +72,7 @@ under the License.
<#if userLogin??>
- <#if helpAnchor??>
-
- <#else>
-<#--if webSiteId?? && requestAttributes._CURRENT_VIEW_?? &&
helpTopic??-->
-<#if parameters.componentName?? && requestAttributes._CURRENT_VIEW_??
&& helpTopic??>
- <#include "component://common-theme/template/includes/HelpLink.ftl"
/>
-
-
-
+ #${helpAnchor}" target="help"
title="${uiLabelMap.CommonHelp}">
${uiLabelMap.CommonLogout}
${uiLabelMap.CommonVisualThemes}
<#else>
[ofbiz-framework] 03/04: fixed: duplicate webtools include help from developer-manual to user-manual for help link work
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 commit 19d5435c978e3092265dd1e8e2c69a6a6d4e55b6 Author: holivier AuthorDate: Mon Oct 26 17:15:07 2020 +0100 fixed: duplicate webtools include help from developer-manual to user-manual for help link work when there will be a general glossary, duplication will not be necessary --- docs/asciidoc/user-manual.adoc | 7 +++ 1 file changed, 7 insertions(+) diff --git a/docs/asciidoc/user-manual.adoc b/docs/asciidoc/user-manual.adoc index c77a6140..bc7481a 100644 --- a/docs/asciidoc/user-manual.adoc +++ b/docs/asciidoc/user-manual.adoc @@ -172,6 +172,13 @@ include::../../applications/party/src/docs/asciidoc/party.adoc[leveloffset=+2] include::../../applications/product/src/docs/asciidoc/product.adoc[leveloffset=+2] + +webtools help should be remove when global glossary exist, and contain a link to developer-manual#webtools + +=== Web tools +The Webtools application is the UI-gateway to all the framework functions. + +include::../../framework/webtools/src/docs/asciidoc/_include/webtools-main.adoc[leveloffset=+3] // Plugins Business Applications include::../../plugins/docs/asciidoc/plugins-user-manual.adoc[leveloffset=+1] \ No newline at end of file
[ofbiz-plugins] branch trunk updated: Documented: migration to help system using asciidoc files (OFBIZ-11587)
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-plugins.git The following commit(s) were added to refs/heads/trunk by this push: new eebd368 Documented: migration to help system using asciidoc files (OFBIZ-11587) eebd368 is described below commit eebd368718ae8a13f57bec68029f568580de4add Author: holivier AuthorDate: Mon Oct 26 16:03:59 2020 +0100 Documented: migration to help system using asciidoc files (OFBIZ-11587) Remove all related help docbook files --- birt/data/BirtHelpData.xml | 28 -- birt/data/helpdata/HELP_BIRT.xml | 33 ebay/data/EbayHelpData.xml | 28 -- ebay/data/HELP_EBAY.xml| 35 - ebaystore/data/EbayStoreHelpData.xml | 29 -- ebaystore/data/HELP_EBAY_STORE.xml | 27 - example/data/ExampleHelpData.xml | 29 -- example/data/HELP_EXAMPLE.xml | 28 -- example/data/helpdata/HELP_EXAMPLE_FR.xml | 44 -- myportal/data/MyPortalPageDemoData.xml | 12 +- .../data/helpdata/HELP_Ofbiz-rest-jersey.xml | 29 -- ofbiz-rest-impl/documents/Ofbiz-rest-jersey.xml| 36 -- projectmgr/data/HELP_PROJECTMGR.xml| 33 projectmgr/data/ProjectMgrHelpData.xml | 30 --- scrum/data/HELP_SCRUM.xml | 36 -- scrum/data/scrumHelpData.xml | 28 -- 16 files changed, 2 insertions(+), 483 deletions(-) diff --git a/birt/data/BirtHelpData.xml b/birt/data/BirtHelpData.xml deleted file mode 100644 index 40acea5..000 --- a/birt/data/BirtHelpData.xml +++ /dev/null @@ -1,28 +0,0 @@ - - - - - - - - diff --git a/birt/data/helpdata/HELP_BIRT.xml b/birt/data/helpdata/HELP_BIRT.xml deleted file mode 100644 index 4235c6f..000 --- a/birt/data/helpdata/HELP_BIRT.xml +++ /dev/null @@ -1,33 +0,0 @@ - - -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;> - -OFBiz BIRT Overview redirection - -Welcome to OFBiz BIRT. The part installed within OFBiz allows you to run the reports which are prepared using Eclipse with the BIRT plugin installed. - -BIRT Help has been migrated to a new system, you can access it by using - https://ci.apache.org/projects/ofbiz/site/trunk/ofbizdoc/html5/user-manual.html#_ebay_store;>OFBiz user documentation site / BIRT - - diff --git a/ebay/data/EbayHelpData.xml b/ebay/data/EbayHelpData.xml deleted file mode 100644 index e95be3e..000 --- a/ebay/data/EbayHelpData.xml +++ /dev/null @@ -1,28 +0,0 @@ - - - - - - - - diff --git a/ebay/data/HELP_EBAY.xml b/ebay/data/HELP_EBAY.xml deleted file mode 100644 index d88b4ec..000 --- a/ebay/data/HELP_EBAY.xml +++ /dev/null @@ -1,35 +0,0 @@ - - -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;> - - -The Ebay application Help redirection. - -The Ebay component provides an interface to the Ebay website. It is possible to export products from your store into eBay category also import an orders from ebay. - -Ebay Help has been migrated to a new system, you can access it by using - https://ci.apache.org/projects/ofbiz/site/trunk/ofbizdoc/html5/user-manual.html#_the_ebay_component;>OFBiz user documentation site / Ebay - - - diff --git a/ebaystore/data/EbayStoreHelpData.xml b/ebaystore/data/EbayStoreHelpData.xml deleted file mode 100644 index 552675e..000 --- a/ebaystore/data/EbayStoreHelpData.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - - - - diff --git a/ebaystore/data/HELP_EBAY_STORE.xml b/ebaystore/data/HELP_EBAY_STORE.xml deleted file mode 100644 index ae9b432..000 --- a/ebaystore/data/HELP_EBAY_STORE.xml +++ /dev/null @@ -1,27 +0,0 @@ - - -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;> -Ebay Store help redirection. - -
[ofbiz-plugins] branch trunk updated: Documented: migration to help system using asciidoc files (OFBIZ-11587)
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-plugins.git The following commit(s) were added to refs/heads/trunk by this push: new 30aa013 Documented: migration to help system using asciidoc files (OFBIZ-11587) 30aa013 is described below commit 30aa0132e6f903625342c9cc5d99eadcbf3cd76b Author: holivier AuthorDate: Fri Oct 23 18:34:33 2020 +0200 Documented: migration to help system using asciidoc files (OFBIZ-11587) Add + @@ -138,6 +139,6 @@ under the License. - + diff --git a/assetmaint/widget/ismgr/CommonScreens.xml b/assetmaint/widget/ismgr/CommonScreens.xml index 38f2488..db660e2 100644 --- a/assetmaint/widget/ismgr/CommonScreens.xml +++ b/assetmaint/widget/ismgr/CommonScreens.xml @@ -34,6 +34,7 @@ under the License. +
[ofbiz-framework] branch trunk updated: fixed: createPartyGroupRoleAndContactMechs service not working (OFBIZ-11986)
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 cf7164f fixed: createPartyGroupRoleAndContactMechs service not working (OFBIZ-11986) cf7164f is described below commit cf7164fc64280eb8747073622dea3e0bc4d31ca6 Author: holivier AuthorDate: Wed Oct 7 11:44:49 2020 +0200 fixed: createPartyGroupRoleAndContactMechs service not working (OFBIZ-11986) Service is used for create employee service, and email address is not mandatory, so emailAddressContext should be empty if parameters.emailAddress is empty. Correction done is to call createPerson before creating emailAddressContext to be able to put set partyId in the if not empty parameters.emailAddress --- applications/party/minilang/party/PartySimpleMethods.xml | 16 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/applications/party/minilang/party/PartySimpleMethods.xml b/applications/party/minilang/party/PartySimpleMethods.xml index 91fb7c8..e8af48a 100644 --- a/applications/party/minilang/party/PartySimpleMethods.xml +++ b/applications/party/minilang/party/PartySimpleMethods.xml @@ -120,6 +120,11 @@ under the License. xml-resource="component://party/minilang/contact/PartyContactMechMapProcs.xml"/> + + + + + @@ -129,15 +134,10 @@ under the License. + - - - - - - - + @@ -147,7 +147,6 @@ under the License. - @@ -233,6 +232,7 @@ under the License. +
[ofbiz-framework] branch trunk updated: fixed: title-logo-image should be in header so without blank line
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 e934b2b fixed: title-logo-image should be in header so without blank line e934b2b is described below commit e934b2bd137738877c51560c5dd56bb9cb999123 Author: holivier AuthorDate: Tue Oct 6 14:00:06 2020 +0200 fixed: title-logo-image should be in header so without blank line Now OFBiz-Logo is printed in pdf --- docs/asciidoc/developer-manual.adoc | 1 - docs/asciidoc/documentation_guidelines.adoc | 1 - docs/asciidoc/user-manual.adoc | 1 - 3 files changed, 3 deletions(-) diff --git a/docs/asciidoc/developer-manual.adoc b/docs/asciidoc/developer-manual.adoc index 8ddd5a3..a25d138 100644 --- a/docs/asciidoc/developer-manual.adoc +++ b/docs/asciidoc/developer-manual.adoc @@ -18,7 +18,6 @@ under the License. = Apache OFBiz Developer Manual The Apache OFBiz Project - :imagesdir: ./images ifdef::backend-pdf[] :title-logo-image: image::OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=4.25in, align=center] diff --git a/docs/asciidoc/documentation_guidelines.adoc b/docs/asciidoc/documentation_guidelines.adoc index 1c69c86..88bcb6a 100644 --- a/docs/asciidoc/documentation_guidelines.adoc +++ b/docs/asciidoc/documentation_guidelines.adoc @@ -18,7 +18,6 @@ under the License. = Apache OFBiz Documentation Guidelines The Apache OFBiz Project - :imagesdir: ./images ifdef::backend-pdf[] :title-logo-image: image::OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=4.25in, align=center] diff --git a/docs/asciidoc/user-manual.adoc b/docs/asciidoc/user-manual.adoc index 70154a4..c77a6140 100644 --- a/docs/asciidoc/user-manual.adoc +++ b/docs/asciidoc/user-manual.adoc @@ -18,7 +18,6 @@ under the License. = Apache OFBiz User Manual The Apache OFBiz Project - :imagesdir: ./images ifdef::backend-pdf[] :title-logo-image: image::OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=4.25in, align=center]
[ofbiz-plugins] branch trunk updated: fixed: asciidoc attribute imagesDir should not be in the header
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-plugins.git The following commit(s) were added to refs/heads/trunk by this push: new 3660185 fixed: asciidoc attribute imagesDir should not be in the header 3660185 is described below commit 36601854f2bc6138a49004533fa2ae778982b8ed Author: holivier AuthorDate: Tue Oct 6 13:53:12 2020 +0200 fixed: asciidoc attribute imagesDir should not be in the header --- birt/src/docs/asciidoc/birt.adoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/birt/src/docs/asciidoc/birt.adoc b/birt/src/docs/asciidoc/birt.adoc index 7395450..8c34747 100644 --- a/birt/src/docs/asciidoc/birt.adoc +++ b/birt/src/docs/asciidoc/birt.adoc @@ -19,9 +19,10 @@ under the License. = Birt OFBiz® plugin The Apache OFBiz Project ifdef::backend-pdf[] -:title-logo-image: image::../OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=4.25in, align=center] +:title-logo-image: image::images/OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=4.25in, align=center] :source-highlighter: rouge endif::[] + :imagesdir: ./images/birt image:https://img.shields.io/badge/License-Apache%202.0-blue.svg[link="http://www.apache.org/licenses/LICENSE-2.0;]
[ofbiz-plugins] branch trunk updated: fixed: title-logo-image should be in header so without blank line
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-plugins.git The following commit(s) were added to refs/heads/trunk by this push: new c8f0123 fixed: title-logo-image should be in header so without blank line c8f0123 is described below commit c8f012384580fd7cc4353dbc8d3d0d9f6259aef0 Author: holivier AuthorDate: Mon Oct 5 12:42:33 2020 +0200 fixed: title-logo-image should be in header so without blank line Now OFBiz-Logo is print in pdf --- birt/src/docs/asciidoc/birt.adoc | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/birt/src/docs/asciidoc/birt.adoc b/birt/src/docs/asciidoc/birt.adoc index 98096ce..7395450 100644 --- a/birt/src/docs/asciidoc/birt.adoc +++ b/birt/src/docs/asciidoc/birt.adoc @@ -18,10 +18,8 @@ under the License. = Birt OFBiz® plugin The Apache OFBiz Project - ifdef::backend-pdf[] -:imagesdir: ./images -:title-logo-image: image::OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=4.25in, align=center] +:title-logo-image: image::../OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=4.25in, align=center] :source-highlighter: rouge endif::[] :imagesdir: ./images/birt
[ofbiz-plugins] branch release18.12 updated: Improved: Error messages when generating HTML and PDF file from AsciiDoc files (OFBIZ-11893)
This is an automated email from the ASF dual-hosted git repository. holivier pushed a commit to branch release18.12 in repository https://gitbox.apache.org/repos/asf/ofbiz-plugins.git The following commit(s) were added to refs/heads/release18.12 by this push: new ccfb388 Improved: Error messages when generating HTML and PDF file from AsciiDoc files (OFBIZ-11893) ccfb388 is described below commit ccfb388999068707a4e1f88d794f55356cad49e6 Author: holivier AuthorDate: Mon Oct 5 11:31:39 2020 +0200 Improved: Error messages when generating HTML and PDF file from AsciiDoc files (OFBIZ-11893) re-encode birt image Report-Master.png to be supported by asciidoctor --- birt/src/docs/asciidoc/images/Report-Master.png | Bin 215737 -> 201057 bytes 1 file changed, 0 insertions(+), 0 deletions(-) diff --git a/birt/src/docs/asciidoc/images/Report-Master.png b/birt/src/docs/asciidoc/images/Report-Master.png index a60f82f..3119d6a 100644 Binary files a/birt/src/docs/asciidoc/images/Report-Master.png and b/birt/src/docs/asciidoc/images/Report-Master.png differ
[ofbiz-framework] branch release18.12 updated: Improvement: Error messages when generating HTML and PDF file from AsciiDoc files (OFBIZ-11893)
This is an automated email from the ASF dual-hosted git repository. holivier pushed a commit to branch release18.12 in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git The following commit(s) were added to refs/heads/release18.12 by this push: new 009beb4 Improvement: Error messages when generating HTML and PDF file from AsciiDoc files (OFBIZ-11893) 009beb4 is described below commit 009beb4b11c5fc4fc4823ba0cc0609e09482c2ee Author: holivier AuthorDate: Mon Oct 5 10:39:28 2020 +0200 Improvement: Error messages when generating HTML and PDF file from AsciiDoc files (OFBIZ-11893) minor correction, title level and anchor definition --- framework/security/src/docs/asciidoc/_include/sy-CSRF-defense.adoc | 2 +- .../security/src/docs/asciidoc/_include/sy-impersonation.adoc | 7 ++- 2 files changed, 3 insertions(+), 6 deletions(-) diff --git a/framework/security/src/docs/asciidoc/_include/sy-CSRF-defense.adoc b/framework/security/src/docs/asciidoc/_include/sy-CSRF-defense.adoc index ee47604..8440b4d 100644 --- a/framework/security/src/docs/asciidoc/_include/sy-CSRF-defense.adoc +++ b/framework/security/src/docs/asciidoc/_include/sy-CSRF-defense.adoc @@ -38,7 +38,7 @@ By default OOTB the SameSiteFilter property sets the same-site attribute value to 'strict. SameSiteFilter allows to change to 'lax' if needed -= Properties + Properties The _security.properties_ file contains related properties: diff --git a/framework/security/src/docs/asciidoc/_include/sy-impersonation.adoc b/framework/security/src/docs/asciidoc/_include/sy-impersonation.adoc index 8876f32..7612102 100644 --- a/framework/security/src/docs/asciidoc/_include/sy-impersonation.adoc +++ b/framework/security/src/docs/asciidoc/_include/sy-impersonation.adoc @@ -23,10 +23,6 @@ The Apache OFBiz Project Release 18.12 :imagesdir: ../../themes/common-theme/webapp/images/img/ -ifdef::backend-pdf[] -:title-logo-image: image::OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=4.25in, align=center] -:source-highlighter: rouge -endif::[] === Introduction to User impersonation @@ -35,7 +31,7 @@ see navigating through the application in his name. === How do this work ? -An authorized user _(see <> and <> section for configuration)_, can select a user +An authorized user _(see <> and <> section for configuration)_, can select a user that will be impersonated. The impersonation start, if everything is well configured, in current application (partymgr for the demo). @@ -50,6 +46,7 @@ This icon indicates, when clicking on it, the user impersonated, and offer a way The impersonate period is stored for audit purpose, and if the impersonator forgot to depersonate, the period is terminated _one hour_ after impersonation start. +[[impersonation_security]] === Security This feature can draw some concerns about security aspect. This paragraph will introduce every controls and properties
[ofbiz-framework] branch release17.12 updated: fixed: svg files not removed on clean (OFBIZ-11976)
This is an automated email from the ASF dual-hosted git repository.
holivier pushed a commit to branch release17.12
in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git
The following commit(s) were added to refs/heads/release17.12 by this push:
new 726ebe8 fixed: svg files not removed on clean (OFBIZ-11976)
726ebe8 is described below
commit 726ebe8493ead8f0596445a5facac1b72ca669ad
Author: holivier
AuthorDate: Fri Oct 2 19:00:18 2020 +0200
fixed: svg files not removed on clean (OFBIZ-11976)
Backport build.gradle correction from OFBIZ-12035, correction in
generateAllPluginsDocumentation to put copy of OFBiz-Logo in doFirst to avoid
it's run during gradle Configure project
---
build.gradle | 13 -
1 file changed, 8 insertions(+), 5 deletions(-)
diff --git a/build.gradle b/build.gradle
index cf3d68c..24ced15 100644
--- a/build.gradle
+++ b/build.gradle
@@ -594,11 +594,15 @@ task generateAllPluginsDocumentation(group: docsGroup,
// the other inner task temporary created by the
generatePluginDocumentation task
def pluginAsciidoc = task
"${component.name}-Documentation" (type: AsciidoctorTask) {
def asciidocFolder = new
File("${component}/src/docs/asciidoc")
-if (asciidocFolder.exists()) {
-copy {
-from
"${rootDir}/docs/asciidoc/images/OFBiz-Logo.svg"
-into "${component}/src/docs/asciidoc/images"
+doFirst {
+if (asciidocFolder.exists()) {
+copy {
+from
"${rootDir}/docs/asciidoc/images/OFBiz-Logo.svg"
+into
"${component}/src/docs/asciidoc/images"
+}
}
+}
+if (asciidocFolder.exists()) {
sourceDir file("${component}/src/docs/asciidoc")
outputDir
file("${buildDir}/asciidoc/plugins/${component.name}")
doLast { println "Documentation generated for
plugin ${component.name}" }
@@ -609,7 +613,6 @@ task generateAllPluginsDocumentation(group: docsGroup,
dependsOn pluginAsciidoc
}
-doLast { delete
"${component}/src/docs/asciidoc/images/OFBiz-Logo.svg" }
}
}
}
[ofbiz-plugins] branch release17.12 updated: Improved: Error messages when generating HTML and PDF file from AsciiDoc files (OFBIZ-11893)
This is an automated email from the ASF dual-hosted git repository. holivier pushed a commit to branch release17.12 in repository https://gitbox.apache.org/repos/asf/ofbiz-plugins.git The following commit(s) were added to refs/heads/release17.12 by this push: new eadffa2 Improved: Error messages when generating HTML and PDF file from AsciiDoc files (OFBIZ-11893) eadffa2 is described below commit eadffa215bcbe33d171d6e6263aca8fa21c9ddf7 Author: holivier AuthorDate: Fri Oct 2 18:34:40 2020 +0200 Improved: Error messages when generating HTML and PDF file from AsciiDoc files (OFBIZ-11893) re-encode birt image Report-Master.png to be supported by asciidoctor --- birt/src/docs/asciidoc/images/Report-Master.png | Bin 215737 -> 201057 bytes 1 file changed, 0 insertions(+), 0 deletions(-) diff --git a/birt/src/docs/asciidoc/images/Report-Master.png b/birt/src/docs/asciidoc/images/Report-Master.png index a60f82f..3119d6a 100644 Binary files a/birt/src/docs/asciidoc/images/Report-Master.png and b/birt/src/docs/asciidoc/images/Report-Master.png differ
[ofbiz-plugins] branch release17.12 updated: Improved: Error messages when generating HTML and PDF file from AsciiDoc files (OFBIZ-11893)
This is an automated email from the ASF dual-hosted git repository. holivier pushed a commit to branch release17.12 in repository https://gitbox.apache.org/repos/asf/ofbiz-plugins.git The following commit(s) were added to refs/heads/release17.12 by this push: new eadffa2 Improved: Error messages when generating HTML and PDF file from AsciiDoc files (OFBIZ-11893) eadffa2 is described below commit eadffa215bcbe33d171d6e6263aca8fa21c9ddf7 Author: holivier AuthorDate: Fri Oct 2 18:34:40 2020 +0200 Improved: Error messages when generating HTML and PDF file from AsciiDoc files (OFBIZ-11893) re-encode birt image Report-Master.png to be supported by asciidoctor --- birt/src/docs/asciidoc/images/Report-Master.png | Bin 215737 -> 201057 bytes 1 file changed, 0 insertions(+), 0 deletions(-) diff --git a/birt/src/docs/asciidoc/images/Report-Master.png b/birt/src/docs/asciidoc/images/Report-Master.png index a60f82f..3119d6a 100644 Binary files a/birt/src/docs/asciidoc/images/Report-Master.png and b/birt/src/docs/asciidoc/images/Report-Master.png differ
[ofbiz-framework] 02/02: Improvement: Error messages when generating HTML and PDF file from AsciiDoc files (OFBIZ-11893)
This is an automated email from the ASF dual-hosted git repository. holivier pushed a commit to branch release17.12 in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git commit 85db312077ceeade6b9fa585f8d3eb7d77579ca0 Author: holivier AuthorDate: Fri Oct 2 18:05:28 2020 +0200 Improvement: Error messages when generating HTML and PDF file from AsciiDoc files (OFBIZ-11893) minor correction, title level --- framework/security/src/docs/asciidoc/_include/sy-CSRF-defense.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/framework/security/src/docs/asciidoc/_include/sy-CSRF-defense.adoc b/framework/security/src/docs/asciidoc/_include/sy-CSRF-defense.adoc index 4c380ff..07c6fee 100644 --- a/framework/security/src/docs/asciidoc/_include/sy-CSRF-defense.adoc +++ b/framework/security/src/docs/asciidoc/_include/sy-CSRF-defense.adoc @@ -38,7 +38,7 @@ By default OOTB the SameSiteFilter property sets the same-site attribute value to 'strict. SameSiteFilter allows to change to 'lax' if needed -= Properties + Properties The _security.properties_ file contains related properties:
[ofbiz-framework] 01/02: Improvement: Error messages when generating HTML and PDF file from AsciiDoc files (OFBIZ-11893)
This is an automated email from the ASF dual-hosted git repository. holivier pushed a commit to branch release17.12 in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git commit 744fa72316b9da6adfab621a9c77699b1ea57c6c Author: holivier AuthorDate: Fri Oct 2 18:04:39 2020 +0200 Improvement: Error messages when generating HTML and PDF file from AsciiDoc files (OFBIZ-11893) remove sy-impersonation.adoc because impersonation is not implemented in 17.12 --- .../docs/asciidoc/_include/sy-impersonation.adoc | 127 - framework/security/src/docs/asciidoc/security.adoc | 1 - 2 files changed, 128 deletions(-) diff --git a/framework/security/src/docs/asciidoc/_include/sy-impersonation.adoc b/framework/security/src/docs/asciidoc/_include/sy-impersonation.adoc deleted file mode 100644 index e0b1bb4..000 --- a/framework/security/src/docs/asciidoc/_include/sy-impersonation.adoc +++ /dev/null @@ -1,127 +0,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. - - -= Impersonation -== What is Impersonation in Apache OFBiz -The Apache OFBiz Project -Release 17.12 - -:imagesdir: ../../themes/common-theme/webapp/images/img/ -ifdef::backend-pdf[] -:title-logo-image: image::OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=4.25in, align=center] -:source-highlighter: rouge -endif::[] - -=== Introduction to User impersonation - -User Impersonation is a feature that offer a way to select a user login and impersonate it, i.e. see what the user could -see navigating through the application in his name. - -=== How do this work ? - -An authorized user _(see <> and <> section for configuration)_, can select a user -that will be impersonated. - -The impersonation start, if everything is well configured, in current application (partymgr for the demo). -Everything appears like if we were logged in with the userLoginId and the valid password (though we know nothing about it) - -The only thing showing that we currently are impersonating a user is the little bottom-right image : - -image::impersonate-ico.png[Impersonate icon, pdfwidth=0.5in, align=left] - -This icon indicates, when clicking on it, the user impersonated, and offer a way to depersonate. - -The impersonate period is stored for audit purpose, and if the impersonator forgot to depersonate, the period -is terminated _one hour_ after impersonation start. - -=== Security - -This feature can draw some concerns about security aspect. This paragraph will introduce every controls and properties -that have been implemented around the impersonation feature. - -[CAUTION] -These configuration steps are not to be neglected for a *production environment* since this feature offer a way to act - in place of another user. - - Properties - -The _security.properties_ file introduce two properties that control impersonation feature : - - -[source] -security.disable.impersonation = true - -This property, set by default to *true*, controls the activation of impersonation feature. If no configuration is done -any user trying to use impersonation will face an error message, indicating that the feature is disabled. - -To enable impersonation this property need to be set to *false* - - -[source] -security.login.authorised.during.impersonate = false - -This property controls the way impersonation occurred to the impersonated user : - -In default configuration, the impersonated user see nothing and can use the application without knowing that he is -currently impersonated. Several authorized user can impersonate a same login without any issue. - -[NOTE] -This configuration is intended for testing/QA environment allowing any authorized user to impersonate a login -to validate its configuration, test the application etc. - -Set to *true*, this configuration improve the control of the data generated by the impersonated user. Indeed, Only one -authorized user can impersonate a login at the same time, and during the impersonation process, the impersonated user -is unable to act within the application. - -Since the impersonation period is stored in database, the actions done by the -authorized user can be identified if there is the need to do so. -[NOTE] -This configuration is int
[ofbiz-framework] branch trunk updated: Improved: Error messages when generating HTML and PDF file from AsciiDoc files (OFBIZ-11893)
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 7c7eae2 Improved: Error messages when generating HTML and PDF file from AsciiDoc files (OFBIZ-11893) 7c7eae2 is described below commit 7c7eae2f84bef7ca0251063d6872bcea0ee81a40 Author: holivier AuthorDate: Fri Oct 2 18:23:14 2020 +0200 Improved: Error messages when generating HTML and PDF file from AsciiDoc files (OFBIZ-11893) sy-impersonation.adoc minor correction, * imagesDir cannot be out of asciidoc directory because content of it s copied in build directory when document is generated * internal link to go to sub-section security was wrong because securty automatic anchor is generate for general security chapter --- .../src/docs/asciidoc/_include/sy-impersonation.adoc | 9 +++-- .../docs/asciidoc/images/security/impersonate-ico.png| Bin 0 -> 3823 bytes 2 files changed, 3 insertions(+), 6 deletions(-) diff --git a/framework/security/src/docs/asciidoc/_include/sy-impersonation.adoc b/framework/security/src/docs/asciidoc/_include/sy-impersonation.adoc index 6956278..67dc894 100644 --- a/framework/security/src/docs/asciidoc/_include/sy-impersonation.adoc +++ b/framework/security/src/docs/asciidoc/_include/sy-impersonation.adoc @@ -22,11 +22,7 @@ under the License. The Apache OFBiz Project Release trunk -:imagesdir: ../../themes/common-theme/webapp/images/img/ -ifdef::backend-pdf[] -:title-logo-image: image::OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=4.25in, align=center] -:source-highlighter: rouge -endif::[] +:imagesdir: ./images/security === Introduction to User impersonation @@ -35,7 +31,7 @@ see navigating through the application in his name. === How do this work ? -An authorized user _(see <> and <> section for configuration)_, can select a user +An authorized user _(see <> and <> section for configuration)_, can select a user that will be impersonated. The impersonation start, if everything is well configured, in current application (partymgr for the demo). @@ -50,6 +46,7 @@ This icon indicates, when clicking on it, the user impersonated, and offer a way The impersonate period is stored for audit purpose, and if the impersonator forgot to depersonate, the period is terminated _one hour_ after impersonation start. +[[impersonation_security]] === Security This feature can draw some concerns about security aspect. This paragraph will introduce every controls and properties diff --git a/framework/security/src/docs/asciidoc/images/security/impersonate-ico.png b/framework/security/src/docs/asciidoc/images/security/impersonate-ico.png new file mode 100644 index 000..d12c252 Binary files /dev/null and b/framework/security/src/docs/asciidoc/images/security/impersonate-ico.png differ
[ofbiz-framework] branch release17.12 updated (f1e8ea7 -> 85db312)
This is an automated email from the ASF dual-hosted git repository. holivier pushed a change to branch release17.12 in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git. from f1e8ea7 Fixed: Incorrect data issue for InvoiceItemTypeMap and ReturnItemTypeMap. (OFBIZ-11971) As we have returnItemTypeId as RET_MISC_ADJ, same should be used in ReturnItemTypeMap and corresponding InvoiceItemTypeMap. Thanks Amit Gadaley for reporting and providing the patch. new 744fa72 Improvement: Error messages when generating HTML and PDF file from AsciiDoc files (OFBIZ-11893) new 85db312 Improvement: Error messages when generating HTML and PDF file from AsciiDoc files (OFBIZ-11893) The 2 revisions listed above as "new" are entirely new to this repository and will be described in separate emails. The revisions listed as "add" were already present in the repository and have only been added to this reference. Summary of changes: .../docs/asciidoc/_include/sy-CSRF-defense.adoc| 2 +- .../docs/asciidoc/_include/sy-impersonation.adoc | 127 - framework/security/src/docs/asciidoc/security.adoc | 1 - 3 files changed, 1 insertion(+), 129 deletions(-) delete mode 100644 framework/security/src/docs/asciidoc/_include/sy-impersonation.adoc
[ofbiz-framework] branch trunk updated: Improved: change asciidoc Image directory convention for plugins (OFBIZ-12035)
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 a10d932 Improved: change asciidoc Image directory convention for
plugins (OFBIZ-12035)
a10d932 is described below
commit a10d93283640553147f98d11be3acdef1e60dcb8
Author: holivier
AuthorDate: Thu Oct 1 15:51:11 2020 +0200
Improved: change asciidoc Image directory convention for plugins
(OFBIZ-12035)
* modification in gradle generateOfbizDocumentation task to copy the
image/${components.name} subdirectory in the general
docs/asciidoc/images/ directory before generation
and remove it after.
* correction in generateAllPluginsDocumentation to put copy of OFBiz-Logo
in doFirst to avoid it's run during gradle Configure project
---
build.gradle | 31 +++
1 file changed, 23 insertions(+), 8 deletions(-)
diff --git a/build.gradle b/build.gradle
index 830e000..3013b75 100644
--- a/build.gradle
+++ b/build.gradle
@@ -504,9 +504,9 @@ tasks.withType(AsciidoctorTask) { task ->
backends 'html5', 'pdf'
attributes \
'doctype': 'book',
- 'revnumber': 'Trunk',
+'revnumber': 'Trunk',
'experimental': '',
- 'allow-uri-read': true,
+'allow-uri-read': true,
'icons': 'font',
'sectnums': '',
'chapter-label': '',
@@ -541,15 +541,27 @@ task generateReadmeFiles(group: docsGroup, type:
AsciidoctorTask) {
sourceDir "${rootDir}"
sources {
include 'README.adoc', 'CHANGELOG.adoc', 'CONTRIBUTING.adoc'
- }
+ }
outputDir file("${buildDir}/asciidoc/readme/")
}
task generateOfbizDocumentation(group: docsGroup, type: AsciidoctorTask) {
dependsOn deleteOfbizDocumentation
description 'Generate OFBiz documentation manuals'
+activeComponents().each { component ->
+copy {
+from "${component}/src/docs/asciidoc/images/${component.name}"
+include '**/*.*'
+into "${rootDir}/docs/asciidoc/images/${component.name}"
+}
+}
sourceDir "${rootDir}/docs/asciidoc"
outputDir file("${buildDir}/asciidoc/ofbiz")
+doLast {
+ activeComponents().each { component ->
+ delete "${rootDir}/docs/asciidoc/images/${component.name}"
+ }
+}
}
task generatePluginDocumentation(group: docsGroup) {
@@ -591,11 +603,15 @@ task generateAllPluginsDocumentation(group: docsGroup,
// the other inner task temporary created by the
generatePluginDocumentation task
def pluginAsciidoc = task
"${component.name}-Documentation" (type: AsciidoctorTask) {
def asciidocFolder = new
File("${component}/src/docs/asciidoc")
-if (asciidocFolder.exists()) {
-copy {
-from
"${rootDir}/docs/asciidoc/images/OFBiz-Logo.svg"
-into "${component}/src/docs/asciidoc/images"
+doFirst {
+if (asciidocFolder.exists()) {
+copy {
+from
"${rootDir}/docs/asciidoc/images/OFBiz-Logo.svg"
+into
"${component}/src/docs/asciidoc/images"
+}
}
+}
+if (asciidocFolder.exists()) {
sourceDir file("${component}/src/docs/asciidoc")
outputDir
file("${buildDir}/asciidoc/plugins/${component.name}")
doLast { println "Documentation generated for
plugin ${component.name}" }
@@ -605,7 +621,6 @@ task generateAllPluginsDocumentation(group: docsGroup,
}
dependsOn pluginAsciidoc
}
-doLast { delete
"${component}/src/docs/asciidoc/images/OFBiz-Logo.svg" }
}
}
}
[ofbiz-plugins] branch trunk updated: Improved: change asciidoc Image directory convention for plugins (OFBIZ-12035)
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-plugins.git
The following commit(s) were added to refs/heads/trunk by this push:
new 70180cf Improved: change asciidoc Image directory convention for
plugins (OFBIZ-12035)
70180cf is described below
commit 70180cf2547600c0e1efaba6a4480480b70ee67f
Author: holivier
AuthorDate: Thu Oct 1 15:36:18 2020 +0200
Improved: change asciidoc Image directory convention for plugins
(OFBIZ-12035)
* for birt component,
* move all images to images/birt directory
* change in birt.adoc imagesdir to ./images/birt
---
birt/src/docs/asciidoc/birt.adoc | 9 ++---
birt/src/docs/asciidoc/images/Report-Master.png| Bin 215737 -> 0 bytes
.../asciidoc/images/{ => birt}/Aggregation-builder.png | Bin
.../src/docs/asciidoc/images/{ => birt}/Birt-Menus.png | Bin
.../docs/asciidoc/images/{ => birt}/Data-Explorer.png | Bin
.../images/{ => birt}/Design-with-break-complete.png | Bin
.../asciidoc/images/{ => birt}/Design-with-break.png | Bin
.../asciidoc/images/{ => birt}/Edit-Report-screen.png | Bin
.../docs/asciidoc/images/{ => birt}/Example-Report.png | Bin
.../asciidoc/images/{ => birt}/Expression-builder.png | Bin
birt/src/docs/asciidoc/images/{ => birt}/Group.png | Bin
birt/src/docs/asciidoc/images/{ => birt}/Palette.png | Bin
.../docs/asciidoc/images/{ => birt}/Report-Builder.png | Bin
birt/src/docs/asciidoc/images/birt/Report-Master.png | Bin 0 -> 201057 bytes
14 files changed, 6 insertions(+), 3 deletions(-)
diff --git a/birt/src/docs/asciidoc/birt.adoc b/birt/src/docs/asciidoc/birt.adoc
index 03ee924..ec44ab2 100644
--- a/birt/src/docs/asciidoc/birt.adoc
+++ b/birt/src/docs/asciidoc/birt.adoc
@@ -18,12 +18,15 @@ under the License.
= Birt OFBiz® plugin
The Apache OFBiz Project
-Release trunk
-:imagesdir: ./images
+
ifdef::backend-pdf[]
+:imagesdir: ./images
:title-logo-image: image::OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=4.25in,
align=center]
:source-highlighter: rouge
endif::[]
+:imagesdir: ./images/birt
+
+image:https://img.shields.io/badge/License-Apache%202.0-blue.svg[link="http://www.apache.org/licenses/LICENSE-2.0;]
The birt plugin is one of the OFBiz plugins.
@@ -32,7 +35,7 @@ One of the functionalities of the birt plugin are the "OFBiz
Flexible Reports"
NOTE: This feature will begin to be officially available with the R17.12
branch first release
-There is an anounce with some history in the OFBiz blog:
+There is an announce with some history in the OFBiz blog:
https://blogs.apache.org/ofbiz/entry/the-birt-flexible-reports-a[Reporting in
Apache OFBiz® and the OFBiz Flexible Reports]
== Technical Documentation
diff --git a/birt/src/docs/asciidoc/images/Report-Master.png
b/birt/src/docs/asciidoc/images/Report-Master.png
deleted file mode 100644
index a60f82f..000
Binary files a/birt/src/docs/asciidoc/images/Report-Master.png and /dev/null
differ
diff --git a/birt/src/docs/asciidoc/images/Aggregation-builder.png
b/birt/src/docs/asciidoc/images/birt/Aggregation-builder.png
similarity index 100%
rename from birt/src/docs/asciidoc/images/Aggregation-builder.png
rename to birt/src/docs/asciidoc/images/birt/Aggregation-builder.png
diff --git a/birt/src/docs/asciidoc/images/Birt-Menus.png
b/birt/src/docs/asciidoc/images/birt/Birt-Menus.png
similarity index 100%
rename from birt/src/docs/asciidoc/images/Birt-Menus.png
rename to birt/src/docs/asciidoc/images/birt/Birt-Menus.png
diff --git a/birt/src/docs/asciidoc/images/Data-Explorer.png
b/birt/src/docs/asciidoc/images/birt/Data-Explorer.png
similarity index 100%
rename from birt/src/docs/asciidoc/images/Data-Explorer.png
rename to birt/src/docs/asciidoc/images/birt/Data-Explorer.png
diff --git a/birt/src/docs/asciidoc/images/Design-with-break-complete.png
b/birt/src/docs/asciidoc/images/birt/Design-with-break-complete.png
similarity index 100%
rename from birt/src/docs/asciidoc/images/Design-with-break-complete.png
rename to birt/src/docs/asciidoc/images/birt/Design-with-break-complete.png
diff --git a/birt/src/docs/asciidoc/images/Design-with-break.png
b/birt/src/docs/asciidoc/images/birt/Design-with-break.png
similarity index 100%
rename from birt/src/docs/asciidoc/images/Design-with-break.png
rename to birt/src/docs/asciidoc/images/birt/Design-with-break.png
diff --git a/birt/src/docs/asciidoc/images/Edit-Report-screen.png
b/birt/src/docs/asciidoc/images/birt/Edit-Report-screen.png
similarity index 100%
rename from birt/src/docs/asciidoc/images/Edit-Report-screen.png
rename to birt/src/docs/asciidoc/images/birt/Edit-Report-screen.png
diff --git a/birt/src/docs/asciidoc/images/Example-Report.png
b/birt/src/docs/asciidoc/images/birt/Example-Report.png
similarity index 100%
rename from birt/src/docs/asciidoc/imag
[ofbiz-plugins] branch trunk updated: Improved: solve Error messages when generating HTML and PDF file from AsciiDoc files (OFBIZ-11893)
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-plugins.git The following commit(s) were added to refs/heads/trunk by this push: new f152d03 Improved: solve Error messages when generating HTML and PDF file from AsciiDoc files (OFBIZ-11893) f152d03 is described below commit f152d031cb2e04e46c83c97a0ab52d78e5bf153c Author: holivier AuthorDate: Thu Oct 1 16:46:53 2020 +0200 Improved: solve Error messages when generating HTML and PDF file from AsciiDoc files (OFBIZ-11893) minor corrections after framework corrections --- docs/asciidoc/plugins-developer-manual.adoc| 2 +- docs/asciidoc/plugins-user-manual.adoc | 2 +- example/src/docs/asciidoc/example.adoc | 1 + scrum/src/docs/asciidoc/_include/scrum-add-sprint.adoc | 2 +- 4 files changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/asciidoc/plugins-developer-manual.adoc b/docs/asciidoc/plugins-developer-manual.adoc index cd5f04b..3f43339 100644 --- a/docs/asciidoc/plugins-developer-manual.adoc +++ b/docs/asciidoc/plugins-developer-manual.adoc @@ -18,7 +18,7 @@ under the License. = Apache OFBiz Plugins for Developer The Apache OFBiz Project -Release trunk + :imagesdir: ./images ifdef::backend-pdf[] :title-logo-image: image::OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=4.25in, align=center] diff --git a/docs/asciidoc/plugins-user-manual.adoc b/docs/asciidoc/plugins-user-manual.adoc index bb43069..1a3ea4c 100644 --- a/docs/asciidoc/plugins-user-manual.adoc +++ b/docs/asciidoc/plugins-user-manual.adoc @@ -18,7 +18,7 @@ under the License. = Apache OFBiz Plugins The Apache OFBiz Project -Release trunk + :imagesdir: ./images ifdef::backend-pdf[] :title-logo-image: image::OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=4.25in, align=center] diff --git a/example/src/docs/asciidoc/example.adoc b/example/src/docs/asciidoc/example.adoc index a03d059..91181c9 100644 --- a/example/src/docs/asciidoc/example.adoc +++ b/example/src/docs/asciidoc/example.adoc @@ -17,6 +17,7 @@ specific language governing permissions and limitations under the License. = Example Plugin + The Example application will allow you to discover the possibilities to create an application, with a lot of search boxes, lists and many more. diff --git a/scrum/src/docs/asciidoc/_include/scrum-add-sprint.adoc b/scrum/src/docs/asciidoc/_include/scrum-add-sprint.adoc index 83342b4..2af231f 100644 --- a/scrum/src/docs/asciidoc/_include/scrum-add-sprint.adoc +++ b/scrum/src/docs/asciidoc/_include/scrum-add-sprint.adoc @@ -29,7 +29,7 @@ This screen includes details that need to create sprint. . Fill all of fields. . Click at the submit button. -= Update Sprint. +== Update Sprint. This part use to update Sprint backlog such as planned hours, . Product Name
[ofbiz-framework] 02/02: Improved: solve Error messages when generating HTML and PDF file from AsciiDoc files (OFBIZ-11893)
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 commit ee20e6c715e0301eb29b90ca5a0231b3fcc18816 Author: holivier AuthorDate: Thu Oct 1 16:25:06 2020 +0200 Improved: solve Error messages when generating HTML and PDF file from AsciiDoc files (OFBIZ-11893) Add the correct set when use icon, to avoid INFO message --- docs/asciidoc/documentation_guidelines.adoc | 27 --- 1 file changed, 20 insertions(+), 7 deletions(-) diff --git a/docs/asciidoc/documentation_guidelines.adoc b/docs/asciidoc/documentation_guidelines.adoc index 8d7b863..1c69c86 100644 --- a/docs/asciidoc/documentation_guidelines.adoc +++ b/docs/asciidoc/documentation_guidelines.adoc @@ -563,18 +563,31 @@ The result will be different depending on the rendering (PDF, HTML). === Using inline icons You can also add the `:icons: font` directive to the top of your document, which allows you to use the icons -from http://fortawesome.github.io/Font-Awesome/icons/ directory via a macro. +from http://fortawesome.github.io/Font-Awesome/icons/ directory via a macro using any of the following icon sets: + +* fa - https://fontawesome.com/v4.7.0/icons (default) +* fas - https://fontawesome.com/icons?d=gallery=solid[Font Awesome - Solid] +* fab - https://fontawesome.com/icons?d=gallery=brands[Font Awesome - Brands] +* far - https://fontawesome.com/icons?d=gallery=regular[Font Awesome - Regular] +* fi - http://zurb.com/playground/foundation-icon-fonts-3[Foundation Icons] +* pf - https://paymentfont.com/[Payment font] + +The fa icon set is deprecated. Please use one of the other three FontAwesome icon sets. + +when icon is not available in fa icon set but in an other, it's possible to give the correct set. + +The generate Document process generate a INFOS message, if icon is available in an other set and it is not given. -icon:comment[] This is a comment icon -icon:file[] And a file icon -icon:battery-full[] And a battery icon +icon:comment[set=far] This is a comment icon +icon:file[set=far] And a file icon +icon:battery-full[set=fas] And a battery icon .The output looks like the following [example] -icon:comment[] This is a comment icon + -icon:file[] And a file icon + -icon:battery-full[] And a battery icon +icon:comment[set=far] This is a comment icon + +icon:file[set=far] And a file icon + +icon:battery-full[set=fas] And a battery icon + == How to write a...
[ofbiz-framework] 01/02: Improved: solve Error messages when generating HTML and PDF file from AsciiDoc files (OFBIZ-11893)
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
commit f2f43bc8d146fbbb3470e7b204494df59abe3a54
Author: holivier
AuthorDate: Thu Oct 1 16:22:09 2020 +0200
Improved: solve Error messages when generating HTML and PDF file from
AsciiDoc files (OFBIZ-11893)
* Add allow-uri-read when generated html and pdf to be able to allow
image from external uri, it's used for apache2.0 image;
Generalize usage of apache2.0 image for all main documents
* Put Trunk Version in gradle generation parameter and so remove in all
documents (to avoid Version unspecified)
---
README.adoc | 1 +
build.gradle| 2 ++
docs/asciidoc/developer-manual.adoc | 4 ++-
docs/asciidoc/documentation_guidelines.adoc | 52 +++--
docs/asciidoc/user-manual.adoc | 4 ++-
5 files changed, 36 insertions(+), 27 deletions(-)
diff --git a/README.adoc b/README.adoc
index 944d5ee..8d74b10 100644
--- a/README.adoc
+++ b/README.adoc
@@ -18,6 +18,7 @@ under the License.
[[apache-ofbiz]]
= Apache OFBiz®
+The Apache OFBiz Project
image:https://img.shields.io/badge/License-Apache%202.0-blue.svg[link="http://www.apache.org/licenses/LICENSE-2.0;]
diff --git a/build.gradle b/build.gradle
index e5ec8b4..830e000 100644
--- a/build.gradle
+++ b/build.gradle
@@ -504,7 +504,9 @@ tasks.withType(AsciidoctorTask) { task ->
backends 'html5', 'pdf'
attributes \
'doctype': 'book',
+ 'revnumber': 'Trunk',
'experimental': '',
+ 'allow-uri-read': true,
'icons': 'font',
'sectnums': '',
'chapter-label': '',
diff --git a/docs/asciidoc/developer-manual.adoc
b/docs/asciidoc/developer-manual.adoc
index c32f8e7..8ddd5a3 100644
--- a/docs/asciidoc/developer-manual.adoc
+++ b/docs/asciidoc/developer-manual.adoc
@@ -18,13 +18,15 @@ under the License.
= Apache OFBiz Developer Manual
The Apache OFBiz Project
-Release trunk
+
:imagesdir: ./images
ifdef::backend-pdf[]
:title-logo-image: image::OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=4.25in,
align=center]
:source-highlighter: rouge
endif::[]
+image::https://img.shields.io/badge/License-Apache%202.0-blue.svg[link="http://www.apache.org/licenses/LICENSE-2.0;]
+
== Introduction
Welcome to the Apache OFBiz developer manual. This manual provides information
diff --git a/docs/asciidoc/documentation_guidelines.adoc
b/docs/asciidoc/documentation_guidelines.adoc
index 011b59b..8d7b863 100644
--- a/docs/asciidoc/documentation_guidelines.adoc
+++ b/docs/asciidoc/documentation_guidelines.adoc
@@ -18,13 +18,15 @@ under the License.
= Apache OFBiz Documentation Guidelines
The Apache OFBiz Project
-Release trunk
+
:imagesdir: ./images
ifdef::backend-pdf[]
:title-logo-image: image::OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=4.25in,
align=center]
:source-highlighter: rouge
endif::[]
+image:https://img.shields.io/badge/License-Apache%202.0-blue.svg[link="http://www.apache.org/licenses/LICENSE-2.0;]
+
== Intro
These guidelines serve as a general style guide and collection of examples of
how we are documenting the project.
@@ -61,20 +63,18 @@ Please see below for details of the proposed configuration:
The Apache OFBiz Project // <1>
-Release 17.12 // <2>
-:imagesdir: ./images // <3>
-ifdef::backend-pdf[] // <4>
-:title-logo-image: image::OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=4.25in,
align=center] // <5>
-:source-highlighter: rouge // <6>
-endif::[] // <7>
+:imagesdir: ./images // <2>
+ifdef::backend-pdf[] // <3>
+:title-logo-image: image::OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=4.25in,
align=center] // <4>
+:source-highlighter: rouge // <5>
+endif::[] // <6>
<1> author
-<2> target release, indicates the release for which this documentation is valid
-<3> global definition of the image directory
-<4> begin block of configurations only for pdf rendering
-<5> define the title logo image
-<6> use the Rouge source code highlighter
-<7> end block of configurations only for PDF rendering
+<2> global definition of the image directory
+<3> begin block of configurations only for pdf rendering
+<4> define the title logo image
+<5> use the Rouge source code highlighter
+<6> end block of configurations only for PDF rendering
The following configuration options are set globally in the Gradle build file.
They are not configured in the document itself and are listed for reference
only:
@@ -82,20 +82,22 @@ They are not configured in the document itself and are
listed for reference only
.build.gradle
'doctype': 'book', // <1>
-'experimental': '', // &l
[ofbiz-framework] branch trunk updated (70ff1c5 -> ee20e6c)
This is an automated email from the ASF dual-hosted git repository. holivier pushed a change to branch trunk in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git. from 70ff1c5 Fixed: createPartyGroupRoleAndContactMechs service not working (OFBIZ-11986) new f2f43bc Improved: solve Error messages when generating HTML and PDF file from AsciiDoc files (OFBIZ-11893) new ee20e6c Improved: solve Error messages when generating HTML and PDF file from AsciiDoc files (OFBIZ-11893) The 2 revisions listed above as "new" are entirely new to this repository and will be described in separate emails. The revisions listed as "add" were already present in the repository and have only been added to this reference. Summary of changes: README.adoc | 1 + build.gradle| 2 + docs/asciidoc/developer-manual.adoc | 4 +- docs/asciidoc/documentation_guidelines.adoc | 79 + docs/asciidoc/user-manual.adoc | 4 +- 5 files changed, 56 insertions(+), 34 deletions(-)
[ofbiz-framework] branch trunk updated: Documented: migration to help system using asciidoc files (OFBIZ-11587)
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 9eaf180 Documented: migration to help system using asciidoc files (OFBIZ-11587) 9eaf180 is described below commit 9eaf180a4bbddbb66436ab9fec064f53ba9fd1fb Author: holivier AuthorDate: Mon Sep 28 15:13:06 2020 +0200 Documented: migration to help system using asciidoc files (OFBIZ-11587) Add + @@ -146,7 +147,7 @@ under the License. - + @@ -193,7 +194,7 @@ under the License. - + diff --git a/applications/accounting/widget/ar/CommonScreens.xml b/applications/accounting/widget/ar/CommonScreens.xml index 0f1034b..b9baeed 100644 --- a/applications/accounting/widget/ar/CommonScreens.xml +++ b/applications/accounting/widget/ar/CommonScreens.xml @@ -33,6 +33,7 @@ under the License. + diff --git a/applications/product/widget/catalog/CommonScreens.xml b/applications/product/widget/catalog/CommonScreens.xml index 5b3aa28..289d524 100644 --- a/applications/product/widget/catalog/CommonScreens.xml +++ b/applications/product/widget/catalog/CommonScreens.xml @@ -372,7 +372,7 @@ under the License. - + diff --git a/applications/product/widget/facility/CommonScreens.xml b/applications/product/widget/facility/CommonScreens.xml index d46439f..b584eac 100644 --- a/applications/product/widget/facility/CommonScreens.xml +++ b/applications/product/widget/facility/CommonScreens.xml @@ -42,6 +42,7 @@ under the License. + diff --git a/applications/workeffort/widget/CommonScreens.xml b/applications/workeffort/widget/CommonScreens.xml index 9f9376f..a7bc76c 100644 --- a/applications/workeffort/widget/CommonScreens.xml +++ b/applications/workeffort/widget/CommonScreens.xml @@ -43,6 +43,7 @@ under the License. + diff --git a/framework/webtools/widget/CommonScreens.xml b/framework/webtools/widget/CommonScreens.xml index c119ad3..17dd97b 100644 --- a/framework/webtools/widget/CommonScreens.xml +++ b/framework/webtools/widget/CommonScreens.xml @@ -37,7 +37,7 @@ under the License. - + @@ -214,7 +214,7 @@ under the License. - + @@ -322,5 +322,5 @@ under the License. - +
[ofbiz-plugins] branch trunk updated: Documented: ofbiz-plugins / Example, migration of docbook help files to asciidoc, forgot on previous commit to add example in plugins-user-manual (OFBIZ-11587)
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-plugins.git The following commit(s) were added to refs/heads/trunk by this push: new 19a97b5 Documented: ofbiz-plugins / Example, migration of docbook help files to asciidoc, forgot on previous commit to add example in plugins-user-manual (OFBIZ-11587) 19a97b5 is described below commit 19a97b5819c5c2ab92fcc9742af42d09df8a4c7e Author: holivier AuthorDate: Mon Sep 28 14:13:40 2020 +0200 Documented: ofbiz-plugins / Example, migration of docbook help files to asciidoc, forgot on previous commit to add example in plugins-user-manual (OFBIZ-11587) --- docs/asciidoc/plugins-user-manual.adoc | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/asciidoc/plugins-user-manual.adoc b/docs/asciidoc/plugins-user-manual.adoc index c30b58e..bb43069 100644 --- a/docs/asciidoc/plugins-user-manual.adoc +++ b/docs/asciidoc/plugins-user-manual.adoc @@ -33,6 +33,8 @@ include::../../ebay/src/docs/asciidoc/ebay.adoc[leveloffset=+1] include::../../ebaystore/src/docs/asciidoc/ebay-store.adoc[leveloffset=+1] +include::../../example/src/docs/asciidoc/example.adoc[leveloffset=+1] + include::../../myportal/src/docs/asciidoc/my-portal.adoc[leveloffset=+1] include::../../projectmgr/src/docs/asciidoc/project-mgr.adoc[leveloffset=+1]
[ofbiz-plugins] branch trunk updated: Documented: ofbiz-plugins / Example, migration of docbook help files to asciidoc (OFBIZ-11587)
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-plugins.git The following commit(s) were added to refs/heads/trunk by this push: new 66070a6 Documented: ofbiz-plugins / Example, migration of docbook help files to asciidoc (OFBIZ-11587) 66070a6 is described below commit 66070a6bc1731b13f03ca3b11066a706764e993b Author: holivier AuthorDate: Thu Sep 24 18:09:10 2020 +0200 Documented: ofbiz-plugins / Example, migration of docbook help files to asciidoc (OFBIZ-11587) example.adoc and example_main.adoc created Help link now point to the html file generated from the asciidoc files In the global Help Docbook index tree, change Example help page to a short page with a link to the new help Remove docbook help files for example HELP_EXAMPLE_docbook.xml has not been migrate because it's replace by the existing documentation_guidelines.adoc --- birt/data/example/ExampleHelpData.xml | 48 --- example/data/ExampleHelpData.xml | 25 +--- .../HELP_EXAMPLE_main.xml => HELP_EXAMPLE.xml} | 13 ++-- example/data/helpdata/HELP_EXAMPLE.xml | 55 - example/data/helpdata/HELP_EXAMPLE_docbook.xml | 72 -- .../src/docs/asciidoc/_include/example_main.adoc | 22 +++ example/src/docs/asciidoc/example.adoc | 53 example/widget/example/CommonScreens.xml | 1 + example/widget/example/ExampleScreens.xml | 3 +- 9 files changed, 89 insertions(+), 203 deletions(-) diff --git a/birt/data/example/ExampleHelpData.xml b/birt/data/example/ExampleHelpData.xml deleted file mode 100644 index ac85929..000 --- a/birt/data/example/ExampleHelpData.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - diff --git a/example/data/ExampleHelpData.xml b/example/data/ExampleHelpData.xml index ac85929..0e03d1f 100644 --- a/example/data/ExampleHelpData.xml +++ b/example/data/ExampleHelpData.xml @@ -19,30 +19,11 @@ under the License. --> - - - - - - - - - - - - - - - - diff --git a/example/data/helpdata/HELP_EXAMPLE_main.xml b/example/data/HELP_EXAMPLE.xml similarity index 70% rename from example/data/helpdata/HELP_EXAMPLE_main.xml rename to example/data/HELP_EXAMPLE.xml index a421dfc..dbb8f1f 100644 --- a/example/data/helpdata/HELP_EXAMPLE_main.xml +++ b/example/data/HELP_EXAMPLE.xml @@ -17,9 +17,12 @@ License. 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;> -The Example Main page. -About the Example application - -In this page, you can create or search an example - + Example Help redirection. + +The Example application will allow you to discover the possibilities to create an application, with a lot of search boxes, lists and many more. + + Example Help has been migrated to a new system, you can access it by using + https://ci.apache.org/projects/ofbiz/site/trunk/ofbizdoc/html5/user-manual.html#_example;>OFBiz user documentation site / Example + + diff --git a/example/data/helpdata/HELP_EXAMPLE.xml b/example/data/helpdata/HELP_EXAMPLE.xml deleted file mode 100644 index ae4fb90..000 --- a/example/data/helpdata/HELP_EXAMPLE.xml +++ /dev/null @@ -1,55 +0,0 @@ - - -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;> - The Example Main Help page. - -The Example application will allow you to discover the possibilities to create an application, with a lot of search boxes, lists and many more. - This application could be used to have an example of the bests practices in user interface development in Apache - OFBiz. - Look help for each example screen, help will explain which part of development is used in this case. - For example, if you want to see how you should do to add some help you can look to help files in data/helpdata directory in example -component and data/ExempleHelpData.xml in content component. - - -Help file organization -Help is managed by using content component functionality. -Help can be for : - -one component or sub-component, access is possible by navigation in help index tree and select it, contentId is associated to - HELP_RO
[ofbiz-framework] branch trunk updated: Improved: remove trailing space
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 b8894c4 Improved: remove trailing space b8894c4 is described below commit b8894c4c1d199cdd94f49b29bedc0582ce6dcde9 Author: holivier AuthorDate: Mon Sep 14 16:46:59 2020 +0200 Improved: remove trailing space --- .../src/docs/asciidoc/_include/acc-agreements.adoc | 20 ++-- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/applications/accounting/src/docs/asciidoc/_include/acc-agreements.adoc b/applications/accounting/src/docs/asciidoc/_include/acc-agreements.adoc index 4fe9d7e..30fccb5 100644 --- a/applications/accounting/src/docs/asciidoc/_include/acc-agreements.adoc +++ b/applications/accounting/src/docs/asciidoc/_include/acc-agreements.adoc @@ -33,25 +33,25 @@ At the time of writing, OFBiz allows you to create the following type of agreeme * Commission * End User Licence -The most common agreements you will use will be Sales Agreements (for your -Customers), Purchase Agreements (for your Suppliers) and Commission Agreements +The most common agreements you will use will be Sales Agreements (for your +Customers), Purchase Agreements (for your Suppliers) and Commission Agreements (for your Sales Representatives). == Sales Agreement A “Sales Agreement” is an agreement between you and your customers. A customer -can also be another business. You can create a range of conditions for your +can also be another business. You can create a range of conditions for your customer including giving them such as payment discounts or special payment terms -and credit limits. +and credit limits. If you have installed OFBiz with the demo data then there are already examples of Sales Agreements created for you. == Purchase Agreement -A “Purchase Agreement” is an agreement between your business and a supplier. You +A “Purchase Agreement” is an agreement between your business and a supplier. You may have negotiated special conditions such as delivery, volume pricing and -invoice terms. +invoice terms. If you have installed OFBiz with the demo data then there are already examples of Purchase Agreements created for you. @@ -59,10 +59,10 @@ of Purchase Agreements created for you. == Commission Agreement A “Commission Agreement” is an agreement that is used to calculate how much money -a Sales Representative will get when products they have promoted or marketed are +a Sales Representative will get when products they have promoted or marketed are sold to customers. The rate paid to the Sales Representative is can be based on a -fixed or variable on a percentage of each sale they make. These amounts can be -quite small amounts so it can be easier to consolidate multiple commission +fixed or variable on a percentage of each sale they make. These amounts can be +quite small amounts so it can be easier to consolidate multiple commission payments into one large payment that is paid monthly. If you have installed OFBiz with the demo data then there are already two example @@ -92,7 +92,7 @@ include::HELP_ListAgreementItemTerms.adoc[leveloffset=+2] === Help Edit Agreement Item Term This screen is used to create or update the terms for an agreement item. + -For more information about Agreement Term look at <<_help_edit_agreement_terms>> +For more information about Agreement Term look at <<_help_for_edit_agreement_terms>> include::HELP_ListAgreementItemProducts.adoc[leveloffset=+2]
[ofbiz-framework] branch trunk updated: Fixed: link address correction on EditAgreement and EditAgreementItem documentation
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 96b30f5 Fixed: link address correction on EditAgreement and EditAgreementItem documentation 96b30f5 is described below commit 96b30f55676a44e2569f63a9fa425bc966de9284 Author: holivier AuthorDate: Sat Sep 12 09:52:28 2020 +0200 Fixed: link address correction on EditAgreement and EditAgreementItem documentation --- .../accounting/src/docs/asciidoc/_include/HELP_EditAgreement.adoc | 2 +- .../accounting/src/docs/asciidoc/_include/HELP_EditAgreementItem.adoc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/applications/accounting/src/docs/asciidoc/_include/HELP_EditAgreement.adoc b/applications/accounting/src/docs/asciidoc/_include/HELP_EditAgreement.adoc index 5188d9b..eab892e 100644 --- a/applications/accounting/src/docs/asciidoc/_include/HELP_EditAgreement.adoc +++ b/applications/accounting/src/docs/asciidoc/_include/HELP_EditAgreement.adoc @@ -38,6 +38,6 @@ It can be used to create or update the following details for an Agreement: == How do I copy an existing agreement? . Find the agreement that needs to be copied -. Click on the Agreement Id <> +. Click on the Agreement Id <<_how_do_i_edit_an_agreement, How do it?>> . The 'Edit Agreement' screen will be displayed . At the bottom of the screen press the 'Copy' in the 'Copy Agreement' window (NOTE: The default tick boxes will copy the agreement terms, products and party. If not required then click on the boxes to stop them being copied) diff --git a/applications/accounting/src/docs/asciidoc/_include/HELP_EditAgreementItem.adoc b/applications/accounting/src/docs/asciidoc/_include/HELP_EditAgreementItem.adoc index 893a463..b3f40eb 100644 --- a/applications/accounting/src/docs/asciidoc/_include/HELP_EditAgreementItem.adoc +++ b/applications/accounting/src/docs/asciidoc/_include/HELP_EditAgreementItem.adoc @@ -39,5 +39,5 @@ Currently these are limited to the following: == How do I edit an agreement item? . Select the agreement item to be updated by clicking on the Agreement Item Id -. The 'Edit Agreement Item' screen is displayed <> +. The 'Edit Agreement Item' screen is displayed <<_how_do_i_edit_an_agreement, How do it?>> . Update the fields required (NOTE: Additional details can be updated by selecting the Promotions, Terms, Product, Party or Geo sub menus)
[ofbiz-plugins] 02/02: Documented: migrate help link to asciidoc user manual for Plugin Scrum (OFBIZ-11587)
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-plugins.git commit 94e77248e554f3c0a3588736a9b49c41c920d4b5 Author: holivier AuthorDate: Thu Sep 10 19:02:24 2020 +0200 Documented: migrate help link to asciidoc user manual for Plugin Scrum (OFBIZ-11587) All files have been migrated to asciidoc format and help link now point to the html file generated from the asciidoc files In the global Help Docbook index tree, change Scrum help page to a short page with a link to the new help Remove docbook help files for Scrum --- ...LP_SCRUM_NewProductEmail.xml => HELP_SCRUM.xml} | 27 +--- scrum/data/helpdata/DEMO-CONTENT.xml | 36 - scrum/data/helpdata/HELP_ROOT.xml | 35 - scrum/data/helpdata/HELP_SCRUM.xml | 123 --- scrum/data/helpdata/HELP_SCRUM_AddProdBacklog.xml | 53 --- scrum/data/helpdata/HELP_SCRUM_AddProduct.xml | 39 - scrum/data/helpdata/HELP_SCRUM_AddSprint.xml | 48 -- .../data/helpdata/HELP_SCRUM_AddSprintBacklog.xml | 32 .../helpdata/HELP_SCRUM_CreateScrumProject.xml | 32 .../HELP_SCRUM_DailyScrumMeetingMinute.xml | 39 - .../helpdata/HELP_SCRUM_EditBacklogItemContent.xml | 52 -- scrum/data/helpdata/HELP_SCRUM_EditProdBacklog.xml | 49 -- .../helpdata/HELP_SCRUM_EditProductContents.xml| 52 -- .../helpdata/HELP_SCRUM_EditProjectContents.xml| 52 -- scrum/data/helpdata/HELP_SCRUM_EditSprint.xml | 32 .../data/helpdata/HELP_SCRUM_EditSprintBacklog.xml | 26 --- scrum/data/helpdata/HELP_SCRUM_FindResource.xml| 58 --- scrum/data/helpdata/HELP_SCRUM_FindTimeSheet.xml | 41 - .../HELP_SCRUM_ListProductBacklogCategories.xml| 56 --- scrum/data/helpdata/HELP_SCRUM_MyWork.xml | 69 scrum/data/helpdata/HELP_SCRUM_OpenTest.xml| 47 -- .../helpdata/HELP_SCRUM_ProductBacklogEmails.xml | 48 -- scrum/data/helpdata/HELP_SCRUM_ProductEmails.xml | 48 -- scrum/data/helpdata/HELP_SCRUM_ProductView.xml | 37 - scrum/data/helpdata/HELP_SCRUM_Project.xml | 30 scrum/data/helpdata/HELP_SCRUM_SprintList.xml | 45 -- scrum/data/helpdata/HELP_SCRUM_SprintMember.xml| 41 - scrum/data/helpdata/HELP_SCRUM_TaskView.xml| 31 .../helpdata/HELP_SCRUM_ViewProdBacklogItem.xml| 86 -- scrum/data/helpdata/HELP_SCRUM_ViewProduct.xml | 86 -- scrum/data/helpdata/HELP_SCRUM_ViewSprint.xml | 42 - scrum/data/helpdata/HELP_SCRUM_defaultTasks.xml| 56 --- scrum/data/scrumHelpData.xml | 175 + scrum/documents/Scrum.xml | 27 scrum/widget/CommonScreens.xml | 5 + scrum/widget/OpenTestScreens.xml | 6 +- scrum/widget/ResourceScreens.xml | 5 +- scrum/widget/TaskScreens.xml | 5 +- scrum/widget/TimeSheetScreens.xml | 5 +- scrum/widget/scrumScreens.xml | 102 +++- 40 files changed, 94 insertions(+), 1784 deletions(-) diff --git a/scrum/data/helpdata/HELP_SCRUM_NewProductEmail.xml b/scrum/data/HELP_SCRUM.xml similarity index 68% rename from scrum/data/helpdata/HELP_SCRUM_NewProductEmail.xml rename to scrum/data/HELP_SCRUM.xml index bf78986..7ebb362 100644 --- a/scrum/data/helpdata/HELP_SCRUM_NewProductEmail.xml +++ b/scrum/data/HELP_SCRUM.xml @@ -7,9 +7,9 @@ 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 @@ -21,27 +21,16 @@ 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;> -New Email Help +SCRUM Component Help redirection -New E-mail +Introduction -The screen consists of : - -New Email -E-mail Contents - +The purpose of this component is to have a web based and ERP integrated access and recording for all information +related to your Scrum project development. - - -New Email - -To insert the content to product owner. - - -
[ofbiz-plugins] branch trunk updated (42192da -> 94e7724)
This is an automated email from the ASF dual-hosted git repository.
holivier pushed a change to branch trunk
in repository https://gitbox.apache.org/repos/asf/ofbiz-plugins.git.
from 42192da Improved: Added 400 for POST requests with no request
body(OFBIZ-11328)
new e314fc7 Documented: ofbiz-plugins / Scrum, migration of docbook help
files to asciidoc (OFBIZ-11587)
new 94e7724 Documented: migrate help link to asciidoc user manual for
Plugin Scrum (OFBIZ-11587)
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
docs/asciidoc/plugins-user-manual.adoc | 1 +
...LP_SCRUM_NewProductEmail.xml => HELP_SCRUM.xml} | 27 +---
scrum/data/helpdata/DEMO-CONTENT.xml | 36 -
scrum/data/helpdata/HELP_ROOT.xml | 35 -
scrum/data/helpdata/HELP_SCRUM.xml | 123 ---
scrum/data/helpdata/HELP_SCRUM_AddProdBacklog.xml | 53 ---
scrum/data/helpdata/HELP_SCRUM_AddProduct.xml | 39 -
scrum/data/helpdata/HELP_SCRUM_AddSprint.xml | 48 --
.../data/helpdata/HELP_SCRUM_AddSprintBacklog.xml | 32
.../helpdata/HELP_SCRUM_CreateScrumProject.xml | 32
.../HELP_SCRUM_DailyScrumMeetingMinute.xml | 39 -
.../helpdata/HELP_SCRUM_EditBacklogItemContent.xml | 52 --
scrum/data/helpdata/HELP_SCRUM_EditProdBacklog.xml | 49 --
.../helpdata/HELP_SCRUM_EditProductContents.xml| 52 --
.../helpdata/HELP_SCRUM_EditProjectContents.xml| 52 --
scrum/data/helpdata/HELP_SCRUM_EditSprint.xml | 32
.../data/helpdata/HELP_SCRUM_EditSprintBacklog.xml | 26 ---
scrum/data/helpdata/HELP_SCRUM_FindResource.xml| 58 ---
scrum/data/helpdata/HELP_SCRUM_FindTimeSheet.xml | 41 -
.../HELP_SCRUM_ListProductBacklogCategories.xml| 56 ---
scrum/data/helpdata/HELP_SCRUM_MyWork.xml | 69
scrum/data/helpdata/HELP_SCRUM_OpenTest.xml| 47 --
.../helpdata/HELP_SCRUM_ProductBacklogEmails.xml | 48 --
scrum/data/helpdata/HELP_SCRUM_ProductEmails.xml | 48 --
scrum/data/helpdata/HELP_SCRUM_ProductView.xml | 37 -
scrum/data/helpdata/HELP_SCRUM_Project.xml | 30
scrum/data/helpdata/HELP_SCRUM_SprintList.xml | 45 --
scrum/data/helpdata/HELP_SCRUM_SprintMember.xml| 41 -
scrum/data/helpdata/HELP_SCRUM_TaskView.xml| 31
.../helpdata/HELP_SCRUM_ViewProdBacklogItem.xml| 86 --
scrum/data/helpdata/HELP_SCRUM_ViewProduct.xml | 86 --
scrum/data/helpdata/HELP_SCRUM_ViewSprint.xml | 42 -
scrum/data/helpdata/HELP_SCRUM_defaultTasks.xml| 56 ---
scrum/data/scrumHelpData.xml | 175 +
scrum/documents/Scrum.xml | 27
.../docs/asciidoc/_include/scrum-add-sprint.adoc | 43 +
.../_include/scrum-backlogItem-content.adoc| 27 ++--
.../asciidoc/_include/scrum-default-tasks.adoc | 25 +--
.../src/docs/asciidoc/_include/scrum-members.adoc | 47 ++
.../src/docs/asciidoc/_include/scrum-my-work.adoc | 46 +++---
.../docs/asciidoc/_include/scrum-open-test.adoc| 42 +++--
.../_include/scrum-product-backlog-item.adoc | 74 +
.../_include/scrum-product-categories.adoc | 31 ++--
.../asciidoc/_include/scrum-product-overview.adoc | 31
.../src/docs/asciidoc/_include/scrum-product.adoc | 76 +
.../asciidoc/_include/scrum-project-sprint.adoc| 132
.../docs/asciidoc/_include/scrum-timeSheet.adoc| 12 +-
scrum/src/docs/asciidoc/scrum.adoc | 93 +++
scrum/widget/CommonScreens.xml | 5 +
scrum/widget/OpenTestScreens.xml | 6 +-
scrum/widget/ResourceScreens.xml | 5 +-
scrum/widget/TaskScreens.xml | 5 +-
scrum/widget/TimeSheetScreens.xml | 5 +-
scrum/widget/scrumScreens.xml | 102 +++-
54 files changed, 699 insertions(+), 1859 deletions(-)
rename scrum/data/{helpdata/HELP_SCRUM_NewProductEmail.xml => HELP_SCRUM.xml}
(68%)
delete mode 100644 scrum/data/helpdata/DEMO-CONTENT.xml
delete mode 100644 scrum/data/helpdata/HELP_ROOT.xml
delete mode 100644 scrum/data/helpdata/HELP_SCRUM.xml
delete mode 100644 scrum/data/helpdata/HELP_SCRUM_AddProdBacklog.xml
delete mode 100644 scrum/data/helpdata/HELP_SCRUM_AddProduct.xml
delete mode 100644 scrum/data/helpdata/HELP_SCRUM_AddSprint.xml
delete mode 100644 scrum/data/helpdata/HELP_SCRUM_AddSprintBacklog.xml
delete mode 100644 scrum/data/helpdata/HELP_SCRUM_CreateScrumProject.xml
delete mode 100644 scrum/data/helpdata/HELP_SCRUM_DailyScrumMeet
[ofbiz-plugins] 01/02: Documented: ofbiz-plugins / Scrum, migration of docbook help files to asciidoc (OFBIZ-11587)
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-plugins.git commit e314fc7c99cdf39a7cc21f83ea2de0a0ad24c8ea Author: holivier AuthorDate: Tue May 5 18:55:18 2020 +0200 Documented: ofbiz-plugins / Scrum, migration of docbook help files to asciidoc (OFBIZ-11587) scrum.adoc created and re-organize adoc files to have them similar to menu name and menu items order --- docs/asciidoc/plugins-user-manual.adoc | 1 + .../docs/asciidoc/_include/scrum-add-sprint.adoc | 43 +++ .../_include/scrum-backlogItem-content.adoc| 28 ++--- .../asciidoc/_include/scrum-default-tasks.adoc | 28 ++--- .../src/docs/asciidoc/_include/scrum-members.adoc | 47 .../src/docs/asciidoc/_include/scrum-my-work.adoc | 32 ++--- .../docs/asciidoc/_include/scrum-open-test.adoc| 44 +++ .../_include/scrum-product-backlog-item.adoc | 74 .../_include/scrum-product-categories.adoc | 30 ++--- .../asciidoc/_include/scrum-product-overview.adoc | 31 + .../src/docs/asciidoc/_include/scrum-product.adoc | 76 .../asciidoc/_include/scrum-project-sprint.adoc| 132 + .../docs/asciidoc/_include/scrum-timeSheet.adoc| 28 ++--- scrum/src/docs/asciidoc/scrum.adoc | 93 +++ 14 files changed, 605 insertions(+), 82 deletions(-) diff --git a/docs/asciidoc/plugins-user-manual.adoc b/docs/asciidoc/plugins-user-manual.adoc index 789622e..c30b58e 100644 --- a/docs/asciidoc/plugins-user-manual.adoc +++ b/docs/asciidoc/plugins-user-manual.adoc @@ -37,3 +37,4 @@ include::../../myportal/src/docs/asciidoc/my-portal.adoc[leveloffset=+1] include::../../projectmgr/src/docs/asciidoc/project-mgr.adoc[leveloffset=+1] +include::../../scrum/src/docs/asciidoc/scrum.adoc[leveloffset=+1] \ No newline at end of file diff --git a/scrum/src/docs/asciidoc/_include/scrum-add-sprint.adoc b/scrum/src/docs/asciidoc/_include/scrum-add-sprint.adoc new file mode 100644 index 000..83342b4 --- /dev/null +++ b/scrum/src/docs/asciidoc/_include/scrum-add-sprint.adoc @@ -0,0 +1,43 @@ + +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. + +This screen includes details that need to create sprint. + +== Fields Description +. "Sprint Name" field should contain the name of sprint. +. "Description" field should contain the description of sprint. +. "Start Date" field should contain the starting date of the sprint. +. "End Date" field should contain the ending date of the sprint. +. "How many Sprint Backlog(s)?" field should contain how many Sprint Backlog do you want from the top of Product Backlog. + +== How to create the sprint +. Fill all of fields. +. Click at the submit button. + += Update Sprint. +This part use to update Sprint backlog such as planned hours, + +. Product Name +. Sprint Name +. Sprint Goal +. Status +. Start Date +. End date +. Planned Hours (Integer or floating point). +. Sprint Length Weeks +. Click the update button to update the Sprint Backlog. diff --git a/docs/asciidoc/plugins-user-manual.adoc b/scrum/src/docs/asciidoc/_include/scrum-backlogItem-content.adoc similarity index 56% copy from docs/asciidoc/plugins-user-manual.adoc copy to scrum/src/docs/asciidoc/_include/scrum-backlogItem-content.adoc index 789622e..ec2c833 100644 --- a/docs/asciidoc/plugins-user-manual.adoc +++ b/scrum/src/docs/asciidoc/_include/scrum-backlogItem-content.adoc @@ -16,24 +16,22 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -= Apache OFBiz Plugins -The Apache OFBiz Project -Release trunk -:imagesdir: ./images -ifdef::backend-pdf[] -:title-logo-image: image::OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=4.25in, align=center] -:source-highlighter: rouge -endif::[] -:toc: -:sectnums: += Backlog Item Contents +This screen use for uploading any contents that concern to the Backlog Item. +The screen consists of : -include::../../birt/src/docs/asciidoc/birt.adoc[leveloffset=+1] +. Backlog Item Co
[ofbiz-framework] branch trunk updated: Documented: Framework, migration all docbook files to asciidoc (OFBIZ-11587)
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 93eb9c6 Documented: Framework, migration all docbook files to asciidoc (OFBIZ-11587) 93eb9c6 is described below commit 93eb9c65a24afce5bfa98f11d52818aca38aa641 Author: holivier AuthorDate: Thu Sep 10 15:27:40 2020 +0200 Documented: Framework, migration all docbook files to asciidoc (OFBIZ-11587) - Correction on tag added in README.adoc, wrong comment characters, - and correction in included:: in unit-tests.adoc to have correct paragraph level --- README.adoc | 8 framework/testtools/src/docs/asciidoc/unit-tests.adoc | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.adoc b/README.adoc index 4dfd0a2..944d5ee 100644 --- a/README.adoc +++ b/README.adoc @@ -22,7 +22,7 @@ under the License. image:https://img.shields.io/badge/License-Apache%202.0-blue.svg[link="http://www.apache.org/licenses/LICENSE-2.0;] -If you are reading this file in AsciiDoc format you may want to see it in +If you are reading this file in AsciiDoc format you may want to see it in https://ci.apache.org/projects/ofbiz/site/trunk/readme/html5/README.html[HTML] + or https://ci.apache.org/projects/ofbiz/site/trunk/readme/pdf/README.pdf[PDF] format @@ -395,7 +395,7 @@ dash! Loads all data sets; meant for initial loading of generic OFBiz data. Can be applied for development, testing, demonstration, etc. purposes. Be aware that executing this task can result in your data being overwritten in your database -of choice. +of choice. `gradlew loadAll` OR `gradlew "ofbiz --load-data"` @@ -482,7 +482,7 @@ parameters are passed: [[testing-tasks]] === Testing tasks -# tag::testingtasks[] +// tag::testingtasks[] [[execute-all-unit-tests]] Execute all unit tests @@ -542,7 +542,7 @@ listens on port *5005* `gradlew "ofbiz --test component=entity --test suitename=entitytests" --debug-jvm` -# end::testingtasks[] +// end::testingtasks[] [[miscellaneous-tasks]] diff --git a/framework/testtools/src/docs/asciidoc/unit-tests.adoc b/framework/testtools/src/docs/asciidoc/unit-tests.adoc index e6faa48..6cc2b56 100644 --- a/framework/testtools/src/docs/asciidoc/unit-tests.adoc +++ b/framework/testtools/src/docs/asciidoc/unit-tests.adoc @@ -94,7 +94,7 @@ like this: == How to run a unit test? You can run unit test by run 'gradle' with following target: -include::../../../../../README.adoc[tag=testingtasks] +include::../../../../../README.adoc[tag=testingtasks, leveloffset=-1] == Possible error messages
[ofbiz-plugins] 02/02: Documented: migrate help link to asciidoc user manual for Plugin ProjectMgr (OFBIZ-11587)
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-plugins.git commit d349811a26f40bb4a4491a62e889b68c1fab101e Author: holivier AuthorDate: Fri May 1 18:34:00 2020 +0200 Documented: migrate help link to asciidoc user manual for Plugin ProjectMgr (OFBIZ-11587) All files have been migrated to asciidoc format and help link now point to the html file generated from the asciidoc files In the global Help Docbook index tree, change Project help page to a short page with a link to the new help Remove docbook help files for PROJECTMGR --- ...TMGR_ProjectBilling.xml => HELP_PROJECTMGR.xml} | 18 +-- projectmgr/data/ProjectMgrHelpData.xml | 153 + projectmgr/data/helpdata/HELP_PROJECTMGR.xml | 89 .../data/helpdata/HELP_PROJECTMGR_MyTasks.xml | 30 .../data/helpdata/HELP_PROJECTMGR_MyTimesheet.xml | 33 - .../data/helpdata/HELP_PROJECTMGR_Project.xml | 90 .../helpdata/HELP_PROJECTMGR_ProjectContent.xml| 38 - .../HELP_PROJECTMGR_ProjectEditProject.xml | 30 .../HELP_PROJECTMGR_ProjectMailingList.xml | 38 - .../data/helpdata/HELP_PROJECTMGR_ProjectNotes.xml | 38 - .../helpdata/HELP_PROJECTMGR_ProjectOrders.xml | 30 .../helpdata/HELP_PROJECTMGR_ProjectPhases.xml | 33 - .../helpdata/HELP_PROJECTMGR_ProjectResources.xml | 33 - .../HELP_PROJECTMGR_ProjectSubProjects.xml | 38 - .../data/helpdata/HELP_PROJECTMGR_ProjectTasks.xml | 30 .../data/helpdata/HELP_PROJECTMGR_Projects.xml | 30 .../data/helpdata/HELP_PROJECTMGR_Requests.xml | 30 .../data/helpdata/HELP_PROJECTMGR_Resources.xml| 38 - .../data/helpdata/HELP_PROJECTMGR_Skills.xml | 38 - projectmgr/data/helpdata/HELP_PROJECTMGR_Tasks.xml | 30 .../data/helpdata/HELP_PROJECTMGR_TimeSheets.xml | 30 projectmgr/data/helpdata/HELP_PROJECTMGR_main.xml | 30 projectmgr/documents/ProjectMgr.xml| 47 --- projectmgr/widget/CommonScreens.xml| 4 + projectmgr/widget/CustRequestScreens.xml | 9 +- projectmgr/widget/ProjectScreens.xml | 12 +- projectmgr/widget/ResourceScreens.xml | 1 + projectmgr/widget/TaskScreens.xml | 5 +- projectmgr/widget/TimeSheetScreens.xml | 1 + 29 files changed, 37 insertions(+), 989 deletions(-) diff --git a/projectmgr/data/helpdata/HELP_PROJECTMGR_ProjectBilling.xml b/projectmgr/data/HELP_PROJECTMGR.xml similarity index 68% rename from projectmgr/data/helpdata/HELP_PROJECTMGR_ProjectBilling.xml rename to projectmgr/data/HELP_PROJECTMGR.xml index f4cb70e..cf70e91 100644 --- a/projectmgr/data/helpdata/HELP_PROJECTMGR_ProjectBilling.xml +++ b/projectmgr/data/HELP_PROJECTMGR.xml @@ -7,9 +7,9 @@ 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 @@ -17,17 +17,17 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --> -http://www.w3.org/2001/XMLSchema-instance; version="5.0" -xmlns:xl="http://www.w3.org/1999/xlink; +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;> -Project Mgr: Project - billing - -This screen shows all hours registered to the various tasks in the project by all participants. - +Project Manager Help redirection -From here the Project Manager processes all time entries for further processing regarding invoicing and cost accounting. +The project manager allows you to manage a project which in its simplest form consists out of phases and tasks. +Project Help has been migrated to a new system, you can access it by using + https://ci.apache.org/projects/ofbiz/site/trunk/ofbizdoc/html5/user-manual.html#_project_manager;>OFBiz user documentation site / Project Manager + diff --git a/projectmgr/data/ProjectMgrHelpData.xml b/projectmgr/data/ProjectMgrHelpData.xml index ff85469..3cebc5c 100644 --- a/projectmgr/data/Pro
[ofbiz-plugins] 01/02: Documented: ofbiz-plugins / ProjectMgr, migration of docbook help files to asciidoc, most of files have been directly included in project-mgr.adoc. (OFBIZ-11587)
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-plugins.git commit 8d6c36b624064e41526649e1bf7b0b6612f91b9d Author: holivier AuthorDate: Fri May 1 18:31:40 2020 +0200 Documented: ofbiz-plugins / ProjectMgr, migration of docbook help files to asciidoc, most of files have been directly included in project-mgr.adoc. (OFBIZ-11587) --- docs/asciidoc/plugins-user-manual.adoc | 3 + .../src/docs/asciidoc/_include/prjm_intro.adoc | 72 +++ .../src/docs/asciidoc/_include/prjm_project.adoc | 64 + projectmgr/src/docs/asciidoc/project-mgr.adoc | 80 ++ 4 files changed, 219 insertions(+) diff --git a/docs/asciidoc/plugins-user-manual.adoc b/docs/asciidoc/plugins-user-manual.adoc index 7803615..789622e 100644 --- a/docs/asciidoc/plugins-user-manual.adoc +++ b/docs/asciidoc/plugins-user-manual.adoc @@ -34,3 +34,6 @@ include::../../ebay/src/docs/asciidoc/ebay.adoc[leveloffset=+1] include::../../ebaystore/src/docs/asciidoc/ebay-store.adoc[leveloffset=+1] include::../../myportal/src/docs/asciidoc/my-portal.adoc[leveloffset=+1] + +include::../../projectmgr/src/docs/asciidoc/project-mgr.adoc[leveloffset=+1] + diff --git a/projectmgr/src/docs/asciidoc/_include/prjm_intro.adoc b/projectmgr/src/docs/asciidoc/_include/prjm_intro.adoc new file mode 100644 index 000..f705fce --- /dev/null +++ b/projectmgr/src/docs/asciidoc/_include/prjm_intro.adoc @@ -0,0 +1,72 @@ + +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. + += Project Manager Introduction +The project manager allows you to manage a project which in its simplest form consists out of phases and tasks. + +A project consists out of one or more phases of which each phase can have one or more tasks. + +A task always has a single parentPhase. + +Time registration is only done on a task level. + +Estimated and actual dates are only maintained at the task level. + +For reporting they are calculated to the higher levels. + +Project views are created to support this. + +== Status management +Status is managed at task level, Project and Phase statuses shown on screen are tasks status compilation. + +Task statuses are : + +|=== +| StatusId| Status | Description +| PTS_CREATED,| Created | after task creation +| PTS_CREATED_UA | Unassigned | currently not used by an automatic process +| PTS_CREATED_AS | Assigned| after a resource is assigned +| PTS_CREATED_IP | In Progress | after a time entry is created on the task +| PTS_COMPLETED .| Completed |Manually changed by button +| PTS_ON_HOLD | On Hold | +| PTS_CANCELLED |Cancelled| +|=== + +Project or Phase is completed if all included tasks are completed (or cancelled) + +== Resources +You can describe a customer (company and contact) and who provides the task (named provider) in the resource portlet. + +To be able to associate someone to a project he should have, two (or more) project roleType, first PROJECT_TEAM to appear +in Party drop-down, and at least one of the PROJECT_TEAM sub-roles for the second drop-down. + +Look at parameters section to have the complete project roletypes list. +And go to the party profile to associate a role type to a party. + +== Parameters : +* RoleType with PROJECT_TEAM as parentTypeId, used in a lot of screens; default proposed roleTypes are : +** CLIENT% : used to select parties which appears in Projects Parties info, client side +** CLIENT_MANAGER : user login associated to a project with this roleType view it in ListCustomerProjects +** CLIENT_ANALYST : same as CLIENT_MANAGER for ListCustomerProjects +** CLIENT_BILLING : partyId which will be invoiced; same as CLIENT_MANAGER for ListCustomerProjects; appears in Company part + of Project Parties info, other CLIENT% role appears in contact part +** PROVIDER% : all parties which provide the project. In Projects Parties info, provider part, all roleType not equals to CLIENT% + will appear +** PROVIDER_MANAGER : currently no process or specific selection +** PROVIDER_ACCOUNTING : currently no process or specific selection +** PROVIDER
[ofbiz-plugins] branch trunk updated (cb502ca -> d349811)
This is an automated email from the ASF dual-hosted git repository.
holivier pushed a change to branch trunk
in repository https://gitbox.apache.org/repos/asf/ofbiz-plugins.git.
from cb502ca Documented: ofbiz-plugins / MyPortal, remove docbook migrated
to asciidoc (only a short introduction) (OFBIZ-11587)
new 8d6c36b Documented: ofbiz-plugins / ProjectMgr, migration of docbook
help files to asciidoc, most of files have been directly included in
project-mgr.adoc. (OFBIZ-11587)
new d349811 Documented: migrate help link to asciidoc user manual for
Plugin ProjectMgr (OFBIZ-11587)
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
docs/asciidoc/plugins-user-manual.adoc | 3 +
..._PROJECTMGR_MyTasks.xml => HELP_PROJECTMGR.xml} | 15 +-
projectmgr/data/ProjectMgrHelpData.xml | 153 +
projectmgr/data/helpdata/HELP_PROJECTMGR.xml | 89
.../data/helpdata/HELP_PROJECTMGR_MyTimesheet.xml | 33 -
.../data/helpdata/HELP_PROJECTMGR_Project.xml | 90
.../helpdata/HELP_PROJECTMGR_ProjectBilling.xml| 33 -
.../helpdata/HELP_PROJECTMGR_ProjectContent.xml| 38 -
.../HELP_PROJECTMGR_ProjectEditProject.xml | 30
.../HELP_PROJECTMGR_ProjectMailingList.xml | 38 -
.../data/helpdata/HELP_PROJECTMGR_ProjectNotes.xml | 38 -
.../helpdata/HELP_PROJECTMGR_ProjectOrders.xml | 30
.../helpdata/HELP_PROJECTMGR_ProjectPhases.xml | 33 -
.../helpdata/HELP_PROJECTMGR_ProjectResources.xml | 33 -
.../HELP_PROJECTMGR_ProjectSubProjects.xml | 38 -
.../data/helpdata/HELP_PROJECTMGR_ProjectTasks.xml | 30
.../data/helpdata/HELP_PROJECTMGR_Projects.xml | 30
.../data/helpdata/HELP_PROJECTMGR_Requests.xml | 30
.../data/helpdata/HELP_PROJECTMGR_Resources.xml| 38 -
.../data/helpdata/HELP_PROJECTMGR_Skills.xml | 38 -
projectmgr/data/helpdata/HELP_PROJECTMGR_Tasks.xml | 30
.../data/helpdata/HELP_PROJECTMGR_TimeSheets.xml | 30
projectmgr/data/helpdata/HELP_PROJECTMGR_main.xml | 30
projectmgr/documents/ProjectMgr.xml| 47 ---
.../src/docs/asciidoc/_include/prjm_intro.adoc | 72 ++
.../src/docs/asciidoc/_include/prjm_project.adoc | 64 +
projectmgr/src/docs/asciidoc/project-mgr.adoc | 80 +++
projectmgr/widget/CommonScreens.xml| 4 +
projectmgr/widget/CustRequestScreens.xml | 9 +-
projectmgr/widget/ProjectScreens.xml | 12 +-
projectmgr/widget/ResourceScreens.xml | 1 +
projectmgr/widget/TaskScreens.xml | 5 +-
projectmgr/widget/TimeSheetScreens.xml | 1 +
33 files changed, 256 insertions(+), 989 deletions(-)
rename projectmgr/data/{helpdata/HELP_PROJECTMGR_MyTasks.xml =>
HELP_PROJECTMGR.xml} (68%)
delete mode 100644 projectmgr/data/helpdata/HELP_PROJECTMGR.xml
delete mode 100644 projectmgr/data/helpdata/HELP_PROJECTMGR_MyTimesheet.xml
delete mode 100644 projectmgr/data/helpdata/HELP_PROJECTMGR_Project.xml
delete mode 100644 projectmgr/data/helpdata/HELP_PROJECTMGR_ProjectBilling.xml
delete mode 100644 projectmgr/data/helpdata/HELP_PROJECTMGR_ProjectContent.xml
delete mode 100644
projectmgr/data/helpdata/HELP_PROJECTMGR_ProjectEditProject.xml
delete mode 100644
projectmgr/data/helpdata/HELP_PROJECTMGR_ProjectMailingList.xml
delete mode 100644 projectmgr/data/helpdata/HELP_PROJECTMGR_ProjectNotes.xml
delete mode 100644 projectmgr/data/helpdata/HELP_PROJECTMGR_ProjectOrders.xml
delete mode 100644 projectmgr/data/helpdata/HELP_PROJECTMGR_ProjectPhases.xml
delete mode 100644
projectmgr/data/helpdata/HELP_PROJECTMGR_ProjectResources.xml
delete mode 100644
projectmgr/data/helpdata/HELP_PROJECTMGR_ProjectSubProjects.xml
delete mode 100644 projectmgr/data/helpdata/HELP_PROJECTMGR_ProjectTasks.xml
delete mode 100644 projectmgr/data/helpdata/HELP_PROJECTMGR_Projects.xml
delete mode 100644 projectmgr/data/helpdata/HELP_PROJECTMGR_Requests.xml
delete mode 100644 projectmgr/data/helpdata/HELP_PROJECTMGR_Resources.xml
delete mode 100644 projectmgr/data/helpdata/HELP_PROJECTMGR_Skills.xml
delete mode 100644 projectmgr/data/helpdata/HELP_PROJECTMGR_Tasks.xml
delete mode 100644 projectmgr/data/helpdata/HELP_PROJECTMGR_TimeSheets.xml
delete mode 100644 projectmgr/data/helpdata/HELP_PROJECTMGR_main.xml
delete mode 100644 projectmgr/documents/ProjectMgr.xml
create mode 100644 projectmgr/src/docs/asciidoc/_include/prjm_intro.adoc
create mode 100644 projectmgr/src/docs/asciidoc/_include/prjm_project.adoc
create mode 100644 projectmgr/src/docs/asciidoc/project-mgr.adoc
[ofbiz-framework] branch trunk updated (679b288 -> b3fbf6d)
This is an automated email from the ASF dual-hosted git repository. holivier pushed a change to branch trunk in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git. from 679b288 Improved : Convert createRoleType service to entity-auto from Java and update its service calls (OFBIZ-11894) (#215) new bd0efaf Documented: remove docbook migrated to asciidoc, portlet help are now in ofbiz-plugins / MyPortal (OFBIZ-11587) new b3fbf6d Documented: remove old content links for ofbiz-setup, the docs have been migrated to asciidoc (OFBIZ-11587) The 2 revisions listed above as "new" are entirely new to this repository and will be described in separate emails. The revisions listed as "add" were already present in the repository and have only been added to this reference. Summary of changes: applications/commonext/data/CommonExtHelpData.xml | 36 --- .../commonext/data/SystemInfoPortletData.xml | 9 ++--- .../data/helpdata/HELP_SystemInfoNotes.xml | 40 -- 3 files changed, 2 insertions(+), 83 deletions(-) delete mode 100644 applications/commonext/data/helpdata/HELP_SystemInfoNotes.xml
[ofbiz-framework] 02/02: Documented: remove old content links for ofbiz-setup, the docs have been migrated to asciidoc (OFBIZ-11587)
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 commit b3fbf6d680cbfa897c9018f6e28e5f1ec9f85de9 Author: holivier AuthorDate: Wed Jul 22 18:15:07 2020 +0200 Documented: remove old content links for ofbiz-setup, the docs have been migrated to asciidoc (OFBIZ-11587) --- applications/commonext/data/CommonExtHelpData.xml | 36 --- 1 file changed, 36 deletions(-) diff --git a/applications/commonext/data/CommonExtHelpData.xml b/applications/commonext/data/CommonExtHelpData.xml index e872d34..a535de5 100644 --- a/applications/commonext/data/CommonExtHelpData.xml +++ b/applications/commonext/data/CommonExtHelpData.xml @@ -23,42 +23,6 @@ under the License. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
[ofbiz-framework] 01/02: Documented: remove docbook migrated to asciidoc, portlet help are now in ofbiz-plugins / MyPortal (OFBIZ-11587)
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 commit bd0efaf89bbe6c315c75d7bcbddcb958d24b6d15 Author: holivier AuthorDate: Wed Jul 22 18:13:28 2020 +0200 Documented: remove docbook migrated to asciidoc, portlet help are now in ofbiz-plugins / MyPortal (OFBIZ-11587) --- .../commonext/data/SystemInfoPortletData.xml | 9 ++--- .../data/helpdata/HELP_SystemInfoNotes.xml | 40 -- 2 files changed, 2 insertions(+), 47 deletions(-) diff --git a/applications/commonext/data/SystemInfoPortletData.xml b/applications/commonext/data/SystemInfoPortletData.xml index f9831d0..6b6b46c 100644 --- a/applications/commonext/data/SystemInfoPortletData.xml +++ b/applications/commonext/data/SystemInfoPortletData.xml @@ -7,9 +7,9 @@ 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 @@ -28,11 +28,6 @@ editFormName="EditSysInfoPortletParams" editFormLocation="component://commonext/widget/SystemInfoForms.xml" screenshot="/images/portlets/SystemInfoNotes.png"/> - - - - -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;> -The System Event Portlet - This portlet shows changes which happened in the system for the logged on user. The first two functions which are working now: - - - -Incoming communication events (email, internal notes). - - -Tasks which are assigned either in projectmanager or workeffort. -These event can be notified to the user even when not logged on to OFBiz by using a firefox plugin and when it changes the -employee is notified from within firefox -The plugin: http://updatescanner.mozdev.org/en/index.html and it should check the following url: (adjust to your requirements) - - In the Flat Grey theme (only) notifications show in the header when they are available. - - - -
[ofbiz-plugins] branch trunk updated (9c87fb8 -> cb502ca)
This is an automated email from the ASF dual-hosted git repository. holivier pushed a change to branch trunk in repository https://gitbox.apache.org/repos/asf/ofbiz-plugins.git. from 9c87fb8 Improved: Update build.gradle to the latest dependencies (OFBIZ-11903) new 2a7ea47 Documented: ofbiz-plugins / MyPortal, migration for the Help docbook file to asciidoc (only a short introduction) (OFBIZ-11587) new cb502ca Documented: ofbiz-plugins / MyPortal, remove docbook migrated to asciidoc (only a short introduction) (OFBIZ-11587) The 2 revisions listed above as "new" are entirely new to this repository and will be described in separate emails. The revisions listed as "add" were already present in the repository and have only been added to this reference. Summary of changes: docs/asciidoc/plugins-user-manual.adoc | 2 ++ myportal/data/helpdata/HELP_MYPORTAL.xml | 33 -- myportal/documents/MyPortal.xml| 32 - .../docs/asciidoc/_include/portlet-calendar.adoc | 11 .../_include/portlet-system-info-notes.adoc| 31 .../src/docs/asciidoc/my-portal.adoc | 24 6 files changed, 50 insertions(+), 83 deletions(-) delete mode 100644 myportal/data/helpdata/HELP_MYPORTAL.xml delete mode 100644 myportal/documents/MyPortal.xml copy solr/testdef/data/SolrTestsData.xml => myportal/src/docs/asciidoc/_include/portlet-calendar.adoc (81%) create mode 100644 myportal/src/docs/asciidoc/_include/portlet-system-info-notes.adoc copy docs/asciidoc/plugins-developer-manual.adoc => myportal/src/docs/asciidoc/my-portal.adoc (55%)
[ofbiz-plugins] 01/02: Documented: ofbiz-plugins / MyPortal, migration for the Help docbook file to asciidoc (only a short introduction) (OFBIZ-11587)
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-plugins.git commit 2a7ea475d3a46df4e2dbb0f7d020ebfa2db8493f Author: holivier AuthorDate: Fri May 1 16:50:31 2020 +0200 Documented: ofbiz-plugins / MyPortal, migration for the Help docbook file to asciidoc (only a short introduction) (OFBIZ-11587) add in _include directory, two portlet help coming from other components (commonext and workeffort) --- docs/asciidoc/plugins-user-manual.adoc | 2 ++ .../docs/asciidoc/_include/portlet-calendar.adoc | 17 ++-- .../_include/portlet-system-info-notes.adoc| 31 + .../src/docs/asciidoc/my-portal.adoc | 32 +++--- 4 files changed, 52 insertions(+), 30 deletions(-) diff --git a/docs/asciidoc/plugins-user-manual.adoc b/docs/asciidoc/plugins-user-manual.adoc index b5cc654..7803615 100644 --- a/docs/asciidoc/plugins-user-manual.adoc +++ b/docs/asciidoc/plugins-user-manual.adoc @@ -32,3 +32,5 @@ include::../../birt/src/docs/asciidoc/birt.adoc[leveloffset=+1] include::../../ebay/src/docs/asciidoc/ebay.adoc[leveloffset=+1] include::../../ebaystore/src/docs/asciidoc/ebay-store.adoc[leveloffset=+1] + +include::../../myportal/src/docs/asciidoc/my-portal.adoc[leveloffset=+1] diff --git a/docs/asciidoc/plugins-user-manual.adoc b/myportal/src/docs/asciidoc/_include/portlet-calendar.adoc similarity index 62% copy from docs/asciidoc/plugins-user-manual.adoc copy to myportal/src/docs/asciidoc/_include/portlet-calendar.adoc index b5cc654..a3aeae8 100644 --- a/docs/asciidoc/plugins-user-manual.adoc +++ b/myportal/src/docs/asciidoc/_include/portlet-calendar.adoc @@ -16,19 +16,8 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -= Apache OFBiz Plugins -The Apache OFBiz Project -Release trunk -:imagesdir: ./images -ifdef::backend-pdf[] -:title-logo-image: image::OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=4.25in, align=center] -:source-highlighter: rouge -endif::[] -:toc: -:sectnums: -include::../../birt/src/docs/asciidoc/birt.adoc[leveloffset=+1] += The Calendar Portlet -include::../../ebay/src/docs/asciidoc/ebay.adoc[leveloffset=+1] - -include::../../ebaystore/src/docs/asciidoc/ebay-store.adoc[leveloffset=+1] +This portlet provides an overview on a dayly/weekly/or month period. +You will see the particular view with the ability to add an event. \ No newline at end of file diff --git a/myportal/src/docs/asciidoc/_include/portlet-system-info-notes.adoc b/myportal/src/docs/asciidoc/_include/portlet-system-info-notes.adoc new file mode 100644 index 000..31f9cb5 --- /dev/null +++ b/myportal/src/docs/asciidoc/_include/portlet-system-info-notes.adoc @@ -0,0 +1,31 @@ + +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 System Event Portlet + +This portlet shows changes which happened in the system for the logged on user. +The first two functions which are working now:. + +1. Incoming communication events (email, internal notes). +2. Tasks which are assigned either in projectmanager or workeffort. + + These event can be notified to the user even when not logged on to OFBiz by using a firefox plugin and when it changes the + employee is notified from within firefox + + The plugin: http://updatescanner.mozdev.org/en/index.html and it should check the following url: (adjust to your requirements) + + https://localhost:8443/myportal/control/showPortletSimpleDecorator?portalPortletId=SystemInfoNotes=admin=ofbiz + + In the Flat Grey theme (only) notifications show in the header when they are available. diff --git a/docs/asciidoc/plugins-user-manual.adoc b/myportal/src/docs/asciidoc/my-portal.adoc similarity index 55% copy from docs/asciidoc/plugins-user-manual.adoc copy to myportal/src/docs/asciidoc/my-portal.adoc index b5cc654..de07d2e 100644 --- a/docs/asciidoc/plugins-user-manual.adoc +++ b/myportal/src/docs/asciidoc/my-portal.adoc @@ -16,19 +16,19 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitation
[ofbiz-plugins] 02/02: Documented: ofbiz-plugins / MyPortal, remove docbook migrated to asciidoc (only a short introduction) (OFBIZ-11587)
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-plugins.git commit cb502cae037299a54ab462d927151b6c08bb2bd8 Author: holivier AuthorDate: Fri May 1 16:52:27 2020 +0200 Documented: ofbiz-plugins / MyPortal, remove docbook migrated to asciidoc (only a short introduction) (OFBIZ-11587) --- myportal/data/helpdata/HELP_MYPORTAL.xml | 33 myportal/documents/MyPortal.xml | 32 --- 2 files changed, 65 deletions(-) diff --git a/myportal/data/helpdata/HELP_MYPORTAL.xml b/myportal/data/helpdata/HELP_MYPORTAL.xml deleted file mode 100644 index 79e5621..000 --- a/myportal/data/helpdata/HELP_MYPORTAL.xml +++ /dev/null @@ -1,33 +0,0 @@ - - -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;> - - -The My portal application introduction. - -Within the 'my portal' application it is possible to create a collection of screens for a specific type of user of the system. -Examples are a general employee, an account manager, a customer, a supplier etc... -The system makes use of special portlets which can be arranged and selected/hidden by the logged on user. - - diff --git a/myportal/documents/MyPortal.xml b/myportal/documents/MyPortal.xml deleted file mode 100644 index e3fc40d..000 --- a/myportal/documents/MyPortal.xml +++ /dev/null @@ -1,32 +0,0 @@ - - -http://docbook.org/ns/docbook; -xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance; -xsi:schemaLocation="http://docbook.org/ns/docbook ../../../applications/content/dtd/docbook.xsd"> -The myportal Component - -Introduction - -and a introduction paragraph in myportal - - -http://www.w3.org/2001/XInclude; -href="../data/helpdata/HELP_MYPORTAL.xml"/> -
[ofbiz-plugins] 01/02: Documented: ofbiz-plugins / Birt, review existing adoc and migration for Help docbook file to asciidoc (OFBIZ-11587)
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-plugins.git commit bf48bcb098db6e01b54a2ca669166bcd77ecab7f Author: holivier AuthorDate: Fri May 1 15:35:13 2020 +0200 Documented: ofbiz-plugins / Birt, review existing adoc and migration for Help docbook file to asciidoc (OFBIZ-11587) * add license in each file, and remove trailing space * better numberer list management * add section Birt in Ofbiz user screen with help migrated file --- .../asciidoc/_include/bt-creating reports.adoc | 126 ++ birt/src/docs/asciidoc/_include/bt-help.adoc | 75 +++ .../_include/bt-how to use flexible reports.adoc | 44 +-- .../_include/bt-report master creation.adoc| 101 +-- .../bt-using the birt report designer.adoc | 142 - birt/src/docs/asciidoc/birt.adoc | 27 ++-- docs/asciidoc/plugins-user-manual.adoc | 2 + 7 files changed, 338 insertions(+), 179 deletions(-) diff --git a/birt/src/docs/asciidoc/_include/bt-creating reports.adoc b/birt/src/docs/asciidoc/_include/bt-creating reports.adoc index e8bf0dc..34bab88 100644 --- a/birt/src/docs/asciidoc/_include/bt-creating reports.adoc +++ b/birt/src/docs/asciidoc/_include/bt-creating reports.adoc @@ -1,23 +1,39 @@ -=== Report creation - - Introduction - -NOTE: This feature will begin to be officially available with the R17.12 branch first release - -A flexible report is an OFBiz content of FLEXIBLE_REPORT type that allows a final user to make use of the reporting -module to obtain flexible reports, ie reports which are created from an entity or view definition and even from a -service. A flexible report is created from a Report Master (content REPORT_MASTER), and an optional XML override of the -parent form. - - Pre-requisite - -* OFBiz framework -* The Birt plugin -* The BIRT Report Designer: <<#_using_the_birt_report_designer,Using the Birt Report Designer>> - -''' - -. Get to Birt component in OFBiz image:Birt-Menus.png[Birt menus] + +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. + +=== Report creation + + Introduction + +NOTE: This feature will begin to be officially available with the R17.12 branch first release + +A flexible report is an OFBiz content of FLEXIBLE_REPORT type that allows a final user to make use of the reporting +module to obtain flexible reports, ie reports which are created from an entity or view definition and even from a +service. A flexible report is created from a Report Master (content REPORT_MASTER), and an optional XML override of the +parent form. + + Pre-requisite +* OFBiz framework +* The Birt plugin +* The BIRT Report Designer: <<#_using_the_birt_report_designer,Using the Birt Report Designer>> + + How to do +. Get to Birt component in OFBiz image:Birt-Menus.png[Birt menus] . Click on the "Flexible Report" menu (varies depending on themes) . Click on the "Generate report" button, you get to this screen: . Fill the form: image:Example-Report.png[Example Report] @@ -26,54 +42,54 @@ parent form. ** The description is a short description which will allow you to recognise the report and its topic. ** The box "Generate filters in design" will add in the design the visualisation of the filters filled in the filtering form. -Once the form is validated, OFBiz will show you the "Edit Report" screen. +Once the form is validated, OFBiz will show you the "Edit Report" screen. -image::Edit-Report-screen.png[Edit Report screen] +image::Edit-Report-screen.png[Edit Report screen] - Report information + Report information -This first panel allows you to change the report description and status. Actually it does not make sense changing the -status to published before having downloaded the .rptdesign file (Birt Report Designer file) from the server (in -database), edited and uploaded it back to the server. This is explained in the section below. Changing the status allows -users to use your reports. But if
[ofbiz-plugins] branch trunk updated: Documented: ofbiz-plugins / msgGateway, remove docbook file without migrate them to asciidoc (contain only a title) (OFBIZ-11587)
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-plugins.git The following commit(s) were added to refs/heads/trunk by this push: new 1d41025 Documented: ofbiz-plugins / msgGateway, remove docbook file without migrate them to asciidoc (contain only a title) (OFBIZ-11587) 1d41025 is described below commit 1d41025097f79067fad9c3df9c192ede436f2d6b Author: holivier AuthorDate: Fri May 1 16:09:37 2020 +0200 Documented: ofbiz-plugins / msgGateway, remove docbook file without migrate them to asciidoc (contain only a title) (OFBIZ-11587) --- msggateway/data/helpdata/HELP_MsgGateway.xml | 29 --- msggateway/documents/MsgGateway.xml | 35 2 files changed, 64 deletions(-) diff --git a/msggateway/data/helpdata/HELP_MsgGateway.xml b/msggateway/data/helpdata/HELP_MsgGateway.xml deleted file mode 100644 index 4edfd78..000 --- a/msggateway/data/helpdata/HELP_MsgGateway.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - -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;> -MsgGateway Overview -The MsgGateway Help file template. - - diff --git a/msggateway/documents/MsgGateway.xml b/msggateway/documents/MsgGateway.xml deleted file mode 100644 index 5d7517f..000 --- a/msggateway/documents/MsgGateway.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - -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;> - -The MsgGateway Component - -Introduction - - - - - -
[ofbiz-plugins] 02/02: Documented: migrate help link to asciidoc user manual for Plugin BIRT (OFBIZ-11587)
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-plugins.git commit cb082af5134291a2fb410fae1d509305ed1a7f92 Author: holivier AuthorDate: Mon Jul 20 16:08:36 2020 +0200 Documented: migrate help link to asciidoc user manual for Plugin BIRT (OFBIZ-11587) All files have been migrated to asciidoc format and help link now point to the html file generated from the asciidoc files In the global Help Docbook index tree, change BIRT help page to a short page with a link to the new help Remove docbook help files for BIRT --- birt/data/helpdata/HELP_BIRT.xml | 70 +--- birt/documents/Birt.xml | 29 - birt/widget/birt/BirtScreens.xml | 5 +-- 3 files changed, 11 insertions(+), 93 deletions(-) diff --git a/birt/data/helpdata/HELP_BIRT.xml b/birt/data/helpdata/HELP_BIRT.xml index ca1c8f9..4235c6f 100644 --- a/birt/data/helpdata/HELP_BIRT.xml +++ b/birt/data/helpdata/HELP_BIRT.xml @@ -7,9 +7,9 @@ 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 @@ -17,71 +17,17 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --> -http://www.w3.org/2001/XMLSchema-instance; version="5.0" -xmlns:xl="http://www.w3.org/1999/xlink; +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;> - -OFBiz BIRT Overview + +OFBiz BIRT Overview redirection Welcome to OFBiz BIRT. The part installed within OFBiz allows you to run the reports which are prepared using Eclipse with the BIRT plugin installed. - -This is a short document to help you get started using BIRT to make a report. - - -As a demo we have prepared a an example report. -Look at the http://eclipse.org/birt/phoenix/;>Eclipse BIRT web site for more information. - - -- - - -There is also a new feature (2017) which allows you to dynamically create Birt reports, and allow your users to customise them: the OFBiz Flexible Reports. - - -Look at the https://cwiki.apache.org/confluence/display/OFBIZ/Birt+Flexible+Reports;>the official documentation for more information. +BIRT Help has been migrated to a new system, you can access it by using + https://ci.apache.org/projects/ofbiz/site/trunk/ofbizdoc/html5/user-manual.html#_ebay_store;>OFBiz user documentation site / BIRT - -1. PDF tab -When you click on this tab. It will render the example report in a PDF format - - -2. Send any format through Mail tab -When you click on this tab. It will show a form that can send the report per email. - - -3. Chart tab -When you click on this tab. An example chart will render in a PDF format - - -Examine the Example Report - -The example report that run in OFBiz is in the file component://birt/webapp/birt/report/example.rptdesign. When you have started Eclipse BIRT, open this document. -This report show how a report receives data from OFBiz through Scripted Data Source using the OFBiz delegator. -This report has the scripted data source name "OFBiz" and the data set that use the script data source name is called "Product". -Open the script editor for Product data set, it uses the delegator object query data from the Product entity. -A report that runs on the OFBiz platform can use the delegator object, dispatcher object, security object and classpath of OFBiz environment in the script. - - -How do I send parameter to report? -If a report is to be rendered through a view map, you can send a parameter through attribute of the request object, the attribute's name is "birtParameters" which is a map. -If a report is to be rendered through an e-mail, you can send the parameter through the service's parameter name called birtParameters. - - -Which are the supported content types? -
[ofbiz-plugins] branch trunk updated (a321e5f -> cb082af)
This is an automated email from the ASF dual-hosted git repository. holivier pushed a change to branch trunk in repository https://gitbox.apache.org/repos/asf/ofbiz-plugins.git. from a321e5f Documented: migrate help link to asciidoc user manual for Plugin EbayStore (OFBIZ-11587) new bf48bcb Documented: ofbiz-plugins / Birt, review existing adoc and migration for Help docbook file to asciidoc (OFBIZ-11587) new cb082af Documented: migrate help link to asciidoc user manual for Plugin BIRT (OFBIZ-11587) The 2 revisions listed above as "new" are entirely new to this repository and will be described in separate emails. The revisions listed as "add" were already present in the repository and have only been added to this reference. Summary of changes: birt/data/helpdata/HELP_BIRT.xml | 70 ++ birt/documents/Birt.xml| 29 - .../asciidoc/_include/bt-creating reports.adoc | 126 ++ birt/src/docs/asciidoc/_include/bt-help.adoc | 75 +++ .../_include/bt-how to use flexible reports.adoc | 44 +-- .../_include/bt-report master creation.adoc| 101 +-- .../bt-using the birt report designer.adoc | 142 - birt/src/docs/asciidoc/birt.adoc | 27 ++-- birt/widget/birt/BirtScreens.xml | 5 +- docs/asciidoc/plugins-user-manual.adoc | 2 + 10 files changed, 349 insertions(+), 272 deletions(-) delete mode 100644 birt/documents/Birt.xml create mode 100644 birt/src/docs/asciidoc/_include/bt-help.adoc
[ofbiz-plugins] 02/02: Documented: migrate help link to asciidoc user manual for Plugin EbayStore (OFBIZ-11587)
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-plugins.git commit a321e5f49f4c66ba95f2a45f1653c3166393ba0c Author: holivier AuthorDate: Mon Jul 20 15:44:36 2020 +0200 Documented: migrate help link to asciidoc user manual for Plugin EbayStore (OFBIZ-11587) All files have been migrated to asciidoc format and help link now point to the html file generated from the asciidoc files In the global Help Docbook index tree, remove all points about EbayStore and add a short page with a link to the new help Remove docbook help files for EbayStore --- ebaystore/data/EbayStoreHelpData.xml | 55 ++- ...ortCategoriesToEbay.xml => HELP_EBAY_STORE.xml} | 9 +-- ebaystore/data/helpdata/HELP_EBAY_AutoPref.xml | 48 - .../data/helpdata/HELP_EBAY_BlockItemOutStock.xml | 26 --- ebaystore/data/helpdata/HELP_EBAY_EbayStore.xml| 40 --- ebaystore/data/helpdata/HELP_EBAY_Feedback.xml | 39 --- .../data/helpdata/HELP_EBAY_LeaveFeedback.xml | 39 --- .../data/helpdata/HELP_EBAY_NewEbayAccount.xml | 43 .../data/helpdata/HELP_EBAY_ProductInventory.xml | 79 -- .../data/helpdata/HELP_EBAY_ReserveProduct.xml | 32 - ebaystore/data/helpdata/HELP_EBAY_StoreSetting.xml | 52 -- ebaystore/documents/EbayStore.xml | 39 --- ebaystore/widget/CommonScreens.xml | 5 +- ebaystore/widget/EbayAccountScreens.xml| 12 ++-- ebaystore/widget/EbaySellingManagerScreens.xml | 7 +- ebaystore/widget/EbayStoreScreens.xml | 4 ++ 16 files changed, 28 insertions(+), 501 deletions(-) diff --git a/ebaystore/data/EbayStoreHelpData.xml b/ebaystore/data/EbayStoreHelpData.xml index 63438f1..552675e 100644 --- a/ebaystore/data/EbayStoreHelpData.xml +++ b/ebaystore/data/EbayStoreHelpData.xml @@ -19,58 +19,11 @@ under the License. --> - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/ebaystore/data/helpdata/HELP_EBAY_ExportCategoriesToEbay.xml b/ebaystore/data/HELP_EBAY_STORE.xml similarity index 71% rename from ebaystore/data/helpdata/HELP_EBAY_ExportCategoriesToEbay.xml rename to ebaystore/data/HELP_EBAY_STORE.xml index 2d87ec9..ae9b432 100644 --- a/ebaystore/data/helpdata/HELP_EBAY_ExportCategoriesToEbay.xml +++ b/ebaystore/data/HELP_EBAY_STORE.xml @@ -17,10 +17,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;> -Ebay Store Export categories to ebay store screen. +Ebay Store help redirection. -The screen allow user to export categories and product to eBay store. -First you should select catalog and click on Export to eBay store button to complete function. -When you click Export to eBay store button, this function will add your categories that in catalog selected to eBay store also add product to categories too. +This application allows the user to access to ebay store by using their account and you can set up and manage your ebay store in ofbiz. + +EbayStore Help has been migrated to a new system, you can access it by using + https://ci.apache.org/projects/ofbiz/site/trunk/ofbizdoc/html5/user-manual.html#_ebay_store;>OFBiz user documentation site / Ebay-Store \ No newline at end of file diff --git a/ebaystore/data/helpdata/HELP_EBAY_AutoPref.xml b/ebaystore/data/helpdata/HELP_EBAY_AutoPref.xml deleted file mode 100644 index a6b01bd..000 --- a/ebaystore/data/helpdata/HELP_EBAY_AutoPref.xml +++ /dev/null @@ -1,48 +0,0 @@ - - -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;> -Ebay Store Detail screen. - -This section contains all Auto setting of specify Account. - - -Fields Description : - - -Automation Re-list Items - - -Automation Re-list Items is setting when items are sold or quantity empty or don't active and then auto re-listing those items. - - - -Start Date have to start before today or finish date. Format: -MM-dd HH:mm:ss.SSS" -
[ofbiz-plugins] branch trunk updated (b76ee41 -> a321e5f)
This is an automated email from the ASF dual-hosted git repository.
holivier pushed a change to branch trunk
in repository https://gitbox.apache.org/repos/asf/ofbiz-plugins.git.
from b76ee41 Documented: migrate help link to asciidoc developer manual
for Plugins dedicated for developer (OFBIZ-11587)
new 0d8efd4 Documented: ofbiz-plugins / ebayStore, migration for Help
docbook file to asciidoc (OFBIZ-11587)
new a321e5f Documented: migrate help link to asciidoc user manual for
Plugin EbayStore (OFBIZ-11587)
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
docs/asciidoc/plugins-user-manual.adoc | 2 +
ebaystore/data/EbayStoreHelpData.xml | 55 +---
...Y_BlockItemOutStock.xml => HELP_EBAY_STORE.xml} | 11 +--
ebaystore/data/helpdata/HELP_EBAY_AutoPref.xml | 48 --
ebaystore/data/helpdata/HELP_EBAY_EbayStore.xml| 40 -
.../helpdata/HELP_EBAY_ExportCategoriesToEbay.xml | 26 --
ebaystore/data/helpdata/HELP_EBAY_Feedback.xml | 39
.../data/helpdata/HELP_EBAY_LeaveFeedback.xml | 39
.../data/helpdata/HELP_EBAY_NewEbayAccount.xml | 43 -
.../data/helpdata/HELP_EBAY_ProductInventory.xml | 79
.../data/helpdata/HELP_EBAY_ReserveProduct.xml | 32 ---
ebaystore/data/helpdata/HELP_EBAY_StoreSetting.xml | 52 ---
ebaystore/documents/EbayStore.xml | 39
ebaystore/src/docs/asciidoc/_include/ebs-main.adoc | 34 +++
.../asciidoc/_include/ebs-new-ebay-account.adoc| 27 +++---
.../asciidoc/_include/ebs-product-inventory.adoc | 70 +++
.../docs/asciidoc/_include/ebs-store-setting.adoc | 50 +++
ebaystore/src/docs/asciidoc/ebay-store.adoc| 100 +
ebaystore/widget/CommonScreens.xml | 5 +-
ebaystore/widget/EbayAccountScreens.xml| 12 +--
ebaystore/widget/EbaySellingManagerScreens.xml | 7 +-
ebaystore/widget/EbayStoreScreens.xml | 4 +
22 files changed, 298 insertions(+), 516 deletions(-)
rename ebaystore/data/{helpdata/HELP_EBAY_BlockItemOutStock.xml =>
HELP_EBAY_STORE.xml} (71%)
delete mode 100644 ebaystore/data/helpdata/HELP_EBAY_AutoPref.xml
delete mode 100644 ebaystore/data/helpdata/HELP_EBAY_EbayStore.xml
delete mode 100644 ebaystore/data/helpdata/HELP_EBAY_ExportCategoriesToEbay.xml
delete mode 100644 ebaystore/data/helpdata/HELP_EBAY_Feedback.xml
delete mode 100644 ebaystore/data/helpdata/HELP_EBAY_LeaveFeedback.xml
delete mode 100644 ebaystore/data/helpdata/HELP_EBAY_NewEbayAccount.xml
delete mode 100644 ebaystore/data/helpdata/HELP_EBAY_ProductInventory.xml
delete mode 100644 ebaystore/data/helpdata/HELP_EBAY_ReserveProduct.xml
delete mode 100644 ebaystore/data/helpdata/HELP_EBAY_StoreSetting.xml
delete mode 100644 ebaystore/documents/EbayStore.xml
create mode 100644 ebaystore/src/docs/asciidoc/_include/ebs-main.adoc
copy docs/asciidoc/plugins-developer-manual.adoc =>
ebaystore/src/docs/asciidoc/_include/ebs-new-ebay-account.adoc (58%)
create mode 100644
ebaystore/src/docs/asciidoc/_include/ebs-product-inventory.adoc
create mode 100644 ebaystore/src/docs/asciidoc/_include/ebs-store-setting.adoc
create mode 100644 ebaystore/src/docs/asciidoc/ebay-store.adoc
[ofbiz-plugins] 01/02: Documented: ofbiz-plugins / ebayStore, migration for Help docbook file to asciidoc (OFBIZ-11587)
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-plugins.git commit 0d8efd4a1bb40d7fe093522be834a7408b37b4ed Author: holivier AuthorDate: Mon Apr 20 10:55:05 2020 +0200 Documented: ofbiz-plugins / ebayStore, migration for Help docbook file to asciidoc (OFBIZ-11587) - ebay-store.adoc include directly some content and call (with include) other files --- docs/asciidoc/plugins-user-manual.adoc | 2 + ebaystore/src/docs/asciidoc/_include/ebs-main.adoc | 34 +++ .../asciidoc/_include/ebs-new-ebay-account.adoc| 25 +++--- .../asciidoc/_include/ebs-product-inventory.adoc | 70 +++ .../docs/asciidoc/_include/ebs-store-setting.adoc | 50 +++ ebaystore/src/docs/asciidoc/ebay-store.adoc| 100 + 6 files changed, 270 insertions(+), 11 deletions(-) diff --git a/docs/asciidoc/plugins-user-manual.adoc b/docs/asciidoc/plugins-user-manual.adoc index becac7c..972cbcd 100644 --- a/docs/asciidoc/plugins-user-manual.adoc +++ b/docs/asciidoc/plugins-user-manual.adoc @@ -28,3 +28,5 @@ endif::[] :sectnums: include::../../ebay/src/docs/asciidoc/ebay.adoc[leveloffset=+1] + +include::../../ebaystore/src/docs/asciidoc/ebay-store.adoc[leveloffset=+1] diff --git a/ebaystore/src/docs/asciidoc/_include/ebs-main.adoc b/ebaystore/src/docs/asciidoc/_include/ebs-main.adoc new file mode 100644 index 000..546e40e --- /dev/null +++ b/ebaystore/src/docs/asciidoc/_include/ebs-main.adoc @@ -0,0 +1,34 @@ + +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. + += Ebay Store main screen. +This screen allows the user to access to ebay store by using their account and you can set up and manage your ebay store in ofbiz. + +Before you take action on this function, you should already have an ebay store and ebay account on the ebay site +because ebay does not allow to create a store from third party site. + +== How to start ebay store in ofbiz? +. Register with ebay developer site to obtain keys and certificate (eBayExport.devId,eBayExport.appId,eBayExport.cerId and + eBayExport.token etc.) at https://developer.ebay.com/join/[Join with ebay developers] +. Press 'New Ebay Account' button to create your ebay account in ofbiz. After you have created ,the system will generate new + product store in ofbiz which link to ebay store. (note :An ebay account in ofbiz use for access to your ebay store on + the ebay site) +. Put your keys in Ebay Configurations Tab. + +== How to connect to your ebay store? +. Go to 'Ebay Accounts' section select your account then press 'submit' button,the system will show functions. diff --git a/docs/asciidoc/plugins-user-manual.adoc b/ebaystore/src/docs/asciidoc/_include/ebs-new-ebay-account.adoc similarity index 58% copy from docs/asciidoc/plugins-user-manual.adoc copy to ebaystore/src/docs/asciidoc/_include/ebs-new-ebay-account.adoc index becac7c..db9592d 100644 --- a/docs/asciidoc/plugins-user-manual.adoc +++ b/ebaystore/src/docs/asciidoc/_include/ebs-new-ebay-account.adoc @@ -16,15 +16,18 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -= Apache OFBiz Plugins -The Apache OFBiz Project -Release trunk -:imagesdir: ./images -ifdef::backend-pdf[] -:title-logo-image: image::OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=4.25in, align=center] -:source-highlighter: rouge -endif::[] -:toc: -:sectnums: += New Ebay Account. +This screen allows the user to add new ebay account for access to using their ebay store. -include::../../ebay/src/docs/asciidoc/ebay.adoc[leveloffset=+1] +== Fields Description : +. Enter 'Salutation' (ex:Mr,miss,Missis) +. Enter 'First Name' (ex:Demo) +. Enter 'Middle Name' +. Enter 'Last Name' (ex: DemoLastName) +. Enter 'Gender' +. Enter 'User Login Id' (ex:exbaySandBox123) which you registered on ebay +. Enter 'Current Password' the same which you registered on ebay +. Press the 'Create' button. + +[NOTE] +Go to Party module -> Search your party -> then you can update your profiles diff --git a/ebaystore/src/docs/asciidoc/_include/ebs
[ofbiz-plugins] 01/03: Documented: ofbiz-plugins / ebay, migration for Help docbook file to asciidoc (OFBIZ-11587)
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-plugins.git commit 7ecfaebc721a5393a46cdec4eb35740dbd875ea0 Author: holivier AuthorDate: Fri Apr 17 17:54:53 2020 +0200 Documented: ofbiz-plugins / ebay, migration for Help docbook file to asciidoc (OFBIZ-11587) - ebay.adoc call (with include) other files --- .../asciidoc/_include/ebay-ShippingMethods.adoc| 38 ++ .../asciidoc/_include/ebay-configurations.adoc | 55 .../asciidoc/_include/ebay-export-to-ebay.adoc | 59 ++ .../ebay-filter-result-search-product.adoc | 37 ++ .../docs/asciidoc/_include/ebay-import-orders.adoc | 36 + .../_include/ebay-import-single-transaction.adoc | 37 ++ ebay/src/docs/asciidoc/_include/ebay-intro.adoc| 52 +++ .../asciidoc/_include/ebay-search-product.adoc | 29 +++ ebay/src/docs/asciidoc/ebay.adoc | 50 ++ 9 files changed, 393 insertions(+) diff --git a/ebay/src/docs/asciidoc/_include/ebay-ShippingMethods.adoc b/ebay/src/docs/asciidoc/_include/ebay-ShippingMethods.adoc new file mode 100644 index 000..a978136 --- /dev/null +++ b/ebay/src/docs/asciidoc/_include/ebay-ShippingMethods.adoc @@ -0,0 +1,38 @@ + +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. + += Shipping Methods Configuration +This screen allows the user to add shipping methods rate for intregrate ofbiz and Ebay. + +== How to add shipping methods? +. Enter 'Shipment Method Name ' (ex:'LocalDelivery') +. Select 'product store' (ex:'OFBiz E-Commerce Store [9000]') +. Enter 'Amount' +. Enter 'Additional Amount' (if you want ) +. Enter 'Additional Percent' (if you want ) +. Enter 'Method Type Enum Id' (ex:Flat Rate Shipping) +. Enter 'Carrier Party Id' select from lookup (Default is UPS) +. select 'Shipment Method Type Id' +. Press the 'Add' button to add shipping method. + +== How to update shipping methods? +. Update the fields required in the screen +. Press the 'Update' button + +== How to delete shipping methods? +. Press the 'Delete' button in each shipping method diff --git a/ebay/src/docs/asciidoc/_include/ebay-configurations.adoc b/ebay/src/docs/asciidoc/_include/ebay-configurations.adoc new file mode 100644 index 000..6ef5263 --- /dev/null +++ b/ebay/src/docs/asciidoc/_include/ebay-configurations.adoc @@ -0,0 +1,55 @@ + +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. + += Configurations +The default screen is for the Ebay Configurations tab is 'Ebay Configurations'. +It is used to locate existing configurations that have been created automatically by the system or manually by the user. + +It can also be used to create a new configurations or edit to integration between OFBiz and eBay. + +== How to find Ebay configurations? +. Select 'product store' you want to see configuration. (Example product store is 'OFBiz E-Commerce Store [9000]') +. Select 'web site' if known. +. Press the 'Search' button to view configurations. +. Select 'Any' then Press the 'Search' button to view all configurations. + +== New/Edit Ebay configurations. +This screen allows the user to create or edit an Ebay Configuration for intregrate ofbiz and Ebay. + +Press New on top or 'Edit' button at product store you want to edit configuration. +System will show screen for
[ofbiz-plugins] 03/03: Documented: migrate help link to asciidoc developer manual for Plugins dedicated for developer (OFBIZ-11587)
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-plugins.git commit b76ee4119794cc090724349370dd7cef6ff7cc77 Author: holivier AuthorDate: Mon Jul 20 12:52:14 2020 +0200 Documented: migrate help link to asciidoc developer manual for Plugins dedicated for developer (OFBIZ-11587) create file plugins-developer-manual, which will include all include plugins for developer. The file plugin-developer-manual is include in developer-manual --- docs/asciidoc/plugins-developer-manual.adoc | 34 + 1 file changed, 34 insertions(+) diff --git a/docs/asciidoc/plugins-developer-manual.adoc b/docs/asciidoc/plugins-developer-manual.adoc new file mode 100644 index 000..cd5f04b --- /dev/null +++ b/docs/asciidoc/plugins-developer-manual.adoc @@ -0,0 +1,34 @@ + +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. + += Apache OFBiz Plugins for Developer +The Apache OFBiz Project +Release trunk +:imagesdir: ./images +ifdef::backend-pdf[] +:title-logo-image: image::OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=4.25in, align=center] +:source-highlighter: rouge +endif::[] +:toc: +:sectnums: + +== Deployment + +include::../../ldap/src/docs/asciidoc/SingleSignOn.adoc[leveloffset=+2] + +
[ofbiz-plugins] 02/03: Documented: migrate help link to asciidoc user manual for Plugin Ebay (OFBIZ-11587)
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-plugins.git
commit 8f57d0c87f40c5d0ac4c5c38ec9398470300ad97
Author: holivier
AuthorDate: Mon Jul 20 12:43:08 2020 +0200
Documented: migrate help link to asciidoc user manual for Plugin Ebay
(OFBIZ-11587)
All files have been migrated to asciidoc format and help link now point
to the html file generated from the asciidoc files
In the global Help Docbook index tree, remove all points about
Ebay and add a short page with a link to the new help
Remove docbook help files for Ebay
---
docs/asciidoc/plugins-user-manual.adoc | 30 +
ebay/data/EbayHelpData.xml | 65 +--
ebay/data/{helpdata => }/HELP_EBAY.xml | 19 +++---
ebay/data/helpdata/HELP_EBAY_AdvanceSearch.xml | 34 --
.../helpdata/HELP_EBAY_EditEbayConfiguration.xml | 47 --
ebay/data/helpdata/HELP_EBAY_Features.xml | 41
.../data/helpdata/HELP_EBAY_FindConfigurations.xml | 54
ebay/data/helpdata/HELP_EBAY_KeywordSearch.xml | 48 --
.../helpdata/HELP_EBAY_ManageOrdersFromEbay.xml| 47 --
.../helpdata/HELP_EBAY_ProductsExportToEbay.xml| 57
ebay/data/helpdata/HELP_EBAY_ShippingMethods.xml | 52 ---
ebay/data/helpdata/HELP_EBAY_eBayOrders.xml| 47 --
ebay/data/helpdata/HELP_EBAY_main.xml | 75 --
ebay/documents/Ebay.xml| 38 ---
ebay/widget/CommonScreens.xml | 3 +-
ebay/widget/EbayScreens.xml| 22 +--
16 files changed, 61 insertions(+), 618 deletions(-)
diff --git a/docs/asciidoc/plugins-user-manual.adoc
b/docs/asciidoc/plugins-user-manual.adoc
new file mode 100644
index 000..becac7c
--- /dev/null
+++ b/docs/asciidoc/plugins-user-manual.adoc
@@ -0,0 +1,30 @@
+
+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.
+
+= Apache OFBiz Plugins
+The Apache OFBiz Project
+Release trunk
+:imagesdir: ./images
+ifdef::backend-pdf[]
+:title-logo-image: image::OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=4.25in,
align=center]
+:source-highlighter: rouge
+endif::[]
+:toc:
+:sectnums:
+
+include::../../ebay/src/docs/asciidoc/ebay.adoc[leveloffset=+1]
diff --git a/ebay/data/EbayHelpData.xml b/ebay/data/EbayHelpData.xml
index 32b7388..e95be3e 100644
--- a/ebay/data/EbayHelpData.xml
+++ b/ebay/data/EbayHelpData.xml
@@ -18,70 +18,11 @@ specific language governing permissions and limitations
under the License.
-->
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/ebay/data/helpdata/HELP_EBAY.xml b/ebay/data/HELP_EBAY.xml
similarity index 74%
rename from ebay/data/helpdata/HELP_EBAY.xml
rename to ebay/data/HELP_EBAY.xml
index 1cc142f..d88b4ec 100644
--- a/ebay/data/helpdata/HELP_EBAY.xml
+++ b/ebay/data/HELP_EBAY.xml
@@ -7,9 +7,9 @@
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
@@ -17,16 +17,19 @@
specific language governing permissions and limitations
under the License.
-->
-http://www.w3.org/2001/XMLSchema-instance; version="5.0"
-xmlns:xl="http://www.w3.org/1999/xlink;
+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
[ofbiz-plugins] branch trunk updated (a905d45 -> b76ee41)
This is an automated email from the ASF dual-hosted git repository.
holivier pushed a change to branch trunk
in repository https://gitbox.apache.org/repos/asf/ofbiz-plugins.git.
from a905d45 Improved: Rename a few map files (OFBIZ-11882)
new 7ecfaeb Documented: ofbiz-plugins / ebay, migration for Help docbook
file to asciidoc (OFBIZ-11587)
new 8f57d0c Documented: migrate help link to asciidoc user manual for
Plugin Ebay (OFBIZ-11587)
new b76ee41 Documented: migrate help link to asciidoc developer manual
for Plugins dedicated for developer (OFBIZ-11587)
The 3 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../asciidoc/plugins-developer-manual.adoc | 26
.../asciidoc/plugins-user-manual.adoc | 18 --
ebay/data/EbayHelpData.xml | 65 +--
ebay/data/{helpdata => }/HELP_EBAY.xml | 19 +++---
ebay/data/helpdata/HELP_EBAY_AdvanceSearch.xml | 34 --
.../helpdata/HELP_EBAY_EditEbayConfiguration.xml | 47 --
ebay/data/helpdata/HELP_EBAY_Features.xml | 41
.../data/helpdata/HELP_EBAY_FindConfigurations.xml | 54
ebay/data/helpdata/HELP_EBAY_KeywordSearch.xml | 48 --
.../helpdata/HELP_EBAY_ManageOrdersFromEbay.xml| 47 --
.../helpdata/HELP_EBAY_ProductsExportToEbay.xml| 57
ebay/data/helpdata/HELP_EBAY_ShippingMethods.xml | 52 ---
ebay/data/helpdata/HELP_EBAY_eBayOrders.xml| 47 --
ebay/data/helpdata/HELP_EBAY_main.xml | 75 --
ebay/documents/Ebay.xml| 38 ---
.../asciidoc/_include/ebay-ShippingMethods.adoc| 38 +++
.../asciidoc/_include/ebay-configurations.adoc | 55
.../asciidoc/_include/ebay-export-to-ebay.adoc | 59 +
.../ebay-filter-result-search-product.adoc | 37 +++
.../docs/asciidoc/_include/ebay-import-orders.adoc | 36 +++
.../_include/ebay-import-single-transaction.adoc | 37 +++
ebay/src/docs/asciidoc/_include/ebay-intro.adoc| 52 +++
.../asciidoc/_include/ebay-search-product.adoc | 17 +++--
ebay/src/docs/asciidoc/ebay.adoc | 50 +++
ebay/widget/CommonScreens.xml | 3 +-
ebay/widget/EbayScreens.xml| 22 +--
26 files changed, 435 insertions(+), 639 deletions(-)
copy ecommerce/template/order/CcInfo.ftl =>
docs/asciidoc/plugins-developer-manual.adoc (67%)
copy assetmaint/data/AssetMaintSeedData.xml =>
docs/asciidoc/plugins-user-manual.adoc (70%)
rename ebay/data/{helpdata => }/HELP_EBAY.xml (74%)
delete mode 100644 ebay/data/helpdata/HELP_EBAY_AdvanceSearch.xml
delete mode 100644 ebay/data/helpdata/HELP_EBAY_EditEbayConfiguration.xml
delete mode 100644 ebay/data/helpdata/HELP_EBAY_Features.xml
delete mode 100644 ebay/data/helpdata/HELP_EBAY_FindConfigurations.xml
delete mode 100644 ebay/data/helpdata/HELP_EBAY_KeywordSearch.xml
delete mode 100644 ebay/data/helpdata/HELP_EBAY_ManageOrdersFromEbay.xml
delete mode 100644 ebay/data/helpdata/HELP_EBAY_ProductsExportToEbay.xml
delete mode 100644 ebay/data/helpdata/HELP_EBAY_ShippingMethods.xml
delete mode 100644 ebay/data/helpdata/HELP_EBAY_eBayOrders.xml
delete mode 100644 ebay/data/helpdata/HELP_EBAY_main.xml
delete mode 100644 ebay/documents/Ebay.xml
create mode 100644 ebay/src/docs/asciidoc/_include/ebay-ShippingMethods.adoc
create mode 100644 ebay/src/docs/asciidoc/_include/ebay-configurations.adoc
create mode 100644 ebay/src/docs/asciidoc/_include/ebay-export-to-ebay.adoc
create mode 100644
ebay/src/docs/asciidoc/_include/ebay-filter-result-search-product.adoc
create mode 100644 ebay/src/docs/asciidoc/_include/ebay-import-orders.adoc
create mode 100644
ebay/src/docs/asciidoc/_include/ebay-import-single-transaction.adoc
create mode 100644 ebay/src/docs/asciidoc/_include/ebay-intro.adoc
copy assetmaint/data/AssetMaintSeedData.xml =>
ebay/src/docs/asciidoc/_include/ebay-search-product.adoc (54%)
create mode 100644 ebay/src/docs/asciidoc/ebay.adoc
[ofbiz-framework] branch trunk updated: Documented: include asciidoc user and developer manual from ofbiz-plugins (OFBIZ-11587)
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 bc6deb2 Documented: include asciidoc user and developer manual from ofbiz-plugins (OFBIZ-11587) bc6deb2 is described below commit bc6deb281c2203091560d1602972e52a9b52f5b6 Author: holivier AuthorDate: Mon Jul 20 12:58:28 2020 +0200 Documented: include asciidoc user and developer manual from ofbiz-plugins (OFBIZ-11587) create file in ofbiz-plugins * plugins-developer-manual, which will include all include:: plugins for developer, * plugins-user-manual, which will include all include:: plugins for user The file plugins-user-manual is include in user-manual and plugin-developer-manual is include in developer-manual --- docs/asciidoc/developer-manual.adoc | 5 +++-- docs/asciidoc/user-manual.adoc | 4 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/asciidoc/developer-manual.adoc b/docs/asciidoc/developer-manual.adoc index ef1261c..c32f8e7 100644 --- a/docs/asciidoc/developer-manual.adoc +++ b/docs/asciidoc/developer-manual.adoc @@ -289,9 +289,10 @@ https://cwiki.apache.org/confluence/display/OFBIZ/Framework+Configuration+Guide[ include::../../framework/base/src/docs/asciidoc/email.adoc[leveloffset=+2] -include::../../plugins/ldap/src/docs/asciidoc/SingleSignOn.adoc[leveloffset=+2] - include::../../framework/security/src/docs/asciidoc/security.adoc[leveloffset=+1] == Appendices +// Developers Plugins + +include::../../plugins/docs/asciidoc/plugins-developer-manual.adoc[leveloffset=+1] diff --git a/docs/asciidoc/user-manual.adoc b/docs/asciidoc/user-manual.adoc index 273ce2c..c8393cb 100644 --- a/docs/asciidoc/user-manual.adoc +++ b/docs/asciidoc/user-manual.adoc @@ -170,3 +170,7 @@ 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] + +// Plugins Business Applications + +include::../../plugins/docs/asciidoc/plugins-user-manual.adoc[leveloffset=+1] \ No newline at end of file
[ofbiz-plugins] branch trunk updated: Documented: ofbiz-framework /framework, migration for SingleSignOn-docbook files to asciidoc (OFBIZ-11587)
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-plugins.git The following commit(s) were added to refs/heads/trunk by this push: new 647e103 Documented: ofbiz-framework /framework, migration for SingleSignOn-docbook files to asciidoc (OFBIZ-11587) 647e103 is described below commit 647e10377b3fcf78e5b51b632cbacdf9af8e71f0 Author: holivier AuthorDate: Tue Apr 14 14:47:28 2020 +0200 Documented: ofbiz-framework /framework, migration for SingleSignOn-docbook files to asciidoc (OFBIZ-11587) - SingleSignOn with LDAP: move to plugin LDAP and include in developer-manual in deployment section --- ldap/src/docs/asciidoc/SingleSignOn.adoc | 159 +++ 1 file changed, 159 insertions(+) diff --git a/ldap/src/docs/asciidoc/SingleSignOn.adoc b/ldap/src/docs/asciidoc/SingleSignOn.adoc new file mode 100644 index 000..3fec4f6 --- /dev/null +++ b/ldap/src/docs/asciidoc/SingleSignOn.adoc @@ -0,0 +1,159 @@ + +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. + += OFBiz Single Sign On using CAS and LDAP + +== Setup the Java Key Store +From the directory in which you want to create the keystore, run keytool with the following parameters. + +. Generate the server certificate. ++ +[source] + +$ keytool -genkey -alias tomcat -keyalg RSA -keypass changeit -storepass changeit -keystore keystore.jks + +When you press Enter, keytool prompts you to enter the server name, organizational unit, organization, locality, state, +and country code. +[NOTE] +Note that you must enter the server name in response to keytool's first prompt, in which it asks for first and + last names. ++ +For testing purposes, this can be localhost. +. Export the generated server certificate in keystore.jks into the file server.cer. ++ +[source] + +$ keytool -export -alias tomcat -storepass changeit -file server.cer -keystore keystore.jks + +. To create the trust-store file cacerts.jks and add the server certificate to the trust-store, run keytool from + the directory where you created the keystore and server certificate. Use the following parameters: ++ +[source] + +$ keytool -import -v -trustcacerts -alias tomcat -file server.cer -keystore cacerts.jks -keypass changeit -storepass changeit + +. Information on the certificate, such as that shown next, will display. ++ +[source] + +$ keytool -import -v -trustcacerts -alias tomcat -file server.cer -keystore cacerts.jks -keypass changeit -storepass changeit + +Owner: CN=localhost, OU=Sun Micro, O=Docs, L=Santa Clara, ST=CA, C=US +Issuer: CN=localhost, OU=Sun Micro, O=Docs, L=Santa Clara, ST=CA, C=US +Serial number: 3e932169 +Valid from: Tue Apr 08 +Certificate fingerprints: +MD5: 52:9F:49:68:ED:78:6F:39:87:F3:98:B3:6A:6B:0F:90 +SHA1: EE:2E:2A:A6:9E:03:9A:3A:1C:17:4A:28:5E:97:20:78:3F: +Trust this certificate? [no]: + +. Enter yes, and then press the Enter or Return key. The following information displays: ++ +[source] + +Certificate was added to keystore +[Saving cacerts.jks] + + + +== CAS Server +. Download CAS server from http://www.jasig.org/cas[the CAS web site]. +. Deploy cas-server-webapp-[version].war to Tomcat +. Set key store file to Tomcat ++ +[source] + +keystoreFile="path/to/keystore.jks" + +. Start Tomcat + + +== OFBiz Certificate +Set trust store's file to Java Virtual Machine (JVM) before start OFBiz. +[source] + +-Djavax.net.ssl.trustStore=path/to/cacerts.jks + + +== LDAP Component +OFBiz uses the LDAP component in the plugins to check the security in a web application. + +OFBiz disabled LDAP component as default, you can enable this component by take the comment out from +plugins/component-load.xml file. + +=== LDAP Properties +LDAP properties file is plugins/ldap/config/ldap.xml. + +You can change a filter condition you want. + + Attributes +. Attribute : LDAP attbitue for filter e.g. uid=%u +. AuthenType : LDAP authentication method e.g. simple +. AuthenticaionHandler : CAS handler class e.g. org.apache.ofbiz.ldap.cas.OFBizCasAuthen
[ofbiz-plugins] branch trunk updated: Documented: ofbiz-framework /framework, migration for SingleSignOn-docbook files to asciidoc (OFBIZ-11587)
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-plugins.git The following commit(s) were added to refs/heads/trunk by this push: new 647e103 Documented: ofbiz-framework /framework, migration for SingleSignOn-docbook files to asciidoc (OFBIZ-11587) 647e103 is described below commit 647e10377b3fcf78e5b51b632cbacdf9af8e71f0 Author: holivier AuthorDate: Tue Apr 14 14:47:28 2020 +0200 Documented: ofbiz-framework /framework, migration for SingleSignOn-docbook files to asciidoc (OFBIZ-11587) - SingleSignOn with LDAP: move to plugin LDAP and include in developer-manual in deployment section --- ldap/src/docs/asciidoc/SingleSignOn.adoc | 159 +++ 1 file changed, 159 insertions(+) diff --git a/ldap/src/docs/asciidoc/SingleSignOn.adoc b/ldap/src/docs/asciidoc/SingleSignOn.adoc new file mode 100644 index 000..3fec4f6 --- /dev/null +++ b/ldap/src/docs/asciidoc/SingleSignOn.adoc @@ -0,0 +1,159 @@ + +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. + += OFBiz Single Sign On using CAS and LDAP + +== Setup the Java Key Store +From the directory in which you want to create the keystore, run keytool with the following parameters. + +. Generate the server certificate. ++ +[source] + +$ keytool -genkey -alias tomcat -keyalg RSA -keypass changeit -storepass changeit -keystore keystore.jks + +When you press Enter, keytool prompts you to enter the server name, organizational unit, organization, locality, state, +and country code. +[NOTE] +Note that you must enter the server name in response to keytool's first prompt, in which it asks for first and + last names. ++ +For testing purposes, this can be localhost. +. Export the generated server certificate in keystore.jks into the file server.cer. ++ +[source] + +$ keytool -export -alias tomcat -storepass changeit -file server.cer -keystore keystore.jks + +. To create the trust-store file cacerts.jks and add the server certificate to the trust-store, run keytool from + the directory where you created the keystore and server certificate. Use the following parameters: ++ +[source] + +$ keytool -import -v -trustcacerts -alias tomcat -file server.cer -keystore cacerts.jks -keypass changeit -storepass changeit + +. Information on the certificate, such as that shown next, will display. ++ +[source] + +$ keytool -import -v -trustcacerts -alias tomcat -file server.cer -keystore cacerts.jks -keypass changeit -storepass changeit + +Owner: CN=localhost, OU=Sun Micro, O=Docs, L=Santa Clara, ST=CA, C=US +Issuer: CN=localhost, OU=Sun Micro, O=Docs, L=Santa Clara, ST=CA, C=US +Serial number: 3e932169 +Valid from: Tue Apr 08 +Certificate fingerprints: +MD5: 52:9F:49:68:ED:78:6F:39:87:F3:98:B3:6A:6B:0F:90 +SHA1: EE:2E:2A:A6:9E:03:9A:3A:1C:17:4A:28:5E:97:20:78:3F: +Trust this certificate? [no]: + +. Enter yes, and then press the Enter or Return key. The following information displays: ++ +[source] + +Certificate was added to keystore +[Saving cacerts.jks] + + + +== CAS Server +. Download CAS server from http://www.jasig.org/cas[the CAS web site]. +. Deploy cas-server-webapp-[version].war to Tomcat +. Set key store file to Tomcat ++ +[source] + +keystoreFile="path/to/keystore.jks" + +. Start Tomcat + + +== OFBiz Certificate +Set trust store's file to Java Virtual Machine (JVM) before start OFBiz. +[source] + +-Djavax.net.ssl.trustStore=path/to/cacerts.jks + + +== LDAP Component +OFBiz uses the LDAP component in the plugins to check the security in a web application. + +OFBiz disabled LDAP component as default, you can enable this component by take the comment out from +plugins/component-load.xml file. + +=== LDAP Properties +LDAP properties file is plugins/ldap/config/ldap.xml. + +You can change a filter condition you want. + + Attributes +. Attribute : LDAP attbitue for filter e.g. uid=%u +. AuthenType : LDAP authentication method e.g. simple +. AuthenticaionHandler : CAS handler class e.g. org.apache.ofbiz.ldap.cas.OFBizCasAuthen
[ofbiz-framework] 07/11: Documented: Check all docbook file in each applications-component documents directory (OFBIZ-11587)
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 commit e5d49b26053a8244772b7a1716280f0ceeb46472 Author: holivier AuthorDate: Fri Apr 10 17:47:05 2020 +0200 Documented: Check all docbook file in each applications-component documents directory (OFBIZ-11587) theses files have no content except for marketing component (2 sentences, migrated to overview for marketing and sfa) --- applications/marketing/src/docs/asciidoc/marketing.adoc | 3 +++ applications/marketing/src/docs/asciidoc/sfa.adoc | 5 + 2 files changed, 8 insertions(+) diff --git a/applications/marketing/src/docs/asciidoc/marketing.adoc b/applications/marketing/src/docs/asciidoc/marketing.adoc index 458927a..d2b67e2 100644 --- a/applications/marketing/src/docs/asciidoc/marketing.adoc +++ b/applications/marketing/src/docs/asciidoc/marketing.adoc @@ -22,6 +22,9 @@ The overall purpose of the Marketing application is the support to select leads or marketing segment to convert to opportunities by contacting these parties via a contact-list related to a marketing campaign. + (contact-list generation support not yet implemented) +The marketing application is supporting you to create, select and follow sales opportunities in order to create sales orders +for the company. + The first option of the marketing application is the definition of a datasource [DataSource], and connecting or loading party information to it [PartyDataSource]. In the party application a data source Id can be added to the party. diff --git a/applications/marketing/src/docs/asciidoc/sfa.adoc b/applications/marketing/src/docs/asciidoc/sfa.adoc index 1e86333..f187bd8a 100644 --- a/applications/marketing/src/docs/asciidoc/sfa.adoc +++ b/applications/marketing/src/docs/asciidoc/sfa.adoc @@ -26,6 +26,11 @@ The main purpose of the SFA application is to support the process of creating or The SFA application is for a specific user to list his leads, contacts accounts and opportunities. + He can create new parties or he can assign existing parties to himself. +It is very much based on the party application as its source. + +Records from the party application are selected with only one basic reason: a possible sale in the future. + +That also means that records in the party manager should be complete, especially the role is pretty important. +Not All roles, but at least 'lead' 'contact' and 'Account' should be defined. + == SFA in User Interface === Main screen
[ofbiz-framework] branch trunk updated (33ca531 -> 9ec3d9c)
This is an automated email from the ASF dual-hosted git repository.
holivier pushed a change to branch trunk
in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git.
from 33ca531 Improved: correct formatting of LoginServices
new 1c09166 Documented: Product (catalog) migration to asciidoc
(OFBIZ-11587)
new 63daf25 Documented: migrate help link to asciidoc user manual for
Product (OFBIZ-11587)
new f4d01e8 Documented: Workeffort migration to asciidoc (OFBIZ-11587)
new 28e82c2 Documented: Workeffort migration to asciidoc (OFBIZ-11587)
new 2c700e8 Documented: Framework/base migration to asciidoc
(OFBIZ-11587)
new 5f56177 Documented: Framework/base migration to asciidoc
(OFBIZ-11587)
new e5d49b2 Documented: Check all docbook file in each
applications-component documents directory (OFBIZ-11587)
new b36943d Documented: Check all docbook file in each
applications-component documents directory (OFBIZ-11587)
new b0f445b Documented: Framework, migration all docbook files to
asciidoc (OFBIZ-11587)
new 91fe7bf Documented: Framework, delete all docbook files related to
migration to asciidoc (OFBIZ-11587)
new 9ec3d9c Documented: Framework, delete all docbook files related to
migration to asciidoc (OFBIZ-11587)
The 11 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
README.adoc| 2 +
applications/accounting/documents/Accounting.xml | 39 ---
applications/commonext/documents/Setup.xml | 27 --
applications/content/data/WebtoolsHelpData.xml | 11 +-
applications/content/documents/Content.xml | 30 ---
applications/humanres/documents/Humanres.xml | 51
.../manufacturing/documents/manufacturing.xml | 64 -
applications/marketing/documents/Marketing.xml | 47
.../marketing/src/docs/asciidoc/marketing.adoc | 3 +
applications/marketing/src/docs/asciidoc/sfa.adoc | 5 +
applications/order/documents/Order.xml | 29 ---
applications/party/documents/Party.xml | 32 ---
.../data/HELP_PRODUCT.xml} | 18 +-
applications/product/data/ProductHelpData.xml | 24 --
.../product/data/helpdata/HELP_IMAGEMANAGEMENT.xml | 211 ---
.../data/helpdata/HELP_PRODCATALOG_main.xml| 66 -
.../product/data/helpdata/HELP_PRODUCT.xml | 39 ---
.../data/helpdata/HELP_PRODUCT_Catalog_Promos.xml | 64 -
.../data/helpdata/HELP_PRODUCT_Features.xml| 93 ---
.../data/helpdata/HELP_PRODUCT_Product_Stores.xml | 129 --
.../helpdata/HELP_PRODUCT_WorkingwithCatalogs.xml | 111
applications/product/documents/Product.xml | 33 ---
.../docs/asciidoc/_include/product-catalogs.adoc | 107
.../docs/asciidoc/_include/product-features.adoc | 108
.../_include/product-image-management.adoc | 149 +++
.../src/docs/asciidoc/_include/product-promos.adoc | 60 +
.../src/docs/asciidoc/_include/product-stores.adoc | 135 ++
.../product/src/docs/asciidoc/product.adoc | 89 +++
.../product/widget/catalog/CommonScreens.xml | 11 +-
.../docs/asciidoc/_include/portlet-calendar.adoc | 6 +-
docs/asciidoc/developer-manual.adoc| 23 +-
docs/asciidoc/user-manual.adoc | 2 +
framework/base/documents/FrameworkBase.xml | 32 ---
framework/base/documents/ReceivingEmail.xml| 46
.../docs/asciidoc/_include/email-receiving.adoc| 39 +++
.../src/docs/asciidoc/_include/email-sending.adoc | 15 +-
.../base/src/docs/asciidoc/email.adoc | 9 +-
framework/common/documents/FrameworkCommon.xml | 30 ---
framework/common/documents/SendingEmail.xml| 45
.../datafile/src/docs/asciidoc/datafiles.adoc | 111
framework/documents/DataFiles.xml | 239 -
framework/documents/Framework.xml | 28 --
framework/documents/SingleSignOn.xml | 282 -
framework/documents/UnitTest.xml | 228 -
framework/entity/documents/EntityEngine.xml| 48
.../entity/src/docs/asciidoc/entity-engine.adoc| 12 +-
framework/minilang/documents/MiniLang.xml | 28 --
.../docs/asciidoc/minilang-to-groovy-manual.adoc | 9 +-
framework/service/documents/ServiceEngine.xml | 28 --
.../testtools/src/docs/asciidoc/SingleSignOn.adoc | 159
.../testtools/src/docs/asciidoc/unit-tests.adoc| 155 +++
.../webtools/data/{helpdata => }/HELP_WEBTOOLS.xml | 6 +-
.../webtools/data/helpdata/HELP_WEBTOOLS_main.xml | 48 -
[ofbiz-framework] 04/11: Documented: Workeffort migration to asciidoc (OFBIZ-11587)
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 commit 28e82c217b866ae580dc932c0ebbac9c4c70e827 Author: holivier AuthorDate: Fri Apr 10 12:44:04 2020 +0200 Documented: Workeffort migration to asciidoc (OFBIZ-11587) deleted related docbook file --- .../data/helpdata/HELP_PORTLET_CALENDAR.xml| 30 -- 1 file changed, 30 deletions(-) diff --git a/applications/workeffort/data/helpdata/HELP_PORTLET_CALENDAR.xml b/applications/workeffort/data/helpdata/HELP_PORTLET_CALENDAR.xml deleted file mode 100644 index 711dddc..000 --- a/applications/workeffort/data/helpdata/HELP_PORTLET_CALENDAR.xml +++ /dev/null @@ -1,30 +0,0 @@ - - -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;> -The Calendar Portlet - -It provides an overview on a dayly/weekly/or month period. -You will see the particular view with the ability to add an event. - -
[ofbiz-framework] 10/11: Documented: Framework, delete all docbook files related to migration to asciidoc (OFBIZ-11587)
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
commit 91fe7bf4cce245268319ca75efe365191e6867f9
Author: holivier
AuthorDate: Tue Apr 14 12:25:26 2020 +0200
Documented: Framework, delete all docbook files related to migration to
asciidoc
(OFBIZ-11587)
- common-sending-email: include in email
- datafile: move as a include at the end of entity-engine section
- entity-engine: list of link to OFBiz wiki about entity configuration
- service-engine: a link to OFBiz wiki Service Engine Guide
- webtools: help for main screen
- mini-lang: include a link to OFBiz wiki mini-lang-reference at the
beginning of minilang-to-groovy-manual
move minilang-to-groovy-manual to Development environment
section
- unit-test: include as Junit test, and use README to list gradle
command available (so add a tag in REAME.adoc)
- base: add a link to OFBiz wiki Configuration Guide, in deployment
section
- SingleSignOn with LDAP: move to plugin LDAP and include in deployment
section
---
framework/common/documents/FrameworkCommon.xml | 30 ---
framework/common/documents/SendingEmail.xml| 45
framework/documents/DataFiles.xml | 239 -
framework/documents/Framework.xml | 28 --
framework/documents/SingleSignOn.xml | 282 -
framework/documents/UnitTest.xml | 228 -
framework/entity/documents/EntityEngine.xml| 48
framework/minilang/documents/MiniLang.xml | 28 --
framework/service/documents/ServiceEngine.xml | 28 --
framework/webtools/data/helpdata/HELP_WEBTOOLS.xml | 22 --
.../webtools/data/helpdata/HELP_WEBTOOLS_main.xml | 48
framework/webtools/documents/Webtools.xml | 30 ---
12 files changed, 1056 deletions(-)
diff --git a/framework/common/documents/FrameworkCommon.xml
b/framework/common/documents/FrameworkCommon.xml
deleted file mode 100644
index ce0d252..000
--- a/framework/common/documents/FrameworkCommon.xml
+++ /dev/null
@@ -1,30 +0,0 @@
-
-
-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;>
-The Framework Common Component.
-
-The framework Common component contains all functions which do not
justify a separate framework component.
-
-
-
diff --git a/framework/common/documents/SendingEmail.xml
b/framework/common/documents/SendingEmail.xml
deleted file mode 100644
index f369156..000
--- a/framework/common/documents/SendingEmail.xml
+++ /dev/null
@@ -1,45 +0,0 @@
-
-
-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;>
-Sending Email in OFBiz
-
-Various parts in the OFBiz application are sending out email for
various reasons. Sending out email is controlled in the
-${ofbiz install dir}/framework/common/config/general.properties
file with the following parameters:
-
-
-SMTP Server (relay host): mail.smtp.relay.host
-
-
-SMTP Username (if needed): mail.smtp.auth.user
-
-
-SMTP Password (if needed): mail.smtp.auth.password
-
-
-Turn on email notifications by setting the
mail.notifications.enabled property to "Y".
-
-
-
-
-
diff --git a/framework/documents/DataFiles.xml
b/framework/documents/DataFiles.xml
deleted file mode 100644
index 8b90139..000
--- a/framework/documents/DataFiles.xml
+++ /dev/null
@@ -1,239 +0,0 @@
-
-
-http://www.docbook.org/xml/5.0b3/xsd/docbook.xsd;
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance;
xmlns:xl="http://www.w3.org/1999/xlink;
xmlns:xi="http://www.w3.org/2001/XInclude;
xmlns="http://docbook.org/ns/docbook;>
-The OFBiz Datafiles
-
-
-Intoduction
-There is a data import tool in OFBiz called the DataFile
tool. It uses XML files that describe flat file formats (including character
delimited, fixed width, etc) and parses the flat files based on those
definitions. So, by design it is somewhat like the Entity Engine. It uses a
generic object t
[ofbiz-framework] 01/11: Documented: Product (catalog) migration to asciidoc (OFBIZ-11587)
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 commit 1c0916694839577c9fbf2781ecbd461173404570 Author: holivier AuthorDate: Tue Apr 7 14:21:58 2020 +0200 Documented: Product (catalog) migration to asciidoc (OFBIZ-11587) product.adoc included (by include:: ) the other files by sub-component user-manual is updated to include it in. --- .../docs/asciidoc/_include/product-catalogs.adoc | 107 +++ .../docs/asciidoc/_include/product-features.adoc | 108 +++ .../_include/product-image-management.adoc | 149 + .../src/docs/asciidoc/_include/product-promos.adoc | 60 + .../src/docs/asciidoc/_include/product-stores.adoc | 135 +++ .../product/src/docs/asciidoc/product.adoc | 89 docs/asciidoc/user-manual.adoc | 2 + 7 files changed, 650 insertions(+) diff --git a/applications/product/src/docs/asciidoc/_include/product-catalogs.adoc b/applications/product/src/docs/asciidoc/_include/product-catalogs.adoc new file mode 100644 index 000..39bc6be --- /dev/null +++ b/applications/product/src/docs/asciidoc/_include/product-catalogs.adoc @@ -0,0 +1,107 @@ + +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. + += Catalogs + +== Catalogs overview +A product catalog is used to group many product categories together and forms an intermediate step in the organization between +products, categories, and stores. + +The product catalog can be used to define a common look and feel for all categories in this catalog and specify +the way different categories will behave. + +For example, it is very useful for stores which sell products from different manufacturer or completely different product types + that require differing presentations to the customer. + +=== Sequence from a Store to the Products +Although the process sequence through the tabs discussed below does not correspond with the tab layout within the Catalog Manager, +the progression of the steps is intentional. + +. Promotions and Price Rules cannot exist without Products. +. Products are usually so numerous that you wish to divide them into Categories and distinguish them by their Features. +. Categories are then the major sections of your Catalogs. +. And Catalogs must be associated with their related Stores. +. Therefore, when setting up your business, you need to start with the Store. + +All of these details are handled within the Catalog Manager. + +== Working with Catalogs +To follow this topic, click on the 'Catalog Detail List' in the left-hand panel under the 'Browse Catalogs' section. + +Then click on any catalog in the table of current catalogs presented in the main screen. + +You will see the top-level editing screen for that catalog. + +Along the top of the working screen are four sub-tabs: Catalog, Stores, Parties and Catalogs. + +Each of those are discussed as a topic below. + + +=== Catalog tab +The main Catalog tab for a product catalog is mostly for establishing the look and feel. + +Each catalog can have its own style sheet (CSS), its own logo, and its own content repository (the content path prefix) +and templates prefix (where its freemarker templates are located). + +=== The Stores tab +The 'Stores' tab shows a list of Stores that this Catalog is currently featured in. + +[NOTE] +Stores and Catalogs do not have a one-to-one relationship: the same Store can feature multiple Catalogs, +and the same Catalog could be featured in many Stores. + +=== The Parties tab +Here you identify which Party is responsible for or assigned to work with the specific Catalog selected. + +The Party's Role is assigned or identified and, if appropriate, a start and/or finish date for the assignment can be specified. + +=== Categories tab +The 'categories' tab shows the different product categories and their roles for this catalog. +Specifically: + +* Each catalog can (should) have a 'Browse Root' category, which is used as the root category for navigation. + + For example, the navigation menu would start at this category and show i
[ofbiz-framework] 06/11: Documented: Framework/base migration to asciidoc (OFBIZ-11587)
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
commit 5f56177d0276f8ad03cf0aac7ce2f352ec3243c1
Author: holivier
AuthorDate: Fri Apr 10 16:07:50 2020 +0200
Documented: Framework/base migration to asciidoc
(OFBIZ-11587)
Delete docbook files
---
framework/base/documents/FrameworkBase.xml | 32
framework/base/documents/ReceivingEmail.xml | 46 -
2 files changed, 78 deletions(-)
diff --git a/framework/base/documents/FrameworkBase.xml
b/framework/base/documents/FrameworkBase.xml
deleted file mode 100644
index 8c9d488..000
--- a/framework/base/documents/FrameworkBase.xml
+++ /dev/null
@@ -1,32 +0,0 @@
-
-
-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;>
-Framework Base components
-
-This part of the framework contain the basic components like the
several different connectors, catalina(tomcat)
-which are the base of the other framework.
-
-
-
-
-
diff --git a/framework/base/documents/ReceivingEmail.xml
b/framework/base/documents/ReceivingEmail.xml
deleted file mode 100644
index d28d033..000
--- a/framework/base/documents/ReceivingEmail.xml
+++ /dev/null
@@ -1,46 +0,0 @@
-
-
-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;>
-Receiving Email.
-
-OFBiz can receive email for multiple email addresses and via an
MCA can create Communication events
-for the involved parties of the email. Email attachments, via
again the MCA are stored in the content component
-and can be accessed via the content Id. Examples of an MCA can be
found in the Party and Content Component.
-
-
-To receive email a single POP/IMAP mailbox is polled at regular
intervals. This is configured in the
-${ofbiz install dir}/framework/base/config/ofbiz-containers.xml
file. Any email address you want to be handled
-by OFBiz need to be forwarded to this single mailbox by an
external mail server. OFBiz then will try to match the
-email addresses to existing parties and will create a single
communication event referring to the found parties.
-
-
-If an incoming email address cannot be matched against a party,
the communication event will get a special status
-and the receiving party can either delete the communication event
or can ask the system to automatically create a party
-from the incoming email address.
-
-
-By default the configuaration file has the email poller commented
out. The parameters to this function are pretty self
-explanatory.
-
-
-
[ofbiz-framework] 05/11: Documented: Framework/base migration to asciidoc (OFBIZ-11587)
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
commit 2c700e86af00afa3f70e4267fb8ab2d774e231f2
Author: holivier
AuthorDate: Fri Apr 10 16:06:05 2020 +0200
Documented: Framework/base migration to asciidoc
(OFBIZ-11587)
only one file about receiving email, so create email.adoc which included
receiving and later sending.
email.adoc is included in developer-manual.adoc in deployment section
---
docs/asciidoc/developer-manual.adoc| 2 ++
.../docs/asciidoc/_include/email-receiving.adoc| 39 ++
framework/base/src/docs/asciidoc/email.adoc| 23 +
3 files changed, 64 insertions(+)
diff --git a/docs/asciidoc/developer-manual.adoc
b/docs/asciidoc/developer-manual.adoc
index 6895acd..3e07ab9 100644
--- a/docs/asciidoc/developer-manual.adoc
+++ b/docs/asciidoc/developer-manual.adoc
@@ -273,6 +273,8 @@ include::../../themes/docs/themes.adoc[leveloffset=+2]
== Deployment
+include::../../framework/base/src/docs/asciidoc/email.adoc[leveloffset=+2]
+
include::../../framework/security/src/docs/asciidoc/security.adoc[leveloffset=+1]
== Appendices
diff --git a/framework/base/src/docs/asciidoc/_include/email-receiving.adoc
b/framework/base/src/docs/asciidoc/_include/email-receiving.adoc
new file mode 100644
index 000..2e3c7c2
--- /dev/null
+++ b/framework/base/src/docs/asciidoc/_include/email-receiving.adoc
@@ -0,0 +1,39 @@
+
+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.
+
+= Receiving Email.
+
+OFBiz can receive email for multiple email addresses and via an MCA can create
Communication events for the involved parties
+of the email. +
+Email attachments, via again the MCA are stored in the content component and
can be accessed via the content Id. +
+Examples of an MCA can be found in the Party and Content Component.
+
+To receive email a single POP/IMAP mailbox is polled at regular intervals. +
+This is configured in the ${ofbiz install
dir}/framework/service/ofbiz-component.xml file in the commented section
+JavaMail Listener Container.
+
+Any email address you want to be handled by OFBiz need to be forwarded to
this single mailbox by an external mail server. +
+OFBiz then will try to match the email addresses to existing parties and will
create a single communication event referring
+to the found parties.
+
+If an incoming email address cannot be matched against a party, the
communication event will get a special status and
+the receiving party can either delete the communication event or can ask the
system to automatically create a party
+from the incoming email address.
+
+By default the configuaration file has the email poller commented out. +
+The parameters to this function are pretty self explanatory.
\ No newline at end of file
diff --git a/framework/base/src/docs/asciidoc/email.adoc
b/framework/base/src/docs/asciidoc/email.adoc
new file mode 100644
index 000..6408da3
--- /dev/null
+++ b/framework/base/src/docs/asciidoc/email.adoc
@@ -0,0 +1,23 @@
+
+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.
+
+= email
+
+== HowTo use email in OFBiz
+
+include::_include/email-receiving.adoc[leveloffset=+2]
[ofbiz-framework] 08/11: Documented: Check all docbook file in each applications-component documents directory (OFBIZ-11587)
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 commit b36943d56faadaf650cb7c96c889e68a4dc8ac6b Author: holivier AuthorDate: Fri Apr 10 17:49:25 2020 +0200 Documented: Check all docbook file in each applications-component documents directory (OFBIZ-11587) remove all files --- applications/accounting/documents/Accounting.xml | 39 - applications/commonext/documents/Setup.xml | 27 - applications/content/documents/Content.xml | 30 -- applications/humanres/documents/Humanres.xml | 51 - .../manufacturing/documents/manufacturing.xml | 64 -- applications/marketing/documents/Marketing.xml | 47 applications/order/documents/Order.xml | 29 -- applications/party/documents/Party.xml | 32 --- applications/product/documents/Product.xml | 33 --- 9 files changed, 352 deletions(-) diff --git a/applications/accounting/documents/Accounting.xml b/applications/accounting/documents/Accounting.xml deleted file mode 100644 index 7c18673..000 --- a/applications/accounting/documents/Accounting.xml +++ /dev/null @@ -1,39 +0,0 @@ - - -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;> -The Accounting Component. - - - - - - - - - - - - - - diff --git a/applications/commonext/documents/Setup.xml b/applications/commonext/documents/Setup.xml deleted file mode 100644 index 9d72809..000 --- a/applications/commonext/documents/Setup.xml +++ /dev/null @@ -1,27 +0,0 @@ - - -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;> -The Setup Component - - diff --git a/applications/content/documents/Content.xml b/applications/content/documents/Content.xml deleted file mode 100644 index 717eabd..000 --- a/applications/content/documents/Content.xml +++ /dev/null @@ -1,30 +0,0 @@ - - -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;> -The Content Component - -Introduction - - - - diff --git a/applications/humanres/documents/Humanres.xml b/applications/humanres/documents/Humanres.xml deleted file mode 100644 index 9864fd8..000 --- a/applications/humanres/documents/Humanres.xml +++ /dev/null @@ -1,51 +0,0 @@ - - -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;> -The Human Resource Application. - -The human resource application is supporting you to ...WIP, to be completed... - - - -Human resource in Apache OFBiz, an overview. - - WIP, to be completed... - - - - - - - - - - - diff --git a/applications/manufacturing/documents/manufacturing.xml b/applications/manufacturing/documents/manufacturing.xml deleted file mode 100644 index 8f63fea..000 --- a/applications/manufacturing/documents/manufacturing.xml +++ /dev/null @@ -1,64 +0,0 @@ - - -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;> -Manufacturing - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/applications/marketing/documents/Marketing.xml b/applications/marketing/documents/Marketing.xml deleted file mode 100644 index d31f1ed..000 --- a/applications/marketing/documents/Marketing.xml +++ /dev/null @@ -1,47 +0,0 @@ - - -http://www.w3.org/2001/XMLSchema-instance; vers
[ofbiz-framework] 03/11: Documented: Workeffort migration to asciidoc (OFBIZ-11587)
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 commit f4d01e8610b97e8b905e937a90b98e55f0e97460 Author: holivier AuthorDate: Fri Apr 10 12:41:46 2020 +0200 Documented: Workeffort migration to asciidoc (OFBIZ-11587) only one file about portlet-calendar, currently not include in a document --- .../docs/asciidoc/_include/portlet-calendar.adoc | 22 ++ 1 file changed, 22 insertions(+) diff --git a/applications/workeffort/src/docs/asciidoc/_include/portlet-calendar.adoc b/applications/workeffort/src/docs/asciidoc/_include/portlet-calendar.adoc new file mode 100644 index 000..663101a --- /dev/null +++ b/applications/workeffort/src/docs/asciidoc/_include/portlet-calendar.adoc @@ -0,0 +1,22 @@ + +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 Calendar Portlet + +It provides an overview on a dayly/weekly/or month period. +You will see the particular view with the ability to add an event. \ No newline at end of file
[ofbiz-framework] 09/11: Documented: Framework, migration all docbook files to asciidoc (OFBIZ-11587)
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
commit b0f445b123e0df6dd71786ad945384972c43bd4d
Author: holivier
AuthorDate: Tue Apr 14 12:22:17 2020 +0200
Documented: Framework, migration all docbook files to asciidoc
(OFBIZ-11587)
- common-sending-email: include in email
- datafile: move as a include at the end of entity-engine section
- entity-engine: list of link to OFBiz wiki about entity configuration
- service-engine: a link to OFBiz wiki Service Engine Guide
- webtools: help for main screen
- mini-lang: include a link to OFBiz wiki mini-lang-reference at the
beginning of minilang-to-groovy-manual
move minilang-to-groovy-manual to Development environment
section
- unit-test: include as Junit test, and use README to list gradle
command available (so add a tag in REAME.adoc)
- base: add a link to OFBiz wiki Configuration Guide, in deployment
section
- SingleSignOn with LDAP: move to plugin LDAP and include in deployment
section
developer-manual is updated with some include lines or with directly a
sentence.
---
README.adoc| 2 +
docs/asciidoc/developer-manual.adoc| 21 ++-
.../{email.adoc => _include/email-sending.adoc}| 11 +-
framework/base/src/docs/asciidoc/email.adoc| 2 +
.../datafile/src/docs/asciidoc/datafiles.adoc | 111 ++
.../src/docs/asciidoc/entity-engine.adoc} | 11 +-
.../docs/asciidoc/minilang-to-groovy-manual.adoc | 9 +-
.../testtools/src/docs/asciidoc/SingleSignOn.adoc | 159 +
.../testtools/src/docs/asciidoc/unit-tests.adoc| 155
.../src/docs/asciidoc/_include/webtools-main.adoc | 38 +
10 files changed, 507 insertions(+), 12 deletions(-)
diff --git a/README.adoc b/README.adoc
index 2ed7bff..9d3d513 100644
--- a/README.adoc
+++ b/README.adoc
@@ -481,6 +481,7 @@ parameters are passed:
[[testing-tasks]]
=== Testing tasks
+# tag::testingtasks[]
[[execute-all-unit-tests]]
Execute all unit tests
@@ -540,6 +541,7 @@ listens on port *5005*
`gradlew "ofbiz --test component=entity --test suitename=entitytests"
--debug-jvm`
+# end::testingtasks[]
[[miscellaneous-tasks]]
diff --git a/docs/asciidoc/developer-manual.adoc
b/docs/asciidoc/developer-manual.adoc
index 3e07ab9..ef1261c 100644
--- a/docs/asciidoc/developer-manual.adoc
+++ b/docs/asciidoc/developer-manual.adoc
@@ -199,7 +199,7 @@
include::../../framework/webapp/src/docs/asciidoc/webapp.adoc[leveloffset=+1]
Views
-== Entity Engine
+include::../../framework/entity/src/docs/asciidoc/entity-engine.adoc[leveloffset=+1]
=== Entities
@@ -213,6 +213,8 @@
include::../../framework/webapp/src/docs/asciidoc/webapp.adoc[leveloffset=+1]
=== XML Data
+include::../../framework/datafile/src/docs/asciidoc/datafiles.adoc[leveloffset=+2]
+
=== Entity engine configuration
=== Supported databases
@@ -220,6 +222,8 @@
include::../../framework/webapp/src/docs/asciidoc/webapp.adoc[leveloffset=+1]
include::../../applications/datamodel/DATAMODEL_CHANGES.adoc[leveloffset=+2]
== Service Engine
+A description of the service engine can be found at the
+https://cwiki.apache.org/confluence/display/OFBIZ/Service+Engine+Guide[OFBiz
wiki Service Engine Guide]
=== Declaration and Implementation
@@ -264,19 +268,30 @@ include::../../themes/docs/themes.adoc[leveloffset=+2]
Database
=== Web tools
+The Webtools application is the UI-gateway to all the framework functions.
+
+include::../../framework/webtools/src/docs/asciidoc/_include/webtools-main.adoc[leveloffset=+3]
+
+include::../../framework/minilang/src/docs/asciidoc/minilang-to-groovy-manual.adoc[leveloffset=+1]
== Testing
-=== Unit Tests
+include::../../framework/testtools/src/docs/asciidoc/unit-tests.adoc[leveloffset=+2]
=== Integration Tests
== Deployment
+For a core configuration guide check
+https://cwiki.apache.org/confluence/display/OFBIZ/Framework+Configuration+Guide[the
OFBiz configuration Guide]
+ (some points are not up to date).
+
+
include::../../framework/base/src/docs/asciidoc/email.adoc[leveloffset=+2]
+include::../../plugins/ldap/src/docs/asciidoc/SingleSignOn.adoc[leveloffset=+2]
+
include::../../framework/security/src/docs/asciidoc/security.adoc[leveloffset=+1]
== Appendices
-include::../../framework/minilang/docs/asciidoc/minilang-to-groovy-manual.adoc[leveloffset=+1]
diff --git a/framework/base/src/docs/asciidoc/email.adoc
b/framework/base/src/docs/asciidoc/_include/email-sending.adoc
similarity index 61%
copy from framework/base/src/docs/asciidoc/email.adoc
copy to framework/base/src/docs/asciidoc/_include/email-sending.adoc
index 6408da3..7e098fa 100644
--- a/framework/base/src/docs/asciidoc/email.adoc
++
[ofbiz-framework] 11/11: Documented: Framework, delete all docbook files related to migration to asciidoc (OFBIZ-11587)
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 commit 9ec3d9ca771dd379af1b8eb942fc36bf329686d7 Author: holivier AuthorDate: Tue Jul 14 17:06:56 2020 +0200 Documented: Framework, delete all docbook files related to migration to asciidoc (OFBIZ-11587) Add a link to developer-manual for webtools in old help system --- applications/content/data/WebtoolsHelpData.xml | 11 +++ framework/webtools/data/HELP_WEBTOOLS.xml | 24 2 files changed, 27 insertions(+), 8 deletions(-) diff --git a/applications/content/data/WebtoolsHelpData.xml b/applications/content/data/WebtoolsHelpData.xml index 9c4c5c9..d688aab 100644 --- a/applications/content/data/WebtoolsHelpData.xml +++ b/applications/content/data/WebtoolsHelpData.xml @@ -21,14 +21,9 @@ under the License. - - - - - - \ No newline at end of file + \ No newline at end of file diff --git a/framework/webtools/data/HELP_WEBTOOLS.xml b/framework/webtools/data/HELP_WEBTOOLS.xml new file mode 100644 index 000..98a74aa --- /dev/null +++ b/framework/webtools/data/HELP_WEBTOOLS.xml @@ -0,0 +1,24 @@ + + +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;> +The Webtools Help redirection. +Webtools Help has been migrated to a new system, you can access it by using + https://ci.apache.org/projects/ofbiz/site/trunk/ofbizdoc/html5/developer-manual.html#_web_tools;>OFBiz Developer documentation site / Webtools + + \ No newline at end of file
[ofbiz-framework] 02/11: Documented: migrate help link to asciidoc user manual for Product (OFBIZ-11587)
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
commit 63daf2511270037b269bccb3dd0c567861e69afb
Author: holivier
AuthorDate: Tue Jul 14 16:19:48 2020 +0200
Documented: migrate help link to asciidoc user manual for Product
(OFBIZ-11587)
All files have been migrated to asciidoc format and help link now point
to the html file generated from the asciidoc files
In the global Help Docbook index tree, remove all points about
Product & Facility and add a short page with a link to the new help
Remove docbook help files for Product & Facility
---
.../product/data/{helpdata => }/HELP_PRODUCT.xml | 23 +--
applications/product/data/ProductHelpData.xml | 24 ---
.../product/data/helpdata/HELP_IMAGEMANAGEMENT.xml | 211 -
.../data/helpdata/HELP_PRODCATALOG_main.xml| 66 ---
.../data/helpdata/HELP_PRODUCT_Catalog_Promos.xml | 64 ---
.../data/helpdata/HELP_PRODUCT_Features.xml| 93 -
.../data/helpdata/HELP_PRODUCT_Product_Stores.xml | 129 -
.../helpdata/HELP_PRODUCT_WorkingwithCatalogs.xml | 111 ---
.../product/widget/catalog/CommonScreens.xml | 11 +-
9 files changed, 14 insertions(+), 718 deletions(-)
diff --git a/applications/product/data/helpdata/HELP_PRODUCT.xml
b/applications/product/data/HELP_PRODUCT.xml
similarity index 66%
rename from applications/product/data/helpdata/HELP_PRODUCT.xml
rename to applications/product/data/HELP_PRODUCT.xml
index 53effb7..f4d59c5 100644
--- a/applications/product/data/helpdata/HELP_PRODUCT.xml
+++ b/applications/product/data/HELP_PRODUCT.xml
@@ -7,9 +7,9 @@
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
@@ -17,23 +17,14 @@
specific language governing permissions and limitations
under the License.
-->
-http://www.w3.org/2001/XMLSchema-instance; version="5.0"
-xmlns:xl="http://www.w3.org/1999/xlink;
+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;>
-The Catalog overview screen help screen
-Introduction
-
-subsection heading
-Subsection content
-
-
-Subsection 2 title
-
-The Main catalog help screen. For more information please
-see the https://cwiki.apache.org/confluence/display/OFBIZ/Home;>OFBiz
documentation site for more info.
+The Catalog help redirection
+Catalog Help has been migrated to a new system, you can access
it by using
+ https://ci.apache.org/projects/ofbiz/site/trunk/ofbizdoc/html5/user-manual.html#_catalog;>OFBiz
user documentation site / Catalog
-
diff --git a/applications/product/data/ProductHelpData.xml
b/applications/product/data/ProductHelpData.xml
index 720ec45..ccc43e1 100644
--- a/applications/product/data/ProductHelpData.xml
+++ b/applications/product/data/ProductHelpData.xml
@@ -22,28 +22,4 @@ under the License.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/applications/product/data/helpdata/HELP_IMAGEMANAGEMENT.xml
b/applications/product/data/helpdata/HELP_IMAGEMANAGEMENT.xml
deleted file mode 100644
index 21197c6..000
--- a/applications/product/data/helpdata/HELP_IMAGEMANAGEMENT.xml
+++ /dev/null
@@ -1,211 +0,0 @@
-
-
-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;>
-Image Management Help.
-The Image Management module manages many kind of image what user
want. There are various functions including 'Gallery', 'Upload', 'Approved',
'Manage' etc.
-
-
-
-Go to Catalog Component.
-Go to Image Management.
-
-
-
-
-How To Add Security Group For Image Management User
-There are three security groups related in the Image Management
including 'IMAGEADMIN', 'IMAGEAPPROVE' and ' IMAGEUPLO
[ofbiz-tools] branch master updated: Buildbot documentation, just a little add in using irc to force build for user with no knowledge of irc
This is an automated email from the ASF dual-hosted git repository. holivier pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/ofbiz-tools.git The following commit(s) were added to refs/heads/master by this push: new 12e5db9 Buildbot documentation, just a little add in using irc to force build for user with no knowledge of irc 12e5db9 is described below commit 12e5db9afb1ed42d8202de7a2b8f403dd37cf9e2 Author: holivier AuthorDate: Fri Jul 3 10:46:23 2020 +0200 Buildbot documentation, just a little add in using irc to force build for user with no knowledge of irc --- documentation/BuildBot/BuildBot.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/BuildBot/BuildBot.md b/documentation/BuildBot/BuildBot.md index 8521577..761ea2f 100644 --- a/documentation/BuildBot/BuildBot.md +++ b/documentation/BuildBot/BuildBot.md @@ -62,7 +62,7 @@ Some other errors may happen, like In such case you can trigger a build from IRC to see if the problem resolves by itself. Most of the time tests and svn issues are resolved this way. If it does not then the best is to ask Infra help, either on [HipChat infra room](https://apache.hipchat.com/chat/room/669587) or through the [service desk](https://issues.apache.org/jira/servicedesk/customer/portal/1/create/3) -When something like that happens, I get to IRC (using https://webchat.freenode.net). There using a recognisable username (I use jleroux) I get to the ofbiz channel. I wait for ofbiz-bot to appear, click on it, click on query and then I can make a request in the chat line to restart a build. +When something like that happens, I get to IRC (using https://webchat.freenode.net). There using a recognisable username (I use jleroux) I get to the ofbiz channel (#ofbiz). I wait for ofbiz-bot to appear in participant panel, click on it, click on query and then I can make a request in the chat line to restart a build. A request is of the form
