HTML Placeholder Replacements, Section Index Macro, and more new features, improvements, and bug fixes.
Today we released version 4.8.0 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.
Breaking Changes
The Web API Extension reports a breaking change with
List of Changes
The following changes are part of the latest projectdoc Toolbox for Confluence.
| Key | Summary | T | P | Description |
|---|---|---|---|---|
| PDAC-1342 | Autocomplete for CSS Classes |
|
|
Provide autocomplete for macro parameters to specify CSS classes. |
| PDAC-1334 | Section Index Macro |
|
|
Add a macro to render an index over the sections on a page. This macro works with the Section Compiler Macro and allows to reference transcluded sections and local sections. |
| PDAC-1333 | Transclusion Macro with HTML Replacements |
|
|
Allow a table for the definition of placeholders and their replacements. |
| PDAC-1339 | Section Compiler with Filter |
|
|
Allow to filter on section names. This allows references to documents stay in the properties without the need to actually render the section. The use case for this are default elements, that need not to be listed as sections, but are mentioned with a reference to save space and not cluttering the page. |
| PDAC-1337 | Allow CSS Classes for Selected Properties |
|
|
Allowing to set CSS classes explicitly for the table that rendered the selected document properties (e.g by the use of the Transclusion Macro, Select Parameter). Especially allows the user to use projectdoc-hide. The information is still on the page for the use of the Section Index Macro, but not rendered in the individual sections. The parameter defaults can be set by the space property projectdoc.css.table.selected-properties. |
| PDAC-1331 | Ancestor-Property for Name List Macro |
|
|
The new strategy ancestor-property should allow to default to the Unique Property value of an ancestor in case no value is set in the Name List Macro. The use case for this is the Glossary Item that could inherit the property of the parent document. |
| PDAC-1332 | Section Compiler prefer local Sections |
|
|
The Section Compiler by Reference Macro should allow to override transcluded content with locally specified sections. Also, the identifier of the local section macro should be used for the match, if present. This way a user may override the name of the property and still have a reference to the property it is based on. |
| PDAC-1352 | Code Transclusion removes empty Parameter List |
|
|
When placeholder replacement is conducted on transcluded code, the empty parameter list (i.e. "()") is removed in some locations. For instance ... function () { ...
is transformed to ... function { ...
|
| PDAC-1351 | Sum with Section Index Macro |
|
|
Calculating the sum for a column fails when the Section Index Macro uses the transcluded content from the Section Compiler Macro. The problem is that the value of the property is not plain text. Therefore the text cannot be parsed as number. |
| PDAC-1350 | Fetch Latest Attachment |
|
|
The service to fetch an attachment by name does not check to return the latest version of the attachment. |
| PDAC-1347 | NPE on Child Fetch |
|
|
When checking the existence of documents on a doctype homepage with child mode, the code runs into an NPE if a child is not a projectdoc document. Pages that are no projectdoc document must be ignored. |
| PDAC-1345 | Compatibility Issue with Confluence 6.12.x |
|
|
The Increment Service is not compatible with Confluence 6.12.x. |
| PDAC-1343 | Autocomplete Name fails to consult Delegate Space |
|
|
When calculating the name for a document for autocomplete the service must take the delegate space into account. Currently all names from all spaces are provided for autocomplete. |
| PDAC-1341 | Table Merger on Lists with Subitems |
|
|
The Table Merger Macro should ignore subitems when merging tables. Subitems should be rendered as defined. Only toplevel element should be merged. Subitems that are empty, have no links, or have no items should be removed, if discard-empty, discard-no-links, or discard-no-items is selected. Currently the subitems are added as duplicates at the bottom of the list. |
| PDAC-1346 | Compatibility 6.12.x to 7.7.x |
|
|
This version is compatible with Confluence version 6.12.4 to 7.7.3. |
| PDAC-1353 | Fixed Unintentional Usage of Rendering a Header Image for Some Macros in Edit Mode |
|
|
The section macro and the transclusion macro render themselves in edit mode different to other macros. Their header image is replaced with an image that renders the most important information for an editing user. In case of the section macro this is the name of the section. Some macros (e.g. Section Compiler Reference macro or Section Index macro) were affected by this feature unintentionally. The transclusion macro was rendered with an "empty" image in some cases, which has been fixed to display the "@self" information. |
| PDAC-1349 | Runtime Space Property Service Enhancement |
|
|
Allow to access the Delegate Space and Search Space properties individually. |
| PDAC-1340 | Provide Common Children Label |
|
|
Add a label for projectdoc.doctype.common.children. |
| PDAC-1338 | Add default texts for Reference and Resource Section Intros |
|
|
Required for doctype add-ons built with the Doctypes Maven Plugin. |
| PDAC-1336 | Rename pd-short-description |
|
|
Rename the CSS class pd-short-description to projectdoc-short-description. In case users have overridden the class or use the selector in scripts, this is a breaking change. It is not marked as such since this has been considered internal API. |
| PDAC-1330 | Discard Empty for No Links and No Items always |
|
|
Whenever there is a discard on links or items, the empty lines should be discarded, too. |
| PDAC-1354 | Fix Pager Service |
|
|
The pager fails to iterate over the hit list with page size. |
| PDAC-1344 | Add missing Documentation to REST Services |
|
|
Some of the parameters of REST services are not documented. |
| PDAC-1335 | Fix NPE on Draft Transclusion |
|
|
In Macro Preview on a Draft Page the Transclusion Macro fails with NPE. |
Related Releases
Extension Add-ons
The following extension are required to be updated for the projectdoc Toolbox.
Web API Extension
The following changes are part of the latest Web API Extension.
| Key | Summary | T | P | Status | Resolution | Description |
|---|---|---|---|---|---|---|
| PDEXWAPI-54 | Representation of XML Fragments in REST Responses |
|
|
Done | Fixed |
The returned values in representations, for properties and sections, are now strings. As a consequence, dependent on the requested format (JSON or XML), the returned value for property values and section contents is now the escaped sequence of characters. The XML response: <p class="abc"> ... The JSON response: "<p class=\"abc\"> ..." This is a breaking change for the content of a section in XML and JSON format. While the handling of JSON is now easier, the handling of XML is a little harder (requiring to render the fragment to valid HTML). But since the namespace handling was broken here, too, it is now cleaner. Maybe we implement another approach for handling XML responses in the future. Currently there is no apparent demand of the XML interface to the REST services (the XML version is still supported and is now consistent over all values, but lacks namespaces and therefore handles XML/HTML fragments as strings). |
| PDEXWAPI-55 | Performance Issue when Sections are expanded |
|
|
Done | Fixed |
When sections are requested to be expaned, the performance of the REST service is very small. The list of selected properties does not apply to the filter. Therefore every section that matches the property name filter will be rendered. For use cases where the property name filter is not set, effectively every document in the result set gets fully rendered. |
| PDEXWAPI-53 | Apply Filter on Space Closure Properties |
|
|
Done | Fixed |
The Delegate Space and Search Space Property are added without checking the provided filter. The filter must also be enforced on these two properties. |
Bookmarklets Extension
The following changes are part of the latest Bookmarklets Extension.
| Key | Summary | T | P | Status | Resolution | Description |
|---|---|---|---|---|---|---|
| PDEXBML-19 | Remove "Macro" from Macro Names |
|
|
Done | Fixed |
The "Bookmarklet Macro" has the name "Bookmarklet Macro", but should have the label "Bookmarklet". This is a convention. Otherwise all listed macros would have the suffix Macro. The same is true for all other macros of this add-on. |
| PDEXBML-17 | Fix Bookmarklets Macro |
|
|
Done | Fixed |
On some environments the JavaScript code to display the bookmarklet buttons fails because of a circular structure in the HTML container: TypeError: Converting circular structure to JSON. |
| PDEXBML-20 | Label of Bookmarklet Macro |
|
|
Done | Fixed |
The key projectdoc-bookmarklet-macro.my-bookmarklet.label of the Bookmarklet Macro is not translated to the localized label. |
Information Systems Extension
The following changes are part of the latest Information Systems Extension.
| Key | Summary | T | P | Status | Resolution | Description |
|---|---|---|---|---|---|---|
| PDEXINFOSY-39 | Provide Tooltip for Links |
|
|
Done | Fixed |
The System, Site, and Javadoc Macro should allow a tooltip to be set. |
| PDEXINFOSY-42 | Remove "Macro" from Macro Names |
|
|
Done | Fixed |
The macros in this add-on are named "Xyz Macro", but should have the label "Xyz". This is a convention. Otherwise all listed macros would have the suffix Macro. |
| PDEXINFOSY-41 | Update to Latest Attachment Reference Attachment Code Block Macro |
|
|
Done | Fixed |
The Reference Attachment Code Block Placeholder does not update to show the contents of the latest attachment. |
| PDEXINFOSY-40 | No Preview in Draft Mode for Link Macros |
|
|
Done | Fixed |
Link macros render an error message when rendering the preview on a draft document. The message should make clear that no preview is (currently) supported. |
Doctype Add-ons
The following doctype add-ons are recommended to be updated for the projectdoc Toolbox.
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.
Core Doctypes
The following changes are part of the latest Core Doctypes Add-on.
| Key | Summary | T | P | Status | Resolution | Description |
|---|---|---|---|---|---|---|
| PDCORED-287 | Flag for Context in Home and Index Pages |
|
|
Done | Fixed |
Add an identifier to locate home and index pages of an app. |
| PDCORED-285 | Relation Property Defaults for Glossary Item |
|
|
Done | Fixed |
Per default the relation should have the same value as the parent glossary item's relation property. |
| PDCORED-283 | Render Type Homepage Links on Home and Index Pages |
|
|
Done | Fixed |
To enhance navigability we should render links to type homepages in the list of index views (aside panel) one homepages and index pages of doctypes. |
| PDCORED-282 | Default discard no-item links on new Spaces to false |
|
|
Done | Fixed |
Make the space property projectdoc.projectdoc-table-merger-macro.param.discard.activate.no-items=false the default for new spaces. This way new users see all the links and can easily switch them off by altering the value of the property. |
| PDCORED-286 | Provide Intro/Extro for References and Resources Sections |
|
|
Done | Fixed |
Adding a short introduction text makes reading references and resources more pleasing. |
| PDCORED-284 | Add Description Section to Home and Index Pages |
|
|
Done | Fixed |
The description section allows to describe the semantics of the listed documents. |
Doctypes for Agile Planning
The following changes are part of the latest Doctypes for Agile Planning.
| Key | Summary | T | P | Status | Resolution | Description |
|---|---|---|---|---|---|---|
| PDAGILE-100 | Flag for Context in Home and Index Pages |
|
|
Done | Fixed |
Add an identifier to locate home and index pages of an app. |
| PDAGILE-97 | Render Type Homepage Links on Home and Index Pages |
|
|
Done | Fixed |
To enhance navigability we should render links to type homepages in the list of index views (aside panel) one homepages and index pages of doctypes. |
| PDAGILE-96 | Default discard no-item links on new Spaces to false |
|
|
Done | Fixed |
Make the space property projectdoc.projectdoc-table-merger-macro.param.discard.activate.no-items=false the default for new spaces. This way new users see all the links and can easily switch them off by altering the value of the property. |
| PDAGILE-99 | Provide Intro/Extro for References and Resources Sections |
|
|
Done | Fixed |
Adding a short introduction text makes reading references and resources more pleasing. |
| PDAGILE-98 | Add Description Section to Home and Index Pages |
|
|
Done | Fixed |
The description section allows to describe the semantics of the listed documents. |
projectdoc Developer Diaries
The following changes are part of the latest projectdoc Developer Diaries.
| Key | Summary | T | P | Status | Resolution | Description |
|---|---|---|---|---|---|---|
| DEVDIARY-143 | Flag for Context in Home and Index Pages |
|
|
Done | Fixed |
Add an identifier to locate home and index pages of an app. |
| DEVDIARY-140 | Render Type Homepage Links on Home and Index Pages |
|
|
Done | Fixed |
To enhance navigability we should render links to type homepages in the list of index views (aside panel) one homepages and index pages of doctypes. |
| DEVDIARY-139 | Default discard no-item links on new Spaces to false |
|
|
Done | Fixed |
Make the space property projectdoc.projectdoc-table-merger-macro.param.discard.activate.no-items=false the default for new spaces. This way new users see all the links and can easily switch them off by altering the value of the property. |
| DEVDIARY-142 | Provide Intro/Extro for References and Resources Sections |
|
|
Done | Fixed |
Adding a short introduction text makes reading references and resources more pleasing. |
| DEVDIARY-141 | Add Description Section to Home and Index Pages |
|
|
Done | Fixed |
The description section allows to describe the semantics of the listed documents. |
Doctypes for Project Management
The following changes are part of the latest Doctypes for Project Management.
| Key | Summary | T | P | Status | Resolution | Description |
|---|---|---|---|---|---|---|
| PDPRJMGMT-85 | Flag for Context in Home and Index Pages |
|
|
Done | Fixed |
Add an identifier to locate home and index pages of an app. |
| PDPRJMGMT-84 | Fix Intro Parameter Name |
|
|
Done | Fixed |
Open Issue Severity and Status failed to render intro text because of a wrong parameter name. The name must changed from "intro" to "intro-text". |
| PDPRJMGMT-81 | Render Type Homepage Links on Home and Index Pages |
|
|
Done | Fixed |
To enhance navigability we should render links to type homepages in the list of index views (aside panel) one homepages and index pages of doctypes. |
| PDPRJMGMT-80 | Default discard no-item links on new Spaces to false |
|
|
Done | Fixed |
Make the space property projectdoc.projectdoc-table-merger-macro.param.discard.activate.no-items=false the default for new spaces. This way new users see all the links and can easily switch them off by altering the value of the property. |
| PDPRJMGMT-83 | Provide Intro/Extro for References and Resources Sections |
|
|
Done | Fixed |
Adding a short introduction text makes reading references and resources more pleasing. |
| PDPRJMGMT-82 | Add Description Section to Home and Index Pages |
|
|
Done | Fixed |
The description section allows to describe the semantics of the listed documents. |
Doctypes for Service Management
The following changes are part of the latest Doctypes for Service Management.
| Key | Summary | T | P | Status | Resolution | Description |
|---|---|---|---|---|---|---|
| SERVICES-37 | Flag for Context in Home and Index Pages |
|
|
Done | Fixed |
Add an identifier to locate home and index pages of an app. |
| SERVICES-34 | Render Type Homepage Links on Home and Index Pages |
|
|
Done | Fixed |
To enhance navigability we should render links to type homepages in the list of index views (aside panel) one homepages and index pages of doctypes. |
| SERVICES-33 | Default discard no-item links on new Spaces to false |
|
|
Done | Fixed |
Make the space property projectdoc.projectdoc-table-merger-macro.param.discard.activate.no-items=false the default for new spaces. This way new users see all the links and can easily switch them off by altering the value of the property. |
| SERVICES-36 | Provide Intro/Extro for References and Resources Sections |
|
|
Done | Fixed |
Adding a short introduction text makes reading references and resources more pleasing. |
| SERVICES-35 | Add Description Section to Home and Index Pages |
|
|
Done | Fixed |
The description section allows to describe the semantics of the listed documents. |
Doctypes for Business Strategy
The following changes are part of the latest Doctypes for Business Strategy.
| Key | Summary | T | P | Status | Resolution | Description |
|---|---|---|---|---|---|---|
| STRATEGY-32 | Flag for Context in Home and Index Pages |
|
|
Done | Fixed |
Add an identifier to locate home and index pages of an app. |
| STRATEGY-29 | Render Type Homepage Links on Home and Index Pages |
|
|
Done | Fixed |
To enhance navigability we should render links to type homepages in the list of index views (aside panel) one homepages and index pages of doctypes. |
| STRATEGY-28 | Default discard no-item links on new Spaces to false |
|
|
Done | Fixed |
Make the space property projectdoc.projectdoc-table-merger-macro.param.discard.activate.no-items=false the default for new spaces. This way new users see all the links and can easily switch them off by altering the value of the property. |
| STRATEGY-31 | Provide Intro/Extro for References and Resources Sections |
|
|
Done | Fixed |
Adding a short introduction text makes reading references and resources more pleasing. |
| STRATEGY-30 | Add Description Section to Home and Index Pages |
|
|
Done | Fixed |
The description section allows to describe the semantics of the listed documents. |
Doctypes for Software Development
The following changes are part of the latest Doctypes for Software Development.
| Key | Summary | T | P | Status | Resolution | Description |
|---|---|---|---|---|---|---|
| PDSWDEVD-162 | Flag for Context in Home and Index Pages |
|
|
Done | Fixed |
Add an identifier to locate home and index pages of an app. |
| PDSWDEVD-159 | Render Type Homepage Links on Home and Index Pages |
|
|
Done | Fixed |
To enhance navigability we should render links to type homepages in the list of index views (aside panel) one homepages and index pages of doctypes. |
| PDSWDEVD-158 | Default discard no-item links on new Spaces to false |
|
|
Done | Fixed |
Make the space property projectdoc.projectdoc-table-merger-macro.param.discard.activate.no-items=false the default for new spaces. This way new users see all the links and can easily switch them off by altering the value of the property. |
| PDSWDEVD-161 | Provide Intro/Extro for References and Resources Sections |
|
|
Done | Fixed |
Adding a short introduction text makes reading references and resources more pleasing. |
| PDSWDEVD-160 | Add Description Section to Home and Index Pages |
|
|
Done | Fixed |
The description section allows to describe the semantics of the listed documents. |
| PDSWDEVD-157 | Details for Code Doctype |
|
|
Done | Fixed |
The Details section has a wrong I18N key and the description text refers to a property instead of a code. |
Doctypes for Teamwork
The following changes are part of the latest Doctypes for Teamwork.
| Key | Summary | T | P | Status | Resolution | Description |
|---|---|---|---|---|---|---|
| PDTEAMWORK-39 | Flag for Context in Home and Index Pages |
|
|
Done | Fixed |
Add an identifier to locate home and index pages of an app. |
| PDTEAMWORK-36 | Render Type Homepage Links on Home and Index Pages |
|
|
Done | Fixed |
To enhance navigability we should render links to type homepages in the list of index views (aside panel) one homepages and index pages of doctypes. |
| PDTEAMWORK-35 | Default discard no-item links on new Spaces to false |
|
|
Done | Fixed |
Make the space property projectdoc.projectdoc-table-merger-macro.param.discard.activate.no-items=false the default for new spaces. This way new users see all the links and can easily switch them off by altering the value of the property. |
| PDTEAMWORK-38 | Provide Intro/Extro for References and Resources Sections |
|
|
Done | Fixed |
Adding a short introduction text makes reading references and resources more pleasing. |
| PDTEAMWORK-37 | Add Description Section to Home and Index Pages |
|
|
Done | Fixed |
The description section allows to describe the semantics of the listed documents. |
Doctypes for V-Modell XT
The following changes are part of the latest Doctypes for V-Modell XT.
| Key | Summary | T | P | Status | Resolution | Description |
|---|---|---|---|---|---|---|
| PDVMXT-39 | Flag for Context in Home and Index Pages |
|
|
Done | Fixed |
Add an identifier to locate home and index pages of an app. |
| PDVMXT-36 | Render Type Homepage Links on Home and Index Pages |
|
|
Done | Fixed |
To enhance navigability we should render links to type homepages in the list of index views (aside panel) one homepages and index pages of doctypes. |
| PDVMXT-35 | Default discard no-item links on new Spaces to false |
|
|
Done | Fixed |
Make the space property projectdoc.projectdoc-table-merger-macro.param.discard.activate.no-items=false the default for new spaces. This way new users see all the links and can easily switch them off by altering the value of the property. |
| PDVMXT-38 | Provide Intro/Extro for References and Resources Sections |
|
|
Done | Fixed |
Adding a short introduction text makes reading references and resources more pleasing. |
| PDVMXT-37 | Add Description Section to Home and Index Pages |
|
|
Done | Fixed |
The description section allows to describe the semantics of the listed documents. |