Versions Compared

Key

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

...

Section


Column


Document Properties Marker
doctyperelease-note
overridefalse


Short DescriptionEasier Linking, Create Links for Name List Macros, more Support for Placeholders in Templates, plus  Enhancements to Artificial Properties, Autocomplete, and Deep Links.
Nameprojectdoc Toolbox 4.6 Release Notes
Short Name
Parent
Parent Property
property-nameName
hide
Audience
Name List
doctyperole
render-no-hits-as-blanktrue
propertyAudience
empty-as-nonetrue

Subject
Name List
doctypesubject
propertySubject

Categories
Name List
doctypecategory
propertyCategories

Tags
Tag List
propertyTags

Iteration

Iteration
valueproduction

hide
Type
Name List
doctyperelease-note-type
render-no-hits-as-blanktrue
propertyType

Version4.6hide
Productprojectdoc Toolboxhide
Release Date

03  

hide
Sponsors
Name List
doctypestakeholder
render-no-hits-as-blanktrue
propertySponsors

Sort Key00004.00006.00000001hide



Section
show-titlefalse
titleDescription

Today we released version 

Display Property
property-nameVersion
of the projectdoc Toolbox on the Atlassian Marketplace!

This release provides new features, improvements, and bugfixes.

Panel
borderColordarkgrey
borderWidth2

The projectdoc Toolbox is an add-on for Confluence supporting agile software development teams to collaborate on process, project, system, and product documentation. 

Transclusion
documentHOMESPACE:projectdoc Video Link
idsprojectdoc



Info Box

Download the projectdoc Toolbox or visit the projectdoc Toolbox on the Atlassian Marketplace!




Column
width350px


Panel
titleRelease Notes Overview

Table of Contents
indent15px
excludeRelease Notes|Description|Summary|"References"|Resources
stylenone



...

 (and its new cousins – see 
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.



sectionWith this version
Section
titleCreate Links

The 

Static Document Link
documentName List Macro
 (and its cousins) are rendering create links if the space property 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 

projectdoc-

titleTemplate Support for Labels and Tooltips

static-document-link-macro
documentTroubleshooting Reindexer for projectdoc Documents
 for details.

Tip Box
titleUpdate Category Doctype

The 

Static Document Link
documentCategory
 doctype requires an improvement on defining its name. In previous version of

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.
Jira
server

the 

Static Document Link
document

Wiki Link Macro
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

Core Doctypes
 the name of the category started with a blank character. With 
Jira
server

smartics JIRA
serverId79ad43bc-d289-364e-bfc7-46c09847bebd
key

PDAC

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



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.

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

With this version the 

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 Wiki Link 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:  (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-1290
 fixes an issues with
1277
). Also the 
Static Document Link
documentDisplay Document Properties Cite Macro
 and the rendering of tooltips.

Section
titleEnhancements to Autocomplete

 supports placeholders in tooltips (see

Jira
serversmartics JIRA
serverId79ad43bc-d289-364e-bfc7-46c09847bebd
keyPDAC-

1286

1280

  • Jira
    serversmartics JIRA
    serverId79ad43bc-d289-364e-bfc7-46c09847bebd
    keyPDAC-1287
  • ).

    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-

    1288

    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.


    projectdoc-section
    Section
    titleEnhancements to Autocomplete

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

    1. Jira
    2. 1281
    3. Jira
      serversmartics JIRA
      serverId79ad43bc-d289-364e-bfc7-46c09847bebd
      keyPDAC-1289
    4. Jira
      serversmartics JIRA
      serverId79ad43bc-d289-364e-bfc7-46c09847bebd
      keyPDAC-12931286
    1. Jira
    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.

    1. serversmartics JIRA
      serverId79ad43bc-d289-364e-bfc7-46c09847bebd
      keyPDAC-1287
    2. Jira
      serversmartics JIRA
      serverId79ad43bc-d289-364e-bfc7-46c09847bebd
      keyPDAC-1288
    3. Jira
      serversmartics JIRA
      serverId79ad43bc-d289-364e-bfc7-46c09847bebd
      keyPDAC-1281
    4. Jira
      serversmartics JIRA
      serverId79ad43bc-d289-364e-bfc7-46c09847bebd
      keyPDAC-1289
    5. 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.



    Section
    titleBreaking Changes



    Section
    titleKnown Issues

    Display Table
    doctypesection
    render-no-hits-as-blanktrue
    render-modedefinition
    restrict-to-immediate-childrentrue
    where$<Flags>=[Known Issue]


    Section
    titleInstallation Instructions

    Due to 

    Jira
    serversmartics JIRA
    serverId79ad43bc-d289-364e-bfc7-46c09847bebd
    keyPDAC-1292
     and
    Jira
    serversmartics JIRA
    serverId79ad43bc-d289-364e-bfc7-46c09847bebd
    keyPDAC-1278
     a reindex is required to update properties.

    In case you do not use this feature, there is no need for a reindex.


    Section
    hidetrue
    titleUpgrade Instructions

    Please install the new OBR of the projectdoc Toolbox, then the extension shown below.


    Section
    titleList of Changes

    The following changes are part of the latest projectdoc Toolbox for Confluence

    Jira
    serversmartics JIRA
    columnskey,summary,type,priority,description
    maximumIssues1000
    jqlQueryproject = 'projectdoc Toolbox' && (fixVersion = '4.6.0' OR fixVersion = '4.6.0') ORDER BY priority DESC, type DESC
    serverId79ad43bc-d289-364e-bfc7-46c09847bebd


    Section
    titleSubordinate Release Notes
    Section
    titleBreaking Changes
    Section
    titleKnown Issues
    Display Table
    doctype
    section
    render-no-hits-as-blanktrue
    render-modedefinition
    restrict-to-immediate-childrentrue
    where$<Flags>=[Known Issue]
    release-note
    render-no-hits-as-blanktrue
    render-modedefinition
    selectName, Short Description
    restrict-to-immediate-childrentrue
    sort-bySort Key, Name


    Due to 

    Section
    titleRelated Releases
    Section
    titleInstallation Instructions
    Jira
    serversmartics JIRA
    serverId79ad43bc-d289-364e-bfc7-46c09847bebd
    keyPDAC-1292
     and
    Jira
    serversmartics JIRA
    serverId79ad43bc-d289-364e-bfc7-46c09847bebd
    keyPDAC-1278
     a reindex is required to update properties.

    In case you do not use this feature, there is no need for a reindex.


    Section
    hidetrue
    title
    Upgrade Instructions
    Extension Add-ons

    The following extension are required to be updated for the projectdoc Toolbox

    Please install the new OBR of the projectdoc Toolbox, then the extension shown below

    .

    Section
    title
    List of Changes
    Web API Extension

    The following changes are part of the latest 

    projectdoc Toolbox for Confluence

    Web API Extension.

    Jira
    serversmartics JIRA
    columnskey,summary,type,priority,status,resolution,description
    maximumIssues1000
    jqlQueryproject = '

    projectdoc Toolbox

    PDEXWAPI' && (fixVersion = '

    4

    8.

    6

    0.0') ORDER BY

    priority DESC,

    type DESC

    serverId79ad43bc-d289-364e-bfc7-46c09847bebd
    Section
    titleSubordinate Release Notes
    Display Table
    doctyperelease-note
    render-no-hits-as-blanktrue
    render-modedefinition
    selectName, Short Description
    restrict-to-immediate-childrentrue
    sort-bySort Key, Name

    , priority DESC
    serverId79ad43bc-d289-364e-bfc7-46c09847bebd


    Section
    titleRelated Releases
    Section
    hidetrue
    titleExtension Add-ons

    The following extension are required to be updated for the projectdoc Toolbox.

    Section
    titleWeb API Bookmarklets Extension

    The following changes are part of the latest Web API Bookmarklets Extension.

    Jira
    serversmartics JIRA
    columnskey,summary,type,priority,status,resolution,description
    maximumIssues1000
    jqlQueryproject = 'PDEXWAPIPDEXBML' && (fixVersion = '84.0.0') ORDER BY type DESC, priority DESC
    serverId79ad43bc-d289-364e-bfc7-46c09847bebd


    Section
    hidetrue
    titleBookmarklets Information Systems Extension

    The following changes are part of the latest Bookmarklets Information Systems Extension.

    Jira
    serversmartics JIRA
    columnskey,summary,type,priority,status,resolution,description
    maximumIssues1000
    jqlQueryproject = 'PDEXBMLPDEXINFOSY' && (fixVersion = '43.01.03') ORDER BY type DESC, priority DESC
    serverId79ad43bc-d289-364e-bfc7-46c09847bebd


    Section
    hidetrue
    titleInformation Systems Maven Extension

    The following changes are part of the latest Information Systems Maven Extension.

    Jira
    serversmartics JIRA
    columnskey,summary,type,priority,status,resolution,description
    maximumIssues1000
    jqlQueryproject = 'PDEXINFOSYPDEXMVN' && (fixVersion = '36.0.1.3') ORDER BY type DESC, priority DESC
    serverId79ad43bc-d289-364e-bfc7-46c09847bebd

    Section
    hidetrue
    titleMaven Extension

    The following changes are part of the latest Maven Extension.

    Jira
    serversmartics JIRA
    columnskey,summary,type,priority,status,resolution,description
    maximumIssues1000
    jqlQueryproject = 'PDEXMVN' && (fixVersion = '6.0.1') ORDER BY type DESC, priority DESC
    serverId79ad43bc-d289-364e-bfc7-46c09847bebd

    DESC, priority DESC
    serverId79ad43bc-d289-364e-bfc7-46c09847bebd




    Section
    titleDoctype Add-ons

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

    Content Marker
    iddoctype-add-ons-overview


    Tour
    header-translationsTitle=Doctype Add-on


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

    Section
    titleCore Doctypes

    The following changes are part of the latest Core Doctypes Add-on

    Jira
    serversmartics JIRA
    columnskey,summary,type,priority,status,resolution,description
    maximumIssues1000
    jqlQueryproject = 'PDCORED' && (fixVersion = '14.1.0') ORDER BY type DESC, priority DESC
    serverId79ad43bc-d289-364e-bfc7-46c09847bebd


    Section
    titleDoctypes for Agile Planning

    The following changes are part of the latest Doctypes for Agile Planning.

    Jira
    serversmartics JIRA
    columnskey,summary,type,priority,status,resolution,description
    maximumIssues1000
    jqlQueryproject = 'PDAGILE' && (fixVersion = '11.1.2') ORDER BY type DESC, priority DESC
    serverId79ad43bc-d289-364e-bfc7-46c09847bebd


    Section
    titleprojectdoc Developer Diaries

    The following changes are part of the latest projectdoc Developer Diaries.

    Jira
    serversmartics JIRA
    columnskey,summary,type,priority,status,resolution,description
    maximumIssues1000
    jqlQueryproject = 'DEVDIARY' && (fixVersion = '12.0.1') ORDER BY type DESC, priority DESC
    serverId79ad43bc-d289-364e-bfc7-46c09847bebd


    Section
    titleDoctypes for Project Management

    The following changes are part of the latest Doctypes for Project Management.

    Jira
    serversmartics JIRA
    columnskey,summary,type,priority,status,resolution,description
    maximumIssues1000
    jqlQueryproject = 'PDPRJMGMT' && (fixVersion = '5.1.2') ORDER BY type DESC, priority DESC
    serverId79ad43bc-d289-364e-bfc7-46c09847bebd


    Section
    hidetrue
    titleDoctypes for Risk Management

    The following changes are part of the latest Doctypes for Risk Management.

    This extension is experimental.

    Jira
    serversmartics JIRA
    columnskey,summary,type,priority,status,resolution,description
    maximumIssues1000
    jqlQueryproject = 'PDRISKMGMT' && (fixVersion = '3.0.0') ORDER BY type DESC, priority DESC
    serverId79ad43bc-d289-364e-bfc7-46c09847bebd


    Section
    titleDoctypes for Service Management

    The following changes are part of the latest Doctypes for Service Management.

    Jira
    serversmartics JIRA
    columnskey,summary,type,priority,status,resolution,description
    maximumIssues1000
    jqlQueryproject = 'SERVICES' && (fixVersion = '3.3.0') ORDER BY type DESC, priority DESC
    serverId79ad43bc-d289-364e-bfc7-46c09847bebd


    Section
    titleDoctypes for Business Strategy

    The following changes are part of the latest Doctypes for Business Strategy.

    Jira
    serversmartics JIRA
    columnskey,summary,type,priority,status,resolution,description
    maximumIssues1000
    jqlQueryproject = 'STRATEGY' && (fixVersion = '3.1.1') ORDER BY type DESC, priority DESC
    serverId79ad43bc-d289-364e-bfc7-46c09847bebd


    Section
    titleDoctypes for Software Development

    The following changes are part of the latest Doctypes for Software Development Doctypes.

    Jira
    serversmartics JIRA
    columnskey,summary,type,priority,status,resolution,description
    maximumIssues1000
    jqlQueryproject = 'PDSWDEVD' && (fixVersion = '11.2.0') ORDER BY type DESC, priority DESC
    serverId79ad43bc-d289-364e-bfc7-46c09847bebd


    Section
    titleDoctypes for Teamwork

    The following changes are part of the latest Doctypes for Teamwork.

    Jira
    serversmartics JIRA
    columnskey,summary,type,priority,status,resolution,description
    maximumIssues1000
    jqlQueryproject = 'PDTEAMWORK' && (fixVersion = '3.1.2') ORDER BY type DESC, priority DESC
    serverId79ad43bc-d289-364e-bfc7-46c09847bebd


    Section
    titleDoctypes for V-Modell XT

    The following changes are part of the latest Doctypes for V-Modell XT.

    Jira
    serversmartics JIRA
    columnskey,summary,type,priority,status,resolution,description
    maximumIssues1000
    jqlQueryproject = 'PDVMXT' && (fixVersion = '3.1.1') ORDER BY type DESC, priority DESC
    serverId79ad43bc-d289-364e-bfc7-46c09847bebd


    Section
    hidetrue
    titleprojectdoc arc42 Template

    The following changes are part of the latest projectdoc Add-on for arc42.

    Jira
    serversmartics JIRA
    columnskey,summary,type,priority,status,resolution,description
    maximumIssues1000
    jqlQueryproject = 'ARCFOURTWO' && (fixVersion = '9.1.1') ORDER BY type DESC, priority DESC
    serverId79ad43bc-d289-364e-bfc7-46c09847bebd


    Section
    hidetrue
    titleDoctypes for Java Developers

    The following changes are part of the latest projectdoc for Java Developers.

    This extension is experimental.

    Jira
    serversmartics JIRA
    columnskey,summary,type,priority,status,resolution,description
    maximumIssues1000
    jqlQueryproject = 'PDJAVADEV' && (fixVersion = '5.1.1') ORDER BY type DESC, priority DESC
    serverId79ad43bc-d289-364e-bfc7-46c09847bebd


    Section
    hidetrue
    titleDoctypes for Maven Developers

    The following changes are part of the latest projectdoc for Maven Developers.

    This extension is experimental.

    Jira
    serversmartics JIRA
    columnskey,summary,type,priority,status,resolution,description
    maximumIssues1000
    jqlQueryproject = 'PDMVNDEV' && (fixVersion = '5.1.1') ORDER BY type DESC, priority DESC
    serverId79ad43bc-d289-364e-bfc7-46c09847bebd



    ...