projectdoc Toolbox

Short Description
The space key and a XML element to reference a space are generated by default.
Iteration
Filled

Description

Explains the parameters related to space properties available in the blueprint context.

Add Space Information to Blueprint Context

The space key is accessible by the key spaceKey from the blueprint context.

Since it is sometimes convenient to render a complete XML tag, this XML fragment is also generated and stored by the key spaceKeyElement:

<ri:space ri:space-key="spaceKey" /> 

Here is an example on how to use the XML element with the Create from Template Macro:

<structured-macro name="create-from-template">
  <parameter name="blueprintModuleCompleteKey">someKey</parameter>
  <parameter name="buttonLabel">Some Label</parameter>
  <parameter name="spaceKey"><at:var at:name="spaceKeyElement" at:rawxhtml="true"/></parameter>
</structured-macro>

This example shows how the spaceKeyElement property is used to render the complete element.

Transcluded By

NameShort DescriptionDoctype
ProjectDocContextProvider
The standard context provider or templates.
component
ProjectDocSpaceContextProvider
Context provider to templates of structural pages that need not to be created individually. This is usually the case for pages like the space homepage. It is created once and edited by the user. There is no need to create this page in an existing page, like it may be the case for a doctype homepage.
component
ProjectDocSubdocumentContextProvider
The 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).
component
SubspaceContextProvider
The standard context provider for home and special pages.
component