projectdoc Toolbox 7.0.1 Release Notes

Confluence 9.1 Support, breaking change in Velocity integration.

Release Date

Today we released version 7.0.1 of the projectdoc Toolbox!

This version supports Confluence version 9.1.x.

This version introduces a breaking change (despite this is only labelled as a bugfix version!). If you use the Velocity integration, the API requires to provide the page identifier instead of the page object. This change is necessary due to a change on Confluence 9.1.0. The API used by the projectdoc Toolbox was not intended for use by apps.

For previous versions of Confluence there are separate versions of the projectdoc Toolbox:

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

Using Velocity with the projectdoc Toolbox

There is an update to the Velocity API of the projectdoc Context object. In previous versions the API required a Velocity Sitemesh Page object as argument. Due to compatibility changes on Confluence the API now requires to pass in the ID of the page as argument.

Use $page.id instead of $page as argument
#if ($projectdocContext && $page)
 ${projectdocContext.toHtml($page.id)}
#end
Old Version which will not work with projectdoc Toolbox 7.0.1 and greater ...
#if ($projectdocContext)
 ${projectdocContext.toHtml($sitemeshPage)}
#end

Selection Macro Rendering

The rendering of Selection Macros, such as the Iteration Macro is no longer taking the user's selected locale into account. Instead the value is always rendered using the site default locale.

See PDAC-1823 - Use Site Default for Selection Macros Done for details.

Breaking Changes

Despite this is only a micro version (aka bugfix) update, it contains a breaking change. Please note that this version is only released for Confluence 9.1.x.

The breaking change is with the Velocity integration. Previous versions allowed to pass the Velocity Page object as parameter to the toHtml method. Since the type of the object is not meant as part of the public API of Confluence, we now need to use the page identifier instead of the whole page object. See New and Noteworthy for details.

Key Summary T P Description Fix Version/s
PDAC-1819 Support Confluence 9.1 Improvement Major

Fix compatibility issues to support Confluence Version 9.1.x.

There is a compatibility issue with the $projectdocContext object in the Velocity context. Clients must now pass the page ID instead of the Velocity Mesh Page object.

7.0.1

Installation Instructions

Install the projectdoc Toolbox to your Confluence instance.

There are no additional steps necessary.

If you like to install an Extension or one or more Doctype Add-ons, please make sure to install the latest versions as shown below.

Upgrade Instructions

Update the projectdoc Toolbox on your Confluence instance.

Update all Doctype Add-ons you are using, since this version of the projectdoc Toolbox introduces API changes for the use of Blueprints.

In case your users used different locales when working with documents (for instance edit and refresh), then you probably would like to refresh the your spaces or the whole site. For detailed information, please refer to projectdoc Rebuild Manual.

List of Changes

The following changes are part of version 7.0.1 of the projectdoc Toolbox for Confluence

Key Summary T P Description
PDAC-1819 Support Confluence 9.1 Improvement Major

Fix compatibility issues to support Confluence Version 9.1.x.

There is a compatibility issue with the $projectdocContext object in the Velocity context. Clients must now pass the page ID instead of the Velocity Mesh Page object.

PDAC-1822 Blueprint Creation Workaround Bug Minor (migrated)

There is an issue where Confluence prevents to create pages with the 7th Page Blueprint per user.

This version provides a workaround for creating partitions that applies to all new pages.

PDAC-1821 Short Descriptions for Space Partitions Bug Minor (migrated)

When creating a space partition the short description specified in the blueprint wizard is not rendered in the generated page.

PDAC-1824 Prevent HTML Processing on null values Improvement Minor (migrated)

When processing values we could handle null values separately. There is no immediate issue with the rendering, but we could simple prevent the processing for null and blank values.

PDAC-1823 Use Site Default for Selection Macros Improvement Minor (migrated)

When rendering a Selection Macro, such as the Iteration Macro, the Locale selected by the user in the settings is used. This imposes an issue when saving pages where a Selection Macro is used as a value to the Document Properties Marker Macro. Instead, the default site locale should be used.

Related Releases

This version does not require updates of of the Web API Extension or the Information Systems Extension, but it does require the update of the Doctype Add-ons to the versions shown below.

Doctype Add-ons

The following doctype add-ons are required 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.

In case any of the following doctype add-ons are used, they are required to be installed to work with 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-302 Space Partition Creation Bug Minor (migrated) Done Fixed

The creation of a space partition fails.

Requires projectdoc Toolbox 7.0.1.

Doctypes for Agile Planning

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

Key Summary T P Status Resolution Description
PDAGILE-110 Space Partition Creation Bug Major Done Fixed

The creation of a space partition fails.

Requires projectdoc Toolbox 7.0.1.

PDAGILE-111 Missing Team Information Bug Minor (migrated) Done Fixed

Provide the team information for Blueprint Wizard.

projectdoc Developer Diaries

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

Key Summary T P Status Resolution Description
DEVDIARY-154 Space Partition Creation Bug Major Done Fixed

The creation of a space partition fails.

Requires projectdoc Toolbox 7.0.1.

DEVDIARY-153 Fix Space Short Description Bug Minor (migrated) Done Fixed

The short description provided with the space blueprint wizard is not rendered in the generated space homepage.

Doctypes for Project Management

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

Key Summary T P Status Resolution Description
PDPRJMGMT-99 Space Partition Creation Bug Minor (migrated) Done Fixed

The creation of a space partition fails.

Requires projectdoc Toolbox 7.0.1.

Doctypes for Service Management

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

Key Summary T P Status Resolution Description
SERVICES-60 Space Partition Creation Bug Major Done Fixed

The creation of a space partition fails.

Requires projectdoc Toolbox 7.0.1.

Doctypes for Business Strategy

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

Key Summary T P Status Resolution Description
STRATEGY-40 Space Partition Creation Bug Major Done Fixed

The creation of a space partition fails.

Requires projectdoc Toolbox 7.0.1.

Doctypes for Software Development

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

Key Summary T P Status Resolution Description
PDSWDEVD-176 Space Partition Creation Bug Major Done Fixed

The creation of a space partition fails.

Requires projectdoc Toolbox 7.0.1.

projectdoc arc42 Template

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

Key Summary T P Status Resolution Description
ARCFOURTWO-87 Pending Text for Solution Strategy Improvement Minor (migrated) Done Fixed

When a new space is created, the chapter numbers do not match with the arc42 Template since the Solution Strategy is not rendered when empty.

It is important that the chapter numbers are correct, therefore we have to add a Pending Box indicating that the Solution Strategy needs to be defined. The Chapter will be shown at position 4 and the following chapter will also render their correct number according to the arc42 Template.

ARCFOURTWO-89 Space Partition Creation Bug Major Done Fixed

The creation of a space partition fails.

Requires projectdoc Toolbox 7.0.1.

ARCFOURTWO-88 URL to arc42 Template Homepage Bug Minor (migrated) Done Fixed

The link to the arc42 Template pointed to the Confluence version in the past. We need to update that link to point to the arc42 homepage.

Doctypes for Teamwork

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

Key Summary T P Status Resolution Description
PDTEAMWORK-47 Space Partition Creation Bug Major Done Fixed

The creation of a space partition fails.

Requires projectdoc Toolbox 7.0.1.

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-49 Space Partition Creation Bug Major Done Fixed

The creation of a space partition fails.

Requires projectdoc Toolbox 7.0.1.

References

Links to information referenced in the release notes.

projectdoc Rebuild Manual
Information for administrators on how to maintain projectdoc documents or to build them from scratch.

Resources

Additional resources on our website regarding the release of the projectdoc Toolbox.

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.