From 9ada09ae60e3085ad1092f5948330059718327f0 Mon Sep 17 00:00:00 2001
From: Johannes Hoermann <j.hoermann@adito.de>
Date: Tue, 5 Nov 2019 11:50:09 +0100
Subject: [PATCH] Address validation explanation

---
 neonContext/Address/Address.aod                   |  1 +
 neonContext/Address/documentation.adoc            |  3 +++
 .../AddressValidation/AddressValidation.aod       |  1 +
 neonContext/AddressValidation/documentation.adoc  | 15 +++++++++++++++
 4 files changed, 20 insertions(+)
 create mode 100644 neonContext/Address/documentation.adoc
 create mode 100644 neonContext/AddressValidation/documentation.adoc

diff --git a/neonContext/Address/Address.aod b/neonContext/Address/Address.aod
index 13b957704c..d52b486fe7 100644
--- a/neonContext/Address/Address.aod
+++ b/neonContext/Address/Address.aod
@@ -3,6 +3,7 @@
   <name>Address</name>
   <title>Addresses</title>
   <majorModelMode>DISTRIBUTED</majorModelMode>
+  <documentation>%aditoprj%/neonContext/Address/documentation.adoc</documentation>
   <lookupView>AddressLookup_view</lookupView>
   <entity>Address_entity</entity>
   <references>
diff --git a/neonContext/Address/documentation.adoc b/neonContext/Address/documentation.adoc
new file mode 100644
index 0000000000..760bf36323
--- /dev/null
+++ b/neonContext/Address/documentation.adoc
@@ -0,0 +1,3 @@
+The address Entity provides addresses for contacts.
+
+If you need address completion / validation support, see documentatioin of AddressValidation Context.
\ No newline at end of file
diff --git a/neonContext/AddressValidation/AddressValidation.aod b/neonContext/AddressValidation/AddressValidation.aod
index 38a48ce6cf..1671b0b213 100644
--- a/neonContext/AddressValidation/AddressValidation.aod
+++ b/neonContext/AddressValidation/AddressValidation.aod
@@ -2,6 +2,7 @@
 <neonContext xmlns="http://www.adito.de/2018/ao/Model" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" VERSION="1.1.1" xsi:schemaLocation="http://www.adito.de/2018/ao/Model adito://models/xsd/neonContext/1.1.1">
   <name>AddressValidation</name>
   <majorModelMode>DISTRIBUTED</majorModelMode>
+  <documentation>%aditoprj%/neonContext/AddressValidation/documentation.adoc</documentation>
   <lookupView>AddressValidationLookup_view</lookupView>
   <entity>AddressValidation_entity</entity>
   <references>
diff --git a/neonContext/AddressValidation/documentation.adoc b/neonContext/AddressValidation/documentation.adoc
new file mode 100644
index 0000000000..cce138a1fb
--- /dev/null
+++ b/neonContext/AddressValidation/documentation.adoc
@@ -0,0 +1,15 @@
+The AddressValidation Context provides a way to load a list of valid addresses by using a custom datasource (e.g. a webservice) based on the user input.
+
+To enable the address-lookups for the address-entity, go to 
+preferences -> _____PREFERENCES_PROJECT -> _____PREFERENCES_PROJECT (in the navigator) -> and enable the checkbox "nominatim.enable"
+
+There are the following configurations are possible to control the nominatim-server, which is used in xrmBasic:
+"nominatim.enable"
+"nominatim.url"
+"nominatim.user"
+"nominatim.pw"
+
+If you would like to use a different webservice (or other datasource are also possible), you can extend the WsValidation_lib.
+See the documentation inside of the lib.
+Basically you just have to add a new type and the respective callbacks.
+
-- 
GitLab