Charity Radar Documentation

You've loaded an old revision of the document! If you save it, you will create a new version with this data.

====== Address Templates ======

International mailing [[:addresses|addresses]] vary a great deal.  Most of the address can be stored as plain text.  However, certain parts need to be separated so that users can perform analytics on the data.  For example: finding everyone in a town or everyone within 20 miles of a postcode.

The address will be stored as one or more plain text lines plus any combination of these fields:
  * Town
  * Postoffice
  * Postcode
  * Region
  * State

The country table will include a template specifying which fields to include, their field name and the order in which they should appear.  It will also show how the fields should be displayed when formatted into an address for printing.

An example template for UK addresses:\\
''[TEXT]\\
[Town|Town]\\
[Postcode|Postcode]\\
[Region|County]''\\

Or for an address in Hungary:\\
''[Town|City]\\
[TEXT]\\
[Postcode|Postal Code]''\\

In these examples, ''[TEXT]'' provides one or more lines of plain text.  The remaining fields are stored in the named field and labelled as the second field.  So ''[Postcode|Postal Code]'' stores the data in the Postcode field but labels it as Postal Code for both the input field and the formatted output.

[[:users|Users]] who are a //SYSADMIN// or a //GOD// will be able to add new countries with templates as well as adding new ones.

Edit summary