Improved support for indexes and howtos

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

projectdoc 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 projectdoc or visit projectdoc site on Atlassian Marketplace!

Summary

New and Noteworthy
Breaking Changes
- Reindex required
Related Releases
List of Changes

New and Noteworthy

The following changes may be the most interesting of this release.

Preview Mode Enhancement

Preview mode for the Display Table Macro initiated a search even if no constraints has been specified. This resulted in putting load on the server where typically nobody was interested in the result.

With PDAC-711 - Prevent Search without Constraints in Preview Mode Done the search is prohibited as long as no constraints are given.

Glossary Support Enhancement

Glossary terms often have short names or abbreviations. These need to be rendered in glossaries and refer to the name of the term in the index.

PDAC-712 - Short Name References for Index Macros Done allows to add the short names to the glossary.

Step-by-Step Instructions

Sometimes a step-by-step instruction is on one page. A simple ordered list may provide not enough room to provide the information for each step in a convenient way. On the other side the steps should not be treated like regular sections in the document.

With PDAC-713 - Steps Macro Done the Steps Macro handles sections within its body as steps of an instruction. These sections are separated from regular sections of the page.

Links as Property Values

Parsing CDATA values for document properties has not been resolved correctly. This is especially an issue, if these values are links to other documents within the wiki.

Since this bug ( PDAC-715 - Error Parsing Links in Property Values Done ) causes wrong values to end up in the index, a reindex is required, if and only if CDATA content is found in property values.

Breaking Changes

There are no changes that actually break the API or the runtime. But one issue may require to reindex the the Lucene index to update broken property values.

Reindex required

Due to issue PDAC-715 - Error Parsing Links in Property Values Done a reindex is required, if and only if CDATA content is found in property values.

Related Releases

In the latest version of the Information Systems Extension the Autoconvert component reads the DC.title header or the HTML title to set the label for the macro. This is due to issue PDEXINFOSY-12 - Fetch Page Title on Autoconvert Done .

This makes it a lot easier for page authors to link to HTML resources on remote information systems registered with Confluence.

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	Status	Resolution	Description
PDAC-713	Steps Macro	Done	Fixed	Make it easier to create step-by-step howtos.
PDAC-712	Short Name References for Index Macros	Done	Fixed	Enable index macros to automatically add additional entries for short names. This feature adds the abbreviated names and links to the entry of the default name.
PDAC-464	Change Pretend Mode Quickly	Done	Fixed	Currently it is possible to change the user's role by the space property 'pretend-being-a' which has to be set as a space property on the user's Confluence homepage. This is not very convenient since the page has to be edited and saved. Changes are also stored in the page history, which may be distracting. We should consider to add an action to quickly change roles. We have to keep in mind that there may be additional roles (than writer, printer and reader) in the future.
PDAC-717	Artificial Property for Delegate Document	Done	Fixed	Provide artificial properties to allow selecting documents.
PDAC-716	Support heading-number-start on Document Level	Done	Fixed	heading-number-start is currently not supported on document level.
PDAC-711	Prevent Search without Constraints in Preview Mode	Done	Fixed	For the Display Table Macro and Display List Macro should not start a search when in preview mode and no search constraints have been set. For large sets of documents this would cause unnecessary resource utilization. Also apply to Transclude Documents. Check apply to Index variants of these macros.
PDAC-714	Support Quote Types	Done	Fixed	Allow to add a type for the quote macros that is rendered as a class attribute.
PDAC-715	Error Parsing Links in Property Values	Done	Fixed	When property values (especially links containing CDATA blocks) are encountered, they have been corrupted since JSoup has problems preserving CDATA blocks.

8 issues

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.

projectdoc Toolbox 1.15.0 Release Notes