Versions Compared

Key

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

...

Document Properties Marker
overridefalse


Short DescriptionThe main purpose of content providers is to add additional context entries for the blueprints provided by an add-on. projectdoc defines a number of context providers to be used by add-on developers.
 

Doctypetopichide
NameContext Provider
 

Parent
Parent Property
property-nameName
 

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

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

Expected Duration
 

Subject
Name List
doctypesubject
propertySubject
 

Categories
Name List
doctypecategory
propertyCategories
 

Tags
Tag List
propertyTags
 

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

Sort Keyhide



Section
show-titlefalse
titleDescription

The context provider classes for projectdoc help to fill the blueprint context with convenient information to populate the created documents.

The context provider class is registered with the Content Template Module in the atlassian-plugin.xml file.

Tip Box

For more information on creating blueprints for Confluence:


projectdoc-box-note

The API is ot considered stable until version 2.0 of the projectdoc Toolbox. Incompatible changes may be rolled out on any minor change. Usually they will be reported in the release notes.



projectdoc-section
titlePrerequisites

...

Section
titleList of Context Providers

The following context providers generate additional information and set them to the blueprint context. This information can be used in your page templates. For each standard case there is a context provider. You may want to extend on of these for your special purpose context provider or create one on your own.

Warning Box

Please note that the API for context providers is not considered stable. Changes to the context provider classes may be applied without notice and may break dependent code.

Expect the API to be stable starting with a later version 2.X of the projectdoc Toolbox.


Hide From Reader

Create from template
blueprintModuleCompleteKeyde.smartics.atlassian.confluence.smartics-projectdoc-confluence-space-blueprintsswdev:projectdoc-blueprint-doctype-component
contentBlueprintId625f47f97db8e66e-666b751a-4d5241d8-b4a78225-0156b58470e28278305e7a2b
templateName625f47f97db8e66e-666b751a-4d5241d8-b4a7-0156b58470e28225-8278305e7a2b
createResultedit
buttonLabelNew Context Provider

 

Display Table
doctypecomponent
render-no-hits-as-blanktrue
selectName, Short Description
restrict-to-immediate-childrentrue
sort-bySort Key, Name

...