Section Macro

...

Section

title	Properties

Section

title	Title

The section title to be rendered. The section title will also be used as an unique identifier of the section within the document.

Note Box

The title will be normalized to an HTML id attribute value that can be used as an anchor in a reference.

The standard mechanism provided by Confluence is used to calculate this identifier. Basically the identifier is stripped from any spaces. If the identifier is not plain letters, a prefix of "id-" is added to the identifier. This is especially the case, if an identifier does not start with a letter. The generated identifier is conform to HTML 5.

Usually document authors do not have to bother with the structure of the id attribute.

From version 1.7 on the title is mandatory. This allows authors to create the macro and add a title with greater speed.

Section

title	Level

The level of the heading. This will create an HTML header element.

Note Box

If you are using version 1.7 of the projectdoc add-on and you are running Confluence in version 5.8, the level '*' is supported to calculate the level automatically.

A section with level '*' located top-level will be considered to be at level 1. If a section with level '*' is inside a section of level X, it will be moved to level X+1. Therefore users may now safely choose the default level of '*' and let projectdoc calculate the level of the sections automatically. This is especially useful if you decide to move a section within another using drag-and-drop.

If the macro is executed inside an older version of Confluence (less than 5.8), the star is always resolved to level 1. That is you have to control the level manually.

Section

title	Delegate on Empty

If checked (default), the macro transcludes the section with the same name as this section from the delegate document, if the content of the section is not empty.

You may control the output if the referenced section is not available in the delegate document. Per default, nothing is rendered (same as in the case the section in the delegate document is empty). If you set Delegate Document Suppress Error Message Section to false, an error message will be rendered in the delegating page.

If no delegate document is provided with the Document Properties Marker Macro, this parameter has no effect.

Note Box
For Information on using the delegation feature for properties, please refer to delegate.

Available since version 1.10.

Transclusion

taget-heading-level	*
document	Content Marker Macro
ids	Localize Links

Section

title	Show Title

If this box is unchecked, the title will not be rendered.

Since version 1.7 on the title is mandatory, this checkbox - also available since version 1.7 - is necessary if the section should be displayed without a title.

Section

title	Identifier

The identifier uniquely identifies the content within the document. This overrides the title as the default.

An HTML element will be rendered with that id as an attribute.

Transclusion

taget-heading-level	*
document	Content Marker Macro
ids	Tags

Section

title	Intro Text

Allows the template author to add a text to introduce the content. Any text added here is considered as not present, if the content is empty. If you are not designing a document template, this attribute is of little use and you will probably add the text to the macro's body.

Section

title	Extro Text

Like the Intro Text property, but will be rendered after the section's content.

Transclusion

taget-heading-level	*
document	Content Marker Macro
ids	Hide

projectdoc-section

title	Consider Empty

If this parameter is checked, then the content is considered to be empty for all checks conducted by the projectdoc Toolbox.

This allows users to add content that is only rendered in case content that is not empty or considered empty is actually present.

This is similar to the Intro Text and Extro Text parameters whose content is also only rendered if the content of the section is not empty.

Version Box

since	4.5

This parameter is available since version 4.5 of the projectdoc Toolbox.

projectdoc-transclusion-macro

taget-heading-level	*
document	Content Marker Macro
ids	Ignore Template Buttons

Transclusion

taget-heading-level	*
document	Content Marker Macro
ids	Required Roles

Transclusion

taget-heading-level	*
document	Content Marker Macro
ids	Required Permissions

Transclusion

taget-heading-level	*
document	Content Marker Macro
ids	Required Document Properties

Transclusion

taget-heading-level	*
document	Content Marker Macro
ids	Required Space Properties

Section

title	CSS Classes

Specify the CSS classes to be attached to the created section.

Example Box

Transclusion

document	CSS Classes for Sections and Content Fragements
ids	Content

Version Box

since	1.6

The parameter is supported since version 1.6.0.

Not that the enclosing HTML DIV element renders a CSS class that includes the identifier of the doctype. This allows users to render sections on different doctypes differently.

Version Box

since	2.0

Since 2.0 the enclosing HTML DIV element renders 'projectdoc-not-a-doctype' instead of 'projectdoc-null'.

Section

title	Numbering

Switch on or off the numbering for the heading.

Note Box
The property `Enable Heading Numbers` is required to be set to `true` on either document or space level.

The numbering is created with CSS. If the output format does not apply CSS styles, no numbers will be rendered.

For more information on how to control numbering in your projectdoc documents, refer to these space properties:

Display List

doctype	property
render-no-hits-as-blank	true
render-short-description	true
uncapitalize-short-description	true
where	Tags="heading-number"
exclude-self	true

Note Box
The parameter is supported since version 1.5.0.

Section

title	Numbering Start

Specify the start of the first level numbering.

Note Box
The parameter is supported since version 1.5.0.

...

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 11

New Version 12

Key

About

Keep up-to-date!

Powered by