- Created by Robert Reiner, last modified on 28. Oct 2020
projectdoc Toolbox
Artificial Document Properties on Metadata, Tasks Report Macro, Section Compilations, Usability enhancements and more.
Today we released version 4.7 of the projectdoc Toolbox on the Atlassian Marketplace!
This release provides new features, improvements, and bugfixes.
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
Artificial Document Properties on Metadata
This release collects metadata to allow documentation gardners to find referencing documents easier.
Information on property names, controls, and values is collected as well as on document part identifiers and tags.
The following artificial properties support queries for documents that define a given name.
| Name | Short Description | Since |
|---|---|---|
| projectdoc IDs for Document Parts | Lists all used part identifier of a given projectdoc document. | 4.7 |
| projectdoc Macro Parameter Names | Lists the parameter names of all macros on a projectdoc document. | 4.7 |
| projectdoc Property Names | Lists the names of all properties, excluding projectdoc metadata properties, of a projectdoc document. | 4.7 |
| projectdoc Property Values | Lists the values of all properties, excluding projectdoc metadata properties, of a projectdoc document. | 4.7 |
| projectdoc Tags for Document Parts | Lists all used part identifier classes or tags of a given projectdoc document. | 4.7 |
The following artificial properties support queries for documents that use a given name by reference.
| Name | Data Type | Short Description | Since |
|---|---|---|---|
| projectdoc Anchor IDs in Document Part References | Content Identifiers | Lists identifiers used by macros of a projectdoc document to identify anchored content on other documents. | 4.7 |
| projectdoc CSS Class References | CSS Classes | Lists all used CSS classes of a given projectdoc document that are mentioned as parameters of projectdoc macros. | 4.7 |
| projectdoc Display in Property Name References | Property Names | Lists the names of all properties that are referenced by a given projectdoc document via display property macros. | 4.7 |
| projectdoc Document Name References | Document Name | Lists the names of all documents that are referenced by a given projectdoc document. | 5.0 |
| projectdoc Dynamic Link Titles | Document Titles | Lists the titles of all pages targeted by dynamic links. | 4.10 |
| projectdoc IDs for Document Part References | Content Identifiers | Lists identifiers used by macros of a projectdoc document to identify content on other documents. | 4.7 |
| projectdoc Macro Parameter Name References | Macro Parameter Names | Lists the names of all macro parameters that are referenced by a given projectdoc document. | 4.7 |
| projectdoc Macro Parameter Name References in Remote Control | Macro Parameter Name | Lists macro parameter names used in the context of remote controls. | 4.7 |
| projectdoc Property Control Name References | Property Control Names | Lists the control names used by properties of a projectdoc document. | 4.7 |
| projectdoc Property Control Value References | Property Control Values | Lists the control values used by properties of a projectdoc document. | 4.7 |
| projectdoc Property Name References | Property Names | Lists the names of all properties that are referenced by a given projectdoc document. | 4.7 |
| projectdoc Select in Property Name References | Property Names | Lists the names of all properties that are referenced by Select parameters in a projectdoc document. | 4.7 |
| projectdoc Sort By in Property Name References | Property Names | Lists the names of all properties that are referenced by a given projectdoc document in Sort By parameters. | 4.7 |
| projectdoc Tags in Document Part References | Content Tags | Lists tags used by macros of a projectdoc document to identify content on other documents. | 4.7 |
| projectdoc Tokens in Document Part References | Strings | Lists identifiers and tags used by macros of a projectdoc document to identify content on other documents. | 4.7 |
| projectdoc Transclusion IDs in Document Part References | Content Identifiers | Lists identifiers used by macros of a projectdoc document to identify transcluded content on other documents. | 4.7 |
| projectdoc Transclusion Tags in Document Part References | Content Tags | Lists tags used by macros of a projectdoc document to identify transcluded content on other documents. | 4.7 |
| projectdoc Value References in Remote Control | Strings | Lists all values of remote controls that are not mapped to a property name by a macro parameter name. | 4.7 |
| projectdoc Where in Property Name References | Property Names | Lists the names of all properties that are referenced by Where parameters in a projectdoc document. | 4.7 |
More information on this topic is available at Name Refactorings.
A reindex is required to add the new properties (see Upgrade Instructions below).
Tasks Report Macro
The new Tasks Report Macro allows to select Confluence Tasks from projectdoc Documents selected by a Where constraint.
The new macro simply configures the Confluence Task Report Macro and executes it. The new macro is not a replacement. In case users want to select on spaces, pages, and labels, the original macro is still in charge. The new macro simply connects projectdoc documents to the world of Confluence Tasks.
Section Compilations
In software product documentation there is a good chance to encounter elements that are reused. For instance a parameter of a collection of macros. Suppose there is a collection of macros that transclude content from a single document. Each of these macros would provide a parameter named "Document" to link to the document to transclude from. Often the documentation for this parameter is identical. Therefore the documentation for the Document Parameter is in one location and the macros transclude this content.
The macros may need to control the order of their parameters. Maybe the first macro has the Document Parameter as its second parameter while all others specify it as their first.
In addition to that some macros may provide parameters they do not share with other macros. So authors may want to document these parameters in sections on the macro documentation document.
In this use case the Section Compiler by Reference Macro is of great support. The body of the macro holds the sections that document parameters the macro does not share. These sections may be in any order. The Section Compiler by Reference Macro references a property that defines the order of all parameters that are to be included in the macro document's documentation. Each reference may refer to a document that contains share information about a parameter or a section in the macros body.
This way it is very easy to mix and merge parameter documentation that is shared with information that has been defined locally.
Usability Enhancements
Autocomplete support is increased by supporting transclusion references ( PDAC-1315 - Getting issue details... STATUS ) and property names in drafts ( PDAC-1312 - Getting issue details... STATUS ).
The property name for the Display Document Property Macro is now a mandatory property ( PDAC-1314 - Getting issue details... STATUS ). Although the default would still be the name of the referenced document, by enforcing to specify a name the macro editor automatically pops up. Since the reference is often not to the name property, this update does better support the usability.
For Scroll Word Exporter (formerly known as Scroll Office) the projectdoc Toolbox now autodetects the required quirk mode ( PDAC-1324 - Getting issue details... STATUS ).
Upgrade Instructions
Here is a short guide to update to this new version of the projectdoc Toolbox. For detailed information on dependencies, please consult the documentation of the add-ons.
Installation Order
Please install the projectdoc Toolbox first, then the extensions and finally update the doctypes.
So this is the basic order:
- projectdoc Toolbox
- extension add-ons (start with Web API Extension)
- doctype add-ons (start with Core Doctypes)
Please install only those add-ons that are actually used! In case you do not use the Web API, there is no need to install it. 
Reindex
Due to the following issues a reindex is required to update properties.
In case you do not use any of these features, there is no need for a reindex.
Please refer to Troubleshooting Reindexer for projectdoc Documents for details on how to reindex projectdoc documents.
Related Releases
Extension Add-ons
The following extension are required to be updated for the projectdoc Toolbox.
Doctype Add-ons
The following doctype add-ons are recommended to be updated for the projectdoc Toolbox.
| Doctype Add-on | Version |
|---|---|
| Core Doctypes Add-on | 14.1.1 |
11.1.4 | |
12.1.0 | |
5.1.3 | |
3.3.1 | |
3.1.2 | |
| Doctypes for Software Development | 11.2.1 |
3.1.3 | |
3.1.2 |
All doctype add-ons are optional. In case an add-on is not installed, there is no need to install it for this version of the projectdoc Toolbox.
Doctypes for Agile Planning
The following changes are part of the latest Doctypes for Agile Planning.
projectdoc Developer Diaries
The following changes are part of the latest projectdoc Developer Diaries.
Doctypes for Project Management
The following changes are part of the latest Doctypes for Project Management.
Doctypes for Service Management
The following changes are part of the latest Doctypes for Service Management.
Doctypes for Business Strategy
The following changes are part of the latest Doctypes for Business Strategy.
Doctypes for Software Development
The following changes are part of the latest Doctypes for Software Development.
Resources
- Release Notes
- Information on all released versions of the projectdoc Toolbox for Confluence.
- Glossary
- Terms used in and defined for projectdoc.
- FAQs
- Questions and answers related to the projectdoc Toolbox and Confluence.
