Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Document Properties Marker
doctypetopic
overridefalse


Doctypetopichide
NameArtificial Properties
 

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

Parent
Parent Property
property-nameName
 

Audience
Name List
doctyperole
render-no-hits-as-blanktrue
render-list-as-comma-separated-valuestrue
namesAuthor, Documentation Architect, Documentation Gardener
propertyAudience
 

Level of Experience
Name List
doctypeexperience-level
render-no-hits-as-blanktrue
propertyLevel of Experience
 

Expected Duration
 

Tags
 

Iteration
Iteration
valuefinished
hide
Type
Name List
doctypetopic-type
render-no-hits-as-blanktrue
namesReference
propertyType
 

Sort Keyhide



Section
show-titlefalse
titleDescription

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

Tip Box

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



Section
titlePrerequisites


Section
titleAbstract


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

Section
titleDates

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 Box

Example for the artificial property "Last Modification Date".

PropertyValue
Last Modification Date

 

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




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

Version Box
since4.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 Box

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

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




Section
titleUsers

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

Adding a '$' renders the full name.

Version Box
since4.0

The full name property is provided since version 4.0.



Section
titleOverriding 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.

Version Box
since4.6

This feature is supported since version 4.6.

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

Example Box
titleFull 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.




Section
idSubtopics
titleList of Artificial Properties

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

projectdoc-hide-from-reader-macro

create-from-template
blueprintModuleCompleteKeyde.smartics.atlassian.confluence.smartics-doctype-addon-app:projectdoc-blueprint-doctype-document-property
contentBlueprintIdccdb1892-60fa-4636-add8-06ed01937031
templateNameccdb1892-60fa-4636-add8-06ed01937031
createResultedit
buttonLabelNew Document Property

projectdoc-display-table
doctypeproperty, document-property
render-no-hits-as-blanktrue
selectName, Short Description, Data Type

restrict-to-immediate-childrentrue
|
sort-bySort Key, Name
where$<AncestorNames>=[${Name}] OR $<Type>=°Artificial Property°


Section
titleNotes


Section
titleReferences

...