New macros, improvements, and bugfixes. Requires update of extensions and all doctype add-ons
Today we released version 1.17.0 of the projectdoc Toolbox on the Atlassian Marketplace!
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!
The following image is a link to a video on YouTube. When you click the link your browser will serve a page from youtube.com.
Very interesting, but way too fast?
Step through at your own pace with with our Prezi Presentation (external link to prezi.com )!
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.
New and Noteworthy
The following changes may be the most interesting of this release.
Tour Macro Supports Templates
The Tour Macro accepts templates containing property references in columns that do not references the document. That is ${} and $[] (for linked property values) may be used in table cells to define the rendered content. This feature makes it very easy to define columns where text with multiple properties are rendered.
See
Display List Template Macro
The Display List Template Macro allows templates to specify the content of the list items. Use ${} and $[] (for linked property values) to reference propery values with the Name Template and the Data Template.
See
Breaking Changes
Doctype Add-ons and Bookmarklet Extension
Due to an internal API change all doctype add-ons and the Bookmarklets Extension need to be updated.
See
Tour Macro
In case a cell of the table inside the Tour Macro contains text value, this test is rendered instead of the property whose value is referenced by the column title.
See
Renamed Artificial Property for Locale DE
The German translation for Space Title is now "Bereichstitel" instead of "Bereich" due to
Transclusions defined by ID
In previous versions the transclusion defined the part of transcluded content by the title of a Section. With this version the ID (if present) is used. When referencing the ID of a section, changes to the title would not take effect on the transclusion defined in other pages (since the ID stays the same).
See
Upgrade Instructions
The following topics have to be considered for an upgrade to this version.
Install the new OBR of the projectdoc Toolbox first.
Reindex recommended
Due to a new artificial property, called Space Link, a reindex is recommended.
If not, existing pages do not have this additional property.
See
List of Changes
The complete list of changes for this release.
The following changes are part of the latest projectdoc Toolbox for Confluence.
| Key | Summary | T | P | Status | Resolution | Description |
|---|---|---|---|---|---|---|
| PDAC-775 | Allow Template for Property Values in Tour Macro |
|
|
Done | Fixed |
Allow to add templates in non-referencing table columns. |
| PDAC-763 | Transclusion-to-Text Macro |
|
|
Done | Fixed |
We need a macro to render the transcluded content as plain text. Since this may be a security risk we need an extra macro instead of a checkbox in the existing Transclusion Macro. There needs to be a Confluence Wiki Markup version of this new macro. |
| PDAC-749 | Original Value for Delegate Property |
|
|
Done | Fixed |
The delegate property feature only delegates the rendered property. This has been sufficient for all our use cases. But now we need to access the original value to derive information from. This is the case for the Tour-by-Property Macro that parses link information from the original value. Therefore we need to add the blank value from the delegate document in addition to the rendered value. |
| PDAC-748 | Display List Template Macro |
|
|
Done | Fixed |
Provide a display list macro that allows to specify a pattern for rendering list items and definition list keys and values. |
| PDAC-774 | Override Cell for Tour Macro |
|
|
Done | Fixed |
If a table cell in a tour macro contains text, this text is rendered instead of the referenced property. |
| PDAC-772 | Template Macro Link Support |
|
|
Done | Fixed |
Currently all is a link, but only $[...] should. |
| PDAC-753 | Support Index Entries with Comma |
|
|
Done | Fixed |
The Index Macros do not allow entries with a comma in their names. To support this, the index macros need to make the separator configurable. |
| PDAC-771 | Space Link as Artificial Property |
|
|
Done | Fixed |
We should make it easier to link to a space a document is part of. Therefore we need the property "Space" that provides a link to the space that is already provided as "Space Key" and "Space Title". |
| PDAC-770 | Render Doctype Value with Link to Doctype Homepage |
|
|
Done | Fixed |
The Display Property Macro should render a link to the doctyper's homepage for the doctype property value. |
| PDAC-769 | Support Properties rendered as List |
|
|
Done | Fixed |
The Display Table Macro should allow the properties above the sections be rendered as a definition list. |
| PDAC-768 | Support Table Width Control |
|
|
Done | Fixed |
Provide means to control the width of the section style properties table for the Display Table Macro. |
| PDAC-765 | Support All Catch Identity |
|
|
Done | Fixed |
Since the "-" on an identifier also includes the identifier as positively defined, we need a way to define "Everything but some" -A, !X would be resolved as "A and nothing else". -A, *, !X would now be resolved as "A and everything else but X" |
| PDAC-761 | Support Transclusion Macro in Confluence Wiki Syntax |
|
|
Done | Fixed |
In order to combine transclusion with other macros that rely on the old Confluence Wiki Syntax we need to support this syntax, too. |
| PDAC-760 | Plain List Rendering |
|
|
Done | Fixed |
Allow Lists to be rendered as plain text. Values are separated by the specified delimiter, ', ' by default. |
| PDAC-759 | Support Multiple Links with Tour-by-Property Macro |
|
|
Done | Fixed |
Currently values for the Tour-by-Property Macro need to be separated by comma. If these are links, we can determine them even without the separator. |
| PDAC-757 | Support alternative Value Separators |
|
|
Done | Fixed |
Allow to specify an alternative property value separator. |
| PDAC-756 | Provide CSS Parameter to Name List Macro |
|
|
Done | Fixed |
Allow users to add a CSS style to the list rendered by the name list, name body list, and tag list macro. |
| PDAC-767 | Support Suppressing Table Header in Section Mode |
|
|
Done | Fixed |
The Display Table Macro allows to suppress the table header, but it does not yet support section mode. This enhancment should extend the feature on the table rendered above the sections. |
| PDAC-752 | Transclusion of Step Macro |
|
|
Done | Fixed |
The level calculation of transcluded section macros fails. The rendered section elements within the section macro will assume to be at a wrong target level. |
| PDAC-750 | Tour-by-Property fails to work with Delegate Properties |
|
|
Done | Fixed |
Due to PDAC-749 delegate properties due not support access to the original property value. This value is required to parse the link information properly. Once PDAC-749 is fixed, the original property value will be available and ready for being parsed. |
| PDAC-773 | Index Links for Short Names |
|
|
Done | Fixed |
In an index with short names the short name entries should link to the (full) name entries. This works for tables, but not for definition list and numbered/unnumbered lists. The ID for the HTML element is not generated. |
| PDAC-766 | Check for NPE in Persistence Listener |
|
|
Done | Fixed |
On checking if an attachment needs to be updated, there may not be an 'old document'. If there is none we run into an NPE instead of returning 'false'. |
| PDAC-764 | Column With Calculation with Counter Column |
|
|
Done | Fixed |
The Display Table Macro confuses the column widths if they are explicitly specified and the counter column is activated. If the counter column is activated, the width for that column should be controlled, too. |
| PDAC-762 | Sort on Short Names fails |
|
|
Done | Fixed |
When sorting on injected short names for the index macro, the sort key is wrongly injected. It is based on the name while it should be based on the short name. |
| PDAC-758 | Target Page Template not used |
|
|
Done | Fixed |
If a doctype defines a template for the target page, this template is not taken into account. |
| PDAC-755 | Template Calculation fails |
|
|
Done | Fixed |
The calculation of the doctype for the parent page fails, if no template or blueprint is available. As a last check we need to find the template label to return as the name of the doctype. |
| PDAC-751 | Base Delegating Sections on ID |
|
|
Done | Fixed |
When delegating sections, the delegating sections should be based on the ID if there is one. Currently it is only based on the title. When referencing the ID of a section, changes to the title would not take effect on the transclusion defined in other pages (since the ID stays the same). |
| PDAC-754 | Display Table Macro NPE |
|
|
Done | Fixed |
Using the Displaytable macro with the following configuartion leads to an NPE in DisplayListHelper.java:406. |
Related Releases
Doctype Add-ons
Doctype add-ons provide space and page blueprints based on the projectdoc Toolbox.
projectdoc Core Doctypes
| Key | Summary | T | P | Status | Resolution | Description |
|---|---|---|---|---|---|---|
| PDCORED-121 | Update for projectdoc Toolbox 1.17 |
|
|
Done | Fixed |
Due to a breaking change this update is required for the add-on to work with the projectdoc Toolbox version 1.17. |
| PDCORED-122 | Add Charters Link to Workspace Space |
|
|
Done | Fixed |
Add a link to the charters homepage from the "For Authors" section in the Workspace space. |
projectdoc for Software Development
| Key | Summary | T | P | Status | Resolution | Description |
|---|---|---|---|---|---|---|
| PDSWDEVD-91 | Update for projectdoc Toolbox 1.17 |
|
|
Done | Fixed |
Due to a breaking change this update is required for the add-on to work with the projectdoc Toolbox version 1.17. |
| PDSWDEVD-92 | Quality and Code Homepages are missing |
|
|
Done | Fixed |
In the dialog of the homepage blueprint, entries for the Quality and Code and Code Type homepages are missing. |
| PDSWDEVD-95 | Move Short Description of Homepage |
|
|
Done | Fixed |
Move the Short Description Property of homepages to the first position in the document properties table. Since excerpts of pages are shown in search results, this short description is more meaningful to readers than the doctype and name of the document. |
| PDSWDEVD-93 | Move Short Description of Homepage |
|
|
Done | Fixed |
Move the Short Description Property of homepages to the first position in the document properties table. Since excerpts of pages are shown in search results, this short description is more meaningful to readers than the doctype and name of the document. |
projectdoc Add-on for arc42
| Key | Summary | T | P | Status | Resolution | Description |
|---|---|---|---|---|---|---|
| ARCFOURTWO-33 | Update for projectdoc Toolbox 1.17 |
|
|
Done | Fixed |
Due to a breaking change this update is required for the add-on to work with the projectdoc Toolbox version 1.17. |
projectdoc for Agile Planning
| Key | Summary | T | P | Status | Resolution | Description |
|---|---|---|---|---|---|---|
| PDAGILE-40 | Update for projectdoc Toolbox 1.17 |
|
|
Done | Fixed |
Due to a breaking change this update is required for the add-on to work with the projectdoc Toolbox version 1.17. |
| PDAGILE-44 | Dependency Error breaks Team Renderer |
|
|
Done | Fixed |
Due to a false dependency the team renderer does not work on all Confluence versions. |
| PDAGILE-43 | Links on Retrospective and Review Index Pages |
|
|
Done | Fixed |
The link on the index page of the Retrospective Doctype and the Review Doctype should render plain, if the referenced index page does not yet exist. |
| PDAGILE-41 | Move Short Description of Homepage |
|
|
Done | Fixed |
Move the Short Description Property of homepages to the first position in the document properties table. Since excerpts of pages are shown in search results, this short description is more meaningful to readers than the doctype and name of the document. |
projectdoc Developer Diaries
| DEVDIARY-55 | Update for projectdoc Toolbox 1.17 |
|
|
Done | Fixed |
Due to a breaking change this update is required for the add-on to work with the projectdoc Toolbox version 1.17. |
| DEVDIARY-58 | Dependency Error breaks Templates |
|
|
Done | Fixed |
Due to a false dependency a number of template related classes are broken on some versions of Confluence. |
| DEVDIARY-56 | Move Short Description of Homepage |
|
|
Done | Fixed |
Move the Short Description Property of homepages to the first position in the document properties table. Since excerpts of pages are shown in search results, this short description is more meaningful to readers than the doctype and name of the document. |
projectdoc for Java Developers
| PDJAVADEV-14 | Update for projectdoc Toolbox 1.17 |
|
|
Done | Fixed |
Due to a breaking change this update is required for the add-on to work with the projectdoc Toolbox version 1.17. |
| PDJAVADEV-18 | NPE in Creating a new Space from POM |
|
|
Done | Fixed |
When creating a new space from a POM file (specified by the GAV coordinates), the following message is logged: [INFO] [talledLocalContainer] Caused by: java.lang.NullPointerException There seems to be no problem with the generated space, though. |
| PDJAVADEV-16 | Move Short Description of Homepage |
|
|
Done | Fixed |
Move the Short Description Property of homepages to the first position in the document properties table. Since excerpts of pages are shown in search results, this short description is more meaningful to readers than the doctype and name of the document. |
projectdoc for Maven Developers
| PDMVNDEV-11 | Update for projectdoc Toolbox 1.17 |
|
|
Done | Fixed |
Due to a breaking change this update is required for the add-on to work with the projectdoc Toolbox version 1.17. |
| PDMVNDEV-14 | Datatype from Plugin Descriptor fails in Translation |
|
|
Done | Fixed | |
| PDMVNDEV-12 | Move Short Description of Homepage |
|
|
Done | Fixed |
Move the Short Description Property of homepages to the first position in the document properties table. Since excerpts of pages are shown in search results, this short description is more meaningful to readers than the doctype and name of the document. |
Doctypes for Project Management
| PDPRJMGMT-18 | Update for projectdoc Toolbox 1.17 |
|
|
Done | Fixed |
Due to a breaking change this update is required for the add-on to work with the projectdoc Toolbox version 1.17. |
| PDPRJMGMT-22 | Dependency Error breaks Templates |
|
|
Done | Fixed |
Due to a false dependency a number of template related classes are broken on some versions of Confluence. |
| PDPRJMGMT-21 | Minutes Template Action Description |
|
|
Done | Fixed |
The description of the action section is only describing the team member who takes responsibility. It should explain that the actions to take should be listed here. |
| PDPRJMGMT-19 | Move Short Description of Homepage |
|
|
Done | Fixed |
Move the Short Description Property of homepages to the first position in the document properties table. Since excerpts of pages are shown in search results, this short description is more meaningful to readers than the doctype and name of the document. |
Extension Add-ons
Extension add-ons extends the functionality of the projectdoc Toolbox.
Bookmarklets Extension
| PDEXBML-7 | Update for projectdoc Toolbox 1.17 |
|
|
Done | Fixed |
Due to a breaking change this update is required for the add-on to work with the projectdoc Toolbox version 1.17. |