| Attributes |
| Name | Required | Request-time | Type | Description |
| name | true | true | java.lang.String | This attribute specifies the property name. |
| file | false | true | java.lang.String | This attribute allows you to specify where to search for the property.
The following values are supported: - uri (default)
- Look up the property on the file with the uri requested by the user.
- search.uri or search
- Look up the property by also checking all parent folders for the property, starting with the file with uri requested by the user and going "upward" if the property was not found there.
- element.uri
- Look up the property on the currently processed sub - element. This is useful in templates or other pages that consist of many elements.
- search.element.uri
- Look up the property by also checking all parent folders for the property, starting with the file with the currently processed sub - element and going "upward" if the property was not found there.
- sitemap
- reads from the current sitemap entry
- search.sitemap
- Look up the property by also checking all parent sitemap entries for the property, starting with the current sitemap entry and going "upward" if the property was not found there.
- container
- reads from the current container element
- {some-file-uri}
- Look up the property on that exact file uri in the OpenCms VFS, fallback if no other valid option is selected for the file attribute.
|
| escapeHtml | false | true | java.lang.String | This attribute allows you to escape HTML code in the returned value.
The following values are supported: - false (default)
- HTML is not escaped.
- true
- HTML is escaped.
|
| default | false | true | java.lang.String | The value returned if the property is not found for the specified file. |
| locale | false | true | java.lang.String | The locale, for which possibly existing locale specific versions of the property should be read. E.g., if you read the property "Title" for the locale "de_DE", then "Title_de_DE" will be read first, and only if it does not exist, "Title_de" and "Title" are tried as well. |