Skip to content

Commit

Permalink
[#252]: Improve AH domain docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Ruhanga committed Nov 7, 2023
1 parent 7281385 commit c9464a8
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion readme/addresshierarchy.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,27 @@ 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 look something like;

```
___________________________ ___________________________ _____
| addresshierarchy.cambodia | addresshierarchy.meanchey | ... |
| addresshierarchy.cambodia | addresshierarchy.banteay | ... |
--------------------------- --------------------------- -----
```
Where the `addresshierarchy.cambodia`, `addresshierarchy.meanchey` and `addresshierarchy.banteay` become candidates for the `.properties` files to allow for name localization.

#### Requirements
* The [Address Hierarchy module](https://addons.openmrs.org/show/org.openmrs.module.addresshierarchy) version 2.17.0 or above must be installed.
Expand Down

0 comments on commit c9464a8

Please sign in to comment.