Versions Compared

Key

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

...

Section
show-titlefalse
titleDescription

The Section Index Macro creates an index with intra-document links to all sections local in the macro body. This is a navigation tool to quickly jump to sections with a document as it provides an overview over the element in tabular form.

Section Sections may be defined locally by the use of the the

Static Document Link
documentSection Macro
 or be transcluded. Local and remote sections can be compiled by the 
Static Document Link
documentSection Compiler by Reference Macro
. Local sections may provide a short description and additional properties inside a 
Static Document Link
documentContent Marker Macro
.

...

Section
titleParameters
intro-textThe macro is configured by the following parameters.


Section
titleSelect

Specify a comma-separated list of document properties or section names to display.

If not specified, the name and short description of the document is displayed per default.


Transclusion
taget-heading-level*
documentDisplay Table Macro
idsCount Columns, Header Translations, Calculation Columns, Render Mode, Caption, No Table Heading, Identifier, Identifier Classes, Context controlled, Remote Controls



Version Box
since4.13

Since version 4.13 the parameter supports to reference a

Static Document Link
documentSpace Properties
labelspace property
. The name of the space property has to be prefixed with the paragraph sign ('§').

For instance, if the value for the select parameter is specified by the space property my-select, then the value of the select parameter is §my-select.



Section
titleMacro Body

Use the 

Static Document Link
documentSection Macro
 to add local sections to the body of the macro. To provide a short description or additional properties for this sections, use the 
Static Document Link
documentContent Marker Macro
.

Section
titleProvide Short Description

If the section should mimic a short description that is rendered in front of the document properties table, then use the 

Static Document Link
documentContent Marker Macro
 with parameter CSS Classes set to 
Static Document Link
documentprojectdoc-short-description
.


Section
titleProvide Document Properties

To provide additional document properties for a section, add a 

Static Document Link
documentContent Marker Macro
 with parameter CSS Classes set to 
Static Document Link
documentprojectdoc-selected-document-properties
.

If the document properties should not be shown in the section, use 

Static Document Link
documentprojectdoc-hide


...