You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ofbiz.apache.org by ho...@apache.org on 2020/07/02 10:21:00 UTC
[ofbiz-framework] 02/02: Documented: migrate help link to asciidoc
user manual for Party (OFBIZ-11581)
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 ef58d647b66bb3b63dc462642cf90652189cf2a7
Author: holivier <ho...@apache.org>
AuthorDate: Thu Jul 2 12:18:11 2020 +0200
Documented: migrate help link to asciidoc user manual for Party
(OFBIZ-11581)
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
Party and add a short page with a link to the new help
Remove docbook help files for Party
---
applications/content/data/PartyHelpData.xml | 12 +++-----
.../party/data/{helpdata => }/HELP_PARTY.xml | 13 ++++----
.../party/data/helpdata/HELP_PARTY_findparty.xml | 35 ----------------------
.../party/widget/partymgr/CommonScreens.xml | 1 +
.../party/widget/partymgr/PartyScreens.xml | 7 +++--
5 files changed, 17 insertions(+), 51 deletions(-)
diff --git a/applications/content/data/PartyHelpData.xml b/applications/content/data/PartyHelpData.xml
index 7068633..d0bccca 100644
--- a/applications/content/data/PartyHelpData.xml
+++ b/applications/content/data/PartyHelpData.xml
@@ -19,15 +19,11 @@ under the License.
-->
<entity-engine-xml>
<!-- party help data -->
- <DataResource dataResourceId="HELP_PARTY" localeString="en" dataResourceTypeId="OFBIZ_FILE"
- objectInfo="applications/party/data/helpdata/HELP_PARTY.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS"
+ <DataResource dataResourceId="HELP_PARTY" localeString="en" dataResourceTypeId="OFBIZ_FILE"
+ objectInfo="applications/party/data/HELP_PARTY.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS"
dataResourceName="Party Overview" mimeTypeId="text/xml" isPublic="Y" />
- <Content contentId="HELP_PARTY" contentTypeId="DOCUMENT" contentName="Party Manager" templateDataResourceId="HELP_TEMPL"
+ <Content contentId="HELP_PARTY" contentTypeId="DOCUMENT" contentName="Party Manager" templateDataResourceId="HELP_TEMPL"
dataResourceId="HELP_PARTY" statusId="CTNT_IN_PROGRESS" mimeTypeId="text/html"/>
<ContentAssoc contentId="HELP_ROOT" contentIdTo="HELP_PARTY" contentAssocTypeId="TREE_CHILD" fromDate="2006-01-12 01:01:01" sequenceNum="000"/>
-
- <DataResource dataResourceId="PARTY_findparty" localeString="en" dataResourceTypeId="OFBIZ_FILE"
- objectInfo="applications/party/data/helpdata/HELP_PARTY_findparty.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS" dataResourceName="List parties Help" mimeTypeId="text/xml" isPublic="Y" />
- <Content contentId="PARTY_findparty" contentTypeId="DOCUMENT" contentName="List parties Help" templateDataResourceId="HELP_TEMPL" dataResourceId="PARTY_findparty" statusId="CTNT_IN_PROGRESS" mimeTypeId="text/html"/>
- <ContentAssoc contentId="HELP_PARTY" contentIdTo="PARTY_findparty" contentAssocTypeId="TREE_CHILD" fromDate="2006-01-12 01:01:01" sequenceNum="000" mapKey="PARTY_findparty"/>
+
</entity-engine-xml>
\ No newline at end of file
diff --git a/applications/party/data/helpdata/HELP_PARTY.xml b/applications/party/data/HELP_PARTY.xml
similarity index 76%
rename from applications/party/data/helpdata/HELP_PARTY.xml
rename to applications/party/data/HELP_PARTY.xml
index cd2fd94..f25af71 100644
--- a/applications/party/data/helpdata/HELP_PARTY.xml
+++ b/applications/party/data/HELP_PARTY.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,14 +17,17 @@ KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0"
- xmlns:xl="http://www.w3.org/1999/xlink"
+<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0"
+ xmlns:xl="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
xmlns="http://docbook.org/ns/docbook">
- <title>The Party Manager Application</title>
+ <title>The Party Manager Help redirection</title>
<para>
The Party Manager application is used to manage the parties, i.e any legal entity your company has to deal with.
</para>
+ <para>Party Help has been migrated to a new system, you can access it by using
+ <link xl:href="https://ci.apache.org/projects/ofbiz/site/trunk/ofbizdoc/html5/user-manual.html#_party">OFBiz user documentation site / Party</link>
+ </para>
</section>
diff --git a/applications/party/data/helpdata/HELP_PARTY_findparty.xml b/applications/party/data/helpdata/HELP_PARTY_findparty.xml
deleted file mode 100644
index 8b9176d..0000000
--- a/applications/party/data/helpdata/HELP_PARTY_findparty.xml
+++ /dev/null
@@ -1,35 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version
-2.0 (the "License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0 Unless required by
-applicable law or agreed to in writing, software distributed under the
-License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-CONDITIONS OF ANY KIND, either express or implied. See the License for
-the specific language governing permissions and limitations under the
-License.
--->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0"
- xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"
- xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
- <title>The Party Find help screen.</title>
- <para>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.</para>
- <para>If the find button is pressed, a list is presented containing several columns.</para>
- <para>The first column shows the Party ID. This is a string that uniquely identifies the Party in the system.</para>
- <para>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.</para>
- <para></para>
- <para></para>
- <para>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 application for more
- information</para>
-</section>
diff --git a/applications/party/widget/partymgr/CommonScreens.xml b/applications/party/widget/partymgr/CommonScreens.xml
index c8d7631..6f728e7 100644
--- a/applications/party/widget/partymgr/CommonScreens.xml
+++ b/applications/party/widget/partymgr/CommonScreens.xml
@@ -49,6 +49,7 @@ under the License.
<set field="activeApp" value="partymgr" global="true"/>
<set field="applicationMenuName" value="PartyAppBar" global="true"/>
<set field="applicationMenuLocation" value="component://party/widget/partymgr/PartyMenus.xml" global="true"/>
+ <set field="helpAnchor" from-field="helpAnchor" default-value="_party"/>
<set field="applicationTitle" from-field="uiLabelMap.PartyManagerApplication" global="true"/>
</actions>
<widgets>
diff --git a/applications/party/widget/partymgr/PartyScreens.xml b/applications/party/widget/partymgr/PartyScreens.xml
index 460522f..596ed89 100644
--- a/applications/party/widget/partymgr/PartyScreens.xml
+++ b/applications/party/widget/partymgr/PartyScreens.xml
@@ -28,13 +28,14 @@ under the License.
<set field="titleProperty" value="PageTitleFindParty"/>
<set field="headerItem" value="find"/>
<set field="tabButtonItem" value="findparty"/>
+ <set field="helpAnchor" value="_help_for_the_party_find_screen"/>
<!-- asmselect parameters, must be prefixed by asm_ for SetMultipleSelectJs.ftl -->
<set field="asm_multipleSelectForm" value="LookupParty"/>
<set field="asm_multipleSelect" value="LookupParty_partyClassificationGroupId"/>
<set field="asm_formSize" value="700"/>
<set field="asm_listItemPercentOfForm" value="95"/>
<set field="asm_sortable" value="false"/>
-
+
<set field="initialyCollapsed" value="${groovy:'Y'.equals(parameters.hideFields)}" type="String"/>
<script location="component://party/groovyScripts/party/FindParty.groovy"/>
</actions>
@@ -576,7 +577,7 @@ under the License.
</widgets>
</section>
</screen>
-
+
<screen name="CreatePartyRelatedAccount">
<section>
<actions>
@@ -1418,5 +1419,5 @@ under the License.
</widgets>
</section>
</screen>
-
+
</screens>