Fixing 86 issues since version 2.4.

Today we released version 2.5.1 of the projectdoc Toolbox on the Atlassian Marketplace!

This release provides some new features, improvements of existing features, and fixes a number issues.

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.

Download the projectdoc Toolbox or visit the projectdoc Toolbox on the Atlassian Marketplace!

New and Noteworthy

Check Property Value

With this version it is possible to show a section or content dependent on a property value.

property-name=my-value,!property-name2=other-value

Prior to this version hiding has been only possible on the presence or absence of a property.

Flags Property

All document types now provide an additional hidden property to add arbitrary strings. These strings are Flags and are used to filter document.

In contrast to Subject, Categories, and Tags, Flags are not defined by their own document type (therefore are not documented) and will not be used to describe the HTML document with Metadata Sets.

Wiki Syntax

Selected macros from the projectdoc Toolbox can now be used with wiki syntax. This allows to use these macros with Confluence, where the new macros are not allowed (such as the menu).

Updated Doctypes

The references and resources section use the Tour Macro by default. This makes it much easier for authors to add references to internal pages and show their short description.

The table is rendered as a definition list. So if the link in the first column of the table is an external link, and no short description is provided, the definition list supports a compact representation by omitting the data value.

Developer Diaries use Templates

Some developer diaries doctypes now use the template feature with the Display Table Macro. This allows to render the Iteration property compactly with the Short Description.

Layout Macros

The projectdoc Toolbox provides macros for layouting web pages.

These include:

Layout Element Macro: Renders an block or inline element of a page.
Action Button Macro: Renders an action button to link to a projectdoc document, Confluence page, or external resource.
Image Element Macro: Renders an image with an overlay text.
Random Transclusion Macro: Transcludes random content from a document marked with the content marker macro.
Page Include Macro: Supports page inclusion dependent on the space of the primary page.
Primary Page Display Document Property Macro: Renders the value of a document property from the primary page.

Breaking Changes

New Blueprint IDs

For all doctype add-on updates to their model version the blueprint keys change. This will effect the Create From Template Macro on existing pages.

This issue needs to either be resolved manually or by a text replacement tool.

Only the value for the blueprintModuleCompleteKey parameter of the macro needs to be replaced.

<ac:parameter ac:name="blueprintModuleCompleteKey">
  de.smartics.atlassian.confluence.smartics-projectdoc-confluence-space-swdev:projectdoc-blueprint-doctype-architecture-decision
</ac:parameter>

The new key prefix (excluding the name of the doctype) for the Software Development Doctypes Add-on is

de.smartics.atlassian.confluence.smartics-projectdoc-confluence-space-swdev:projectdoc-blueprint-doctype-

To update the value a user with write access may simply change the value in the macro editor of the Create From Template Macro:

If you do not want to scroll through long lists of blueprints, you may use the Source Code Editor and do the text replacement in the page source.

Reindex required

In order to fix broken phantom references (due to PDAC-922 - Phantom References broken Done ), a reindex is required.

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-168	Remove Domain Property from Glossary Item			Done	Fixed
PDCORED-186	Rename Glossary Items to Glossary			Done	Fixed

2 issues

projectdoc Add-on for arc42

List of breaking changes in this add-on.

Key	Summary	T	P	Status	Resolution
ARCFOURTWO-37	Remove Blackbox, Whitebox, and Interface Doctypes			Done	Fixed

1 issue

Known Issues

Site refresh required: After import of a space, a reindex and in some cases a refresh page tree is required.
Space cannot be deleted: Some spaces resist to be deleted.
Create From Template Macro fails: Instead of creating a new document instance for a doctype, the template button macro only logs an error to the browser's console.

Upgrade Instructions

Install the new OBR of the projectdoc Toolbox.

Updating the following extensions is required.

Extension Add-on for the projectdoc Toolbox	Version
Information Systems Extension	1.4.1
Web API Extension	3.0.4
Maven Extension	3.0.2

Updating the following doctype add-ons is recommended.

Doctype Add-on for the projectdoc Toolbox	Version
Core Doctypes	11.1.0
Doctypes for Software Development	9.0.0
projectdoc Add-on for arc42	7.0.0
Doctypes for Agile Planning	9.0.0
projectdoc Developer Diaries	7.0.0
Doctypes for Project Management	3.2.1
Doctypes for Teamwork	1.0.1
Doctypes for V-Modell^®XT	1.0.2
Doctypes for Risk Management	1.0.0

List of Changes

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

Key	Summary	Status	Resolution	Description
PDAC-964	List Match with AND	Done	Fixed	Support Where Clauses with a list query where all Elements of a Property Value (List) must match.
PDAC-959	Support Space Imports	Done	Fixed	Currently space imports need to be handled manually. We should append the initialization of the AO tables as part of the import process.
PDAC-953	Image Element Macro	Done	Fixed	Provide a macro to render images with text overlays.
PDAC-952	Layout Element Macro	Done	Fixed	In order to support layouting elements on a page, we need a macro to apply layout information.
PDAC-950	Random Transclusion Macro	Done	Fixed	Provide a macro to select from a set of contents randomly for transclusion.
PDAC-946	Display Property from Primary Page	Done	Fixed	Render a document property from a primary page.
PDAC-945	Page Include Macro	Done	Fixed	Add a macro to include from a page that may be stored in the primary page's space. If not, a default page body is rendered. If that is not present either, nothing is rendered.
PDAC-938	Support Grouping Doctypes with Properties	Done	Fixed	We need to support template authors to make it easier to reference information in related doctypes. Currently there is Doctype Docsubtype is-a To define the type of a document instance. Since is-a demands that the referenced doctype really exists, we need to introduce is-of to define a virtual family relation. Furthermore we add in-context to define a virtual context within which the doctype is defined. This is typically related to the bundle the doctype is part of. We will use the shortId of the add-on as default value. With the context the intended collection of doctypes can be easily selected (i.e. in case the doctype is to any reason not unique - although there will probably more problems to this to discover). The use case for is-of would be to grab from any doctype that belongs to a given virtual family. This is pretty much the same as is-a with the exception that the value may be an arbitrary string.
PDAC-937	Discard Items with Table Merger	Done	Fixed	Allow to configure the table merger so that empty items or items without links are discarded.
PDAC-933	Support Merging and Deleting from List Parameters	Done	Fixed	The API to refactor document property values needs to have the ability to adjust list values. New values may be merged into the list (no duplicates are added) and values may be removed from the list. Lists may either be elements in the td element or added by means of a macro (as body value or parameter value).
PDAC-929	Ancestor Searches in Lists	Done	Fixed	Allow to run Ancestor searches (using ^ and °) with a list query (using ~).
PDAC-915	Flags Property	Done	Fixed	Provide a new property called "Flags" that support adding arbitrary constraints by a common name and add them to the Page keywords / DC.subject
PDAC-914	Check Property Value for Sections	Done	Fixed	Allow to check rendering for the Content Marker Macro (and Section Macro) on property value.
PDAC-825	Support Lists for Deep Links	Done	Fixed	Currently Deep Links fetch the first link from a property value and follow it. We need to support a property value to be a list of links that need to be all followed so that the result is a list of values (but only if the list value is not considered to be a single value). This feature will be accessible through the Select parameter of macros.
PDAC-969	Internal Doctype REST Service	Done	Fixed	Experimental service to access doctype properties and metadata. Currently only a subset of properties is returned, therefore the REST service will show only this subset.
PDAC-968	Doctype Metadata from Model	Done	Fixed	Provide doctype metadata by the model to be applied to doctype instances as artificial properties. This will move them out of the editor (where they could still be overridden).
PDAC-966	Sort Elements in Table Merger Macro	Done	Fixed	Allow to sort tables by one column and lists (by their item / dt).
PDAC-958	Header Translations for all Macros with Select Param	Done	Fixed	Support the translation of headers for all macros that support a Select parameter. This is especially helpfull for Deep Links.
PDAC-951	Action Button Macro	Done	Fixed	Provide a macro to render an action button.
PDAC-932	Parent Doctype Related Subdocuments	Done	Fixed	Provide a wizard configuration to allow titles of new documents only expand on the Title Property value if the parent is actually of a doctype specified by the Parent Property.
PDAC-920	Render Expand Macros without Content as blank	Done	Fixed	If a Expand Macro within a Section Macro has no content, is must not be rendered.
PDAC-916	Wiki Syntax for selected Macros	Done	Fixed	We need to make some more macros available for Wiki Syntax: Tour-by-Property Macro Display Table Macro Display List Macro Display Template List Macro Transclude Documents Macro
PDAC-911	Provide File and File Folder as Domain Terms	Done	Fixed	We need a concept to allow to group a collection of documents or records to a file. projectdoc.doctype.common.file projectdoc.doctype.common.fileFolder
PDAC-902	Allow multiple Doctypes for Parent Macro	Done	Fixed	Allow the parent doctype to be a list of possible doctypes. Assume a parent hit if the parent's doctype matches any of the comma separated values.
PDAC-986	Performance Problem on Move Page Tree	Done	Fixed	Moving a page tree is very slow.
PDAC-983	Improve Move Events	Done	Fixed	Make move more responsive and run the updates asynchronously.
PDAC-967	Default for Loading Doctype Metadata	Done	Fixed	The alternative way needs to provide a fallback solution once the primary way of delivering fails.
PDAC-965	Remove Duplicate Lines from Table Merger	Done	Fixed	Per Default duplicate entries in tables, dls, uls, and ols should be removed by the Table Merger Macro.
PDAC-962	CSS Selectors for Permissions	Done	Fixed	Add CSS selectors for access rights and required roles for the Section Macro and the Content Marker Macro. This allows designers to apply styles to these page fragments according to the access privileges.
PDAC-960	Reject All Feature for Transclusion	Done	Fixed	It would be more intuitive if the Transclude Documents Macro would allow to use "!*" to reject all sections. This makes only sens if at least one property is selected.
PDAC-949	NPE on Displaying on a Missing Page	Done	Fixed	The Display Property Macro throws a NPE if there is no document referenced and there is no page to refer to either.
PDAC-948	Support Wiki Syntax with Breadcrumb Macro	Done	Fixed	Required to add the breadcrumb macro to locations where only the wiki syntax is supported.
PDAC-947	Add Primary Page Option to Breadcrumbs	Done	Fixed	Allow to use the primary page for calculating the breadcrumbs.
PDAC-935	Allow to filter on Space Status	Done	Fixed	The Space List Macro currently does not allow to filter on the space status (current or archived). Users should be able to show only current spaces, only archived spaces, or spaces of any status.
PDAC-931	Update Get-Started Page	Done	Fixed
PDAC-928	Exact Match on Empty Property	Done	Fixed	While an author typically should use the list selector to specify queries based on own property ** $<Tags>~(${Tags}) there are situations where a user might want to specify this for a single value $<Subject>=[${Subject}] Currently this will result in "no constraint" and match any document. It should match no document instead.
PDAC-908	Render Publisher in Quote Macro	Done	Fixed	If the author is to be rendered and no author is provided, the publisher should be rendered as default.
PDAC-899	Support Replacements for rendered Placeholders	Done	Fixed	Transclusion of text with rendered placeholders ($<...>) fails.
PDAC-985	Object Property	Done	Fixed	The object property allows to reference another document whose description refers to an entity that is the main concern of this document. The property is used to bundle information that is referring to the same concept or entity. It enhances the ability of readers to navigate through documentation. A reference does not imply that the referencing document is closely related or represents the concept or entity. For instance a event document in a journal may reference the work instruction and an entity this work instruction has been applied to. The object property provides a list of values.
PDAC-982	Classification Property	Done	Fixed	The classification property allows to tag documents with documents an arbitrary doctype. The semantics are that the entity described by the referenced document is represented by this document. This way any type of document can work as a tag for a document that provides the classification property. The property is used to organize content. A document may reference a document that provides structured information about the less structured document. For instance a tag document named '#Confluence' may reference to a tool document 'Confluence'. Other documents may be tagged with a tag, but are not globally providing a property to reference a tool document. The classification property provides a link between the tag and structured information. The classification property provides a list of values.
PDAC-978	Select on Doctype	Done	Fixed	Rendering the doctype values (which may link to its home or index page) takes a long time. We should cache the result in the context of the request, assuming that all links should point to the same page.
PDAC-977	Apply Sort Key to List Children	Done	Fixed	When child documents are rendered with the Display List Macro, the sort key parameter is not applied to render the children of a list element. So the user has no control over the sort order of child documents.
PDAC-976	Support to Control Column Number Header	Done	Fixed	The Display Table Macro allows to a counter column to keep track of the row number. The heading for this column is set to '#'. We need to provide means to translate this heading.
PDAC-974	Create One Document Macro Subpage Title	Done	Fixed	The title needs to be extended for subpage mode. Currently we need to accept that the name has the same character sequence as the title. But it is easier to remove the suffix from the name than to add that sequence to the title.
PDAC-957	Prevent Query Execution without Constraints	Done	Fixed	Currently queries without constraints are prevented from execution. To protect users from accidentally save a page with a query, the system should provide a protected from these queries even in not preview mode.
PDAC-955	Support PDF Mode for Heading	Done	Fixed	Currently only Word is supported as Quirk Mode for Steps. We also need to support PDF Quirk Mode (with the same resolution as for Word).
PDAC-954	Quote Macro Support for Quote Doctype	Done	Fixed	The Quote Macro should take information from the Quote document directly instead of fetching information from the parent.
PDAC-942	Provide standard Property for Participants	Done	Fixed	We need a standard property to be used to add participants to a document. These may be participants in a conversation or on a work result. Note that there are still special properties for participants for existing doctypes with other names. These properties will persist to exist. Examples are authors of a resource or attendees of a meeting (minutes doctype).
PDAC-927	Hide extracted Short Description	Done	Fixed	If the short descriptions is rendered in extraction mode, it should not be rendered, if the hide control is set.
PDAC-926	Compact representation for Hide Macros	Done	Fixed	The Hide-from-Reader and the Hide-from-Anonymous Macros need to be able to render inline instead of in block mode.
PDAC-924	Default Handling of ProjectdocMacroContext	Done	Fixed	The default value is taken into account to eagerly.
PDAC-923	Skip Rendering empty DT or DD for Tour Macro	Done	Fixed	If a DT or DD is blank (for HTML) the element should not be rendered with the definition list representation of the Tour Macro.
PDAC-919	Find Image Text Representation in Title	Done	Fixed	Dependent on the Confluence and/or Editor version images seem to be coded differently. To broaden the translation of images to text that can be used as constraints in a Where Clause, not only the alt value, but also the title should be taken into consideration. Enhances for accessing storage format are also to be enhanced. This may result in different values for properties dependent on the Confluence and/or Editor version. But since we get the value presented by Confluence, this is out of our control. We also need to make the parsing more resilent.
PDAC-918	Empty Tour Table	Done	Fixed	A table with empty rows needs to be rendered as empty. This change allows to provide a table for users ready to add cell values.
PDAC-913	Replace @currentMonth as Placeholder in Titles	Done	Fixed
PDAC-912	Support for Related Indices	Done	Fixed	Provide I18N keys for related indices (projectdoc.doctype.common.related-indices).
PDAC-906	Check Space and Parent Page Access Rights for Blueprint Metadata	Done	Fixed	Authenticated users may access Blueprint Metadata for spaces and parent pages they do not have access to. The information that may get revealed is Blueprint Content Blueprint ID Blueprint Module Complete Key Item Module Complete Key Page Space Key Page Title (see PDAC-904 Done )
PDAC-904	Reject Title Replacements for Restricted Parent Pages and Spaces	Done	Fixed	The REST service allows to replace placeholders in titles with information that is unaccessible by the authenticated user. The service may reveal the title of the parent page, the name of the space the parent page is part of and the space key. In order to get access to this information, the attacker needs to guess a valid page id in the space.
PDAC-984	Ancestor Property Fix	Done	Fixed	The ancestor macro determines the first ancestor of the list (the root) and not the ancestor that is next to the document (starting with the immediate parent).
PDAC-975	Blueprints REST API fails on null Page ID	Done	Fixed	If the reference to the parent page ID is null, the proper REST service does not get selected.
PDAC-922	Phantom References broken	Done	Fixed	The calculation of phantom references is broken. This fix requires a reindex to recalculate the broken phantom references!
PDAC-981	Reference Tracking for Display Property Ref Macros	Done	Fixed	The Display Document Property Ref Macro (and its cousin) fails to add a reference to the ref document. This is no problem as long as this document and the referenced document are the same. But in case they are different the reference is required since otherwise changes to the "middle" document are not recognized.
PDAC-973	Phantom References for Create One Document Macro	Done	Fixed	The macro fails to track references to other document including phantom references. Therefore if the macro is used as a value for a property, the value is not updated according to changes in the referenced document.
PDAC-963	Short Names Link Generation for Index fails	Done	Fixed	For the Index Entries Macro, when short names support is activated and a template is chosen for the name, the ID generation fails to create a valid ID.
PDAC-944	Tag List Macro renders non-global Labels	Done	Fixed	The Name List Macro adds favourite labels for each "Save for Later" click of a user. The macro should only list labels from the global namespace.
PDAC-930	Search Space fails with @all	Done	Fixed
PDAC-925	Delegate Document Reference	Done	Fixed	The reference resolves to the homepage by default, but should not have a delegate document if unset.
PDAC-910	Fails Replacing Title with Name	Done	Fixed	Due to PDAC-888 a bug has been introduced to fail replacing the title with the name for the Tour Macro in definition list mode.
PDAC-909	Definition List Template for Display Table Macro	Done	Fixed	Using a template for the name value does not work for the render mode 'definition'. The following does not render the template with 'Name' as a link: `#Both{$[Name] (${Iteration})}, Short Description`
PDAC-903	URL handling by Display Property Macros	Done	Fixed	If the property value referenced by a Display Table Macro is an URL and is the macro instructed to append to the URL, the resulting value is not recognized as an URL. This constructed URL should be rendered as an URL pointing to the target of the URL (and not the page the property is part of).
PDAC-972	Runtime Exception on Table Merger without Styles	Done	Fixed	The table merger requires styles for each column, but should work for any number of columns with separate style.
PDAC-970	Description of Parameters for Blueprint REST Service	Done	Fixed	The description of the space and the doctype is wrong.
PDAC-961	Show Empty Rows not honored with Vertical Tabs	Done	Fixed	For Display Table (or related macros) when properties are shown in vertical tables (two columns with first column the th) the empty row parameter is not honored, always skipping the empty row.
PDAC-956	Missing Translation for Macro Descriptions	Done	Fixed	In the macro browser the general description for the macro is displayed for locale en despite the actual configuration of the locale. This is a problem for only a number of macros, not for all.
PDAC-943	Column Styles for Table Merger	Done	Fixed	The table merger should copy the styles from the original table. Currently a centered column is no longer centered after the table is merged.
PDAC-941	I18N for JavaScript Messages	Done	Fixed	Messages provided by the execution of JavaScript code should also be localized.
PDAC-940	Don't render Append Text if Parent Property Value is blank	Done	Fixed	If the property appended to the parent property is blank, the separator must also not be rendered.
PDAC-939	Don't render Append Text if Property Value is blank	Done	Fixed	For the display document property macros the append separator should only be rendered if the property value is not blank.
PDAC-936	Template and Curly Brackets	Done	Fixed	Due to CONFSERVER-33399 macros may misbehave when encountering unescaped curly brackets. To workaround this issue, the macro user needs to escape the curly bracket with a backslash as in `#N {$[Name] ${Iteration`}} Unfortunately the parser of the placeholder template does not check for the escape signs and therefore renders them as text.
PDAC-934	Add missing Key for Homepage Index Description	Done	Fixed	There is no key to define the description for the docsection showing the homepages of doctypes (and other docsections). The missing key is: projectdoc.content.doctype-homepage.index.all.description
PDAC-921	Missing Label doctype-homepage	Done	Fixed	Missing label for key `projectdoc.content.doctype-homepage.index.all.title`.
PDAC-917	Blank Space Key Message	Done	Fixed	The logger receives a message about a blank space key and logs a stack trace at info level although it is valid to have a blank space key at this point (the code refers to a page that is about to be the updated version of the page).
PDAC-907	Quote Macro and blank Authors	Done	Fixed	If the Authors property of a resource is provided with a value that contains macro that resolves to blank, that blank is rendered as the authors' names. Instead anonymous should be rendered.
PDAC-905	Current Date (@currentDate) not replaced	Done	Fixed	On replacing placeholders in titles the currentDate placeholder does not get replaced with a user specific date format value. As a workaround currentDateToken works (but does this does not use the user's date format).
PDAC-901	Replace Doctype by Dokumenttyp for Locale DE	Done	Fixed
PDAC-900	Rephrase Hint for Short Description (de) in Space Blueprint Wizard	Done	Fixed	The text shown in the wizard for the space short descriptions needs to be rephrased.

86 issues

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.