SubspaceContextProvider

Section

Column

Document Properties Marker

override	false

Short Description The standard context provider for home and special pages.

Doctype component hide

Name SubspaceContextProvider

Class de.smartics.projectdoc.atlassian.confluence.page.partition.SubspaceContextProvider

Parent

Parent Property

property-name	Name

Audience

Name List

doctype	role
render-no-hits-as-blank	true
names	Template Author, Documentation Architect
property	Audience
empty-as-none	false

Tags

Tag List

property	Tags

Iteration


value	filled

hide

Sort Key hide

Column

Panel

borderColor	orange
titleColor	white
titleBGColor	orange
title	Contents

Table of Contents

indent	15px
style	none

Section

title	Abstract

Section

title	Description

The main purpose of the context providers is to provide an infrastructure to create this page in the context of creating multiple pages. This is usually the case for projectdoc homepages for document types. It may also be the case for special pages.

This context provider creates the name and short description for a page by applying naming conventions to the I18N keys.

I18N Key	Description
`projectdoc.doctype.my-template-key.name`	References the localized name of the document.
`projectdoc.doctype.my-template-key.short-description`	References the localized short description for the document.

If this lookup in the resource bundle of the plugin provides no result, the following keys are checked:

I18N Key	Description
`projectdoc.doctype.my-template-key.home`	References the localized name of the document.
`projectdoc.doctype.my-template-key.home.short-description`	References the localized short description for the document.

Section

title	Provided Context Parameters

Section

level	2
title	Name and Short Description

The following blueprint context parameters are set:

Parameter Name Description

projectdoc.doctype.common.name

The name of the document. The title of the page is usually identical or derived from the name.

For more information on document names and page titles please refer to Name and Title.

projectdoc.doctype.common.shortDescription

The short description for the document.

Transclusion

taget-heading-level	2
document	Page Title and Document Name Handling
ids	Content

Transclusion

taget-heading-level	2
document	Add Space Information to Blueprint Context
ids	Content

Transclusion

taget-heading-level	2
document	Add Creation Metadata to Blueprint Context
ids	Content

Transclusion

taget-heading-level	2
document	Translate Placeholders in Short Description
ids	Content

Section

title	Example Usage

The context provider is used for home and index templates of your blueprint.

The following fragment registers your home and index templates as Content Template Modules:

Code Block

language	xml

<content-template
  key="category-home-template"
  i18n-name-key="projectdoc.content.my-template-key.home.title">
  <description key="projectdoc.content.my-template-key.home.description" />
  <resource
    name="template"
    type="download"
    location="/my/path/to/home.xml" />
  <context-provider class="de.smartics.projectdoc.atlassian.confluence.page.partition.SubspaceContextProvider" />
</content-template>
<content-template
    key="category-index-template"
    i18n-name-key="projectdoc.content.my-template-key.index.all.title">
  <description key="projectdoc.content.my-template-key.index.all.desc" />
  <resource
    name="template"
    type="download"
    location="/my/path/to/index.xml" />
  <context-provider class="de.smartics.projectdoc.atlassian.confluence.page.partition.SubspaceContextProvider" />
</content-template>

The my-template-key is usually the name of the template (e.g. retrospectives or user-characters).

Section

title	Use Cases

Display Table

doctype	use-cases
render-no-hits-as-blank	true
select	Name, Short Description
restrict-to-immediate-children	true
sort-by	Sort Key, Name
empty-as-none	true

Section

title	Quality Scenarios

Display Table

doctype	quality-scenario
render-no-hits-as-blank	true
select	Name, Short Description
restrict-to-immediate-children	true
sort-by	Sort Key, Name
empty-as-none	true

Section

title	Architecture Aspects

Display Table

doctype	architecture-aspect
render-no-hits-as-blank	true
select	Name, Short Description
restrict-to-immediate-children	true
sort-by	Sort Key, Name
empty-as-none	true

Section

title	Views

Display Table

doctype	view
render-no-hits-as-blank	true
select	Name, Short Description
restrict-to-immediate-children	true
sort-by	Sort Key, Name
where	$<Doctype> = [view]
empty-as-none	true

Section

title	Subordinate Components

Display Table

doctype	component
render-no-hits-as-blank	true
select	Name, Short Description
restrict-to-immediate-children	true
sort-by	Sort Key, Name

Section

title	Related Components

Display Table

doctype	component
render-no-hits-as-blank	true
select	Name, Short Description
restrict-to-immediate-children	true
sort-by	Sort Key, Name
empty-as-none	true

Section

title	Architecture Decisions

Display Table

doctype	decision
render-no-hits-as-blank	true
select	Name, Short Description
sort-by	Sort Key, Name
where	$<Type> = [Architecture] AND Doctype NOT "decision-type"
empty-as-none	true

Section

required-permissions	write-access
title	Notes

Section

title	References

Section

title	Resources

Space shortcuts

Page tree

Docs

Support

Free Blueprints

Tooling for Blueprints

Free Extensions

Spaces

Plugins for Maven

Incubator

Libraries for Java

Incubator

Add-ons for Confluence

Tools

Support

Team

Legal

Versions Compared

Old Version 3

New Version Current

Key

About

Keep up-to-date!

Powered by