Versions Compared

Key

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

...

Document Properties Marker
overridefalse


Short DescriptionService to prefix Prefix the title with an automatically incremented identifier.
Doctypetopichide
NameAutoincrement Auto Increment in Title
Short Name
Parent
Parent Property
property-nameName
hide
Audience

Name List
doctyperole
render-no-hits-as-blanktrue
render-list-as-comma-separated-valuestrue
namesDocumentation Architect, Template Author
propertyAudience


Subject
Name List
doctypesubject
propertySubject

Categories
Name List
doctypecategory
propertyCategories

Tags
Tag List
propertyTags

Flagshide
Iteration

Iteration
valuefinished

hide
Type
Name List
doctypetopic-type
render-no-hits-as-blanktrue
propertyType

Level of Experience
Name List
doctypeexperience-level
render-no-hits-as-blanktrue
propertyLevel of Experience

Expected Duration
Sponsors
Name List
doctypestakeholder
render-no-hits-as-blanktrue
propertySponsors

Sort Keyhide


...

Section
show-titlefalse
titleDescription

For some document types there is a natural tendency to provide a unique identifier. This include documents that specify requirements or issues on an issue tracker.

To administrate these values by hand is a bit cumbersome. Therefore the projectdoc Toolbox provides some support to manage identifiers and add them to the title of generated documents.

...

Section
titlePrerequisites


Section
titleConfigurationUse Cases in Action

The following screencasts show typical uses cases using the Auto Increment Feature to place a unique ID in the title of a projectdoc document.

Section
titleCreate Requirements with Auto ID

Shows how to configure and use Auto IDs for requirement documents.

View file
nameCreate_Requirements.mp4
height250


Section
titleCustomize the ID Prefix

Change the ID Prefix before creating your first Requirement to REQ-Component1 (instead of the default ID).

View file
nameChange_ ID_ Prefix.mp4
height250


Section
titleSkip some Numbers

How to skip some numbers using the Confluence-REST-API (or change the ID Prefix after pages have been created).

View file
nameSkip_Some_ Numbers.mp4
height250

In this video we are using the free Confluence REST API Browser.

While viewing the "Page Information" (see image below) the PageID can be copied from the URL. This ID will be needed to use the REST-API.

Image Added



Section
titleConfiguration

The space property named Doctype Auto ID Pattern The space property named projectdoc.doctype.(doctype).auto-id-pattern controls for which doctype auto-increments for IDs is enabled.

...

Section
titleSequences

The sequences are stored as content properties with the parent page. This makes the generation process quick, even if there are more than a few hundred siblings.

Caution Box

Please note that sequences are not incremented atomically. In case of a sequence clash, a single identifier is used twice. These clashes need to be resolved manually.

If you need to adjust the value, please use the REST API for content properties.

Code Block
languagejs
title/rest/api/content/{id}/property/{key}
{
  "value": "ID-10010-00010",
  "version": {
    "number": 2,
    "minorEdit": false
  }
}

A sequence id is compared by splitting it into its parts. Parts are delimited by the dash ('-') character. Each part which represents an integer is compared as a number. Non-numbers are considered strings and are compared lexicographically. Shorter strings that are prefixes of other strings are considered smaller.

Please note that the natural sort order of titles in Confluence is not changed. So although the Auto Increment service understands that REQ-COMP1-123 is larger than REQ-COMP1-23, the natural sort order of documents being displayed in a list, sorted by the title will still be REQ-COMP1-23, REQ-COMP1-123. To compensate this, you could add leading zeros: REQ-COMP1-00123, REQ-COMP1-00023.


Section
titleSubordinate Topics
Display Table
doctypetopic
render-no-hits-as-blanktrue
render-modedefinition
selectName, Short Description
restrict-to-immediate-childrentrue
sort-bySort Key, Name

...

Section
titleResources


Tour
render-no-hits-as-blanktrue
render-as-definition-listtrue
marker-column-property-nameTitle
replace-title-with-nametrue