From a61bbc73f2e816021af2175c2af4d545b297d540 Mon Sep 17 00:00:00 2001 From: jensp Date: Thu, 6 Jun 2019 17:13:16 +0000 Subject: [PATCH] Documentation for the Freemarker functions provided by ccm-cms-types-address git-svn-id: https://svn.libreccm.org/ccm/trunk@6110 8810af33-2d31-482b-a856-94f89814c4df --- .../doc/freemarker/ccm-cms-types-address.md | 28 +++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 ccm-cms-types-address/doc/freemarker/ccm-cms-types-address.md diff --git a/ccm-cms-types-address/doc/freemarker/ccm-cms-types-address.md b/ccm-cms-types-address/doc/freemarker/ccm-cms-types-address.md new file mode 100644 index 000000000..138760440 --- /dev/null +++ b/ccm-cms-types-address/doc/freemarker/ccm-cms-types-address.md @@ -0,0 +1,28 @@ +# Freemarker functions for ccm-cms-types-address + +Import Path +: `/ccm-cms-type-address.ftl` + +## `getAddressText(item: Node): String` + +Returns the value of the `text` property of the address. + +## `getCity(item: Node): String` + +Returns the value of the `city` property of the address. + +## `getPostalCode(item: Node): String` + +Gets the postal code of the address. + +## `getState(item: Node): String` + +Gets the value of the `state` property of the address. (state means the a federal state or the equivialent here, for example California in the USA oder Lower Saxony in Germany) + +## `getCountry(item: Node): String` + +The country of the address. + +## `getIsoCountryCode(item: Node): String` + +Gets the ISO country code for the country of the address. \ No newline at end of file