projectdoc Toolbox 2.7 Release Notes

Document impersonator and query parameters as HTML data attributes.

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

This release provides some new features, improvements of existing features, and fixes a number issues.

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

If you want to learn more about the projectdoc Toolbox and how it helps to create good project documentation, please refer to the introduction video!

In the Online Manual you’ll find additional video material that introduces you in the concepts of the projectdoc Toolbox.

Refer to use cases and show cases for information on how to use the projectdoc Toolbox.

Release Notes Overview

New and Noteworthy

Document Impersonator

The document impersonator is a special kind of transclusion. Instead of fetching rendered content from a page, the impersonator fetches the unrendered content and renders it in its own context.

This feature is supported by the Transclusion Macro. More information is provided by the tip Impersonator - using Live Templates.

Data Attributes for Queries

In order to use the Remote Control feature more easily the Display Table Macro (and other macros supporting this feature) now renders its parameters as HTML data attributes. These attributes can be used by scripts to adjust a given query by just parsing the table element from the view.

<table
  ...
  data-projectdoc-query-maxhitcount="10"
  data-projectdoc-query-doctypes="blank"
  data-projectdoc-query-select="Name, Iteration, Short Description"
  data-projectdoc-query-sortby="Name-"
  data-projectdoc-query-rendercolumn="true"
  data-projectdoc-query-headertranslations="Name=Topic" 
  ...
  >
  <thead>
    ...
  </thead>
  <tbody>
    ...
  </tbody>
</table>

Upgrade Instructions

Install the new OBR of the projectdoc Toolbox.

Updating all doctype add-ons and extensions to their latest versions is recommended.

List of Changes

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

Key Summary T P Status Resolution Description
PDAC-663 Document Impersonator New Feature Critical (migrated) Done Fixed

Allow defining documents and render them under the properties of the transcluding document.

The Transclusion Macro should provide a checkbox that allows to apply the properties of the transcluded document (default) or to apply the properties of the transcluding document (impersonator=true).

Only works for the Transclusion Macro (and its relatives), not for Transclude Documents Macro.
PDAC-1006 Support Services for Document Creation and Placeholder Handling New Feature Minor (migrated) Done Fixed

Make it easier for extensions to use the placeholder replacement and the document creation services.
PDAC-1003 Query Parameters as HTML Data Attributes Improvement Major Done Fixed

The query parameters provided to the macro, having the ability to be remote controlled, should be rendered as HTML data attributes so that this information can be used by the Remote Control feature more easily.
PDAC-1002 Render Problems with the Query in an Error Box Improvement Major Done Fixed

The Display Table Macro and its relatives should render a problem with the query in an error box instead of raising an exception. The raised exception is not rendered pleasantly.
PDAC-1001 Add Flags Property to Blank Doctype Improvement Minor (migrated) Done Fixed
PDAC-1004 Fix Rendering Issue with HTML IDs Bug Critical (migrated) Done Fixed

Transcluded content that contains HTML element ID is not properly encoded.

This is an issue if the information the ID is based on contains characters that are illegal for HTML attribute values.
PDAC-1007 Provide XhtmlContentHandler as Service Bug Major Done Fixed

The service needs to be exported (public) and fixes are required to the Interface/Implementation classes.
PDAC-1000 Replacement fails on partial Placeholder Supply Bug Major Done Fixed

If placeholders are not replaced fully, the partial replacement is rolled back. The partial replacement should be used.
PDAC-999 Allow HTML Elements in Tour Macro Bug Major Done Fixed

Currently the Tour Macro does not allow HTML elements. In case a user adds an image, the image cannot be rendered and a warning message is rendered into the page:

Cannot parse HTML body: Error on line 2 of document : The element type "img" must be terminated by the matching end-tag "</img>". Nested exception: The element type "img" must be terminated by the matching end-tag "</img>".

We need to allow HTML content in the cells of the table within the Tour Macro.
PDAC-1005 Normalize HTML IDs used in Transclusion Bug Minor (migrated) Done Fixed

The IDs, also used as anchors and rendered in the tooltip, expect the name of the document to be plain text. Users may choose to provide a name with HTML markup. Therefore, when calculating the HTML ID for a transcluded section title, the normalized rendered value must be used, not the rendered value of the name property.
10 issues

Related Releases

Information Systems Extension

The Information Systems Extension provides new features. This version requires the projectdoc Toolbox in version 2.7.

Key Summary T P Status Resolution Description
PDEXINFOSY-24 Support Placeholders for File and Label Parameters New Feature Major Done Fixed

It should be easier to parameter-ify the link and label for macros pointing to remote information. This way all links (and labels) of a space can be redirected by setting properties like 'project.version'.
PDEXINFOSY-25 Support Central Artifact Repositories Improvement Major Done Fixed

We need to support Maven Repo 1, Search Central, and Maven Repository to be linked.

System identifier must be set to 'central'.

  1. Then '*' selects Maven Repo 1,
  2. '$' selects Search Central,
  3. '#' selects Maven Repository.

The current implementation for accessing local Nexus servers stays the same.
2 issues

Core Doctypes

Key Summary T P Status Resolution Description
PDCORED-203 Unique Snapshot Versions New Feature Critical (migrated) Done Fixed

Support setting a unique version to the Atlassian Plugin XML in case of a SNAPSHOT version. This feature allows to uniquely identify a deployed app via the UPM REST API.
PDCORED-200 Change Heading for Generic Subdocuments Improvement Minor (migrated) Done Fixed

To use the Generic Doctype more easily, the heading for the section of the subdocument listing should read "Subordinate Documents" instead of "Generic Documents".
PDCORED-199 Remove Space Key from Create-from-Template Macros Improvement Minor (migrated) Done Fixed

The create-from-template-macros should not explicitly specify the space key parameter. While this does no harm in the usual use cases, it fails the user's expectations once the page is moved to another space. In the new space the create-from-template macro will still send the new pages to the original space, because the space key of that space is set as a parameter.

Therefore we should remove the space key to be explicitly set in our doctype home page templates.
3 issues

Doctypes for Agile Planning

Key Summary T P Status Resolution Description
PDAGILE-70 Unique Snapshot Versions New Feature Critical (migrated) Done Fixed

Support setting a unique version to the Atlassian Plugin XML in case of a
SNAPSHOT version. This feature allows to uniquely identify a deployed app
via the UPM REST API.
PDAGILE-69 Remove Space Key from Create-from-Template Macros Improvement Minor (migrated) Done Fixed

The create-from-template-macros should not explicitly specify the space key parameter. While this does no harm in the usual use cases, it fails the user's expectations once the page is moved to another space. In the new space the create-from-template macro will still send the new pages to the original space, because the space key of that space is set as a parameter.

Therefore we should remove the space key to be explicitly set in our doctype home page templates.
2 issues

projectdoc Developer Diaries

Key Summary T P Status Resolution Description
DEVDIARY-99 Unique Snapshot Versions New Feature Critical (migrated) Done Fixed

Support setting a unique version to the Atlassian Plugin XML in case of a
SNAPSHOT version. This feature allows to uniquely identify a deployed app
via the UPM REST API.
DEVDIARY-98 Remove Space Key from Create-from-Template Macros Improvement Minor (migrated) Done Fixed

The create-from-template-macros should not explicitly specify the space key parameter. While this does no harm in the usual use cases, it fails the user's expectations once the page is moved to another space. In the new space the create-from-template macro will still send the new pages to the original space, because the space key of that space is set as a parameter.

Therefore we should remove the space key to be explicitly set in our doctype home page templates.
2 issues

Doctypes for Project Management

Key Summary T P Status Resolution Description
PDPRJMGMT-47 Unique Snapshot Versions New Feature Critical (migrated) Done Fixed

Support setting a unique version to the Atlassian Plugin XML in case of a
SNAPSHOT version. This feature allows to uniquely identify a deployed app
via the UPM REST API.
PDPRJMGMT-46 Remove Space Key from Create-from-Template Macros Improvement Minor (migrated) Done Fixed

The create-from-template-macros should not explicitly specify the space key parameter. While this does no harm in the usual use cases, it fails the user's expectations once the page is moved to another space. In the new space the create-from-template macro will still send the new pages to the original space, because the space key of that space is set as a parameter.

Therefore we should remove the space key to be explicitly set in our doctype home page templates.
2 issues

Doctypes for Service Management

Key Summary T P Status Resolution Description
SERVICES-1 Unique Snapshot Versions New Feature Critical (migrated) Done Fixed

Support setting a unique version to the Atlassian Plugin XML in case of a
SNAPSHOT version. This feature allows to uniquely identify a deployed app
via the UPM REST API.
SERVICES-2 Remove Space Key from Create-from-Template Macros Improvement Minor (migrated) Done Fixed

The create-from-template-macros should not explicitly specify the space key parameter. While this does no harm in the usual use cases, it fails the user's expectations once the page is moved to another space. In the new space the create-from-template macro will still send the new pages to the original space, because the space key of that space is set as a parameter.

Therefore we should remove the space key to be explicitly set in our doctype home page templates.
2 issues

Doctypes for Business Strategy

Key Summary T P Status Resolution Description
STRATEGY-1 Unique Snapshot Versions New Feature Critical (migrated) Done Fixed

Support setting a unique version to the Atlassian Plugin XML in case of a SNAPSHOT version. This feature allows to uniquely identify a deployed app via the UPM REST API.
STRATEGY-2 Remove Space Key from Create-from-Template Macros Improvement Minor (migrated) Done Fixed

The create-from-template-macros should not explicitly specify the space key parameter. While this does no harm in the usual use cases, it fails the user's expectations once the page is moved to another space. In the new space the create-from-template macro will still send the new pages to the original space, because the space key of that space is set as a parameter.

Therefore we should remove the space key to be explicitly set in our doctype home page templates.
2 issues

Doctypes for Software Development

Key Summary T P Status Resolution Description
PDSWDEVD-118 Unique Snapshot Versions New Feature Critical (migrated) Done Fixed

Support setting a unique version to the Atlassian Plugin XML in case of a
SNAPSHOT version. This feature allows to uniquely identify a deployed app
via the UPM REST API.
PDSWDEVD-117 Remove Space Key from Create-from-Template Macros Improvement Minor (migrated) Done Fixed

The create-from-template-macros should not explicitly specify the space key parameter. While this does no harm in the usual use cases, it fails the user's expectations once the page is moved to another space. In the new space the create-from-template macro will still send the new pages to the original space, because the space key of that space is set as a parameter.

Therefore we should remove the space key to be explicitly set in our doctype home page templates.
2 issues

projectdoc arc42 Template

Key Summary T P Status Resolution Description
ARCFOURTWO-51 Unique Snapshot Versions New Feature Critical (migrated) Done Fixed

Support setting a unique version to the Atlassian Plugin XML in case of a SNAPSHOT version. This feature allows to uniquely identify a deployed app via the UPM REST API.
ARCFOURTWO-50 Remove Space Key from Create-from-Template Macros Improvement Minor (migrated) Done Fixed

The create-from-template-macros should not explicitly specify the space key parameter. While this does no harm in the usual use cases, it fails the user's expectations once the page is moved to another space. In the new space the create-from-template macro will still send the new pages to the original space, because the space key of that space is set as a parameter.

Therefore we should remove the space key to be explicitly set in our doctype home page templates.
2 issues

Doctypes for Teamwork

Key Summary T P Status Resolution Description
PDTEAMWORK-9 Unique Snapshot Versions New Feature Critical (migrated) Done Fixed

Support setting a unique version to the Atlassian Plugin XML in case of a
SNAPSHOT version. This feature allows to uniquely identify a deployed app
via the UPM REST API.
PDTEAMWORK-8 Remove Space Key from Create-from-Template Macros Improvement Minor (migrated) Done Fixed

The create-from-template-macros should not explicitly specify the space key parameter. While this does no harm in the usual use cases, it fails the user's expectations once the page is moved to another space. In the new space the create-from-template macro will still send the new pages to the original space, because the space key of that space is set as a parameter.

Therefore we should remove the space key to be explicitly set in our doctype home page templates.
2 issues

Doctypes for V-Modell XT

Key Summary T P Status Resolution Description
PDVMXT-10 Unique Snapshot Versions New Feature Critical (migrated) Done Fixed

Support setting a unique version to the Atlassian Plugin XML in case of a
SNAPSHOT version. This feature allows to uniquely identify a deployed app
via the UPM REST API.
PDVMXT-9 Remove Space Key from Create-from-Template Macros Improvement Minor (migrated) Done Fixed

The create-from-template-macros should not explicitly specify the space key parameter. While this does no harm in the usual use cases, it fails the user's expectations once the page is moved to another space. In the new space the create-from-template macro will still send the new pages to the original space, because the space key of that space is set as a parameter.

Therefore we should remove the space key to be explicitly set in our doctype home page templates.
2 issues

Doctypes for Java Developers

Key Summary T P Status Resolution Description
PDJAVADEV-23 Unique Snapshot Versions New Feature Critical (migrated) Done Fixed

Support setting a unique version to the Atlassian Plugin XML in case of a SNAPSHOT version. This feature allows to uniquely identify a deployed app via the UPM REST API.
PDJAVADEV-22 Remove Space Key from Create-from-Template Macros Improvement Minor (migrated) Done Fixed

The create-from-template-macros should not explicitly specify the space key parameter. While this does no harm in the usual use cases, it fails the user's expectations once the page is moved to another space. In the new space the create-from-template macro will still send the new pages to the original space, because the space key of that space is set as a parameter.

Therefore we should remove the space key to be explicitly set in our doctype home page templates.
2 issues

Doctypes for Maven Developers

Key Summary T P Status Resolution Description
PDMVNDEV-20 Unique Snapshot Versions New Feature Critical (migrated) Done Fixed

Support setting a unique version to the Atlassian Plugin XML in case of a SNAPSHOT version. This feature allows to uniquely identify a deployed app via the UPM REST API.
PDMVNDEV-19 Remove Space Key from Create-from-Template Macros Improvement Minor (migrated) Done Fixed

The create-from-template-macros should not explicitly specify the space key parameter. While this does no harm in the usual use cases, it fails the user's expectations once the page is moved to another space. In the new space the create-from-template macro will still send the new pages to the original space, because the space key of that space is set as a parameter.

Therefore we should remove the space key to be explicitly set in our doctype home page templates.
2 issues

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.