Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Section
Column
Document Properties Marker
doctyperelease-note
overridefalse
Short DescriptionConfluence 9.1 Support, breaking change in Velocity integration.
Nameprojectdoc Toolbox 7.0.1 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
valuereleased

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

Version7.0.1hide
Productprojectdoc Toolboxhide
Release Date

14


Sponsors

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


Sort Key00007.00000.0010hide
Section
show-titlefalse
titleDescription

Today we released version 

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

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 For previous versions of Confluence there are separate versions of the projectdoc Toolbox:

  • Confluence 8.x/7.x see
    Static Document Link
    documentprojectdoc Toolbox 6.2.13 Release Notes
    labelversion 6.2.13
  • Confluence 9.0.x see
    Static Document Link
    documentprojectdoc Toolbox 7.0.0 Release Notes
    labelversion 7.0.0
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


Content Marker
hidetrue
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

...

Breaking Changes
Section
titleNew and Noteworthy
Section
titleUsing 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.

Code Block
languagetext
titleUse $page.id instead of $page as argument
#if ($projectdocContext && $page)
 ${projectdocContext.toHtml($page.id)}
#end
Expand
titleExpand to see the old use case with Velocity ...
Code Block
languagexml
titleOld Version which will not work with projectdoc Toolbox 7.0.1 and greater ...
#if ($projectdocContext)
 ${projectdocContext.toHtml($sitemeshPage)}
#end
Section
title
contentmarkerconsiderasempty
Selection Macro Rendering

The rendering of Selection Macros, such as the 

projectdoc-

static-

document-

link-

true

macro
documentIteration Macro
is no longer taking the user's selected locale into account. Instead the value is always rendered using the site default locale.

See

Jira
serversmartics JIRA
serverId79ad43bc-d289-364e-bfc7-46c09847bebd
keyPDAC-1823
for details.

Section
titleBreaking Changes
Content Marker
consider-as-emptytrue

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

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

In-Document Link
anchorNew and Noteworthy
for details.

Content Marker
hidetrue
consider-as-emptytrue

List of breaking changes with probably the largest impact on existing installations.

Content Marker
is-empty-textNo issues found

Jira
serversmartics JIRA
columnIdsissuekey,summary,issuetype,priority,description,fixVersions
columnskey,summary,type,priority,description,fixVersions
maximumIssues1000
jqlQueryproject = 'projectdoc Toolbox' && (fixVersion IN ('7.0.1')) && "Break"!='runtime (fix with reindex)' ORDER BY priority DESC, type DESC
serverId79ad43bc-d289-364e-bfc7-46c09847bebd

...

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

Static Document Link
documentprojectdoc Rebuild Manual
.

projectdoc-section
titleList of Changes

The following changes are part of version

Display Property
property-nameVersion
of the projectdoc Toolbox for Confluence

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

...

Section
titleRelated Releases

This version does not require updates of of the

Static Document Link
documentWeb API Extension
or the
Static Document Link
documentInformation Systems Extension
, but it does require the update of the Doctype Add-ons to the versions shown below.

Section
hidetrue
titleExtension Add-ons
Content Marker
hidetrue

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

Content Marker
iddoctype-add-ons-overview-copy
Tour
header-translationsTitle=Doctype Add-on
Section
titleWeb API Extension

The following changes are part of the latest

Static Document Link
documentWeb API Extension
.

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

Section
titleInformation Systems Extension

The following changes are part of the latest

Static Document Link
documentInformation Systems Extension
.

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

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.

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

79ad43bc-d289-364e-bfc7-46c09847bebd

Section
titleDoctype Add-ons

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

Content Marker
iddoctype-add-ons-overview
Tour
header-translationsTitle=Doctype Add-on
for Java Developers
projectdoc
not supported
projectdoc for Maven Developersnot suppoprted
projectdoc-content-marker
hidetrue
iddoctype-add-ons-overview-store
Tour
header-translationsTitle=Doctype Add-on

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.

Section
titleCore Doctypes

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

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

Section
titleDoctypes for Agile Planning
Jira
serversmartics JIRA
columnIdsissuekey,summary,issuetype,priority,status,resolution,description
columnskey,summary,type,priority,status,resolution,description
maximumIssues1000
jqlQueryproject = 'PDAGILE' && (fixVersion = '17.0.0') ORDER BY type DESC, priority DESC
serverId
Section
titleprojectdoc Developer DiariesCore Doctypes

The following changes are part of the latest projectdoc Developer Diaries.Core Doctypes Add-on

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

Section
titleDoctypes for Project ManagementAgile Planning

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

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

hide
Section
truetitleDoctypes for Risk Managementprojectdoc Developer Diaries

The following changes are part of the latest Doctypes for Risk Managementprojectdoc Developer Diaries.

This extension is experimental.

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

Section
titleDoctypes for Service Project Management

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

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

Section
hidetrue
titleDoctypes for Business StrategyRisk Management

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

This extension is experimental.

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

Section
titleDoctypes for Software DevelopmentService Management

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

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

Section
titleprojectdoc arc42 TemplateDoctypes for Business Strategy

The following changes are part of the latest projectdoc Add-on for arc42Doctypes for Business Strategy.

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

Section
titleDoctypes for TeamworkSoftware Development

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

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

Section
titleDoctypes for V-Modell XTprojectdoc arc42 Template

The following changes are part of the latest Doctypes for V-Modell XTprojectdoc Add-on for arc42.

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

true
Section
hide
titleDoctypes for Java DevelopersTeamwork

The following changes are part of the latest projectdoc for Java Developers.This extension is experimentalDoctypes for Teamwork.

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

Section
hidetrue
titleDoctypes for Maven DevelopersV-Modell XT

The following changes are part of the latest projectdoc for Maven Developers.This extension is experimentalDoctypes for V-Modell XT.

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

...

Section
titleReferences
Content Marker
consider-as-emptytrue

Links to information referenced in the release notes.

Tour
render-as-definition-listtrue
replace-title-with-nametrue
TitleShort Description
projectdoc Rebuild Manual
projectdoc-section
titleResources
Content Marker
consider-as-emptytrue

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

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