Attribute settings: GeoNames

From CollectiveAccess Documentation
Jump to: navigation, search

[Valid for v1.6]

GeoNames value. Takes search text, passes it to the GeoNames search service and provides a dropdown with search results (ordered by score). Selected geoname is stored as both text (name, country, continent and ID) and the service URL identifier.


The list (array) of attribute settings can be viewed in the application code at https://github.com/collectiveaccess/providence/blob/master/app/lib/ca/Attributes/Values/GeoNamesAttributeValue.php.

Settings Description Default Values
fieldWidth Width, in characters, of the field when displayed in a user interface. 60 Integers greater than zero
fieldHeight Height, in characters, of the field when displayed in a user interface. 1 Integers greater than zero
mustNotBeBlank Use this option if this attribute value must be set to some value - if, in other words, it must not be blank. 0 (can be blank) 0 or 1
doesNotTakeLocale Defines whether element takes locale specification. 1 (does not take locale specifications) 0 or 1
canBeEmpty Use this option if you want to allow empty attribute values. This - of course - only makes sense if you bundle several elements in a container. 0 0 or 1
canBeUsedInSort Use this option if this attribute value can be used for sorting of search results. 0 (not used in sort) 0 or 1
canBeUsedInSearchForm Use this option if the attribute value can be used in search forms. 1 (used in search forms) 0 or 1
canBeUsedInDisplay Use this option if the attribute value can be used for display in search results. 1 (used for display) 0 or 1
displayTemplate Layout for value when used in a display. Element code tags prefixed with the ^ character, used to represent the value in the template. For example: <i>^my_element_code</i>. HTML
displayDelimiter Delimiter to use between multiple values. ; (semicolon) Text
disableMap Check this option if you want to disable location map display. 0 0 or 1
maxResults Determines the maximum number of results returned by GeoNames. Tweak this number if you want to speed up lookups. 20 Integers greater than zero
gnElements Comma-separated list of GeoNames attributes to be pulled from the service to build the text representation for the selected location. See http://www.geonames.org/export/geonames-search.html for further reference, including the available element names. Note that latitude and longitude are always added to the text value to enable map display. Text
gnDelimiter Delimiter to use between multiple values pulled from GeoNames service. , (comma) Text
canMakePDF Check this option if this metadata element can be output as a printable PDF. (The default is not to be.) 0 0 or 1
CanMakePDFForValue Check this option if individual values for this metadata element can be output as a printable PDF. (The default is not to be.) 0 0 or 1

i_sphinx

Namespaces

Variants
Actions
Navigation
Tools
User
Personal tools