projectdoc Toolbox

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

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

 

Use the Display All Document Properties Macro to list all properties of a document.

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.

 

Example for the artificial property "Last Modification Date".

PropertyValue
Last Modification Date

 

Last Modification Date$30 Aug 2019
Last Modification Date§20190830

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).

Since 4.0 and 4.5

 

This feature is available since the projectdoc Toolbox version 4.0.

Since version 4.5 more URL representations of artificial properties are supported.

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

 

Example for a property with a reference to an external site.

PropertyValue
Homepage
Homepage$smartics
Homepage§https://www.smartics.eu/

Users

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

Adding a '$' renders the full name.

Since 4.0

 

The full name property is provided since version 4.0.

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.

Since 4.6

 

This feature is supported since version 4.6.

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

Full control over Domain Vocabulary

 

The artificial property URL points to the current page as an artificial property.

This would make it impossible for users to design a doctype with the property URL.

List of Artificial Properties

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

Name Short Description Data Type
The list of document IDs, starting from the root page, excluding the ID of this page.
Comma-separated List of Long Numbers (String)
The list of document names, starting from the root page, excluding the name of this page.
Comma-separated List (String)
The list of parent document IDs, starting from the hierarchy's root document.
Comma-separated List (long)
The list of parent document names, starting from the hierarchy's root document.
Comma-separated List (String)
The automatically generated identifier for a document. The services needs to be configured per doctype with a space property.
String
The date the document has been created. The value is created by Confluence.
Date
The hour of day of the date the document has been created. The value is created by Confluence.
Date
The name of the user who created the document. This value is generated by Confluence.
User Name
The type of the document this document delegates to.
String
The name of the document this document delegates to.
String
The page reference (space-key.page-title) of the document this document delegates to.
String
The internal Confluence page identifier of the page's parent.
long
The title of the parent document.
String
Tracks direct property references a document is defining.
List of Strings
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
The date the document had been modified lately. The date is generated by Confluence.
Date
The time of day of the date the document had been modified lately. The date is generated by Confluence.
String
The name of the user who added the last modifications to the document. The value is generated by Confluence.
User Name
The last comment added by the last modifier for the Confluence page.
String
The last version Number that actually has a comment.
Integer
The unique identifier of the page. This is the page ID provided by Confluence.
long
Unique reference of a page within a Confluence site.
String
Lists identifiers used by macros of a projectdoc document to identify anchored content on other documents.
Lists all used CSS classes of a given projectdoc document that are mentioned as parameters of projectdoc macros.
Lists the names of all properties that are referenced by a given projectdoc document via display property macros.
Lists identifiers used by macros of a projectdoc document to identify content on other documents.
Lists all used part identifier of a given projectdoc document.
Lists the names of all macro parameters that are referenced by a given projectdoc document.
Lists macro parameter names used in the context of remote controls.
Lists the parameter names of all macros on a projectdoc document.
Lists the control names used by properties of a projectdoc document.
Lists the control values used by properties of a projectdoc document.
Lists the names of all properties that are referenced by a given projectdoc document.
Lists the names of all properties, excluding projectdoc metadata properties, of a projectdoc document.
Lists the values of all properties, excluding projectdoc metadata properties, of a projectdoc document.
Lists the names of all properties that are referenced by Select parameters in a projectdoc document.
Lists the names of all properties that are referenced by a given projectdoc document in Sort By parameters.
Lists all used part identifier classes or tags of a given projectdoc document.
Lists tags used by macros of a projectdoc document to identify content on other documents.
Lists identifiers and tags used by macros of a projectdoc document to identify content on other documents.
Lists identifiers used by macros of a projectdoc document to identify transcluded content on other documents.
Lists tags used by macros of a projectdoc document to identify transcluded content on other documents.
Lists all values of remote controls that are not mapped to a property name by a macro parameter name.
Lists the names of all properties that are referenced by Where parameters in a projectdoc document.
Provides a relative URL to the projectdoc document.
URL
The key of the space the document is part of.
String
The title of the space the document is part of.
String
Provides a short URL to the projectdoc document.
URL
The title of the Confluence page.
String
Tracks direct transclusions a document is defining.
List of Strings
Provides the absolute URL to the projectdoc document.
URL
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
The list of document names, starting from the root page, including the name of this page.
Comma-separated List (USERNAME:DATE)
The last version number of the Confluence page.
Integer
The type of the confluence entity. This is usually 'page'.
String