Page tree

Versions Compared

Key

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

...

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
titleSelection Macro Rendering

The rendering of Selection Macros, such as the 

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

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

...