Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Section
Column
Document Properties Marker
overridefalse
Short DescriptionDelegate Document Feature, SEO Support, Glossary Support, Title Encodings, Space Closures, Date Properties 
Doctyperelease-notehide
Nameprojectdoc Toolbox 1.10 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
valuefilled
hide
Version1.10hide
Productprojectdoc Toolboxhide
Release Date hide
JIRA Release Noteshttps://www.smartics.eu/jira/projects/PDAC/versions/10902hide
Sort Key00001.00010hide
enable-heading-numberstruehide
Section
show-titlefalse
titleDescription

Today we released version 

Display Property
property-nameVersion
of the projectdoc Toolbox!

Panel
borderColordarkgrey
borderWidth2

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

Column
width300px
Panel
titleContents

Table of Contents
outlinetrue
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
titleDelegate Documents

If you ever thought of extending a document without touching it, the delegate document feature is for you! If you have a document for a person and you want to add additional information to that document in another space you now simply create that new document and delegate to the existing one. Each section of your new document will now render the section of the delegate document as long as it is empty.

To use this feature add a reference to the delegate document to your Document Properties Marker Macro. Read about how delegation works with the Section Macro and delegation for document properties.

Section
titleHTML Metadata for SEO

The properties of a document can be exported as metadata on an HTML page easily. This metadata such as keywords or DC.description is used by web crawlers or search engines to enhance user experience or the search rank ratings.

For more information on this topic refer to Export Metadata on how to configure this feature and metadata-sets Metadata Sets for example sets.

Section
titleSupport for Glossaries

This version adds new macros to make working with glossaries and other indices easier.

Tour
render-as-definition-listtrue
header-translationsName=Type, Title Encoding=Encoding
replace-title-with-nametrue
Section
titleTitle Encodings

Title encodings work around the problem that the title of a Confluence page has to be unique within a space. The encodings are defined by the template author and should be activated by default.

This version introduces the encodings for the following types:

Tour
header-translationsName=Type, Title Encoding=Encoding
replace-title-with-nametrue
TitleShort DescriptionTitle Encoding
Category  
Tag  
Stakeholder  
Subject  
Section
titleSpaces
Section
titleSpace Closures

A space may have defined a list of spaces as its search space. Search macros use the search space to collect documents for the result set. The @all is a special token to search in all spaces. From this version on we also allow to exclude spaces from the search.

Example Box
Code Block
languagetext
titleAll Spaces, except Test Space A & B
@all, !TESTSPACEA, !TESTSPACEB

Authors may also use space labels to include or exclude a set of spaces attached to this label. Use the '#' to select spaces by a space label.

Example Box
Code Block
languagetext
titleExclude Spaces labelled with 'test'
@all, !#test
Code Block
languagetext
titleList Test Spaces, but not Test Space A
#test, !TESTSPACEA
Section
titleNew Space Properties

The following space properties has been introduced with this version.

Tour
replace-title-with-nametrue
Section
titleRequired Document Properties

Sections and content may be hidden dependent on the presence of a property in the document.

This is an interesting feature especially for template authors to design blueprint that hide document parts not relevant in a given context.

Section
titleNew Artificial Properties

Artificial properties are properties that are automatically added to projectdoc documents and available to be selected, used as constraints, or for sorting.

Section
titleDates

Sorting by dates is now easier by using normalized date values to be used with Lucene searches. If the property value is specified with the Confluence Date Autocompletion (opened with the shortcut '//'), and for the creation and last modification date, a normalized date is provided as an artificial property.

The name of this artificial property is that of the original property plus the §-sign appended.

Here is an example where the creation date is check against a custom property named Last Update.

Code Block
languagetext
$[Creation Date§]: [${Last Update§} TO NOW]

There is also an artificial property value containing the date as a timestamp in milliseconds, prefixed with zeros up to 19 digits (%019d). The name of the artificial property is constructed from the original name plus the suffix Timestamp (separated by a blank). Note that the Creation Timestamp is the creation date in milliseconds, while the Creation Date Timestamp is the representation of the date (without hours, minutes, seconds) in milliseconds.

Tip Box

See Date Representation for details on provided artificial properties for the creation and last modification date.

The change may break sort orders for instance in the Display Table Macro where the use of

Code Block
Creation Date@{date}

attempts to parse the date in the user's default format. With this version use Creation Date§ instead.

Section
titleIndex Key

The Index Key is helpful to define glossaries. Authors may sort the hits of a Display Table Macro using the index key and name.

The index key is typically the first character of the name. It may be defined by the author as a document property within the Document Properties Marker Macro to override the default.

Since the value may be overridden the index key is technically a special form of an artificial property.

Section
titleNew Property Controls

This version includes the following new property controls.

Tour
replace-title-with-nametrue
TitleShort Description
delegate 
export 
export-schema 
space-local 
Section
titleHTML Span Macro

The new HTML Span Macro allows to attach a CSS class to a span. This makes it much easier to render Confluence icons.

Code Block
<span class="aui-icon aui-icon-small aui-iconfont-devtools-arrow-right">Insert meaningful text here for accessibility</span>
Section
titleRender Children in Table

The Display Table Macro now allows to render the children of a search hit. This is helpful for authors who want to render a hierarchical view on documents that meet a given search criteria.

Section
titleNon-projectdoc Documents

This version improves support of macros used on non-projectdoc documents. Previous versions typically assumed to calculate default values for non-projectdoc documents. With this release macros will distinguish between projectdoc documents and simple Confluence pages. This removes problems on updating pages that have been converted to projectdoc documents.

...