Send-to-Homepage, Remote Controlled Documents, Deep Links in Queries, Authentication for Remote Information Systems, List Queries, Enhanced Recursion Detection, and model-based Core Add-on.
Today we released version 2.0.0 of the projectdoc Toolbox on the Atlassian Marketplace!
The major release signals that all related doctype and extension add-ons need to be updated. We will continue with this semantic versioning from this version on.
Please note that this new version of the projectdoc Toolbox requires all doctype and extension add-ons for projectdoc need to be updated! See Required Add-on Updates for version details.
Also very important: The site needs to be reindexed! Otherwise exact match queries will fail (that is: find no documents). For some more information see Reindex required on this page.
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
The following changes may be the most interesting of this release.
Exact Match Query Fix
Exact match queries failed to be exact for word stems. That is in an exact match for "Tree" documents having "Trees" where also a match.
This has been fixed with this version. Unfortunately that requires that all exact match tokens need to be recalculated. Therefore a reindex of all pages of the Confluence site is required and the document cache needs to be cleared.
Run the content reindexer.
Troubleshooting Reindexer for projectdoc Documents provides an instruction on how to run the process.
Send to Homepage
Most projectdoc blueprint witzards allow to send a new page to its configured homepage. This feature has been completely redesigned which allows to render the altered location already in the page editor.
The update will also fix an issue where sending the new page to another space has been broken with the latest versions of Confluence.
See
PDAC-776
-
Homepage in different Space fails
Done
.
Remote Controlled Documents
The projectdoc Toolbox supports use cases where a remote system defines the content of a page. The macro parameters of the following macros can be controlled by request parameters.
- Transclusion Macro
- Transclude Documents Macro
- Display Table Macro
- Tour-by-Property Macro
- Index Entries Table Macro
An application may configure the rendering of a page via request parameters. Each macro can be addressed by its manually defined identifier (which happens to be rendered as a HTML identifier attribute). This allows to combine information in Confluence at request time.
Use cases are applications that need to render information on Confluence dependent on the context of the application. If the page needs to show information of different types, remote controlled documents allow to not materialize each combination of this information. Instead the different types are selected with request parameters.
Deep Links in Queries
Prior to this version projectdoc macros had access to the properties of documents in the result set. With version 2.0 also properties of referenced can be accessed. This feature is called "Deep Links".
Suppose "Document
" is a property that has a reference (created by a projectdoc macro or a Confluence link) to another document. To select the name of the document, use "Document->Name
" as expression of the select macro parameter. Links may be deeper than one level (e.g. " Document->Ref->Person->Name
").
The following macros support this feature:
- Display Table Macro
- Transclude Documents Macro
- Display List Macro
- Display List Template Macro
- Tour Macro
- Display Document Properties Macro
This feature is considered experimental. More information on Deep Links for Select Clauses and Where Clauses.
Impersonating OAuth and Basic Authentication
The projectdoc Toolbox provides services for the Information Systems Extension that allows to use Application Links to authenticate. Impersonating OAuth and Basic Authentication are supported.
The autoconverter (fetching the title information from a remote HTML page) and the transclusion macros take advantage of this new feature.
Breadcrumbs
projectdoc allows to provide a document name in addition to a page title. The page title is required to be unique within a Confluence space, but the name does not. It should be unique within its doctype, but even this constraint is not enforced.
The new Breadcrumbs Macro (see
PDAC-776
-
Homepage in different Space fails
Done
) allows to render the name instead of the title on the breadcrumbs. This macro is required to be rendered in the pages context. We use Brikit to provided this service for the header of every our pages.
Transaction Problems
In certain environments users suffered from transaction problems. These have been fixed in projectdoc Toolbox 1.17.1 Release Notes and are also available in this release.
Users that have faced transaction problems in the past are encouraged to test this version with their test cases!
List Queries
The projectdoc Toolbox allows to specify list queries in a more compact form due to
PDAC-802
-
Support Exact Match in List
Done
.
List queries run an exact match on a property where one of the values in the list has to match.
$<Name> ~ (One, Two, Three)
expands to
$<Name>=[One] OR $<Name>=[Two] OR $<Name>=[Three]
This is especially useful when a value is provided as a property.
$<Name> ~ (${Some Names})
Note that the List of values found in Some Names
may have links or be a macro (such as the Name List Macro). Values with a comma are not allowed since the comma is the delimiter of the list elements.
Enhanced Recursion Detection
This version puts more effort in detecting recursions between documents via property references. This is typically only an issue on an empty document cache. But in case of an empty cache this detection stops recursive calls quickly.
Doctype Models
With the Doctype Maven Plugin we unify our blueprint configuration. This will allow us to apply changes to doctypes faster.
Currently the Core Doctypes have already been updated. New doctype add-ons will be based on models and the other existing ones will be translated one-by-one.
Due to the new model approach, we also updated some of the internationalization keys. Therefore old doctype add-ons will not work with this version of the projectdoc Toolbox.
Page Sort Order
Queries now support the sort order defined with the space tool (see
PDAC-789
-
Support Sort Order that preserves the Page Hierarchy
Done
).
Use
#BREADTH_FIRST
or #DEPTH_FIRST
as Sort By parameter in macros running searches.
Import Version via REST
The latest version of the Maven Extension provides a REST resource to import version information from a Maven artifact. This allows to integrate the import of version information from a build server automatically.
Breaking Changes
The following changes break features from previous versions of the projectdoc Toolbox.
Please check carefully before updating to this version of the add-on!
Key | Summary | T | P | Status | Resolution |
---|---|---|---|---|---|
PDAC-776 | Homepage in different Space fails |
|
|
Done | Fixed |
PDAC-842 | Document Property Reference Representation |
|
![]() |
Done | Fixed |
PDAC-841 | Phantom References for Transclusion |
|
![]() |
Done | Fixed |
PDAC-823 | Exact Match Queries fail on Plural Forms |
|
![]() |
Done | Fixed |
PDAC-806 | Remove "div-" prefix from Section ID |
|
![]() |
Done | Fixed |
PDAC-843 | Provide data Attribute for Artificial Property Space |
|
|
Done | Fixed |
PDAC-800 | Section CSS Class on Non-Doctypes |
|
|
Done | Fixed |
Doctype Add-ons
Doctype add-ons provide space and page blueprints based on the projectdoc Toolbox.
projectdoc Core Doctypes
List of breaking changes in this add-on.
Key | Summary | T | P | Status | Resolution |
---|---|---|---|---|---|
PDCORED-123 | Update for Homepage Fix |
|
|
Done | Fixed |
PDCORED-141 | Hide Description Title per Default |
|
![]() |
Done | Fixed |
projectdoc for Software Development
List of breaking changes in this add-on.
Key | Summary | T | P | Status | Resolution |
---|---|---|---|---|---|
PDSWDEVD-96 | Update for Homepage Fix |
|
|
Done | Fixed |
projectdoc Add-on for arc42
List of breaking changes in this add-on.
Key | Summary | T | P | Status | Resolution |
---|---|---|---|---|---|
ARCFOURTWO-34 | Update for Homepage Fix |
|
|
Done | Fixed |
projectdoc for Agile Planning
List of breaking changes in this add-on.
Key | Summary | T | P | Status | Resolution |
---|---|---|---|---|---|
PDAGILE-45 | Update for Homepage Fix |
|
|
Done | Fixed |
projectdoc Developer Diaries
List of breaking changes in this add-on.
Key | Summary | T | P | Status | Resolution |
---|---|---|---|---|---|
DEVDIARY-59 | Update for Homepage Fix |
|
|
Done | Fixed |
projectdoc for Java Developers
List of breaking changes in this add-on.
Key | Summary | T | P | Status | Resolution |
---|---|---|---|---|---|
PDJAVADEV-19 | Update for projectdoc Toolbox 2.0 |
|
|
Done | Fixed |
PDJAVADEV-20 | Update to Maven Extension 2.0 |
|
|
Done | Fixed |
projectdoc for Maven Developers
List of breaking changes in this add-on.
Key | Summary | T | P | Status | Resolution |
---|---|---|---|---|---|
PDJAVADEV-19 | Update for projectdoc Toolbox 2.0 |
|
|
Done | Fixed |
PDJAVADEV-20 | Update to Maven Extension 2.0 |
|
|
Done | Fixed |
Doctypes for Project Management
List of breaking changes in this add-on.
Key | Summary | T | P | Status | Resolution |
---|---|---|---|---|---|
PDPRJMGMT-23 | Update for Homepage Fix |
|
|
Done | Fixed |
Extension Add-ons
Extension add-ons extends the functionality of the projectdoc Toolbox.
Information Systems Extension
List of breaking changes in this add-on.
Key | Summary | T | P | Status | Resolution |
---|---|---|---|---|---|
PDEXINFOSY-22 | Update to projectdoc Toolbox 2.0 |
|
|
Done | Fixed |
Maven Extension
List of breaking changes in this add-on.
Key | Summary | T | P | Status | Resolution |
---|---|---|---|---|---|
PDEXMVN-17 | Update to projectdoc Toolbox 2.0 |
|
|
Done | Fixed |
PDEXMVN-15 | Ensure Uniqueness |
|
|
Done | Fixed |
Web API Extension
List of breaking changes in this add-on.
Key | Summary | T | P | Status | Resolution |
---|---|---|---|---|---|
PDEXWAPI-19 | Update to projectdoc Toolbox 2.0 |
|
|
Done | Fixed |
Upgrade Instructions
The following topics have to be considered for an upgrade to this version.
Install the new OBR of the projectdoc Toolbox first.
Required Add-on Updates
The following add-ons need to be updated to work with this version of the projectdoc Toolbox.
The Maven Extension and the related doctype add-ons have been removed in 2025.
It is recommended to generate the information in other information systems (for instance Maven Sites) and then link from Confluence to these pages.
Note that all doctype add-ons and extensions are optional. None is required to be installed to run the projectdoc Toolbox. Although the use of the Core Doctypes is recommended.
Doctype Add-on | Version |
---|---|
9.0.0 | |
7.0.0 | |
6.0.0 | |
3.0.0 | |
8.0.0 | |
6.0.0 | |
projectdoc for Java Developers | 4.0.0 |
projectdoc for Maven Developers | 4.0.0 |
Doctype Add-on | Version |
---|---|
2.0.0 | |
2.0.1 | |
1.4.0 | |
Maven Extension | 2.0.0 |
Reindex required
The following changes require a content reindex.
Key | Summary | T | P | Status | Resolution |
---|---|---|---|---|---|
PDAC-842 | Document Property Reference Representation |
|
![]() |
Done | Fixed |
PDAC-841 | Phantom References for Transclusion |
|
![]() |
Done | Fixed |
PDAC-823 | Exact Match Queries fail on Plural Forms |
|
![]() |
Done | Fixed |
PDAC-843 | Provide data Attribute for Artificial Property Space |
|
|
Done | Fixed |
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-820 | Render non-normalized Property Values in Templates |
|
|
Done | Fixed |
We need to allow users to render the properties values in their rendered from without normalization. Due to the fact that ${...} indicates the normalized value, we need to introduce $<...> as the non-normalized reference. $[Name]: $<Subject> - ${Audience} Note that $[...] indicates that a link to the document should be rendered on the normalized value. |
PDAC-816 | Deep Links in Queries |
|
|
Done | Fixed |
Support Referencing Properties with deep links in queries. This allows rendering a property transitively using '->'. Deep links apply to SELECT and WHERE clauses (right hand side only) in selected macros (for instance the Display Table Macro). |
PDAC-815 | Remote Controlled Documents |
|
|
Done | Fixed |
We should allow a request to dynamically define the transclusion. Request parameters may override parameters from a transclusion macro iff the id matches the parameter. This way a call can compose a page that otherwise needs to be materialized for each combination. |
PDAC-811 | Add Doctype Class to Body Element |
|
|
Done | Fixed |
It is important to be able to apply styles to a page dependent on the doctype of the page. The CSS attribute should have the selector "projectdoc-doctype-[doctypeId]" set. This way CSS styles may be applied easily to the body or any element within. |
PDAC-802 | Support Exact Match in List |
|
|
Done | Fixed |
Allow to specify queries where a property must make an exact match with one of the elements in a list. $<Xyz>~(a, b, c) $<Xyz>~(${Abc}) $<Xyz>~(${Abc}, a, b, ${Def}) |
PDAC-785 | Breadcrumb Macro |
|
|
Done | Fixed |
Provide a macro to create a breadcrumb based on document properties. Per default we need to show the name of the document instead of its title. |
PDAC-824 | Recursion Detection for Display Property Macro |
|
![]() |
Done | Fixed |
Recursion using display properties is a problem on empty caches (otherwise the cache quickly terminates the recursion). Therefore we need to detect circles to render a proper failure messages. |
PDAC-808 | Provide ID for Quote Macros |
|
![]() |
Done | Fixed |
To support single sourcing with quote macros more easily, allow users to specify an identifier to be rendered as an HTML attribute. The removes the burden of wrapping a quote inside a content marker macro. |
PDAC-807 | Render HTML ID for Content Marker |
|
![]() |
Done | Fixed |
Support single sourcing with the Content Marker Macro should add an HTML ID element when the content is rendered on the enclosing DIV element. Currently only the start is rendered as a span element. |
PDAC-795 | Tag Body List Macro |
|
![]() |
Done | Fixed |
Allow to quickly add tags to a document with a text editor in the tag's body. |
PDAC-789 | Support Sort Order that preserves the Page Hierarchy |
|
![]() |
Done | Fixed |
Check if there as an easy way to provide sort orders breadth- and depth-first on the page hierarchy for running queries. |
PDAC-788 | Version Box |
|
![]() |
Done | Fixed |
To provide version dependent information we need to have a special kind of box. |
PDAC-832 | Support for Colored Sections With Rounded Boxes |
|
|
Done | Fixed |
Every projectdoc section created by the projectdoc-section-macro supports to change the color of the heading and the text within the section. Moreover the section shall be surrounded by a box with rounded edges.
|
PDAC-813 | Servlet to Render a HTML Border Image to Display the Doctype |
|
|
Done | Fixed |
The servlet shall render the doctype title to an image with a certain width and height to be used in a custom CSS to render a border to the main content of a Confluence page. |
PDAC-842 | Document Property Reference Representation |
|
![]() |
Done | Fixed |
In order to support phantom references for property references in future we need to change the string representation for property references. Currently the format is PAGE_ID:PROPERTY_NAME. This needs to be changed to SPACE_KEY.PAGE_TITL:PROPERTY_NAME. This change requires a reindex. Therefore this should be applied to 2.0 of the projectdoc Toolbox which already requires a Lucene reindex. |
PDAC-841 | Phantom References for Transclusion |
|
![]() |
Done | Fixed |
Phantom references should point to transclusions whether or not the target page exists. Positive effects:
|
PDAC-840 | Refresh Page Tree after Copy Tree |
|
![]() |
Done | Won't Fix |
Confluence 6.x allows to copy a page with its descendants. Transclusions or references may need to refresh the page tree from its root. This is not necessary for all use cases, but should be done automatically. |
PDAC-837 | More Controls for Image Link |
|
![]() |
Done | Fixed |
Provide more controls for the Display Property As Image to set the URL for the rendered image. Currently the macro will either render no link or render a link to the image. We should allow to let the user define the property the image should link to. Per default, if a link is requested, the link should point to the document the property is part of. |
PDAC-831 | Display Document Property Reference Concatenation fails with Space Links |
|
![]() |
Done | Fixed |
The Display Document Property Reference Macro fails in following links to another space. The macro should be agnostic to the location of the page. |
PDAC-830 | Force Properties to Show |
|
![]() |
Done | Fixed |
For use cases where the table should show a fixed number of rows and remind authors to apply additional information, we need a property control to force showing the empty property value. |
PDAC-829 | Mandatory Properties |
|
![]() |
Done | Fixed |
Provide a control to signal that a property is mandatory. If a mandatory property is not specified, an error message should be rendered. The control is only on the document instance. The property cannot be forced to be provided. If a user removes the control, it is no longer mandatory for the given document. |
PDAC-828 | Display Document Property Reference fails with Space Links |
|
![]() |
Done | Fixed |
The Display Document Property Reference Macro fails in following links to another space. The macro should be agnostic to the location of the page. |
PDAC-827 | Blank unresolved Placeholders |
|
![]() |
Done | Fixed |
Allow users to control whether unresolved placeholders with the Display Document Properties Macro should be rendered or not. |
PDAC-826 | Support Updates for Display Properties Macro |
|
![]() |
Done | Fixed |
The Display Properties Macro need to be alerted by changes as does the Display Property Macro. |
PDAC-809 | Allow Verbatim Rows in Tour Macro |
|
![]() |
Done | Fixed |
Rows with a smaller row count should be written verbatim instead of being skipped. |
PDAC-806 | Remove "div-" prefix from Section ID |
|
![]() |
Done | Fixed |
The Section Macro renders a "div-" prefix in front of the ID for a section. This should be removed since the ID is identifying the whole section. We should add an additional identifier for the section heading. This is the same as the new section ID, but with a suffix "-head". |
PDAC-805 | Add CSS Selector for Doctype |
|
![]() |
Done | Fixed |
The toplevel elements of a projectdoc document should add a CSS selector to allow doctype-specific styles to be applied. The CSS selector is prefixed with projectdoc-doctype- and appends the lower-cased doctype ID. The currently used pattern projectdoc- {doctypeID}is deprecated and will be removed from future versions. |
PDAC-803 | Add CSS Selector for Space |
|
![]() |
Done | Fixed |
The toplevel elements of a projectdoc document should add a CSS selector to allow space-specific styles to be applied The CSS selector is prefixed with projectdoc-space-key- and appends the lower-cased space key. |
PDAC-798 | Code Placeholder Macro should support simple Escaping |
|
![]() |
Done | Fixed |
A '\' in front of a $ that introduces a placeholder should prevent the replacement. Another '\' in front of the '\' should prevent the escaping. This is quite crude but should hold for most of our use cases. |
PDAC-796 | Support simple "NOT" for Space List Macro |
|
![]() |
Done | Fixed |
We need a simple way to support filtering out spaces in the AND clause. |
PDAC-794 | Create One Document Enhancements |
|
![]() |
Done | Fixed |
Support Doctype Names and provide mode for subdocuments. Subdocuments need to have page titles handled two-way: Check with parent title appended, but add the raw title to the button. |
PDAC-783 | Provide CSS class for Display Property and Display Property Ref Macro |
|
![]() |
Done | Fixed |
Applying styles to a value rendered by the Display Document Property Macro and Display Document Property Ref Macro is required to alter the rendering. |
PDAC-780 | Allow Any Doctype for a Parent |
|
![]() |
Done | Fixed |
Currently the Display Parent Property Macro shows the value only if the parent doctype matches the one given (or its own doctype if empty). We need a simple solution to accept any document type. |
PDAC-778 | Add Margin to titleless Sections |
|
![]() |
Done | Fixed |
If the section title of the first section is hidden, the text is much too close to the properties table. |
PDAC-843 | Provide data Attribute for Artificial Property Space |
|
|
Done | Fixed |
Provide data attribute to the rendered artificial property 'Space'. |
PDAC-839 | User Must Be Informed Of a Imperative Lucene Reindex |
|
|
Done | Fixed |
Due to a change of the lucene reindex handling for exact matches within the projectdoc Toolbox it is imperative that the user is informed that a reindex has to be performed. |
PDAC-821 | Add HTML Data Attribute For Each Property in Display Table |
|
|
Done | Fixed |
For each property (rendered in a td) in the result of a display table two HTML data attributes are rendered:
e.g.: |
PDAC-812 | Add REST Documentation |
|
|
Done | Fixed | |
PDAC-800 | Section CSS Class on Non-Doctypes |
|
|
Done | Fixed |
The Section Macro renders the doctype ID as part of the CSS class on the enclosing HTML DIV element. If the section is on a non-projectdoc page, this value resolves to 'null' so that the class 'projectdoc-null' is rendered. The 'null' sequence may seem as a bug. Therefore we need to change the sequence to 'projectdoc-not-a-doctype'. This change breaks the runtime if users have specified CSS styles where the use the old 'projectdoc-null' CSS class. |
PDAC-781 | Check Link with External Link Macro |
|
|
Done | Fixed |
Template authors may need to signal the macro that only the label, but not the link can be rendered. |
PDAC-776 | Homepage in different Space fails |
|
|
Done | Fixed |
When directing a new document to its homepage that won't work for different spaces. This is due to changes to the way Confluence handles the page creation process. |
PDAC-810 | Diff applied to Draft Documents |
|
|
Done | Fixed |
The Diff mechanism also checks drafts, but should only handle existing pages. |
PDAC-790 | Prevent Eager Updates |
|
|
Done | Fixed |
Eager updates cause transaction problems on some environments. |
PDAC-786 | Moving a Page must update Children |
|
|
Done | Fixed |
The child pages of a moved page are currently not updated. This can be done manually with a refresh page tree, but this is merely a workaround. After a move we need to update the complete tree of children to update ancestor information. |
PDAC-838 | Reindex fails on corrupted Document Cache |
|
![]() |
Done | Fixed |
If the document cache is invalid, reindexing may fail. We need to make the reindex robust by not relying on the existence of the document cache. Therefore the document cache should be cleared before the indexer is started. |
PDAC-836 | Transcluded-by Calculation fails with Fragment-Cache |
|
![]() |
Done | Fixed |
If the fragment cache is activated the calculation of the transcluded-by artificial properties is broken. |
PDAC-835 | Caching Blank Level Fragments |
|
![]() |
Done | Fixed |
The fragment cache fails to cache fragments without target heading properly. The fragment is matched with blank level, but written to with a default level 1. This results in poor cache usage since the new value for level 1 clears all fragments. The cache must be filled with the correct heading level to improve cache usage. |
PDAC-833 | Tour Macro fails to render properly in DL Mode |
|
![]() |
Done | Fixed |
A link to a blog post fails to render in the Tour Macro in definition list mode. The line is simply skipped. |
PDAC-823 | Exact Match Queries fail on Plural Forms |
|
![]() |
Done | Fixed |
Exact match queries fail if Lucene derives a valid word stemp. This will require a reindex to fix exact match queries. |
PDAC-819 | Own missing Properties in Where Clause |
|
![]() |
Done | Fixed |
If a non-existing property of a document is part of the Where clause then this constraint is removed. $<testproperty> = [${XXX}]
If XXX is not a property, there is no constraint on the testproperty. |
PDAC-818 | Fix CSS class rendering for Content Marker Macro |
|
![]() |
Done | Fixed |
The rendering of the CSS classes is done as HTML attributes without value. |
PDAC-817 | Plain List Support |
|
![]() |
Done | Fixed |
The Display Table Macro allows to render lists. 'plain' should render a list as a comma separated list of values and should allow to render elements as links or as plain text. |
PDAC-804 | Fix CSS Selectors |
|
![]() |
Done | Fixed |
We should provide a projectdoc- prefix for all our CSS selectors. |
PDAC-801 | Template Lists fail to render Sections |
|
![]() |
Done | Fixed |
In cases of rendering search results as a list, accessing information from sections is no longer possible. Only property values are accessible. Independent on being a property or a section, all values need to be rendered in template mode. |
PDAC-799 | Delegating Renderer issues Exception |
|
![]() |
Done | Fixed |
A delegating document passes an already rendered body to the delegation document renderer. This results to a (swallowed) exception if the rendered content is no valid XML. |
PDAC-797 | Code Placeholder Macro fails on Angle Brackets |
|
![]() |
Done | Fixed |
The Code Placeholder Macro fails to render $<name>=123 The macro should not touch this sequence of characters. The renderer should also skip square bracket placeholders. |
PDAC-793 | Missing Space rendering data-projectdoc-id |
|
![]() |
Done | Fixed |
In some contexts the rendering of the attribute data-projectdoc-id fails to render a space in front. This causes trouble with parsers that do not expect to have the name of an XML attribute attached to the quotes of the previous attribute value without a space. |
PDAC-792 | NPE if Quote Document has no Parent |
|
![]() |
Done | Fixed |
The quote document expects to be a child to a resource document. If there is no parent, the rendering of the quote runs into a NPE. |
PDAC-791 | Redundant Closing DIV Element with Table Rendering |
|
![]() |
Done | Fixed |
The table section rendering mode (e.g. 5+) of the Display Table Macro renders on HTML div element too much. |
PDAC-787 | Remove Transaction from Admin-Cache-Refresh |
|
![]() |
Done | Fixed |
A refresh run via the admin servlet is run in an transaction. This is not necessary and the transaction needs to be removed. Note that this process is neither used by the Lucene Indexer nor by the Refresh Tree Action users can call from the UI. |
PDAC-777 | Allow Wiki Link for Doctype Homepage Value |
|
![]() |
Done | Fixed |
Currently the space property projectdoc.doctype.(doctype).home only allows plain text links (e.g. My Page or SPACEKEY.My Page). We should also allow a link to another page in this wiki. |
PDAC-784 | Normalize CSS value for Name List Macro |
|
|
Done | Fixed |
The value provided by the user should be normalized before it applies to the value. |
PDAC-779 | Tour Macro fails Name Rendering in DL Mode |
|
|
Done | Fixed |
The definition list mode of the Tour Macro does not change the title with the name property if instructed to do so. With the table macro everything works fine. |
Related Releases
Doctype Add-ons
Doctype add-ons provide space and page blueprints based on the projectdoc Toolbox.
Doctype add-ons typically provide blueprints based on macros provided by the projectdoc Toolbox. These add-ons need a licensed version of the projectdoc Toolbox to be installed.
projectdoc Core Doctypes
List of changes in this add-on.
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
PDCORED-135 | Use Model to create Add-on Project |
|
|
Done | Fixed |
Using a model makes it easier (and faster) to create new doctypes. Especially doctypes with type specific types are much easier. We intend to have it easier to apply changes to home and index pages that will be rolled out for each doctype. |
PDCORED-140 | Add Index Space |
|
![]() |
Done | Fixed |
Add a blueprint to create an index space. |
PDCORED-139 | Add Library (Space) |
|
![]() |
Done | Fixed |
Add a space to organize resources and sources. |
PDCORED-138 | Add Glossary (Space) |
|
![]() |
Done | Fixed |
Add a space to organize and manage terms of a domain. |
PDCORED-137 | Add Addressbook (Space) |
|
![]() |
Done | Fixed |
Add a space to create an addressbook for stakeholders and organizations. |
PDCORED-141 | Hide Description Title per Default |
|
![]() |
Done | Fixed |
The title of a description is typically noise since the relevance of the text is usually recognized by its position. Note that this change breaks the UI since existing documents may show their description title. |
PDCORED-130 | Subdocs and Parent Relationship |
|
![]() |
Done | Fixed |
Subdocuments should accept any doctype document as parent per default. This includes
|
PDCORED-127 | Standard Properties for Home and Index Pages |
|
![]() |
Done | Fixed |
Every index page and every home page for each doctype should have the standard properties table. We should also fix the missing p element around the paragraph on the index pages. |
PDCORED-136 | Remove Related Terms from Glossary Item |
|
|
Done | Fixed |
The related terms should not automatically list all terms since these tend to get long. It will be reserved for related terms that are manually added (or automated by more constraints). |
PDCORED-134 | Hide Name for Tags, Stakeholders, and Subjects by Default |
|
|
Done | Fixed |
The name is shown since the title is encoded. But this is merely a redundancy, especially if the HTML title shows the document's name instead of its title. |
PDCORED-133 | Add Subordinate Relations |
|
|
Done | Fixed |
Allow to build hierarchies of relations. |
PDCORED-131 | Add Parent Property to Docsection (aka Space Index) |
|
|
Done | Fixed |
The docsection doctyp should also allow to reference a parent of the same type. This is useful where the docsection pages provide views on other documents (for instance when a doctype homepage with a large number of documents is broken in multiple, browsable pages. |
PDCORED-129 | Stakeholder Rating Macro NPE on missing Document |
|
|
Done | Fixed |
If the document is missing, a Null Pointer Exception is thrown. |
PDCORED-126 | Title / Version |
|
|
Done | Fixed |
The title of the version template is set to the version by default. It should be prefixed with a 'V' to normalize titles to start with a letter. |
PDCORED-124 | Hide Names for Subdocuments |
|
|
Done | Fixed |
The name of a subdocument (which title has the name of the parent title appended) does not need to list the name. Therefore the Name property should be hidden for these documents. |
PDCORED-123 | Update for Homepage Fix |
|
|
Done | Fixed |
The fix ensures that this add-on works with the update of the homepage resolution process. Due to a change in the projectdoc Toolbox this upgrade will not be backward compatible. |
PDCORED-125 | Profile is not a Subdocument |
|
![]() |
Done | Fixed |
The Profile Doctype is currently modeled as a subdocument, but should be a document for its own. |
PDCORED-132 | Add Missing Parent Name Property |
|
|
Done | Fixed |
Even if the subdocs typically do not have a parent of its own kind, they should specify the name of the property for queries. Applies to
|
projectdoc for Software Development
List of changes in this add-on.
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
PDSWDEVD-102 | Add Charter, Profile, and Relation |
|
![]() |
Done | Fixed |
Reference to new doctypes provided by the Core Doctype Add-on. |
PDSWDEVD-103 | Add Home and Index Links |
|
![]() |
Done | Fixed |
Add links from home and index pages. |
PDSWDEVD-100 | Architecture Alternative accept any Doctype as Parent |
|
![]() |
Done | Fixed |
Subdocuments, like the Architecture Alternative, should accept any doctype document as parent per default. |
PDSWDEVD-98 | Hide Level Property |
|
|
Done | Fixed |
The level information is typically not relevant for the reader. It is a tool to allow to select elements of a given level. For some views this may also be a relevant information, in which case this property can be shown. Therefore we need to hide this information by default. |
PDSWDEVD-97 | Hide Description Title by Default |
|
|
Done | Fixed |
Since the description section is identified by its location, the title is redundant. Therefore we need to hide the title of the description section by default in our templates. |
PDSWDEVD-96 | Update for Homepage Fix |
|
|
Done | Fixed |
The fix ensures that this add-on works with the update of the homepage resolution process. Due to a change in the projectdoc Toolbox this upgrade will not be backward compatible. |
PDSWDEVD-101 | Fixes to Blueprints |
|
![]() |
Done | Fixed |
Fixes to I18N keys, spelling, blueprint configuration. Update online docs. |
projectdoc Add-on for arc42
List of changes in this add-on.
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
ARCFOURTWO-35 | Update to SWDEV 8 |
|
![]() |
Done | Fixed |
Update home / index pages and doctypes to match the configuration of SWDEV. |
ARCFOURTWO-36 | Index Pages as projectdoc Documents |
|
![]() |
Done | Fixed |
The index pages should provide document properties. |
ARCFOURTWO-34 | Update for Homepage Fix |
|
|
Done | Fixed |
The fix ensures that this add-on works with the update of the homepage resolution process. Due to a change in the projectdoc Toolbox this upgrade will not be backward compatible. |
projectdoc for Agile Planning
List of changes in this add-on.
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
PDAGILE-51 | Update for projectdoc Toolbox 2.0 |
|
|
Done | Fixed |
Update I18N keys and clean up for projectdoc Toolbox 2.0. |
PDAGILE-50 | Update for projectdoc Toolbox 2.0 |
|
|
Done | Fixed |
Update I18N keys and clean up for projectdoc Toolbox 2.0. This includes adding Charter and Relation doctypes. |
PDAGILE-45 | Update for Homepage Fix |
|
|
Done | Fixed |
The fix ensures that this add-on works with the update of the homepage resolution process. Due to a change in the projectdoc Toolbox this upgrade will not be backward compatible. |
PDAGILE-46 | User Story Template |
|
|
Done | Fixed |
The name of the template file for the user story doctype is misspelled. Therefore the template cannot be loaded. |
PDAGILE-48 | User Story Macro: Missing Property yields NPE |
|
|
Done | Fixed |
The User Story Macro runs into a NPE if the property to fetch the value to display is missing. |
PDAGILE-47 | User Story Macro: L10n for No Doc Found missing |
|
|
Done | Fixed |
The warning that a document to fetch information from has not been found depends on a L10n key that is missing the resource. |
projectdoc Developer Diaries
List of changes in this add-on.
DEVDIARY-63 | Index Pages as projectdoc Documents |
|
![]() |
Done | Fixed |
The index pages should provide document properties. |
DEVDIARY-64 | Add Home and Index Links |
|
|
Done | Fixed |
Add links from home and index pages. |
DEVDIARY-61 | Sort by Date not by Name on Year Page |
|
|
Done | Fixed |
We need to turn the sort order (although this would not affect any page that is generated with the default name). |
DEVDIARY-59 | Update for Homepage Fix |
|
|
Done | Fixed |
The fix ensures that this add-on works with the update of the homepage resolution process. Due to a change in the projectdoc Toolbox this upgrade will not be backward compatible. |
projectdoc for Java Developers
List of changes in this add-on.
PDJAVADEV-20 | Update to Maven Extension 2.0 |
|
|
Done | Fixed | |
PDJAVADEV-19 | Update for projectdoc Toolbox 2.0 |
|
|
Done | Fixed |
Adjustments for the update to the projectdoc Toolbox 2.0. |
projectdoc for Maven Developers
List of changes in this add-on.
PDMVNDEV-17 | Update to Maven Extension 2.0 |
|
|
Done | Fixed | |
PDMVNDEV-15 | Update for projectdoc Toolbox 2.0 |
|
|
Done | Fixed |
Adjustments for the update to the projectdoc Toolbox 2.0. |
Doctypes for Project Management
List of changes in this add-on.
PDPRJMGMT-24 | Update for projectdoc Toolbox 2.0 |
|
|
Done | Fixed |
Update I18N keys, pages. |
PDPRJMGMT-26 | Add Home and Index Links |
|
![]() |
Done | Fixed |
Add links from home and index pages. |
PDPRJMGMT-25 | Index Pages as projectdoc Documents |
|
![]() |
Done | Fixed |
The index pages should provide document properties. |
PDPRJMGMT-23 | Update for Homepage Fix |
|
|
Done | Fixed |
The fix ensures that this add-on works with the update of the homepage resolution process. Due to a change in the projectdoc Toolbox this upgrade will not be backward compatible. |
Extension Add-ons
Extension add-ons extends the functionality of the projectdoc Toolbox.
Extension add-ons for the projectdoc Toolbox provide additional features. Extensions need a licensed version of the projectdoc Toolbox to be installed.
Information Systems Extension
List of changes in this add-on.
PDEXINFOSY-18 | Support Autoconverter with Impersonating and Basic Auth Access |
|
|
Done | Fixed |
Allow to use impersonating application links and basic authentication to access protected remote resources by the autoconverter. |
PDEXINFOSY-21 | Support Transclusion Macro with Impersonating and Basic Auth Access |
|
![]() |
Done | Fixed |
The remote transclusion macros need to use applinks to access protected resources. |
PDEXINFOSY-22 | Update to projectdoc Toolbox 2.0 |
|
|
Done | Fixed | |
PDEXINFOSY-17 | Default to Link Type |
|
![]() |
Done | Fixed |
If no type is defined for a link in "information-system-autoconvert-hint", a new type is assumed. Typically users want to define a link, therefore it would be easier (and less error-prone) if we would assume that the type is "link" per default. |
Maven Extension
List of changes in this add-on.
PDEXMVN-16 | Web API for POM Import |
|
|
Done | Fixed |
Provide a web API to allow the import of POM information. This allows to integrate the creation of projectdoc documents based on POM information into automation processes. |
PDEXMVN-17 | Update to projectdoc Toolbox 2.0 |
|
|
Done | Fixed | |
PDEXMVN-15 | Ensure Uniqueness |
|
|
Done | Fixed |
The documents within a version need to have unique titles. Otherwise they override existing documents. There has to be a process to generate pages with a non-versioned title and pages with a title that has the version in it. |
PDEXMVN-12 | Mojo Parameter requires Mojo Name in Title |
|
|
Done | Fixed |
Parameters of Mojos may have the same name. Currently only the first page is created. Since the parameters are children to the Mojo page, we need to add the Mojo's name for uniqueness. |
PDEXMVN-14 | Hide Iteration Property |
|
|
Done | Fixed |
The iteration property of the plugin, mojo, and parameter documents should be hidden by default. There is no information for readers and site admins would typically need to hide it manually. |
PDEXMVN-13 | Remove Description Title from Mojo Docs |
|
|
Done | Fixed |
The title of the description sections should be suppressed for the plugin, the mojo, and the parameter descriptions. |
PDEXMVN-11 | Set Iteration to Finished |
|
|
Done | Fixed |
When creating a new document with the project space creator, the iteration of these documents should be set to finished instead of facade. |
PDEXMVN-10 | Fix Description Paragraph |
|
|
Done | Fixed |
When the description text is added to the section body, the body lacks the surrounding paragraph element. |
Web API Extension
List of changes in this add-on.
PDEXWAPI-19 | Update to projectdoc Toolbox 2.0 |
|
|
Done | Fixed |
Required update to meet the changes provided by the projectdoc Toolbox 2.0. |
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.