From f148251a3596561e84923a26911270d588b1bd00 Mon Sep 17 00:00:00 2001
From: "j.goderbauer" <j.goderbauer@adito.de>
Date: Thu, 10 Jan 2019 15:06:41 +0100
Subject: [PATCH] =?UTF-8?q?[Projekt:=20Entwicklung=20-=20Neon][TicketNr.:?=
 =?UTF-8?q?=201030874][=20Technische=20Doku=20-=20Review=20und=20Erg=C3=A4?=
 =?UTF-8?q?nzen]=20ORG?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 entity/Org_entity/Org_entity.aod                            | 3 +++
 entity/Org_entity/documentation.adoc                        | 6 ++++++
 entity/Org_entity/entityfields/newoffer/documentation.adoc  | 1 +
 .../entityfields/openeditdefaultsview/documentation.adoc    | 2 ++
 4 files changed, 12 insertions(+)
 create mode 100644 entity/Org_entity/documentation.adoc
 create mode 100644 entity/Org_entity/entityfields/newoffer/documentation.adoc
 create mode 100644 entity/Org_entity/entityfields/openeditdefaultsview/documentation.adoc

diff --git a/entity/Org_entity/Org_entity.aod b/entity/Org_entity/Org_entity.aod
index d56039b2ba6..06e172f4e41 100644
--- a/entity/Org_entity/Org_entity.aod
+++ b/entity/Org_entity/Org_entity.aod
@@ -3,6 +3,7 @@
   <name>Org_entity</name>
   <title>Company</title>
   <majorModelMode>DISTRIBUTED</majorModelMode>
+  <documentation>%aditoprj%/entity/Org_entity/documentation.adoc</documentation>
   <iconId>VAADIN:BUILDING</iconId>
   <imageProcess>%aditoprj%/entity/Org_entity/imageProcess.js</imageProcess>
   <titleProcess>%aditoprj%/entity/Org_entity/titleProcess.js</titleProcess>
@@ -331,6 +332,7 @@
     <entityActionField>
       <name>openEditDefaultsView</name>
       <fieldType>ACTION</fieldType>
+      <documentation>%aditoprj%/entity/Org_entity/entityfields/openeditdefaultsview/documentation.adoc</documentation>
       <title>Edit defaults</title>
       <onActionProcess>%aditoprj%/entity/Org_entity/entityfields/openeditdefaultsview/onActionProcess.js</onActionProcess>
       <iconId>NEON:WRENCH</iconId>
@@ -338,6 +340,7 @@
     <entityActionField>
       <name>newOffer</name>
       <fieldType>ACTION</fieldType>
+      <documentation>%aditoprj%/entity/Org_entity/entityfields/newoffer/documentation.adoc</documentation>
       <title>New offer</title>
       <onActionProcess>%aditoprj%/entity/Org_entity/entityfields/newoffer/onActionProcess.js</onActionProcess>
       <iconId>VAADIN:CART</iconId>
diff --git a/entity/Org_entity/documentation.adoc b/entity/Org_entity/documentation.adoc
new file mode 100644
index 00000000000..4c424a2c45f
--- /dev/null
+++ b/entity/Org_entity/documentation.adoc
@@ -0,0 +1,6 @@
+An entity for handling organisations (companies).
+
+Besides storing the main data of a company, standard values can be set:
+
+* setting the standard postal address (field directly connected to the db record container)
+* setting standard comm enties (e.g. standard phone or standard email); this is done by performing additional actions onUpdate
diff --git a/entity/Org_entity/entityfields/newoffer/documentation.adoc b/entity/Org_entity/entityfields/newoffer/documentation.adoc
new file mode 100644
index 00000000000..b699f50fce2
--- /dev/null
+++ b/entity/Org_entity/entityfields/newoffer/documentation.adoc
@@ -0,0 +1 @@
+Opens a new OFFER-entry with the current ORG as preset.
\ No newline at end of file
diff --git a/entity/Org_entity/entityfields/openeditdefaultsview/documentation.adoc b/entity/Org_entity/entityfields/openeditdefaultsview/documentation.adoc
new file mode 100644
index 00000000000..a1972d90772
--- /dev/null
+++ b/entity/Org_entity/entityfields/openeditdefaultsview/documentation.adoc
@@ -0,0 +1,2 @@
+This action opens a view where standard values can be changed for a ORG. 
+For example, this could be a standard mail-address (COMM entries) or the standard (postal) address.
-- 
GitLab