projectdoc Toolbox 5.1.0 Release Notes

Support for Space Administration.

Release Date
 

Today we released version 5.1.0 of the projectdoc Toolbox.

This is release provides new features, improvements and a bugfix.

Please also update the Web API Extension to the latest version.

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

Refresh for Space Administrators

There are some issues when a refresh or rebuild is run with the wrong user locale. Some macros that are used as property values will render according to the locale.

In case the users of a space have no Confluence Administrator privileges, then it is quite difficult for them to update these pages.

This version provides a refresh service for space administrators in the space administration section.

Note that only a refresh, but not a rebuild is possible. Only this pages in this space get refreshed. In case users are space administrators for a couple of spaces these spaces need to be refreshed in the appropriate order according to their dependencies.

In case there is no such order, space administrators would likely need to run the refresh more than once.

projectdoc Page Menu for Space Administrators

This version allows space administrators to get the page menu entries for projectdoc actions if the space category 'projectdoc' is set for that space.

If space administrators cannot get any of the projectdoc roles, then this allows them to configure their space themselves, albeit not for standard users.

For more information on that page actions, please refer to Cache Refresh Actions.

Template Document Link Macro

The Wiki Link Macro has been replaced by a couple of macros to make it easier to use. Instead of a single macro serving multiple use cases there is now a separate macro for each use case.

Static Document Link Macro
Renders a static link to a projectdoc document in the wiki. A static link is a link to a Confluence page that is identified by its space key and document title.
In-Document Link Macro
Renders a static link to a location within the same document. This is a static document link macro with a specialized interface.
Dynamic Document Link Macro
Renders a dynamic link to a projectdoc document in the wiki. A dynamic link is a link to a Confluence page that is identified by the page title and the delegate space closure. The target of the link is calculated at render time. In case the delegate space closure changes, a different document may be the target of the link.
Template Document Link Macro
Allows to render a link constructed with a template to a document dependent on the space closure.
Term Link Macro
Renders a dynamic link to a Glossary Item in the wiki.

The Template Document Link Macro allows to construct a link to a document using a template. Now every use case of the Wiki Link Macro should be covered.

List of Changes

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

Key Summary T P Description
PDAC-1655 Provide Space Admin Screen for Refresh New Feature Critical (migrated)

Make it as easy for space admins to refresh the current space via the space admin view as it is for the Confluence admins in their view.
PDAC-1656 Support projectdoc Page Menu for Space Admins New Feature Major

If space administrators do not have the ability to get the required projectdoc roles to get the page menu with the projectdoc actions, there should be a workaround.

In case the space has the category 'projectdoc' and the user is a space administrator, the menu will show the projectdoc actions.
PDAC-1651 Template Document Link Macro New Feature Major

Just like the Dynamic Document Link Macro, but without autocompletion for the page title. This allows to specify placeholders more easily.
PDAC-1654 Allow Space Admins to use Rebuilder Service Improvement Major

Administrators of spaces should have access to the rebuilder to refresh their spaces even if they do not have administration privileges for Confluence.

This way users responsible for spaces are able to do more gardening tasks.
PDAC-1650 Remove Support for Update without Version Improvement Major

Confluence does not allow to update a page without setting a new version as was the case in previous versions.

Therefore: We need to remove the option of saving without a new version.
PDAC-1647 Find Referencing Properties Service New Feature Minor (migrated)

Allow to find properties of doctypes that point to an identifying property on a given doctype.
PDAC-1646 Support Identifying Property in Doctype Model New Feature Minor (migrated)

Add the information about the identifying property in a reference to a projectdoc document to the doctype model.
PDAC-1652 Deprecation of Parameters of the Name List Macro Improvement Minor (migrated)

The main use case for the Name List Macro (and its cousins Name Body List Macro, Tag List Macro, Tag Body List Macro, and Role List Macro) is to provide a list of values to a document property.

In the past we allowed dynamic values for this macro. Users would have specified that all possible values are values for a given property. Since this is not a common use case and it is an issue that these values will not be updated when documents are deleted or added, we do no longer support dynamic values for properties. There are exceptions, in cases where those values are not used in searches or the information architecture ensures that dynamic values are fine.

In a future version of the projectdoc Toolbox we therefore will remove all macro parameters that support dynamic content from the macros mentioned above. In case users need some of these features in their information architecture we will consider to add new macros with this dynamic content to be used outside the document properties table.

With this issue the following parameters are tagged as deprecated:

  • Where
  • Label (use display table instead)
  • Empty Where Clause Handling
  • value all of Default Strategy

Please note that the parameter Autocomplete Sort is only used for Autocompletion.
PDAC-1649 Extend Help Text on Where Parameter Improvement Minor (migrated)

If a name is provided, then the Where Parameter of the Name List Macro is only applied in case the Unique Identifying Parameter is neither the Name, the Short Name, or the Identifier Property.

It is applied however, if the name list is bound to all names. This use case is deprecated, but we need to add some warning to the documentation of the parameter in the Macro Editor.
PDAC-1648 Resolving Constraints Bug Minor (migrated)

When resolving constraints, for instance for the matcher property, the resolvement fails under specific conditions.

The reason is that some properties do not get properly rendered before used in the expression matcher.
10 issues

Related Releases

This version does not require updates of doctype-add-ons, but we recommend the update of the Web API Extension.

Extension Add-ons

Web API Extension

The following changes are part of the latest Web API Extension.

Key Summary T P Status Resolution Description
PDEXWAPI-68 Create new Document based on Doctype New Feature Critical (migrated) Done Fixed

When creating a new document via the REST API the user should be able to specify the doctype the document is based upon. Then the template according to the doctype will be used to create the new document.

Also allow to specify the name and short description properties as request parameters, so that the body of the POST may be the empty JSON document ({}).
PDEXWAPI-61 Support Read-Only Mode New Feature Critical (migrated) Done Fixed

Activate the read-only mode for this extension.
PDEXWAPI-67 Support space-homepage and doctype-homepage as Locations Improvement Minor (migrated) Done Fixed

When creating a new document the special location {homepage} should first check the availability of a doctype homepage and if this page does not exists, uses the space homepage.

We also need to support space-homepage and doctype-homepage to directly address the space homepage or doctype homepage.
PDEXWAPI-65 Replace Access to AJS.params Improvement Minor (migrated) Done Fixed

Access to AJS.params is deprecated in AUI 9 and is planned to be removed in AUI 10.

This is a simple replacement with fetching the information from the metadata.
PDEXWAPI-69 Remove Support for Update without Version Bug Major Done Fixed

Confluence does not allow to update a page without setting a new version as was the case in previous versions.

Therefore: We need to remove the option of saving without a new version from the REST API.

Currently Confluence simply refuses to save the page without complaints.
PDEXWAPI-66 Document Creation without Properties Bug Minor (migrated) Done Fixed

We need to fix NPE issues when no properties are provided. No properties currently won't create a document, because a name and a doctype are required.
6 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.