Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Document clean process

...

Section


Column


Document Properties Marker
overridefalse


Short DescriptionSend-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.
Doctyperelease-notehide
Nameprojectdoc Toolbox 2.0.0 Release Notes
Parent
Parent Property
property-nameName

Audience
Name List
doctyperole
propertyAudience

Subject
Name List
doctypesubject
propertySubject

Categories
Name List
doctypecategory
propertyCategories

Tags
Tag List
propertyTags

Iteration

Iteration
valuefocusedproduction

hide
Version2.0.0hide
Productprojectdoc Toolboxhide
Release Date

hide
Sponsors
Name List
doctypestakeholder
render-no-hits-as-blanktrue
propertySponsors

Sort Key00002.00000.00000hide



Section
show-titlefalse
titleDescription

Today we released version 

Display Property
property-nameVersion
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.

Caution Box
titleIMPORTANT: Add-on Update and Reindex required!!!

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.


Panel
borderColordarkgrey
borderWidth2

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

Transclusion
documentHOMESPACE:projectdoc Video Link
idsprojectdoc



Info Box

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




Column
width350px


Panel
titleRelease Notes Overview

Table of Contents
indent15px
excludeRelease Notes|Description|Summary|References|Resources
stylenone
 



...

Section
titleNew and Noteworthy
intro-textThe following changes may be the most interesting of this release.


Section
titleExact 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.

Question Box
titleHow do I reindex projectdoc Documents?

Run the content reindexer.

Troubleshooting Reindexer for projectdoc Documents provides an instruction on how to run the process.



Section
titleSend 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

Jira
serversmartics JIRA
serverId79ad43bc-d289-364e-bfc7-46c09847bebd
keyPDAC-776
.


Section
titleRemote 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.

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.


Section
titleDeep 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:

This feature is considered experimental. More information on Deep Links for Select Clauses and Where Clauses.


Section
titleImpersonating 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.


Section
titleBreadcrumbs

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

Jira
serversmartics JIRA
serverId79ad43bc-d289-364e-bfc7-46c09847bebd
keyPDAC-776
) 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.


Section
titleTransaction 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.

Caution Box

Users that have faced transaction problems in the past are encouraged to test this version with their test cases!

Section
titleEnhanced 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.



Section
titleList Queries

The projectdoc Toolbox allows to specify list queries in a more compact form due to

Jira
serversmartics JIRA
serverId79ad43bc-d289-364e-bfc7-46c09847bebd
keyPDAC-802
.

Transclusion
documentSearch Tips
idsList Query ExamplesExamples



Section
titleEnhanced 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.


Section
titleDoctype 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.


Section
titlePage Sort Order

Queries now support the sort order defined with the space tool (see

Jira
serversmartics JIRA
serverId79ad43bc-d289-364e-bfc7-46c09847bebd
keyPDAC-789
).

Use #BREADTH_FIRST or #DEPTH_FIRST as Sort By parameter in macros running searches.


Section
titleImport 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.


...

Section
titleKnown Issues
intro-textThis release has the following issues.

Jira
serversmartics JIRA
columnskey,summary,type,priority,status,resolution,description
maximumIssues1000
jqlQueryproject = 'projectdoc Toolbox' && fixVersion = '2.0.1' ORDER BY type DESC, priority DESC
serverId79ad43bc-d289-364e-bfc7-46c09847bebd


projectdoc-section
titleInstallation Instructions
intro-textThe following topics have to be considered for an installation to this version.

...

Section
titleResources


Tour
render-as-definition-listtrue
replace-title-with-nametrue