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 34291541a00fa75119311ba510b2b962e331d8f2
Author: holivier <holiv...@apache.org>
AuthorDate: Fri Apr 3 15:11:37 2020 +0200
Documented: Party migration to asciidoc
(OFBIZ-11581)
For all of HELP_Party files content has been directly put in
party.adoc
user-manual is updated to include it in.
---
applications/party/src/docs/asciidoc/party.adoc | 59 +++++++++++++++++++++++++
docs/asciidoc/user-manual.adoc | 2 +
2 files changed, 61 insertions(+)
diff --git a/applications/party/src/docs/asciidoc/party.adoc
b/applications/party/src/docs/asciidoc/party.adoc
new file mode 100644
index 0000000..853ca78
--- /dev/null
+++ b/applications/party/src/docs/asciidoc/party.adoc
@@ -0,0 +1,59 @@
+////
+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.
+////
+= Party
+
+The Party Manager application is used to manage the parties, i.e any legal
entity your company has to deal with.
+
+== Overview
+TODO
+
+== Parties management
+
+=== Help for The Party Find screen.
+The 'Find Party' is the default screen for the Party Manager application. +
+It is used to locate existing parties. +
+Various search criteria can be used, either based on the general party data
like name role and type
+but also on the postal address, telephone (Telecom) and other like email
address.
+
+If the find button is pressed, a list is presented containing several columns.
+
+The first column shows the Party ID.
+This is a string that uniquely identifies the Party in the system.
+
+The second column shows the Party logins. +
+This is the string the user enters when logging into the system. +
+A single Party can have more than one login.
+In this case the "(many)" string is showed in place of the login string.
+The complete list of user logins can still be seen in the Party details screen.
+If a Party has no user login associated the string "(none)" is shown.
+
+In the "Main Roletype" column the role is listed which is a child of the "Main
role"" roletype.
+It is currently set to "Organisation" and "SFA Role". The later to be prepared
to use he party in he SFA component.
+See the <<_marketing,marketing application>> for more information
+
+
+== Communications
+
+== Visits
+
+== Classifications
+
+== Security
+
+== Miscellaneous
\ No newline at end of file
diff --git a/docs/asciidoc/user-manual.adoc b/docs/asciidoc/user-manual.adoc
index 99449b5..48386c5 100644
--- a/docs/asciidoc/user-manual.adoc
+++ b/docs/asciidoc/user-manual.adoc
@@ -166,3 +166,5 @@
include::../../applications/marketing/src/docs/asciidoc/marketing.adoc[leveloffs
include::../../applications/marketing/src/docs/asciidoc/sfa.adoc[leveloffset=+2]
include::../../applications/order/src/docs/asciidoc/order.adoc[leveloffset=+2]
+
+include::../../applications/party/src/docs/asciidoc/party.adoc[leveloffset=+2]
