Versions Compared

Key

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

...

Section
titleNew and Noteworthy


Section
titleEasier Linking

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

The 

Static Document Link
documentWiki 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 
Static Document Link
documentShort Description
 of the document the link points to, the Wiki Link Macro is now also in use by the 
Static Document Link
documentPDAC: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.

Tour
render-as-definition-listtrue
replace-title-with-nametrue



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 

Static Document Link
documentPDAC:Space Closure
.

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

Use CaseParameterStatic Link MacroDynamic Link Macro

Term Link Macro

Link whole documentPage / Title

Document
(Page)

Document Title
(Title)
Term
(Title)
Space Closure(error)(tick)(error)
Link into documentAnchor(tick)(tick)(error)
Control labelLabel(tick)(tick)(tick)
Lower Case(tick)(tick)(tick)
Tooltip(tick)(tick)(tick)
Abbreviation Mode(tick)(tick)(tick)
CSS Classes(tick)(tick)(tick)
Document creationLink Rendering Control(tick)(tick)(error)
Blueprint(tick)(tick)(error)
Remote ControlRequest Parameters(tick)(tick)(error)
Toggle FeatureRequest Toggle Label(tick)(tick)(error)
Request Toggle Tooltip(tick)(tick)(error)

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 

Static Document Link
documentPDAC:Attachment Space
to-lower-casetrue
for
Static Document Link
documentGlossary Item
labelglossary items
to-lower-casetrue
.


Section
titleAutolinking 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 

Static Document Link
documentWiki Link Macro
 and the 
Static Document Link
documentDynamic Document Link Macro
. Some macros are designed to be used a property values, such as the 
Static Document Link
documentChild Documents Macro
 or the 
Static Document Link
documentParent Property Macro

With this version the 

Static Document Link
documentName List Macro
 provides the
Static Document Link
anchorParent Name
documentName List Macro
tooltipThe Parent Name Parameter allows to add the parent document's name as a value to the list of names.
labelParent 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.

Note Box

Currently the Child Documents Macro does not allow to add additional names.



Section
titleCreate Links

The 

Static Document Link
documentName List Macro
 (and its cousins) are rendering create links if the 
Static Document Link
documentPDAC:Space Property
named 
Static Document Link
documentDocument 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 

Static Document Link
documentTroubleshooting Reindexer for projectdoc Documents
 for details.

projectdoc-box-tip
titleUpdate Category Doctype

The 

Static Document Link
documentCategory
 doctype requires an improvement on defining its name. In previous version of the 
Static Document Link
documentCore Doctypes
 the name of the category started with a blank character. With 
Jira
serversmartics JIRA
serverId79ad43bc-d289-364e-bfc7-46c09847bebd
keyPDCORED-271
 the name has been corrected. This fix is required by the Create Links Feature to successfully update the link with the Name List Macro.



projectdoc-section
titleTemplate 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:

Placeholder ExampleDescription
${Story Points}Renders the document property Story Points of the referenced document.
$[Name] (${Story Points})Renders the Name of the document, with a link, and the Story Points in brackets as text.

With this version the 

Static Document Link
documentWiki Link Macro
 (and its new cousins – see 
Static Document Link
anchorEasier Linking
documentprojectdoc Toolbox 4.6 Release Notes
tooltipThe section introduces the Static Link Macro, Dynamic Link Macro, and the Term Link Macro.
labelabove
) supports the use of property placeholders (see
Jira
serversmartics JIRA
serverId79ad43bc-d289-364e-bfc7-46c09847bebd
keyPDAC-1277
). Also the 
Static Document Link
documentCite Macro
 supports placeholders in tooltips (see
Jira
serversmartics JIRA
serverId79ad43bc-d289-364e-bfc7-46c09847bebd
keyPDAC-1280
).

A little different is the template support for the 

Static Document Link
documentTour Macro
. Here the template with property placeholders is now supported in the table column header (see
Jira
serversmartics JIRA
serverId79ad43bc-d289-364e-bfc7-46c09847bebd
keyPDAC-1283
).

According to tooltips: 

Jira
serversmartics JIRA
serverId79ad43bc-d289-364e-bfc7-46c09847bebd
keyPDAC-1290
 fixes an issues with the 
Static Document Link
documentDisplay Document Properties Macro
 and the rendering of tooltips.


Section
titleEnhancements to Autocomplete

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

  1. Jira
    serversmartics JIRA
    serverId79ad43bc-d289-364e-bfc7-46c09847bebd
    keyPDAC-1286
  2. Jira
    serversmartics JIRA
    serverId79ad43bc-d289-364e-bfc7-46c09847bebd
    keyPDAC-1287
  3. Jira
    serversmartics JIRA
    serverId79ad43bc-d289-364e-bfc7-46c09847bebd
    keyPDAC-1288
  4. Jira
    serversmartics JIRA
    serverId79ad43bc-d289-364e-bfc7-46c09847bebd
    keyPDAC-1281
  5. Jira
    serversmartics JIRA
    serverId79ad43bc-d289-364e-bfc7-46c09847bebd
    keyPDAC-1289
  6. Jira
    serversmartics JIRA
    serverId79ad43bc-d289-364e-bfc7-46c09847bebd
    keyPDAC-1293


Section
titleEnhancements to Artificial Properties

With this version users may override any 

Static Document Link
documentArtificial Properties
labelartificial property
with a document property.

Artificial properties are automatically created by a predefined name, such as 

Static Document Link
documentURL
. 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.


Section
titleEnhancements to Deep Links

With this version aggregated values collected via 

Static Document Link
documentPDAC: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.


...