Improvements to Autocomplete and Linking, includes a collection of improvements and bug fixes.
Today we released version 4.10 of the projectdoc Toolbox on the Atlassian Marketplace!
This is a feature release.
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
Enhancements to Autocomplete
This version provides again a number of enhancements to Autocomplete.
Tooltip for Autocomplete
The currently selected value in the list of possible values is now rendered with full selected value and space key as tooltip.
This is an important improvement for use cases where a couple of listed selection options start with the same letters.
When a user hovers with the mouse pointer over an option in the selection box, the tooltip is rendered, revealing the full name of the option.
Autocomplete Anchors
The projectdoc document link macros provide autocomplete for anchors rendered by the projectdoc content macros. Anchors provides by other sources are not considered by the autocomplete.
Document Link Macros
| Macro | Short Description |
|---|---|
Renders a static link to a projectdoc document in the wiki. A static link is a link to a Confluence page that is identified by its space key and document title. | |
Renders a static link to a location within the same document. This is a static document link macro with a specialized interface. | |
Renders a dynamic link to a projectdoc document in the wiki. A dynamic link is a link to a Confluence page that is identified by the page title and the delegate space closure. The target of the link is calculated at render time. In case the delegate space closure changes, a different document may be the target of the link. |
Content Macros
| Macro | Short Description |
|---|---|
Renders a section, if the body is not empty. Supports authors to create content, clutter-free rendering without empty sections. Allows to transclude the content. | |
Marks a piece of content within a document. This content can be referenced for transclusion. |
Also includes box macros like Caution Box Macro or Info Box Macro.
Installation Instructions
Install the new OBR of the projectdoc Toolbox.
Reindex
Due to the following issues a reindex is required to update properties.
| Key | Summary | T | P | Description |
|---|---|---|---|---|
| PDAC-1394 | Dynamic Link Titles |
|
|
To allow to quickly check which dynamic links may possible match to a document, we need to store the titles found in parameters of the Dynamic Link Macro. The Wiki Link Macro is currently not supported. |
In case you do not use any of these features, there is no need for a reindex.
Please refer to Troubleshooting Reindexer for projectdoc Documents for details on how to reindex projectdoc documents.
List of Changes
The following changes are part of the latest projectdoc Toolbox for Confluence.
| Key | Summary | T | P | Description |
|---|---|---|---|---|
| PDAC-1387 | In-Document Link Macro |
|
|
Provide a macro based on the Static Document Link Macro that makes intra-page linking easier. |
| PDAC-1385 | Autocomplete for Anchors |
|
|
Provide autocomplete for the anchor parameter of the Dynamic Document Link Macro and Static Document Link Macro. |
| PDAC-1382 | Render current Autocomplete Value |
|
|
We need to show the selected value as a tooltip of the macro or page dialog. For many items the select2 element is not wide enough. |
| PDAC-1381 | Reference Space |
|
|
Allow to define the reference space via the reference-space space property. The reference space allows to specify spaces where references to are allowed. This is an experimental feature. Currently the space closure is calculate like the search space. Currently no macro uses this closure to prevent link. The property is currently pure declarative. |
| PDAC-1394 | Dynamic Link Titles |
|
|
To allow to quickly check which dynamic links may possible match to a document, we need to store the titles found in parameters of the Dynamic Link Macro. The Wiki Link Macro is currently not supported. |
| PDAC-1390 | Specify Replacement for Title in Tour Macro |
|
|
Currently the Tour Macro allows to replace the Title property with the Name property. We need to allow users to select the property to render. Typical candidates besides the Name are Short Name and Identifier / ID. |
| PDAC-1397 | Table Set Merge Fix |
|
|
When merging the columns of multiple tables only the first row and column get filled properly. This is related to PDAC-1395 prior to which this ran into an OutOfBounds. |
| PDAC-1386 | Autocomplete fails on Blog Posts |
|
|
When using Autocomplete for some macro parameters (e.g. Display Property Macro), the Autocomplete Service fails to serve when the macro is used on a blog post instead of a Confluence page. |
| PDAC-1384 | Render Parent Value non-normalized |
|
|
Currently the Parent Macro can only be used to render a link to the parent document. A rendered property cannot be rendered. We need to render the rendered value instead of the normalized rendered value. |
| PDAC-1383 | Restrict Autocomplete Metadata |
|
|
Check referenced pages for access restrictions for autocomplete services. |
| PDAC-1402 | Allow Upper Case Letters in CSS Class Names |
|
|
Currently all CSS class names are normalized to lower case letters. We need to allow upper case letters. |
| PDAC-1396 | Apply Preserve for Cleaning to Controls |
|
|
If the control 'preserve' is set for a property, it should also be taken into account to preserve the controls. |
| PDAC-1391 | Provide CSS Classes for Links |
|
|
The Dynamic Document Link Macro, the Static Document Link Macro, and the In-Document Link Macro should render a CSS class to indicate whether the link is intra-document or intra-site. Per default we do not provide specific styles for these classes, but it allows users to render links dependent on their target. |
| PDAC-1401 | Default CSS Classes for Table Merger Macro |
|
|
In case a user sets CSS classes for the Table Merger Macro, the default CSS classes are not set. The default classes must always be set. |
| PDAC-1400 | Default CSS Classes for Table Set Macro |
|
|
In case a user sets CSS classes for the Table Set Macro, the default CSS classes are not set. The default classes must always be set. |
| PDAC-1399 | NPE on Transclusion on Blog Posts |
|
|
The transclusion macro fails to extract artificial properties if it is part of a blog post. In this case no artificial properties must be derived. |
| PDAC-1398 | Translation fails for Table Set Macro |
|
|
The labels of the column headers are not translated despite the macro parameter. For a workaround the translation can take place in the single tables. |
| PDAC-1395 | Table Set Out Of Bound |
|
|
Out of bounds check fails if there is no column for the content to merge. java.lang.IndexOutOfBoundsException: Index: 2, Size: 2 at java.util.ArrayList.rangeCheck(ArrayList.java:657) at java.util.ArrayList.get(ArrayList.java:433) at de.smartics.projectdoc.atlassian.confluence.macros.set.Row.replaceCellIfEmpty(Row.java:85) |
| PDAC-1392 | HTML Identifier Compatibility Confluence 7.4 (Helper) |
|
|
Fix PDAC-1265 fails to take the version of the host application into account when calculating HTML IDs in a static context. |
| PDAC-1389 | Unqualified Autocomplete for Dynamic Document Link Macro |
|
|
For the selection of the page parameter of the Dynamic Document Link Macro currently the select2 result contains the space key. But for this use case we must remove the space key information. |