Blog

Page tree

Versions Compared

Old Version 8

changes.mady.by.user Robert Reiner

Saved on

compared with

New Version Current

changes.mady.by.user Robert Reiner

Saved on

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 ToolboxFor 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. 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-bfc7-46c09847bebd

Section
titleKnown Issues


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

Section
titleKnown Issues
Section
titleInstallation Upgrade Instructions

Install Update the projectdoc Toolbox to on 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.

Section
titleUpgrade Instructions

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

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.

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
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
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
TitleShort Description
Release Notes for the projectdoc Toolbox
Glossary
FAQs

About

This site is maintained by smartics.

Imprint / Impressum

Data Privacy / Datenschutz 

End User License Agreement (EULA)


To get in touch please send us an e-mail!

smartics email

Keep up-to-date!

Read our

smartics Blog

Follow us on

Twitter YouTube Prezi

Find us on

Bitbucket GitHub Atlassian Marketplace

Powered by




© 2001-2023 smartics - Kronseder & Reiner GmbH