projectdoc Toolbox 4.7 Release Notes

...

Section

Column

Document Properties Marker

doctype	release-note
override	false

Short Description

Artificial Document Properties on Metadata, Tasks Report Macro, Section Compilations, Usability enhancements and more.

Name

projectdoc Toolbox 4.7 Release Notes

Short Name

Parent

Parent Property

property-name	Name

hide

Audience

Name List

doctype	role
render-no-hits-as-blank	true
property	Audience
empty-as-none	true

Subject

Name List

doctype	subject
property	Subject

Sponsors

Name List

doctype	stakeholder
render-no-hits-as-blank	true
property	Sponsors

Sort Key

00004.00007.00000010

hide

Section

show-title	false
title	Description

Today we released version

Display Property

property-name	Version

of the projectdoc Toolbox on the Atlassian Marketplace!

This release provides new features, improvements, and bugfixes.

Panel

borderColor	darkgrey
borderWidth	2

The projectdoc Toolbox is an add-on for Confluence supporting agile software development teams to collaborate on process, project, system, and product documentation.

Transclusion

document	HOMESPACE:projectdoc Video Link
ids	projectdoc

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

Column

width	350px

Panel

title	Release Notes Overview

Table of Contents

indent	15px
exclude	Release Notes\|Description\|Summary\|"References"\|Resources
style	none

...

Breaking Changes

Section

title	New and Noteworthy

Section

title	Artificial Document Properties on Metadata

This release collects metadata to allow

Static Document Link

document	PDAC:Documentation Gardener
label	documentation gardners

to find referencing documents easier.

Information on property names, controls, and values is collected as well as on document part identifiers and tags.

Pending Box
List the artificial properties related.

A reindex is required to add the new properties.

Section

title	Tasks Report Macro

The following artificial properties support queries for documents that define a given name.

Display Table

doctype	document-property
select	Name, Short Description, Since\|
where	$<Type>=[projectdoc Metadata Property Definition]

The following artificial properties support queries for documents that use a given name by reference.

Display Table

doctype	document-property
select	Name, Data Type\|, Short Description, Since\|
where	$<Type>=[projectdoc Metadata Property Reference]

More information on this topic is available at

projectdoc-static-document-

The new

Static Document Link

document	Tasks Report Macro

allows to select Confluence Tasks from

projectdoc-static-document-link-macro

document	projectdoc Document
label	projectdoc Documents

selected by a Where constraint.

Name Refactorings

.

A reindex is required to add the new properties (see Upgrade Instructions below).

Section

title	Tasks Report Macro

The new

Static Document Link

document	Tasks Report Macro

allows to select Confluence Tasks from

Static Document Link

document	projectdoc Document
label	projectdoc Documents

selected by a Where constraint.

The new macro simply configures the Confluence Task Report Macro and executes it. The new macro is not a replacement. In case users want to select The new macro simply configures the Confluence Task Report Macro and executes it. The new macro is not a replacement. In case users want to select on spaces, pages, and labels, the original macro is still in charge. The new macro simply connects projectdoc documents to the world of Confluence Tasks.

Section

title

contentmarkerisemptytext

Section Compilations

In software product documentation there is a good chance to encounter elements that are reused. For instance a parameter of a collection of macros. Suppose there is a collection of macros that

projectdoc-

static-

document-

link-

macro

No issues found

Jira

server	smartics JIRA
columns	key,summary,type,priority,description
maximumIssues	1000
jqlQuery	project = 'projectdoc Toolbox' && (fixVersion = '4.7.0') && "Break"!='runtime (fix with reindex)' ORDER BY priority DESC, type DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

title	Known Issues

Display Table

doctype	section
render-no-hits-as-blank	true
render-mode	definition
restrict-to-immediate-children	true
where	$<Flags>=[Known Issue]

document	PDAC:Transclusion
label	transclude

content from a single document. Each of these macros would provide a parameter named "Document" to link to the document to transclude from. Often the documentation for this parameter is identical. Therefore the documentation for the Document Parameter is in one location and the macros transclude this content.

The macros may need to control the order of their parameters. Maybe the first macro has the Document Parameter as its second parameter while all others specify it as their first.

In addition to that some macros may provide parameters they do not share with other macros. So

Static Document Link

document	PDAC:Author
label	authors

may want to document these parameters in sections on the macro documentation document.

In this use case the

Static Document Link

document	Section Compiler by Reference Macro

is of great support. The body of the macro holds the sections that document parameters the macro does not share. These sections may be in any order. The Section Compiler by Reference Macro references a property that defines the order of all parameters that are to be included in the macro document's documentation. Each reference may refer to a document that contains share information about a parameter or a section in the macros body.

This way it is very easy to mix and merge parameter documentation that is shared with information that has been defined locally.

Section

title	Usability Enhancements

Static Document Link

document	Autocomplete
label	Autocomplete support

is increased by supporting

Static Document Link

document	PDAC:Transclusion
label	transclusion

references (

Jira

server	smartics JIRA
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd
key	PDAC-1315

) and property names in drafts (

Jira

server	smartics JIRA
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd
key	PDAC-1312

).

The property name for the

Static Document Link

document	Display Document Property Macro

is now a mandatory property (

Jira

server	smartics JIRA
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd
key	PDAC-1314

). Although the default would still be the name of the referenced document, by enforcing to specify a name the macro editor automatically pops up. Since the reference is often not to the name property, this update does better support the usability.

For Scroll Word Exporter (formerly known as Scroll Office) the projectdoc Toolbox now autodetects the required

Static Document Link

document	Print Quirk Modes
label	quirk mode

(

Jira

server	smartics JIRA
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd
key	PDAC-1324

).

Section

title	Breaking Changes

Content Marker

hide	true
is-empty-text	No issues found

Jira

server	smartics JIRA
columns	key,summary,type,priority,description
maximumIssues	1000
jqlQuery	project = 'projectdoc Toolbox' && (fixVersion = '4.7.0') && "Break"!='runtime (fix with reindex)' ORDER BY priority DESC, type DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

title	Known Issues

Display Table

doctype	section
render-no-hits-as-blank	true
render-mode	definition
restrict-to-immediate-children	true
where	$<Flags>=[Known Issue]

Section

title	Installation Instructions

Installation Instructions

Section

title	Upgrade Instructions

Here is a short guide to update to this new version of the projectdoc Toolbox. For detailed information on dependencies, please consult the documentation of the add-ons.

Section

title	Installation Order

Please install the projectdoc Toolbox first, then the extensions and finally update the doctypes.

So this is the basic order:

projectdoc Toolbox
extension add-ons (start with Web API Extension)
doctype add-ons (start with Core Doctypes)

Please install only those add-ons that are actually used! In case you do not use the Web API, there is no need to install it.

Section

title	Reindex

Section

title

Due to the following issues a reindex is required to update properties.

Jira

server	smartics JIRA
columns	key,summary,type,priority,description
maximumIssues	1000
jqlQuery	project = 'projectdoc Toolbox' && (fixVersion = '4.7.0') && "Break" ='runtime (fix with reindex)' ORDER BY priority DESC, type DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

In case you do not use

this feature

any of these features, there is no need for a reindex.

Please refer to

Static Document Link

document	Troubleshooting Reindexer for projectdoc Documents

for details on how to reindex projectdoc documents.

hide

Section

Upgrade Instructions

true	title

Please install the new OBR of the projectdoc Toolbox, then the extension shown below.

Section

title	List of Changes

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

Jira

server	smartics JIRA
columns	key,summary,type,priority,description
maximumIssues	1000
jqlQuery	project = 'projectdoc Toolbox' && (fixVersion = IN ('4.7.0', '4.7.01')) ORDER BY priority DESC, type DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

...

Section

title	Related Releases

Section

title	Extension Add-ons

The following extension are required to be updated for the projectdoc Toolbox.

Section

title	Web API Extension

The following changes are part of the latest Web API Extension.

Jira

server	smartics JIRA
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'PDEXWAPI' && (fixVersion = '8.0.2') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

hide	true
title	Bookmarklets Extension

The following changes are part of the latest Bookmarklets Extension.

Jira

server	smartics JIRA
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'PDEXBML' && (fixVersion = '4.0.0') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

hide	true
title	Information Systems Extension

The following changes are part of the latest Information Systems Extension.

Jira

server	smartics JIRA
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'PDEXINFOSY' && (fixVersion = '3.1.3') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

hide

Section

true	title	Maven Extension

The following changes are part of the latest Maven Extension.

Jira

server	smartics JIRA
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'PDEXMVN' && (fixVersion = '6.0.1') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

hide

Section

true	title	Doctype Add-ons

The following doctype add-ons are recommended to be updated for the projectdoc Toolbox.

Content Marker

id	doctype-add-ons-overview

Tour

header-translations	Title=Doctype Add-on

Title	Version
Core Doctypes Add-on	14.1.01
Doctypes for Agile Planning	11.1.24
projectdoc Developer Diaries	12.1.0.1
Doctypes for Project Management	5.1.23
Doctypes for Service Management	3.3.01
Doctypes for Business Strategy	3.1.12
Doctypes for Software Development	11.2.01
Doctypes for Teamwork	3.1.23
Doctypes for V-Modell XT	3.1.12

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.

Section

title	Core Doctypes

The following changes are part of the latest Core Doctypes Add-on.

Jira

server	smartics JIRA
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'PDCORED' && (fixVersion = '14.1.01') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

title	Doctypes for Agile Planning

The following changes are part of the latest Doctypes for Agile Planning.

Jira

server	smartics JIRA
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'PDAGILE' && (fixVersion = '11.1.24') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

title	projectdoc Developer Diaries

The following changes are part of the latest projectdoc Developer Diaries.

Jira

server	smartics JIRA
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'DEVDIARY' && (fixVersion = '12.1.0.1') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

title	Doctypes for Project Management

The following changes are part of the latest Doctypes for Project Management.

Jira

server	smartics JIRA
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'PDPRJMGMT' && (fixVersion = '5.1.23') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

hide	true
title	Doctypes for Risk Management

The following changes are part of the latest Doctypes for Risk Management.

This extension is experimental.

Jira

server	smartics JIRA
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'PDRISKMGMT' && (fixVersion = '3.0.0') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

title	Doctypes for Service Management

The following changes are part of the latest Doctypes for Service Management.

Jira

server	smartics JIRA
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'SERVICES' && (fixVersion = '3.3.01') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

title	Doctypes for Business Strategy

The following changes are part of the latest Doctypes for Business Strategy.

Jira

server	smartics JIRA
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'STRATEGY' && (fixVersion = '3.1.12') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

title	Doctypes for Software Development

The following changes are part of the latest Doctypes for Software Development.

Jira

server	smartics JIRA
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'PDSWDEVD' && (fixVersion = '11.2.01') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

title	Doctypes for Teamwork

The following changes are part of the latest Doctypes for Teamwork.

Jira

server	smartics JIRA
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'PDTEAMWORK' && (fixVersion = '3.1.23') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

title	Doctypes for V-Modell XT

The following changes are part of the latest Doctypes for V-Modell XT.

Jira

server	smartics JIRA
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'PDVMXT' && (fixVersion = '3.1.12') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

hide

Section

true	title	projectdoc arc42 Template

The following changes are part of the latest projectdoc Add-on for arc42.

Jira

server	smartics JIRA
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'ARCFOURTWO' && (fixVersion = '9.1.12') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

hide	true
title	Doctypes for Java Developers

The following changes are part of the latest projectdoc for Java Developers.

This extension is experimental.

Jira

server	smartics JIRA
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'PDJAVADEV' && (fixVersion = '5.1.1') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

hide	true
title	Doctypes for Maven Developers

The following changes are part of the latest projectdoc for Maven Developers.

This extension is experimental.

Jira

server	smartics JIRA
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'PDMVNDEV' && (fixVersion = '5.1.1') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

...

Space shortcuts

Page tree

Docs

Support

Free Blueprints

Tooling for Blueprints

Free Extensions

Spaces

Plugins for Maven

Incubator

Libraries for Java

Incubator

Add-ons for Confluence

Tools

Support

Team

Legal

Versions Compared

Old Version 9

New Version Current

Key

About

Keep up-to-date!

Powered by