projectdoc Toolbox

Space shortcuts

Page tree

Versions Compared

Old Version 18

changes.mady.by.user Robert Reiner

Saved on

compared with

New Version 19

changes.mady.by.user Robert Reiner

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section
titleNew and Noteworthy
Section
titleArtificial Document Properties on Metadata

This release collects metadata to allow 

Static Document Link
documentPDAC:Documentation Gardener
labeldocumentation gardners
 to find referencing documents easier.

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

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

Display Table
doctypedocument-property
selectName, 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
doctypedocument-property
selectName, Data Type|, Short Description, Since|
where$<Type>=[projectdoc Metadata Property Reference]

More information on this topic is available at 

Static Document Link
documentName Refactorings
.

A reindex is required to add the new properties.

Section
titleTasks Report Macro

The new 

Static Document Link
documentTasks Report Macro
 allows to select Confluence Tasks from
Static Document Link
documentprojectdoc Document
labelprojectdoc 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 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
titleSection 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 

Static Document Link
documentPDAC:Transclusion
labeltransclude
 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
documentPDAC:Author
labelauthors
may want to document these parameters in sections on the macro documentation document.

In this use case the 

Static Document Link
documentSection 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
titleUsability Enhancements

Static Document Link
documentAutocomplete
labelAutocomplete support
 is increased by supporting 
Static Document Link
documentPDAC:Transclusion
labeltransclusion
Autocompletion support is increased by supporting transclusion references (
Jira
serversmartics JIRA
serverId79ad43bc-d289-364e-bfc7-46c09847bebd
keyPDAC-1315
) and property names in drafts (
Jira
serversmartics JIRA
serverId79ad43bc-d289-364e-bfc7-46c09847bebd
keyPDAC-1312
).

The property name for the 

Static Document Link
documentDisplay Document Property Macro
 is now a mandatory property (
Jira
serversmartics JIRA
serverId79ad43bc-d289-364e-bfc7-46c09847bebd
keyPDAC-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 quirk mode (required 

Static Document Link
documentPrint Quirk Modes
labelquirk mode
(
Jira
server
Jira
serversmartics JIRA
serverId79ad43bc-d289-364e-bfc7-46c09847bebd
keyPDAC-1324
).

...

Section
titleKnown Issues

Display Table
doctypesection
render-no-hits-as-blanktrue
render-modedefinition
restrict-to-immediate-childrentrue
where$<Flags>=[Known Issue]

Section
titleInstallation Instructions


server
Section
titleUpgrade 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
titleInstallation Order

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

So this is the basic order:

  1. projectdoc Toolbox
  2. extension add-ons (start with Web API Extension)
  3.  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. (smile)

Section
titleReindex

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

Jira
server

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

Jira

smartics JIRA
columnskey,summary,type,priority,description
maximumIssues1000
jqlQueryproject = 'projectdoc Toolbox' && (fixVersion = '4.7.0') && "Break" ='runtime (fix with reindex)' ORDER BY priority DESC, type DESC
serverId79ad43bc-d289-364e-bfc7-46c09847bebd

In case you do not use any of these features, there is no need for a reindex.

Please refer to 

Static Document Link
documentTroubleshooting Reindexer for projectdoc Documents
 for details on how to reindex projectdoc documents

. Section
hidetrue
titleUpgrade Instructions
Please install the new OBR of the projectdoc Toolbox, then the extension shown below

.

Section
titleList of Changes

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

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

...

About

This site is maintained by smartics.

Imprint / Impressum

Data Privacy / Datenschutz 

End User License Agreement (EULA)


To get in touch please send us an e-mail!

smartics email

Keep up-to-date!

Read our

smartics Blog

Follow us on

Twitter YouTube Prezi

Find us on

Bitbucket GitHub Atlassian Marketplace

Powered by




© 2001-2023 smartics - Kronseder & Reiner GmbH