Property

Key point: A name-value pair to provide fielded data in your documents and their metadata.

A PSML property lets you define a field within your document by associating one or multiple values with a name. You can use different types of values including text, dates, values from a list, or rich text.

Properties are indexed in your document, making them automatically available as search fields. You can use them to narrow down your search or display their values in search results. Some properties can be edited directly from search results.

PSML properties are useful to:

  • Organize documents sharing the same characteristics.
  • Enforce a particular set of fields to associate with your documents.
  • Use in placeholders (metadata properties only).

Property in detail

Each property has the following characteristics:

Datatype

The datatype determines what kind of value the property can hold. See details under property datatypes.

Multiple

A flag indicating whether the property has a single value or multiple values. When a property has multiple values, they are displayed as a list. In the editor, users can add and remove values.

Note that Placeholders can only be mapped to single value properties.

Name

The name of a property is what PageSeeder uses internally to reference the property and for searches.

The name of a property can only include letters, numbers, dashes (-) and underscores (_).

If no title is defined, PageSeeder automatically displays the name instead, capitalizing it and replacing underscores with spaces for better readability.

Title

The title provides a more user-friendly alternative to the name when displaying the property.

Use titles when the property name is difficult to read, when you need characters not allowed in names, or to use different capitalization.

Value

The value of the property – or values if the property has the multiple flag. Multiple values of a property all share the same datatype.

Property datatypes

Property values have the following datatypes:

Text

This is the default datatype. Any text content can be used, with configurable input methods including text boxes, drop-down menus, or checkboxes for selecting from predefined values.

Additional constraints can ensure values are unique, match specific patterns, or come from a defined list.

Text values are limited to plain text. For formatting options like bold or italic, use markdown or markup datatypes.

Date

Date values use the "YYYY-MM-DD" format. These properties are indexed as dates, enabling date range searches. The editor provides a date picker for user input.

Xref

For a PSML xref, the editor allows users to select existing documents or create new ones to link to. This can be configured to restrict links to specific document types.

Markdown and markup

For text values that require additional formatting, such as bold or italic and/or need to include headings, paragraphs or lists, the editor provides a rich text editor with the available formatting options.

For developers

The PSML element for a property is <property>.

The built-in document types on PageSeeder don’t include properties – you need to define a document type and a document template with a properties fragment or a metadata fragment.

You can configure the editing experience in the editing configuration of the document type, including the type of value that can be entered by end-users and other constraints.