Artificial Properties

In addition to the properties specified in the document properties table, projectdoc provides additional properties drawn from Confluence or metadata.

Audience
Author, Documentation Architect, Documentation Gardener
Type
Reference

Artificial properties are derived properties added to documents and therefore made available to users for displaying and adding constraints for queries.

Properties in different Representations

A property may provide its value in different representations.

The basic concept it that the pure text representation of a property has the same name as the property, but puts a dollar sign ($) at the end. In case the value has a canonical representation, then the name is extended by the paragraph sign (§).

The projectdoc Toolbox provides different representations for dates and URLs (uniform resource locators).

Dates

If a document property value is a date using the time element (create with two slashes '//') then the projectdoc Toolbox will provide a standard rendered value in pure text ('$' version) and a normalized representation of the date ('§' version). The normalized representation can be used to order the elements by the date.

Uniform Resource Locators

For each HTML link with an absolute URL the projectdoc Toolbox provides the names of the link labels ('$' version) and the list of URLs from the HTML href attribute ('§' version).

A URL is considered to be absolute if it includes the scheme (e.g. http://).

Users

The creator's and last modifier's login name is rendered by Creator and Last Modifier.

Adding a '$' renders the full name.

Overriding Artificial Properties

To put full control over the naming of properties into the hands of the users, it is possible to override artificial properties by adding a property with the same name to the projectdoc document.

You cannot override encoded property names, like the text (suffix '$') and normalized (suffix '§') properties.

List of Artificial Properties

The following properties are provided by the projectdoc Toolbox to projectdoc documents per default.

Name Short Description Data Type
AncestorIds
The list of document IDs, starting from the root page, excluding the ID of this page.
Comma-separated List of Long Numbers (String)
AncestorNames
The list of document names, starting from the root page, excluding the name of this page.
Comma-separated List (String)
AncestorTypeIds
The list of parent document IDs, starting from the hierarchy's root document.
Comma-separated List (long)
AncestorTypeNames
The list of parent document names, starting from the hierarchy's root document.
Comma-separated List (String)
Auto ID
The automatically generated identifier for a document. The services needs to be configured per doctype with a space property.
String
Creation Date
The date the document has been created. The value is created by Confluence.
Date
Creation Time
The hour of day of the date the document has been created. The value is created by Confluence.
Date
Creator
The name of the user who created the document. This value is generated by Confluence.
User Name
Delegate Document Doctype
The type of the document this document delegates to.
String
Delegate Document Name
The name of the document this document delegates to.
String
Delegate Document Page Link
The page link to the document this document delegates to.
HTML Link
Delegate Document Page Reference
The page reference (space-key.page-title) of the document this document delegates to.
String
DirectAncestorId
The internal Confluence page identifier of the page's parent.
long
DirectAncestorTitle
The title of the parent document.
String
Doctype Homepage
Provides a link to the document's type homepage.
Link
DocumentPropertyRefs
Tracks direct property references a document is defining.
List of Strings
Index Key
The key to the lookup the document within its context. The index key is typically the first character of the name. It may be defined by the author as a document property to override the default.
String
Last Modification Date
The date the document had been modified lately. The date is generated by Confluence.
Date
Last Modification Time
The time of day of the date the document had been modified lately. The date is generated by Confluence.
String
Last Modifier
The name of the user who added the last modifications to the document. The value is generated by Confluence.
User Name
Last Version Comment
The last comment added by the last modifier for the Confluence page.
String
Last Version Number with Comment
The last version Number that actually has a comment.
Integer
Page ID
The unique identifier of the page. This is the page ID provided by Confluence.
long
Page Key
Unique reference of a page within a Confluence site.
String
projectdoc Anchor IDs in Document Part References
Lists identifiers used by macros of a projectdoc document to identify anchored content on other documents.
Content Identifiers
projectdoc Anchor Link Documents
Provides access to documents with body links to anchors in this or other documents.
projectdoc Anchor Links
Provides access to body links to anchors in this or other documents.
projectdoc CSS Class References
Lists all used CSS classes of a given projectdoc document that are mentioned as parameters of projectdoc macros.
CSS Classes
projectdoc Display in Property Name References
Lists the names of all properties that are referenced by a given projectdoc document via display property macros.
Property Names
projectdoc Document Name References
Lists the names of all documents that are referenced by a given projectdoc document.
Document Name
projectdoc Dynamic Link Titles
Lists the titles of all pages targeted by dynamic links.
Document Titles
projectdoc IDs for Document Part References
Lists identifiers used by macros of a projectdoc document to identify content on other documents.
Content Identifiers
projectdoc IDs for Document Parts
Lists all used part identifier of a given projectdoc document.
Content Identifiers
projectdoc Macro Parameter Name References
Lists the names of all macro parameters that are referenced by a given projectdoc document.
Macro Parameter Names
projectdoc Macro Parameter Name References in Remote Control
Lists macro parameter names used in the context of remote controls.
Macro Parameter Name
projectdoc Macro Parameter Names
Lists the parameter names of all macros on a projectdoc document.
Macro Parameter Names
projectdoc Property Control Name References
Lists the control names used by properties of a projectdoc document.
Property Control Names
projectdoc Property Control Value References
Lists the control values used by properties of a projectdoc document.
Property Control Values
projectdoc Property Name References
Lists the names of all properties that are referenced by a given projectdoc document.
Property Names
projectdoc Property Names
Lists the names of all properties, excluding projectdoc metadata properties, of a projectdoc document.
Property Names
projectdoc Property Value References
Lists all values for matching property values. Includes only literal values, not property name references.
Strings
projectdoc Property Values
Lists the values of all properties, excluding projectdoc metadata properties, of a projectdoc document.
Strings
projectdoc Select in Property Name References
Lists the names of all properties that are referenced by Select parameters in a projectdoc document.
Property Names
projectdoc Sort By in Property Name References
Lists the names of all properties that are referenced by a given projectdoc document in Sort By parameters.
Property Names
projectdoc Tags for Document Parts
Lists all used part identifier classes or tags of a given projectdoc document.
Content Tags
projectdoc Tags in Document Part References
Lists tags used by macros of a projectdoc document to identify content on other documents.
Content Tags
projectdoc Tokens in Document Part References
Lists identifiers and tags used by macros of a projectdoc document to identify content on other documents.
Strings
projectdoc Transclusion IDs in Document Part References
Lists identifiers used by macros of a projectdoc document to identify transcluded content on other documents.
Content Identifiers
projectdoc Transclusion Tags in Document Part References
Lists tags used by macros of a projectdoc document to identify transcluded content on other documents.
Content Tags
projectdoc Value References in Remote Control
Lists all values of remote controls that are not mapped to a property name by a macro parameter name.
Strings
projectdoc Where in Property Name References
Lists the names of all properties that are referenced by Where parameters in a projectdoc document.
Property Names
Relative URL
Provides a relative URL to the projectdoc document.
URL
RootPathPageIds
List of page identifiers from the current page's parent page to the root page in the space.
Space Key
The key of the space the document is part of.
String
Space Title
The title of the space the document is part of.
String
Tiny URL
Provides a short URL to the projectdoc document.
URL
Title
The title of the Confluence page.
String
TranscludedDocumentTitles
Tracks direct transclusions a document is defining.
List of Strings
URL
Provides the absolute URL to the projectdoc document.
URL
Version Comment
The comment added by the last modifier for the last version of the Confluence page. If there is no comment, the property is not set.
String
VersionHistory
The list of document names, starting from the root page, including the name of this page.
Comma-separated List (USERNAME:DATE)
Version Number
The last version number of the Confluence page.
Integer
Wiki Type
The type of the confluence entity. This is usually 'page'.
String