Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
doctypeapp-macro
overridefalse
Short DescriptionCompiles local sections with transcluded content by a reference list.
NameSection Compiler by Reference Macro
Short Name
Parent
Parent Property
property-nameName
hide
Audience
Name List
doctyperole
render-no-hits-as-blanktrue
property-restrict-value-rangetrue
propertyAudience
empty-as-nonetrue

Subject
Name List
doctypesubject
propertySubject

Categories
Name List
doctypecategory
property-restrict-value-rangetrue
propertyCategories

Tags

Tag List
namesTransclusion, Remote Control, Context Control, Remote Controller
propertyTags


Flagshide
Iteration

Iteration
valuereleased

hide
IDprojectdoc-section-compiler-by-reference-macro
Type

Name List
doctypemacro-type, app-macro-type
render-no-hits-as-blanktrue
namesContent Reuse
propertyType


Suite
Name List
doctypeapp, app-extension
property-restrict-value-rangetrue
defaults-toancestor
propertySuite

App-Tool
Name List
doctypeapp-tool
render-no-hits-as-blanktrue
property-restrict-value-rangetrue
propertyApp-Tool

Supports Wiki Markup(error)
Since4.7
Deprecated
Removed
Sort Keyhide
Section
show-titlefalse
titleDescription

The 

Display Property
property-nameName
 allows to mix and merge locally defined sections, by the use of the 
Static Document Link
documentSection Macro
 with and transcluded content from referenced documents.

The main use case for this macro is to allow to seamlessly integrate content from transcluded content as if it were a locally defined section. The order of sections is defined by a referenced property. This way users have full control over the sequence of sections.

...

Section
titleMacro Body

The macro body contains the section that are referenced by the specified property. Whenever a section title matches with a specified name, the local section is rendered in the result. If it does not match a local section, then the content is transcluded. If no content is found on the referenced document, nothing is contributed to the result.

One element of the body may be 

Static Document Link
documentContent Marker Macro
 with preformatted or table content. The content is passed to the transclusion services a placeholder mapping.

Code Block
languagetext
titleExample of a Placeholder Mapping with preformatted Content
Service Name=Authentication Service
Service Level=24/7

On the left side is the name of the placeholder, on the right side is the replacement text. In the example the placeholder ${Service Name} in the transcluded content will be replaced by the text Authentication Service.

The content may also be an HTML table. Each row with at least two table data elements uses the text content in the first column as key and the HTML fragment in the second column as value.

Sample table with placeholders.Image Added

Note that the table header is optional.

Version Box
since4.8

HTML tables to define placeholder replacements is supported since version 4.8.

Section
titleDetails

Section
titleRelated Macros
Display Table
doctypeapp-macro, macro
render-no-hits-as-blanktrue
selectName, Short Description, Tags
render-classesrelated-macros-table, display-table, related-macros
where$<Tags>~(${Tags})

...