Easier Linking

This release adds three macros to make it easier to create links to  in your Confluence.

The Wiki Link Macro allows to create dynamic and static links. It originally has been designed to allow space designers to add links in their space templates to documents that do not already exist. With the tooltip feature that renders the Short Description of the document the link points to, the Wiki Link Macro is now also in use by the Template Author. Since the interface of the Wiki Link Macro is difficult to use, because it actually has two purposes, we decided to provide two new macros with the same functionality, but with a more intuitive interface.

The advantage using the link macros is the rendering of a tooltip on mouse over. The default tooltip text is the short description of the referenced document.

Another use case is rendering links using a publishing process. Typically there is a set of spaces with which the team works. At publishing time the content of some spaces is copied to the published spaces. Dynamic links allow to render the correct links dependent on the Space Closure.

The following table lists the supported parameters of the three macros.

Use Case	Parameter	Static Link Macro	Dynamic Link Macro	Term Link Macro
Link whole document	Page / Title	Document (Page)	Document Title (Title)	Term (Title)
	Space Closure
Link into document	Anchor
Control label	Label
	Lower Case
	Tooltip
	Abbreviation Mode
	CSS Classes
Document creation	Link Rendering Control
	Blueprint
Remote Control	Request Parameters
Toggle Feature	Request Toggle Label
	Request Toggle Tooltip

Since the Static Link Macro is referencing a document similar to a Confluence link by space key and page title, there is no need to specify the space key separately. There is also no need to specify the space closure. All other use cases are supported.

The Term Link Macro is designed for simplified use and therefore does not provide parameters for use cases beyond rendering a reference to an item in the glossary. Although a space key is required to calculate the link to a document, the macro does not allow to specify the space closure as a parameter. The delegate space is required to be set correctly. This requires that a space defines its attachment space for glossary items.

Autolinking on Document Creation

The projectdoc Toolbox provides a number of macros that allow to automatically link to documents at the moment they appear. This includes the Wiki Link Macro and the Dynamic Document Link Macro. Some macros are designed to be used a property values, such as the Child Documents Macro or the Parent Property Macro. 

With this version the Name List Macro provides the Parent Name Parameter to allow template authors to automatically add the parent documents name to the name list.

The use case for this feature is for template authors. Consider a doctype that is in a close relationship to another doctype, such as a lifecycle and its phases. A phase does reference the lifecycle it belongs to and the lifecycle lists all phases it contains. So a typical location for a phase document would be a child of a lifecycle document. By the use of the Child Documents Macro and Name List Macro the links from a lifecycle to its phases and from a phase to its lifecycle can be automatically created. Since a phase may also be commonly used a number of lifecycles, the value of the lifecycle property of a phase document is required to use the Name List Macro to manually add the names of valid lifecycles where this phase is used.

Create Links

The Name List Macro (and its cousins) are rendering create links if the Space Property named Document Creation for Name List is set to true (which is the default value).

This feature also updates links in Name List Macros on creation, rename, and deletion of documents.

This feature requires a reindex of the projectdoc Confluence cache. Please refer to Troubleshooting Reindexer for projectdoc Documents for details.

Template Support for Labels and Tooltips

More macros allow to use property placeholders in labels and tooltips. A property placeholder is a name of a property, surrounded by placeholder delimiters. Here are two examples:

With this version the Wiki Link Macro (and its new cousins – see above) supports the use of property placeholders (see PDAC-1277 - Getting issue details... STATUS ). Also the Cite Macro supports placeholders in tooltips (see PDAC-1280 - Getting issue details... STATUS ).

A little different is the template support for the Tour Macro. Here the template with property placeholders is now supported in the table column header (see PDAC-1283 - Getting issue details... STATUS ).

According to tooltips:  PDAC-1290 - Getting issue details... STATUS  fixes an issues with the Display Document Properties Macro and the rendering of tooltips.

Enhancements to Autocomplete

The following issues enhance the support of the Autocomplete Feature in macros.

1. PDAC-1286 - Getting issue details... STATUS
2. PDAC-1287 - Getting issue details... STATUS
3. PDAC-1288 - Getting issue details... STATUS
4. PDAC-1281 - Getting issue details... STATUS
5. PDAC-1289 - Getting issue details... STATUS
6. PDAC-1293 - Getting issue details... STATUS

Enhancements to Artificial Properties

With this version users may override any artificial property with a document property.

Artificial properties are automatically created by a predefined name, such as URL. In case your domain model required to define a property named URL, the artificial property prevented the regular use of the URL property.

With this version artificial properties are only created if a property by this name does not already exist.

For the properties named Email and Team Email with e-mail addresses as values, now provide a normalized (the plain email address) and a text version (the label of the link) is now supported.

Enhancements to Deep Links

With this version aggregated values collected via Deep Link are now merged more effectively. Previous versions matched the names by the HTML representation, which failed in case the same name was rendered differently. This version matches the text values of the properties.

Doctype Add-ons

The following doctype add-ons are recommended to be updated for the projectdoc Toolbox.

All doctype add-ons are optional. In case an add-on is not installed, there is no need to install it for this version of the projectdoc Toolbox.