projectdoc Toolbox 1.16.0 Release Notes

Support for providing properties by attached files, list documents by properties, and accessing ancestor properties

Today we released version 1.16.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. 

New and Noteworthy

The following changes may be the most interesting of this release.

Supported Confluence Versions

This version of the projectdoc Toolbox requires at minimum the latest version of Confluence 5.8.x.

Versions 5.5, 5.6, and 5.7 are no longer supported for new features.

Attached Properties

With PDAC-718 - Getting issue details... STATUS the projectdoc Toolbox allows to specify document properties as attachments to the Confluence page.

This enhancement makes it easier to add and updated exported properties from a system.

mail.properties
mail.imap.user=jane.doe
mail.imap.host=mail.smartics.eu

Tour-by-Property

Program the table of documents by a document property with the Tour-by-Property Macro. The property lists references to documents.

 

The list may also be traversed breadth-first or depth-first to include information that is referenced by the processed documents.

List Ancestor Property

The Parent Property Macro renders a property from the parent document right from version one. The new Ancestor Property Macro now provides access to a property from the first ancestor document matching the specified document type.

In case you have a hierarchy of documents with different doctypes, you may access information from a specific doctype from all children. For instance if systems and subsystems are deployed in an environment then all the systems document can easily access information from the environment document, being the root of a tree of system documents.

Doctype Changes

The following changes to the free doctype add-ons come with the new version:

  1. The free doctypes support with their latest version the Short Name and Subject properties
  2. Blueprint wizards of all doctypes support XHTML in Short Descriptions and space property placeholders in Name and Short Description

For more information, please refer to Related Releases.

Breaking Changes

Due to an internal API change some add-ons that depend on the projectdoc Toolbox need to be updated.

Single Value in Name List Macro

The interpretation of the single value parameter of the Name List Macro has changed. Previously by setting this parameter the first value of a comma-separated list of values has been chosen as the single value.

With this version, the whole value, containing commas, will be treated as the one value.

PDAC-743 - Getting issue details... STATUS

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 required

Some issues add additional data to the index. The index is updated when the document is saved. To have access to these new properties in Lucene searches, a re-index is required.

Here is the list of issues that require a re-index to provide the new data:

  • PDAC-739 - Getting issue details... STATUS
  • PDAC-733 - Getting issue details... STATUS
  • PDAC-742 - Getting issue details... STATUS

Required Add-on Updates

The following add-ons need to be updated to work with this version of the projectdoc Toolbox.

Add-on for the projectdoc Toolbox Required Version
5.1.0 or newer
1.2.1 or newer

Recommended Add-on Updates

The following add-ons are recommended to be updated for this new version of the projectdoc Toolbox.

Add-on for the projectdoc Toolbox Required Version
6.2.0 or newer
4.1.0 or newer
6.1.0 or newer
4.2.0 or newer

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-721 Limit Support for Confluence Version 5.8.18 and up New Feature Blocker (migrated) Done Fixed

Due to API changes in Confluence we limit feature supported versions to those with EOL lasting longer than 1/2017.

PDAC-729 Ancestor Property Macro New Feature Critical (migrated) Done Fixed

Render the property value of an ancestor of this document, for the first ancestor that matches the specified document type.

PDAC-726 Tour-by-Property Macro New Feature Critical (migrated) Done Fixed

Provide a tour macro that grabs the documents to traverse from a document property.

The value the property is expected to be a list of Confluence link elements or rendered by a macro that provides the data-property-id attribute to the generated anchor.

PDAC-718 Read Document Properties From Attachments New Feature Critical (migrated) Done Fixed

To make it easier to add properties to a projectdoc document there should be a supplier that reads properties directly from an attached file.

PDAC-745 Render Name List with Template New Feature Major Done Fixed

Provide a template to the Name List Macro to allow to render a template with property values.

PDAC-739 Default Values for Short Names New Feature Major Done Fixed

Short Names should default to the Name Property value, iff there is no value specified. This makes it easier to render a list of documents with a short name column when not all documents provided such a value.

PDAC-727 Display Document Property Ref Concat Macro fails to render URLs New Feature Major Done Fixed

The concatenation of URLs is currently not supported by the Display Document Property Ref Concat Macro if the transcluded part is already a URL that actually links to the resource.

If the transcluded part is a URL, then the constructed part should allow to render as a new URL.

For instance:

  • transcluded part: <a href="someurl">someurl</a>
  • local part: service
  • concatenated: <a href="someurl/service">someurl/service</a>
PDAC-725 Provide Common Type Property New Feature Minor (migrated) Done Fixed

Per default a Type property should point to the doctype's specific type.

Currently this property is provided by most doctypes, but not necessarily by this name. The doctype designer may choose to provide this information by any name. So it is not required to use this property, but should be used as default if no other option seems more appropriate.

PDAC-724 Provide is-a Property New Feature Minor (migrated) Done Fixed

Provide a common name and translation for the is-a property.

This interims property is acutally a type information, but lacking the infrastructure to provide this information, it is stored in the template. This will put this information in all document instances (where it does not belong).

PDAC-723 Even Rating Macro New Feature Minor (migrated) Done Fixed

The macro should allow to select a value between 1 and 4. The selector needs to choose for one side since there is no middle value.

PDAC-743 Single Value Control not supported by Name List Macro Improvement Major Done Fixed

The Name List Macro splits the property values by comma, even if the "Restrict to one Value" parameter is selected. We should interpret the selection of the parameter as not to split the value. Currently, the value is split and the first element is considered. But the natural interpretation should be: Use the value as a whole.

The change will break the API due to the new interpretation of the parameter.

PDAC-747 Provide Doctype and Is-A Info for Delegate Documents Improvement Minor (migrated) Done Fixed

Additional to the name of the delegate document we need to make the doctype and is-a relationship visible as artificial properties.

PDAC-740 Render Page ID with Display Collection Macros Improvement Minor (migrated) Done Fixed

The macros referring to pages should provide the page ID as data-projectdoc-id attribute. This includes the Display Table and Display List Macros.

Although these macros are not suitable as values for properties, traversing macros (e.g. to draw a graph) are supported by this feature.

PDAC-737 Render Page ID with Document Properties Macro Improvement Minor (migrated) Done Fixed

The macros referring to pages should provide the page ID as data-projectdoc-id attribute. This includes the Document Properties Macro.

PDAC-736 Render Page ID with Document Property Ref Concat Macro Improvement Minor (migrated) Done Fixed

The macros referring to pages should provide the page ID as data-projectdoc-id attribute. This includes the Document Property Ref Concat Macro

PDAC-735 Render Page ID with Tour Macro Improvement Minor (migrated) Done Fixed

The macros referring to pages should provide the page ID as data-projectdoc-id attribute. This includes the Tour Macro.

PDAC-734 Register Association Doctype Improvement Minor (migrated) Done Fixed

Make the name and document property of the Association Doctype available to the internal API.

PDAC-733 Add Page ID to NameList Link Improvement Minor (migrated) Done Fixed

In order to make traversing documents easier, we should render the data-projectdoc-id attribute to the link generated by the Name List Macro.

PDAC-732 Remove Suffix from Macro Names Improvement Minor (migrated) Done Fixed

To shorten the names of macros the "Macro" suffix is removed from all macros.

PDAC-731 Rename projectdoc Link Label Improvement Minor (migrated) Done Fixed

Rename the "projectdoc" URL label to "projectdoc Toolbox".

PDAC-741 CDATA Comments fail in Code Block Bug Critical (migrated) Done Fixed

Due to an issue in the HTML parser, we need to escape the CDATA blocks. But our special treatment fails if the code acutally contains HTML/XML comments.

With this problem, the page fails to be stored.

PDAC-746 Unique Property Normalization for Name List Macro Bug Major Done Fixed

The Unique Property Parameter of the Name List Macro is not properly normalized. This leads to match failures when the property name contains spaces.

PDAC-744 Lucene Index fails on 'is-single-value' Control Bug Major Done Fixed
PDAC-742 Ampersand in Short Name Bug Major Done Fixed

If the Name value contains an HTML significant character (e.g. the ampersand), the Short Name property default value cannot be generated.

PDAC-728 Accessing List of Doctypes needs to check for Refresh Bug Major Done Fixed

Fetching doctype information needs to check if the cache needs to be refreshed. Otherwise the empty result will be returned.

As a workaround projectdoc users with the appropriate privileges may manually refresh the cache.

PDAC-720 Override fails on Default Values Bug Major Done Fixed

For document properties macros the default values do not override.

It seems that – since default value are internally handled as blank values – default values are not taken into account when overriding is in place.

PDAC-719 Suppress Short Description in Supplier Macro Bug Major Done Fixed

The Document Properties Supplier Macro renders the extracted short description property if instructed by the space property. But it should never.

PDAC-738 Rendering Link with Display Properties Macro Bug Minor (migrated) Done Fixed

If a link is rendered with the Document Properties Macro, the macro needs to remove existing links, since links within links are not allowed.

PDAC-730 Fix Documentation Link for Parent Property Macro Bug Minor (migrated) Done Fixed

The documentation link for the Parent Property Macro links to "Parent Property" instead of "Parent Property Macro".

PDAC-722 Missing Icon in Section Macro Menu Bug Minor (migrated) Done Fixed

The icon in the "Add macro menu" in edit mode misses.

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-107 Limit Support for Confluence Version 5.8.18 and up New Feature Blocker (migrated) Done Fixed

Due to changes in the projectdoc Toolbox support for Confluence is limited 5.8.18 and up.

PDCORED-120 Profile Type New Feature Critical (migrated) Done Fixed

Provide a profile doctype to make it easier to write delegating documents in order to provide additional views on documents.

PDCORED-111 Association Type New Feature Major Done Fixed

Provide means to create associations between document instances.

PDCORED-109 Stakeholder Rating Macro New Feature Minor (migrated) Done Fixed

Add a rating macro for rendering the power/interest value of a stakeholder.

PDCORED-114 Provide a Subject Property to all Doctypes Improvement Major Done Fixed

As a standard organization tool each doctype should have a Subject Property.

PDCORED-113 Provide Short Name for all Doctypes Improvement Major Done Fixed

To add context specific names for documents of all doctypes we need to add the Short Name Property to all.

PDCORED-110 Analysis on Stakeholder Template Improvement Major Done Fixed

The Stakeholder Doctype needs a section to store analysis information to (possibly) render stakeholder charts.

PDCORED-104 Add Short Name to Doctypes Improvement Major Done Fixed

Most doctypes should provide a short name. This allows to specify abbreviations or easy to remember names.

PDCORED-103 Add Publisher to Resource Doctype Improvement Major Done Fixed

Add a property to specify the publisher of a resource. This may also be the name of an organization responsible for publishing a standard.

PDCORED-108 Associated Terms for Glossary Item Improvement Minor (migrated) Done Fixed

Add a section to the Glossary Item Doctype to render associated terms. While related terms are on the same level, child documents represent specializations, associated terms are those that are part of the term and describe it.

PDCORED-106 Move Short Description first Improvement Minor (migrated) Done Fixed

Move the short description properties of doctype homepages to the first table row.

Since search hits may list the first lines of text, this will make the short description visible instead of the doctype and the name of the document (that often matches the page title).

PDCORED-117 Rename Medientyp to Typ Bug Critical (migrated) Done Fixed

According to providing a type property for each doctype by the same name, we needt to rename (in the German version) "Medientyp" of the resource doctype to "Typ".

Note that this change requires to update the property name in existing documents.

PDCORED-119 Select Transcluded Documents by Title Bug Major Done Fixed

The Module Template selects transcluding documents by name, but should do so by title.

PDCORED-118 Workspace Creation Fails Bug Major Done Fixed

Creation of Workspaces fails on Confluence 6.x with a MySQL error.

PDCORED-116 Replace Light Green Boxes Bug Minor (migrated) Done Fixed

Replace the light green boxes with the heading in the panel body with the dark green boxes where the heading is in the panel head.

PDCORED-112 Provide XHTML and Space Properties in Short Description Bug Minor (migrated) Done Fixed

Make sure that for all templates short descriptions allow XHTML and enforce space property replacement.

Currently XHTML is not supported by a view type doctypes and space property replacement is not supported.

PDCORED-105 Short Name Description missing for Organization Doctype Bug Minor (migrated) Done Fixed

projectdoc for Software Development

Key Summary T P Status Resolution Description
PDSWDEVD-76 Limit Support for Confluence Version 5.8.18 and up New Feature Blocker (migrated) Done Fixed

Due to changes in the projectdoc Toolbox support for Confluence is limited 5.8.18 and up.

PDSWDEVD-84 Add Typ Doctypes New Feature Critical (migrated) Done Fixed

Replace selection macros with doctype types.

PDSWDEVD-80 Provide Type for Project Constraints New Feature Major Done Fixed

Currently the type of a project constraint is bound to the values provided by a selection macro.

Users should be able to define their own types of project constraints. Therefore the selection macro should be replaced by a Name List Macro and a new doctype for project constraint types is required.

PDSWDEVD-85 Fix Code Doctype Label Problems New Feature Minor (migrated) Done Fixed
PDSWDEVD-78 Provide Short Name for all Doctypes Improvement Major Done Fixed

To add context specific names for documents of all doctypes we need to add the Short Name Property to all.

PDSWDEVD-82 Type Home and Index Page References Improvement Minor (migrated) Done Fixed

Make the representation of the links to other homepage on the homepage and indexpage of the type doctypes uniform.

PDSWDEVD-77 Provide Space Properties in Short Description Improvement Minor (migrated) Done Fixed

Enforce space property replacement for short descriptions for all templates.

PDSWDEVD-88 Fix Homepage Links for Test Report and Test Session Bug Major Done Fixed

Links should point to the index and not to the non-existent homepages.

PDSWDEVD-87 Add Missing Requirements Link Bug Major Done Fixed

Add the missing link to the requirements homepage on the content management page.

PDSWDEVD-83 Technical Debt Validation Bug Major Done Fixed

Add technical debt validation.

PDSWDEVD-79 Fix Partition Generation: Documentation Dashboard Bug Major Done Fixed

The label for the Documentation Dashboard matches that of the Content Management Dashboard. This will override the page on partition generation (where a user wants to create the pages of a space in an existing space).

PDSWDEVD-89 Architecture Decision Homepage Link to Index Bug Minor (migrated) Done Fixed

The link to the index page should hide in case the index page is missing.

PDSWDEVD-86 Qualities Link on Content Management Bug Minor (migrated) Done Fixed
PDSWDEVD-81 Requirement Type Label Fixes Bug Minor (migrated) Done Fixed

Description labels read "Technical Debt" instread of "Requirement Type".

PDSWDEVD-75 Typo in Help Text for Deployment Section Bug Minor (migrated) Done Fixed

projectdoc for Agile Planning

Key Summary T P Status Resolution Description
PDAGILE-34 Limit Support for Confluence Version 5.8.18 and up New Feature Blocker (migrated) Done Fixed

Due to changes in the projectdoc Toolbox support for Confluence is limited 5.8.18 and up.

PDAGILE-33 Adjustment due to API Change in projectdoc Toolbox 1.16.0 New Feature Blocker (migrated) Done Fixed

Due to an API change for issue PDAC-718 Done the update is required and will not work with older versions of the projectdoc Toolbox.

PDAGILE-37 Provide Short Name for all Doctypes Improvement Major Done Fixed

To add context specific names for documents of all doctypes we need to add the Short Name Property to all.

PDAGILE-32 Provide Subject Property Improvement Major Done Fixed

Provide a subject property for all doctypes (that do not yet have one).

PDAGILE-36 Check that Iteration Dates are specified Improvement Minor (migrated) Done Fixed

The user needs to specify the start and end date of the iteration.

Otherwise the content in the generated page for these two properties is broken.

PDAGILE-35 Provide Space Properties in Short Description Improvement Minor (migrated) Done Fixed

Enforce space property replacement for short descriptions for all templates.

PDAGILE-39 Replace Light Green Boxes Bug Minor (migrated) Done Fixed

Replace the light green boxes with the heading in the panel body with the dark green boxes where the heading is in the panel head.

PDAGILE-38 Wrong Spelling: Dept Bug Minor (migrated) Done Fixed

Technical Debt is missspelled as Technical Dept.

projectdoc Add-on for arc42

ARCFOURTWO-26 Limit Support for Confluence Version 5.8.18 and up New Feature Blocker (migrated) Done Fixed

Due to changes in the projectdoc Toolbox support for Confluence is limited 5.8.18 and up.

ARCFOURTWO-32 Update arc42 V7: Section Titles New Feature Major Done Fixed

Updated the main sections of the arc42 Template to match V7.

ARCFOURTWO-29 Provide a Subject Property to all Doctypes Improvement Major Done Fixed

As a standard organization tool each doctype should have a Subject Property.

ARCFOURTWO-28 Provide Short Name for all Doctypes Improvement Major Done Fixed

To add context specific names for documents of all doctypes we need to add the Short Name Property to all.

ARCFOURTWO-27 Provide Space Properties in Short Description Improvement Minor (migrated) Done Fixed

Enforce space property replacement for short descriptions for all templates.

ARCFOURTWO-31 Replace Light Green Boxes Bug Minor (migrated) Done Fixed

Replace the light green boxes with the heading in the panel body with the dark green boxes where the heading is in the panel head.

ARCFOURTWO-30 Wrong Spelling: Dept Bug Minor (migrated) Done Fixed

Technical Debt is missspelled as Technical Dept.

projectdoc Developer Diaries

DEVDIARY-48 Limit Support for Confluence Version 5.8.18 and up New Feature Blocker (migrated) Done Fixed

Due to changes in the projectdoc Toolbox support for Confluence is limited 5.8.18 and up.

DEVDIARY-50 Show Issues with Status Changes Improvement Critical (migrated) Done Fixed

Instead of showing only issues that have been resolved on a given day with the day template, we should show all issues that have been changed on that day.

This way it is easier to track issues that have been worked on (according status changes) when checking days in the journal.

DEVDIARY-54 Add Link to Previous Work on Event Improvement Major Done Fixed

Add a "Continuation of" property to the Event Template to link to an event document this event continues to work on. This makes it easier to track work that is done over a number of events.

Currently these links have been added in the references section.

Also add a section to collect the documents referenced in a breadth-first manner (although probably there is only one document referenced per event).

DEVDIARY-53 Provide a Subject Property to all Doctypes Improvement Major Done Fixed

As a standard organization tool each doctype should have a Subject Property.

DEVDIARY-52 Provide Short Name for all Doctypes Improvement Major Done Fixed

To add context specific names for documents of all doctypes we need to add the Short Name Property to all.

DEVDIARY-49 Provide Space Properties in Short Description Improvement Minor (migrated) Done Fixed

Enforce space property replacement for short descriptions for all templates.

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.