Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Section
Column
Document Properties Marker
overridefalse
Short DescriptionThe standard context provider or templates to create subpages. The context provider basically deals with the title uniqueness (by adding the parent document's name as part of the page title) and sort order (first documents first).
Doctypecomponenthide
NameProjectDocSubdocumentContextProvider
Classde.smartics.projectdoc.atlassian.confluence.blueprint.provider.ProjectDocSubdocumentContextProvider
Parent
Parent Property
property-nameName

Audience
Name List
doctyperole
render-no-hits-as-blanktrue
namesTemplate Author, Documentation Architect
propertyAudience
empty-as-nonefalse

Categories
Name List
doctypecategory
propertyCategories

Tags
Tag List
propertyTags

Iteration
Iteration
valuefilled
hide
Since1.11
Sort Keyhide
Column
width450px
Panel
borderColororange
titleColorwhite
titleBGColororange
titleContents

Table of Contents
indent15px
stylenone

Note Box

Prior to version 1.11 the name of the class has been de.smartics.projectdoc.atlassian.confluence.ProjectDocSubdocumentContextProvider.

Column
Panel
borderColororange
titleColorwhite
titleBGColororange
titleContents

Table of Contents
indent15px
stylenone

Section
titleAbstract

Section
titleDescription

The main purpose of the context providers is to create subdocuments to a given document. It tackles the problem of page title unique within a space. The title is expanded by the name of the parent page, which in most contexts makes it unique.

Example Box

For instance if you want to add an event to your developer journal with the name "Continuous Delivery" there may already be a page with this title in your page. Or you want to create a subpage with the name "Introduction", you may have applied this convention to other pages and the the title may collide.

By adding the parent page's title, the subpage's title will be unique:

  • Continuous Delivery - Jane Doe's events on 4th of May 2015
  • Introduction - Agile Testing Concept

Due to the Display Table Macro the title of the pages is less important than usual in you Confluence wiki. Within pages you can work with the name of the document, which is still "Continuous Delivery" or "Introduction".

The context provider also creates a sort key to help adding new pages at the end of the stack. The first page will have a sort key of 000100. Each additional page will increment by 10, allowing to insert additional pages later to the sort order. This is very convenient if you are adding excerpts to a resource document. If you create excerpts chapter by chapter, the natural sort order will be "Append at the end".

Use the context key projectdoc.doctype.common.sortKey to reference the generated sort key.

Code Block
<tr>
  <th class="confluenceTh"><at:i18n at:key="projectdoc.doctype.common.sortKey"/></th>
  <td class="confluenceTd"><at:var at:name="projectdoc.doctype.common.sortKey"/></td>
  <td class="confluenceTd">hide</td>
</tr>

...