New artificial property Page Key.
Today we released version 3.1 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
- Breaking Changes
- Upgrade Instructions
- List of Changes
- Related Releases
- Core Doctypes
- Doctypes for Agile Planning
- projectdoc Developer Diaries
- Doctypes for Project Management
- Doctypes for Risk Management
- Doctypes for Service Management
- Doctypes for Business Strategy
- Doctypes for Software Development
- Doctypes for Teamwork
- Doctypes for V-Modell XT
- projectdoc arc42 Template
New and Noteworthy
Context Controlled Macros
Control the dynamic parameters of a macro by the document and space properties.
This new feature allows to override properties controlled by the template author, such as the Select parameter of the Display Table Macro.
More information on Context Controlled Macros and provided by the tip Use Context Controlled Macros.
Support Space Closure Default for Wiki Link Macro
The Wiki Link Macro allows to render a link to a projectdoc document on the delegate space or the search space. This is controlled by a parameter of the macro.
For index spaces this property should be set to 'search space
' by default, whereas it should default to 'delegate space
' on most other kinds of spaces.
The new version of the macro allows to specify this default behavior by the space property Default Space Closure.
Deep Link Support for more Macros
The Display Template
parameter of the Name List Macro now supports Deep Links.
The Deep Links used in the Display Table Macro now point to the last document in the deep link chain, when a link is added.
Tooltips
When the Display List Macro, Display Table Macro, Tour Macro, or Display Document Property Macro renders a link, the tooltip (aka title in HTML lingo) renders the Short Description of the document pointed to.
REST API Browser Issue Workaround
Due to an issue with the Atlassian REST API Browser (see CONFSERVER-57887) the URLs for the REST services provided by the projectdoc Toolbox and the Web API Extension are incorrect.
This version provides a workaround since the issue seems not to take too much interest by the Confluence community.
Read our blog article Problems with the Web API and the REST API Browser on this subject.
Breaking Changes
The following changes may be considered breaking changes, although we expect that no users will notice. Hence we do not release this version as a 4.0.
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
PDAC-1038 | Remove unused Link Properties Parameter from Name List Macro |
|
|
Done | Fixed |
The Name List Macro provides a parameter named Link Properties to mark the properties in the Display Template that should provided a link. Since the template allows to specify the link with $[...] and properties without a link with $ {...}there is no need for an extra property. Note that in case there is no link rendered, the whole value is considered to be the label for the link. Please note that for use cases that use this parameter, the properties listed in the Link Properties need to be updated in the template. That is, each property listed needs to have its curly braces replaced by square brackets. Old: ${Name} - ${Tags} And Link Properties: Name New: $[Name] - ${Tags} Without this update the whole template value would provide a link. |
The following features require a reindex to work on existing documents.
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
PDAC-1034 | Provide Page Key |
|
![]() |
Done | Fixed |
Add an additional artificial document property that identifies it by the space key and the page title. |
Upgrade Instructions
Install the new OBR of the projectdoc Toolbox.
No updates for extension add-ons or doctype add-ons are required. The update of doctype add-ons is recommended, though, since they provide new features, some of which require this latest version of the projectdoc Toolbox.
- Core Doctypes
- Doctypes for Agile Planning
- projectdoc Developer Diaries
- Doctypes for Project Management
- Doctypes for Risk Management
- Doctypes for Service Management
- Doctypes for Business Strategy
- Software Development Doctypes
- Doctypes for Teamwork
- Doctypes for V-Modell XT
- projectdoc Add-on for arc42
See Related Releases section below for a list of changes for each of this add-ons.
List of Changes
The following changes are part of the latest projectdoc Toolbox for Confluence.
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
PDAC-1053 | Context Controlled Macros |
|
|
Done | Fixed |
Allow remote controlled macros to be controlled by the context they live in. This includes the document it is part of, the hierarchy of pages, and the space. |
PDAC-1049 | Allow Images for Display Document Property As Image Macro |
|
|
Done | Fixed |
Adding an URL as a property value is a bit clumbsy. It would be easier to add an image and use the src URL from that image. This would make using the person and stakeholder doctypes regarding the image much easier. |
PDAC-1047 | Support Deep Links in Name List Template |
|
|
Done | Fixed |
The Display Template parameter of the Name List Macro should support the use of Deep Links. Currently only simple properties are supported. |
PDAC-1043 | Support Space Closure Default for Wiki Link Macro |
|
|
Done | Fixed |
The Wiki Link Macro allows to render a link to a projectdoc document on the delegate space or the search space. This is controlled by a parameter of the macro. For index spaces this property should be set to 'search space' by default, whereas it should default to 'delegate space' on all other kinds of spaces (we currently know of). Therefore we need to default to the space closure – being either search-space or delegate space (default) – which is a space property with name 'default-space-closure'. |
PDAC-1052 | Team Property Support |
|
![]() |
Done | Fixed |
Add a property to override user specific placeholder resolvement. By adding the property projectdoc.doctype.common.team or the translated name "Team" as a property to a page, to a page in the hierarchy up, or as a space property, the placeholders referring to the current user will be replaced by this property's value. This feature allows to override the placeholders in titles. This is a use case for developer journals, where these journals are used by a team. |
PDAC-1048 | Provide Tooltip for Name List Macro |
|
![]() |
Done | Fixed |
The Name List Macro should also render tooltips with the links. The tooltip shows the short description. Currently the tooltip uses the HTML title which supports no HTML. |
PDAC-1042 | Render Tooltip for Display List, Display Table, Tour Macro, and Display Property Macro |
|
![]() |
Done | Fixed |
Render a tooltip for property values that link to the document. The tooltip is per default the value of the Short Description property. |
PDAC-1040 | Allow Values in Space Property Check |
|
![]() |
Done | Fixed |
The Section and Content Marker Macro allow to check for the existence or not existence of space properties. We need to support to check for a specific value. |
PDAC-1046 | Transclusion Reference Macro fails to signal transclusion |
|
|
Done | Fixed |
The Transclusion Reference Macro does not add its transclusions to the TranscludedDocumentTitles. Therefore documents cannot determine from which pages they are transcluded of the Transclusion Reference Macro is used. |
PDAC-1056 | REST API Browser Issue Workaround |
|
![]() |
Done | Fixed |
Due to an issue with the REST API Browser (see https://jira.atlassian.com/browse/CONFSERVER-57887) the URLs for the REST services are incorrect. We added a workaround that fixes the problem. This workaround needs to be removed once the fix is applied by Atlassian. |
PDAC-1041 | Allow Rendered Values in Document Property Check |
|
![]() |
Done | Fixed |
The Section and Content Marker Macros allow to check for original values. We need to support values that need to be rendered prior to the check. |
PDAC-1036 | Transclusion should support hidden Headings |
|
![]() |
Done | Fixed |
If a section heading is hidden it should not be overridden by the configuration of the transcluding macro. |
PDAC-1035 | Transclusion Reference Macro with List of References |
|
![]() |
Done | Fixed |
The Transclusion References Macro should support to find a list of references in the specified property. Each reference found should be used for the transclusion. |
PDAC-1034 | Provide Page Key |
|
![]() |
Done | Fixed |
Add an additional artificial document property that identifies it by the space key and the page title. |
PDAC-1055 | Make Rendering Transclusion Box dynamic for Transclude Documents Macro |
|
|
Done | Fixed |
Currently the transclusion box cannot be controlled fro the Transclude Documents Macro, but it should. |
PDAC-1051 | Add Space Permission Parameter |
|
|
Done | Fixed |
Add a parameter to the Role List Macro to check space permissions as well as page permissions. |
PDAC-1038 | Remove unused Link Properties Parameter from Name List Macro |
|
|
Done | Fixed |
The Name List Macro provides a parameter named Link Properties to mark the properties in the Display Template that should provided a link. Since the template allows to specify the link with $[...] and properties without a link with $ {...}there is no need for an extra property. Note that in case there is no link rendered, the whole value is considered to be the label for the link. Please note that for use cases that use this parameter, the properties listed in the Link Properties need to be updated in the template. That is, each property listed needs to have its curly braces replaced by square brackets. Old: ${Name} - ${Tags} And Link Properties: Name New: $[Name] - ${Tags} Without this update the whole template value would provide a link. |
PDAC-1058 | Fix Steps Rendering |
|
![]() |
Done | Fixed |
When rendering heading numbers with steps, the steps also increment the numbering of the headings. |
PDAC-1057 | Deep Links for Display Table Macro should point to last Document |
|
![]() |
Done | Fixed |
A deep link should render a link to the last document the deep link points to. We (currently) see no use case for linking to the first document, which the linking algorithm actually resolves to. This change aligns with the approach of the Display Document Properties Macro. |
PDAC-1050 | Name Property for Index Entry Macro |
|
![]() |
Done | Fixed |
The Index Entry Macro fails to render the correct value in case the Name Property contains HTML markup. |
PDAC-1045 | Force no Short Description for Supplier Macros |
|
![]() |
Done | Fixed |
Supplier macros correctly set the rendering for the short description property to false. In case the behavior is overridden by the use of the space property 'extract-short-description-from-metadata-table' then the short description shows. The short description should never be rendered for supplier macros since this property is defined to be used with the main properties macro. |
PDAC-1044 | Text content with more than one non-breaking space not considered blank |
|
![]() |
Done | Fixed |
Most of the time text content is provided as one text string. If this text string contains a non-breaking space than this string is typically of length 1. This use case has been detected by the projectdoc Toolbox. Unfortunately if the text was longer than one and contained only blanks or non-breaking spaces, then this test fails. We need to detect text with of any sequence of blanks and non-breaking spaces to be detected as being blank. |
PDAC-1039 | Labels of Links in Property Values not resolved |
|
![]() |
Done | Fixed |
A property value that contains a link where the label is explicitly set, this label is no longer rendered. |
PDAC-1054 | Name List Macro renders wrong Phantom References |
|
|
Done | Fixed |
The Name List Macro is rendered as plain text for a phantom reference. Phantom references for the Name List Macro is currently not supported. The additional entry does no harm, but is not valid either. It needs to be removed. The DocumentPropertyRefs property contains values like "myspacekey.persontrueJane DoePersonal Informationtrue:Country". |
PDAC-1037 | NameList fails with NPE if Property is unknown |
|
|
Done | Fixed |
If the Display Template parameter of the Name List Macro contains a reference to an unknown property the rendering fails with an NPE. Instead the unknown property should result in rendering the unresolved placeholder. This way a user can recognize that either the placeholder is misspelled or the placeholder could be replaced by a further processing step. |
Related Releases
Core Doctypes
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
PDCORED-214 | Add references to Reports for Stakeholders |
|
![]() |
Done | Fixed |
Add properties to the Stakeholder template to reference report types a stakeholder is interested in and reports the stakeholder communicates. |
PDCORED-212 | Add Action and Communication Plan to Stakeholder |
|
![]() |
Done | Fixed |
Allow to plan how to work and communicate with a stakeholder. |
PDCORED-211 | Make Participations and Meetings for Stakeholders exandable |
|
![]() |
Done | Fixed |
To keep a better overview on the Stakeholder template, we need to add the Expand Macro to the sections that have growing lists of references (Meetings and Participations). |
PDCORED-210 | Stakeholder and Organization |
|
![]() |
Done | Fixed |
A stakeholder may also reference an organization instead of a person. While an organization may not provide values for all properties (e.g. salutation and given name), the address information is easily reusable. |
PDCORED-207 | Use Search Space Closure for Index Space |
|
![]() |
Done | Fixed |
To link to homepages from an index space, the default-space-closure space property needs to be set per default to the index space template. This way the links will find the homepages for doctypes on attachment spaces automatically. |
PDCORED-213 | Wrap Stakeholder Rating in Span Element |
|
|
Done | Fixed |
To make it easier to apply CSS for the stakeholder rating, we need to wrap the rendered text inside a span element with proper class attributes. projectdoc-selection pd-document-property-value-stakeholderRating- Plus
|
PDCORED-209 | Autofill Authors for Quote Doctype |
|
|
Done | Fixed |
When a user adds a quote document to a person, that person's name is automatically used for the authors of the quote. Now we need the same way of automatically select the right value for Authors in case a new quote is added to a resource or excerpt document. |
PDCORED-208 | Authors Property for Excerpt Doctype |
|
|
Done | Fixed |
Add a hidden property with name Authors that automatically uses the Authors property provided by a parent of any doctype (provided that property is also named "Authors"). |
PDCORED-206 | Stakeholder fails to reference Given Name |
|
![]() |
Done | Fixed |
The Stakeholder Doctype fails to reference the Given Name in the referenced Person Document. The name of the property is wrong. It must read "Given Name". |
PDCORED-204 | Use Flags instead of Tags for Docsection Pages |
|
![]() |
Done | Fixed |
Use flags instead of tags to tag home, index, and special pages. |
PDCORED-205 | Rename Index Space DE |
|
|
Done | Fixed |
The name of the index space for the DE locale needs to be renamed to contain the word "Index". |
Doctypes for Agile Planning
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
PDAGILE-71 | Use Flags instead of Tags for Docsection Pages |
|
![]() |
Done | Fixed |
Use flags instead of tags to tag home, index, and special pages. |
projectdoc Developer Diaries
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
DEVDIARY-104 | Support Team Journals |
|
|
Done | Fixed |
Remove the identifiers for users and replace them with a team identifier. This allows teams to run a joint journal. Add the Team property to either a page or space. Requires projectdoc 3.1. |
DEVDIARY-101 | Add List of continuing Events to Event Doctype |
|
![]() |
Done | Fixed |
The event doctype shows the list of events this event continues. Now we want the other perspective where we show the events that continue this event. This may typically be one event, but it may have more than that. |
DEVDIARY-103 | Use Flags instead of Tags for Docsection Pages |
|
![]() |
Done | Fixed |
Use flags instead of tags to tag home, index, and special pages. |
Doctypes for Project Management
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
PDPRJMGMT-49 | Add Participants to Templates |
|
![]() |
Done | Fixed |
Adding the Participants property to the following templates makes it easy to track them with stakeholders. The following doctypes should provide the Participants property:
|
Doctypes for Risk Management
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
PDRISKMGMT-2 | Add Participants to Templates |
|
![]() |
Done | Fixed |
Adding the Participants property to the following templates makes it easy to track them with stakeholders. The following doctypes should provide the Participants property:
|
Doctypes for Service Management
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
SERVICES-3 | Use Flags instead of Tags for Docsection Pages |
|
![]() |
Done | Fixed |
Use flags instead of tags to tag home, index, and special pages. |
Doctypes for Business Strategy
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
STRATEGY-3 | Use Flags instead of Tags for Docsection Pages |
|
![]() |
Done | Fixed |
Use flags instead of tags to tag home, index, and special pages. |
Doctypes for Software Development
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
PDSWDEVD-119 | Use Flags instead of Tags for Docsection Pages |
|
![]() |
Done | Fixed |
Use flags instead of tags to tag home, index, and special pages. |
Doctypes for Teamwork
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
PDTEAMWORK-10 | Use Flags instead of Tags for Docsection Pages |
|
![]() |
Done | Fixed |
Use flags instead of tags to tag home, index, and special pages. |
Doctypes for V-Modell XT
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
PDVMXT-13 | Add Projekttagebuch |
|
![]() |
Done | Fixed |
Add a doctype for the Projekttagebuch. |
PDVMXT-12 | Add Besprechungsdokument |
|
![]() |
Done | Fixed |
Add a doctype for the Besprechungsdokument. |
PDVMXT-11 | Use Flags instead of Tags for Docsection Pages |
|
![]() |
Done | Fixed |
Use flags instead of tags to tag home, index, and special pages. |
projectdoc arc42 Template
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
ARCFOURTWO-63 | I18N Keys for Types |
|
![]() |
Done | Fixed |
The keys projectdoc.doctype.view.type and projectdoc.doctype.project-contraint.type have been replaced by the generic projectdoc.doctype.common.type. The keys have not been replaced on the contrainst and the building blocks page. |
ARCFOURTWO-61 | Use Flags instead of Tags for Docsection Pages |
|
![]() |
Done | Fixed |
Use flags instead of tags to tag home, index, and special pages. |
ARCFOURTWO-62 | Show Blackbox Create Buttons |
|
|
Done | Fixed |
The Whitebox and Blackbox doctypes do not provide their own homepage since they are always added as subdocuments. Therefore these doctypes are not promoted. Users may choose these doctypes from the wizard, but need to click the "Show more" button to have access to the doctype's blueprint wizard. Having these doctype not promoted is correct, but the templates with the Create Buttons for Whitebox and Blackbox documents should be shown by default. |
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.