projectdoc Toolbox

A list of Property Names.

Type
The data type Property Names is a list of property names.

Details

Information to specify properties and parameters of this type.

List

The elements of a list are single values.

The constraints for single values apply for each element of the list.

Single Value

The definition of a single value may come in different forms. Often a value is simply added as the value of a parameter or property.

A single value may be an HTML fragment such as a link, if the element type supports HTML. This is the case for space and document properties, but not for macro parameters or doctype properties. For space and document properties exist a text (encoded by a $ suffix) and a normalized (encoded by a § suffix) version for a property value. In case of an HTML link the text version is the label, the normalized version is the URI of the link.

Since single values may be specified as members of a list they typically must not contain a comma. Also single values are matched in queries and therefore must not contain any characters that are significant in searches.

The following characters are typically not allowed.

  1. comma
  2. opening an closing bracket of any kind
  3. quotes or double quotes

The current version of the projectdoc Toolbox does not provide tools to escape characters. This may change in future versions so that the characters above may be allowed.

Property Name

A property name is a sequence of characters that identifies a property of a space or document.

Property names are defined inside a Document Properties Marker Macro or one of its cousins. A property name is unique within its context.

Besides the characters that are discouraged by the single value type, the following characters are also not allowed. All uses of non-letter or digits as first or last character of a property name are discouraged.

  1. Characters used as name encodings
    1. $ suffix, used for text version of a property
    2. § suffix, used for normalized version of a property
    3. + suffix, used for link indicators in macro parameters
    4. - prefix, used in title/identifier references in macro parameters
    5. ! prefix, used in title/identifier references in macro parameters 

Use

List of elements that declare this data type.

NameDoctypeShort Description
projectdoc Display in Property Name References
document-property
Lists the names of all properties that are referenced by a given projectdoc document via display property macros.
projectdoc Property Name References
document-property
Lists the names of all properties that are referenced by a given projectdoc document.
projectdoc Property Names
document-property
Lists the names of all properties, excluding projectdoc metadata properties, of a projectdoc document.
projectdoc Select in Property Name References
document-property
Lists the names of all properties that are referenced by Select parameters in a projectdoc document.
projectdoc Sort By in Property Name References
document-property
Lists the names of all properties that are referenced by a given projectdoc document in Sort By parameters.
projectdoc Where in Property Name References
document-property
Lists the names of all properties that are referenced by Where parameters in a projectdoc document.