[#252]: Improve AH domain docs

mekomsolutions · Nov 7, 2023 · 16c88f3 · 16c88f3
1 parent 7281385
commit 16c88f3
Showing 1 changed file with 18 additions and 1 deletion.
diff --git a/readme/addresshierarchy.md b/readme/addresshierarchy.md
@@ -66,7 +66,24 @@ In this Haiti example, the configuration loader will map address field and hiera
 | `ADDRESS_2`      | -               |
 
 ###### I18n `.properties` files *(optional)*
-* The i18n `.properties` files are used to populate the address/location i18n cache. The messages files can be similarly defined as those loaded by the [messageproperties](readme/messageproperties.md) domain.
+* The i18n `.properties` files are used to populate the address/location i18n cache. The messages files can be similarly defined as those loaded by the [messageproperties](readme/messageproperties.md) domain. The message properties are usable as actual Location or Address names. For example, typical Location lines  could look something like;
+
+```
+ ______________________________________ _____________ ___________________________ ___________________________ _______________________ _________________ _____
+| Uuid                                 | Void/Retire | Name                      | Parent                    | Tag|Facility Location | Address 1       | ... |
+|--------------------------------------|-------------|---------------------------|---------------------------|-----------------------|-----------------|-----|
+| a03e395c-b881-49b7-b6fc-983f6bddc7fc | false       | addresshierarchy.cambodia |                           | TRUE                  | Paradise Street | ... |
+| cbaaaab4-d960-4ae9-9b6a-8983fbd947b6 | true        | addresshierarchy.meanchey | addresshierarchy.cambodia |                       |                 | ... |
+ -------------------------------------- ------------- --------------------------- --------------------------- ----------------------- ----------------- -----
+```
+And typical Address Hierarchy entries could  something like;
+
+```
+ ___________________________ ___________________________ _____
+| addresshierarchy.cambodia | addresshierarchy.meanchey | ... |
+| addresshierarchy.cambodia | addresshierarchy.banteay  | ... |
+ --------------------------- --------------------------- -----
+```
 
 #### Requirements
 * The [Address Hierarchy module](https://addons.openmrs.org/show/org.openmrs.module.addresshierarchy) version 2.17.0 or above must be installed.