Attribute settings: Container

From CollectiveAccess Documentation
Jump to: navigation, search

[Valid for v1.6]

Unlike all other attribute types, containers do not represent data values. Rather their sole function is to organize attributes into groups for display. In a multi-attribute value set (for example an address with separate attributes for street number, city, state, country and postal code), there will be at least one container serving as the "root" (or top) of the attribute hierarchy. Other containers may serve to further group items in the multi-attribute set into sub-groups displayed on separate lines of a form.

ExampleContainer.png

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/ContainerAttributeValue.php.

i_sphinx
Settings Description Default Values
doesNotTakeLocale Defines whether element take locale specification. 0 (takes locale) 0 or 1
lineBreakAfterNumberOfElements Number of metadata elements after which a line break should be inserted. 0 (no line breaks) Integers zero or greater
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>. Display_Templates
displayDelimiter Delimiter to use between multiple values. ; (semicolon) Text
readonlyTemplate Layout used when a container value is in read-only mode. If this template is set, existing values are always displayed in read-only mode until you click to edit. This can be used to preserve screen space for large containers.

Element code tags prefixed with the ^ character, used to represent the value in the template. For example: ^ca_objects.my_notes. Each of these templates is evaluated relative to a specific value instance for this container, so other display template elements like <unit>, <ifdef> or <more> might not work exactly as expected. More general notes on display templates are here: Display_Templates

HTML
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
Namespaces

Variants
Actions
Navigation
Tools
User
Personal tools