projectdoc Toolbox 4.1 Release Notes

Services for User Macros, Autocomplete IDs and Tags, improvements for the Scroll integration.

Today we released version 4.1 of the projectdoc Toolbox on the Atlassian Marketplace!

This release provides new features, improvements, and bugfixes.

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

New and Noteworthy

Services for User Macros

Currently the internal Java API of the projectdoc Toolbox is still considered to be internal and be subject to change without notice.

Users who would like to integrate the projectdoc Toolbox into their own tool sets needed to use the Web API Extension. With this version the projectdoc Toolbox provides a limited API that falls under semantic versioning. Therefore changes to this API will be properly announced through the version number. 

For more information on this API, please refer to User Macro Integration.

Autocomplete IDs and Tags

Transclusion macros now list the valid IDs and tags of the content to transclude.

 

This currently only works for non-transitive transclusions. That is: the autocomplete only looks at the referenced document and does not follow additional transclusions.

Scroll Support

This version also fixes issues with the integration of the latest Scroll Exporter products.

In case your Scroll Ignore macros get ignored, this version will provide a fix for that.

Breaking Changes

This version has no breaking changes.

Upgrade Instructions

Install the new OBR of the projectdoc Toolbox.

List of Changes

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

Key Summary T P Status Resolution Description
PDAC-1144 Autocomplete IDs and Tags New Feature Critical (migrated) Done Fixed

Provide support to fetch IDs and tags for the transclusion macro.

This version will only support the non-transitive transclusion use case.

PDAC-1140 User Macro Interface New Feature Critical (migrated) Done Fixed

Provide access to selected projectdoc services via a stable interface to be used in user macros.

PDAC-1138 Improve Support for Integration with Scroll PDF Improvement Critical (migrated) Done Fixed

Improves integration with transclusion and Scroll PDF.

Due to an update of the Scroll products the projectdoc Toolbox no longer provides the correct context to obey Scroll Ignore and Scroll Only macros.

This improvement also fixes problems with labels on tables.

PDAC-1147 Display Table Highlighting New Feature Major Done Fixed

Allow to highlight the current document in a display table listing.

PDAC-1142 Tour Highlighting New Feature Major Done Fixed

Allow to highlight the current document in a tour table listing.

PDAC-1152 Support Greater Than and Less Than for Where Constraints Improvement Major Done Fixed

When specifying Where Constraints the operators '>=' and '<=' are supported, but not '>' and '<'.

In the context of date functions we need the additional operators.

PDAC-1149 Replace Values Parameter Fix Improvement Major Done Fixed

When replacing values via the REST API the Tag Macro is not correctly manipulated. The parameter is rendered in a corrupt state.

PDAC-1148 Abbreviated Argument Specification for Date Functions Improvement Major Done Fixed

Instead of specifying the date function call as now("", "-3w") allow the abbreviated form of now(-3w).

PDAC-1143 Provide Time of Day as Artificial Property Improvement Major Done Fixed

In addition to the creation date and last modification date we need to add an artificial property that holds the time of day.

  • Creation Time, e.g. 10:39 AM
  • Creation Time$, e.g. 10:39:27 AM
  • Creation Time§, e.g. 103927
  • Last Modification Time, e.g. 1:00 PM
  • Last Modification Time$, e.g. 1:00:41 PM
  • Last Modification Time§, e.g. 130041

The format of the first two (...Time and ...Time$) is derived from the formatter provided by Confluence. The last (...Time§, normalized) is the format HHmmss.

Note that existing pages must be reindexed to generate the artificial properties.

PDAC-1141 Render Title for Name in Transclusion per Default Improvement Major Done Fixed

In case a transclusion renders the name of the transcluded document as a header, the macro assumes that the referenced page is a projectdoc document. If it is not a projectdoc document it has no name and no heading will be added.

In case there is no name property, the macro should render the title instead. This also makes it easier for users to spot a configurations that do not align to the intended specification. Otherwise the heading would simply be missing.

PDAC-1137 Render Name for Wiki Link Macro Improvement Major Done Fixed

The Wiki Link Macro should render the name of the referenced document in case it is actually a projectdoc document. Currently it is rendering the page title.

PDAC-1134 Hide Aside Panels without Content Improvement Major Done Fixed

Hide Aside Panels if they have an empty body.

PDAC-1154 Fix Merge Semantics Bug Major Done Fixed

When merging properties the value will not be merged.

PDAC-1153 Fix Title Extension Bug Major Done Fixed

Due to changes in the Title Handling the Maven supported Version Doctype fails to render a propert unversioned title: the (Current Version) suffix is missing.

PDAC-1151 Wiki Link URL Construction Fails Bug Major Done Fixed

In case the URL already contains parameters (for instance of the page is referenced by page ID), then the additional parameters are not correctly added.

PDAC-1150 Wiki Link fails on Page Titles with Apostrophe Bug Major Done Fixed

In case the title of a referenced page contains an apostrophe, the link is not correctly rendered.

This is because the lookup in the I18N bundle will remove the apostrophe when returning the key. The macro assumes that the title is actually a key, while it is not and uses the returned value as the page's title (the one without the apostrophe).

PDAC-1139 Tooltip rendering with Wiki Link Macro Bug Major Done Fixed

The Wiki Link Macro does not render its tooltip title free of HTML.

PDAC-1136 Support of Umlauts in Autocomplete Bug Major Done Fixed

When a search term for Autocomplete contains a umlauts character, the match fails.

We also need to filter on terms using '-' or '+'.

PDAC-1131 Support Page Title with Space Key by Wiki Link Macro Bug Major Done Fixed

The Document parameter does not allow a prefix for the space key. The prefix should override any space key specified.
In case the space key is provided as a value to the document parameter, it must not be rendered.

PDAC-1130 Render preview for Document Property Table Macros Bug Major Done Fixed

When rendering the preview of the Document Properties Marker Macro in the macro browser currently a page editor version of the macro body is rendered. It should render the fragment in the page view.

PDAC-1135 Control Related Information Intro Text for Aside Macro Improvement Minor (migrated) Done Fixed

To make it easy to replace the introductional text for related information on home pages and index pages, this text must be controlled by a space property.

PDAC-1133 Support Smaller View in Edit-Mode for WikiLink-Macro Improvement Minor (migrated) Done Fixed

Support the smaller view in edit-mode for WikiLink-Macro @see NameList-Macro.

PDAC-1132 Support Different Modes for Instance Finding for Wiki Link Macro Improvement Minor (migrated) Done Fixed

Maybe we only need one mode if this is efficient enough. For now we will implement different modes to find which one we should use per default.

PDAC-1145 Render Recursion Detection in Tour Macro Bug Minor (migrated) Done Fixed

A transclusion recursion is detected, but rendered as a parsing problem.

The transclusion recursion needs to be rendered instead.

Related Releases

Extension Add-ons

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

All extensions are optional. In case an extension is not installed, there is no need to install it for this version of the projectdoc Toolbox.

Web API Extension

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

Key Summary T P Status Resolution Description
PDEXWAPI-36 Upload Hierarchies of Documents New Feature Critical (migrated) Done Fixed

Allow to upload document instances.

Requires projectdoc Toolbox 4.1.

PDEXWAPI-31 Upload Documents in CSV New Feature Critical (migrated) Done Fixed

Allow to upload a CSV file and create a document per line.

PDEXWAPI-37 Support Changing Values for Iteration Macro New Feature Major Done Fixed

Add the Iteration Macro to the list of macros we know how to change values.

This way the user does not need to construct the macro as value, but can simply pass the value.

PDEXWAPI-38 Fix Dropping Property Controls Improvement Major Done Fixed

Fix issues with merging property controls.

The update information prunes property controls. They need to be applied.

PDEXWAPI-39 Fix Property Merging Bug Major Done Fixed

Merging property values fails for positions without references.

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.

Core Doctypes

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

Key Summary T P Status Resolution Description
PDCORED-254 Support empty Aside Panels Improvement Major Done Fixed

Redesign the integration of the Aside Panel Macro to allow hiding empty panels.

PDCORED-253 Support Short Name Queries Improvement Major Done Fixed

Allow to query for Names and Short Names alike with type doctypes.

PDCORED-252 Hide Section in Module Doctype Improvement Major Done Fixed

Hide Description, Summary, and Transcluded By from users without write permission.

The module is meant for reuse and usually does not provide information to readers.

PDCORED-251 Add IDs Home/Index Page Boxes Improvement Major Done Fixed

The boxes on home pages and index pages need to provide a unique identifier to refer to these boxes individually from CSS.

Doctypes for Agile Planning

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

Key Summary T P Status Resolution Description
PDAGILE-83 Support empty Aside Panels Improvement Major Done Fixed

Redesign the integration of the Aside Panel Macro to allow hiding empty panels.

PDAGILE-82 Support Short Name Queries Improvement Major Done Fixed

Allow to query for Names and Short Names alike with type doctypes.

PDAGILE-81 Add IDs Home/Index Page Boxes Improvement Major Done Fixed

The boxes on home pages and index pages need to provide a unique identifier to refer to these boxes individually from CSS.

projectdoc Developer Diaries

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

Key Summary T P Status Resolution Description
DEVDIARY-119 Add Author to Event, Asset, and Todo Improvement Major Done Fixed

For use cases related to event driven documentation the author of an event may be relevant for selection. This value should be derived from the parent's author property.

DEVDIARY-118 Support empty Aside Panels Improvement Major Done Fixed

Redesign the integration of the Aside Panel Macro to allow hiding empty panels.

DEVDIARY-117 Support Short Name Queries Improvement Major Done Fixed

Allow to query for Names and Short Names alike with type doctypes.

DEVDIARY-116 Add IDs Home/Index Page Boxes Improvement Major Done Fixed

The boxes on home pages and index pages need to provide a unique identifier to refer to these boxes individually from CSS.

Doctypes for Project Management

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

Key Summary T P Status Resolution Description
PDPRJMGMT-66 Support empty Aside Panels Improvement Major Done Fixed

Redesign the integration of the Aside Panel Macro to allow hiding empty panels.

PDPRJMGMT-65 Support Short Name Queries Improvement Major Done Fixed

Allow to query for Names and Short Names alike with type doctypes.

PDPRJMGMT-64 Add IDs Home/Index Page Boxes Improvement Major Done Fixed

The boxes on home pages and index pages need to provide a unique identifier to refer to these boxes individually from CSS.

Doctypes for Service Management

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

Key Summary T P Status Resolution Description

Doctypes for Business Strategy

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

Key Summary T P Status Resolution Description

Doctypes for Software Development

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

Key Summary T P Status Resolution Description
PDSWDEVD-135 Support empty Aside Panels Improvement Major Done Fixed

Redesign the integration of the Aside Panel Macro to allow hiding empty panels.

PDSWDEVD-134 Support Short Name Queries Improvement Major Done Fixed

Allow to query for Names and Short Names alike with type doctypes.

PDSWDEVD-133 Add IDs Home/Index Page Boxes Improvement Major Done Fixed

The boxes on home pages and index pages need to provide a unique identifier to refer to these boxes individually from CSS.

Doctypes for Teamwork

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

Key Summary T P Status Resolution Description
PDTEAMWORK-22 Support empty Aside Panels Improvement Major Done Fixed

Redesign the integration of the Aside Panel Macro to allow hiding empty panels.

PDTEAMWORK-21 Support Short Name Queries Improvement Major Done Fixed

Allow to query for Names and Short Names alike with type doctypes.

PDTEAMWORK-20 Add IDs Home/Index Page Boxes Improvement Major Done Fixed

The boxes on home pages and index pages need to provide a unique identifier to refer to these boxes individually from CSS.

Doctypes for V-Modell XT

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

Key Summary T P Status Resolution Description
PDVMXT-23 Support empty Aside Panels Improvement Major Done Fixed

Redesign the integration of the Aside Panel Macro to allow hiding empty panels.

PDVMXT-22 Support Short Name Queries Improvement Major Done Fixed

Allow to query for Names and Short Names alike with type doctypes.

PDVMXT-21 Add IDs Home/Index Page Boxes Improvement Major Done Fixed

The boxes on home pages and index pages need to provide a unique identifier to refer to these boxes individually from CSS.

projectdoc arc42 Template

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

Key Summary T P Status Resolution Description
ARCFOURTWO-68 Support empty Aside Panels Improvement Major Done Fixed

Redesign the integration of the Aside Panel Macro to allow hiding empty panels.

ARCFOURTWO-67 Add IDs Home/Index Page Boxes Improvement Major Done Fixed

The boxes on home pages and index pages need to provide a unique identifier to refer to these boxes individually from CSS.

ARCFOURTWO-69 Remove hard-coded Intro Text Improvement Minor (migrated) Done Fixed

By removing the hard coded intro text the boxes on the Home and Index Pages are shorter.

ARCFOURTWO-70 Fix Null in Title of SWAD Bug Major Done Fixed

Resources

Release Notes for the projectdoc Toolbox
Relevant information on changes to the projectdoc Toolbox for Confluence introduces by new versions of this app.
Glossary
Terms used in and defined for projectdoc.
FAQs
Questions and answers related to the projectdoc Toolbox and Confluence.