Versions Compared

Key

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

...

Section
titleProperties


Section
titleIdentifier

The identifier uniquely identifies the content within the document. An HTML element will be rendered with this identifier as value to the HTML attribute id.

If the identifier has the hashmark as prefix, it is used verbatim. If the prefix is not a hashmark, the system will ensure the uniqueness of the element within the space and on the page.

Version Box
since4.9

The verbatim identifiers are supported since version 4.9 of the projectdoc Toolbox.



Section
titleTags

Allows to tag the content for transclusion with the Transclusion Macro. You may specify more than one tag in this comma separated list.


Section
titleHide

The flag allows to not render the content, if checked. Use this parameter to temporarily hide content from being show to readers.


Section
titleLocalize Links

Check if links in transcluded content should be re-targeted to the current page.

This is especially useful if content is to be exported to PDF or Microsoft Word.


Section
titleConsider 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.

Version Box
since4.5

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



Section
titleEmpty Block Text

The block is considered empty if the text matches the content.

Note that only content rendered on the server side is considered. If the content is altered by a JavaScript on the client side, this parameter has no effect.

Version Box
since4.7

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



Section
titleIgnore Template Buttons

If checked template button macros are regarded as whitespace.

This allows to add a template button to create subordinate pages without rendering the section just because of the button being part of the body.


Section
titleRequired Roles

Readers require the given roles to have access to the content. If not specified, the content is accessible to anyone.

Transclusion
documentSecurity Note for Hide Macros
idsbox


The user must have one of the specified roles, not all, to access the content.

Add the name of roles here you have (optionally) defined with a role document. It is required that the name of the role is created as a Confluence group.

Note Box
titleCase insensitive

Note that while Confluence group names are required to be lower case, the names of roles may still be provided in mixed case.



Section
titleRequired Permissions

Readers require the given permissions to have access to the content.

Transclusion
documentSecurity Note for Hide Macros
idsbox



PermissionDescription
no-permissions-requiredThe content is accessible by anyone who has access to the page.
not-authenticated

Users are required to be not authenticated to have access to the content.

This allows text to be rendered in case a user is authenticated or not authenticated.

Version Box
since4.2.1

This option is available since version 4.2.1.


authenticated

Users have to be logged in to access the content.

Usually you have to be a team member in the role of a reader to access the content.

write-access

Users have to have write access to access the content.

The content will only be rendered to authors.

The space property Pretend Being A allows to override this value.


Section
titleRequired Document Properties

The listed document properties are required to be set to a non-empty value to show the content.

The names have to be comma-separated.

Transclusion
documentSecurity Note for Hide Macros
idsbox


The property names are allowed to be prefixed with an exclamation mark (!) in which case the content is only shown if the value of the space property is not blank.

It is possible to check for a certain property value.

Code Block
property-name=my-value,!property-name2=other-value

In case the properties list is starting with a pipe character ("|") then at least one of the properties is required to match.

Version Box
since4.2

The OR semantics are supported since version 4.2 of the projectdoc Toolbox.



Section
titleRequired Space Properties

The listed space properties are required to be set to a non-empty value to show the content.

The names have to be comma-separated.

Transclusion
documentSecurity Note for Hide Macros
idsbox


Property names are allowed to be prefixed with an exclamation mark (!) in which case the content is only shown if the value of the space property is not blank.

Code Block
space-property-name=my-value,!space-property-name2=other-value

In case the properties list is starting with a pipe character ("|") then at least one of the properties is required to match.

Version Box
since4.2

The OR semantics are supported since version 4.2 of the projectdoc Toolbox.



Section
titleCSS Classes

Specify the CSS classes to be attached to the div element (HTML) around the marked content.

Example Box


Transclusion
documentCSS Classes for Sections and Content Fragements
idsContent





Section
titleMerge Block Elements

Controls whether (true) or not (false, default) to merge block elements to a single element.

The following block elements are supported.

Block Element
p

All paragraphs will be merged into one. The contents of each merged paragraph will be rendered in a span element, with the parent's attributes applied.

The use case is to split parts of a paragraph into multiple Content Marker Macros and then allow to rendered the paragraph again in one block.

ul

Allows to merge bullet / unordered lists that are on any level, but not contained within another list element.

This allows to merge lists that have been rendered separately within Content Marker Macros and then allow to render the multiple lists as one.

This use case is focused on merging Content Marker Macros. For other use cases the

Static Document Link
documentTable Merger Macro
allows to merge lists, too.

olAllows to merge ordered lists. For details please refer to the description of ul above.


Version Box
since4.12

This parameter is supported since version 4.12 of the projectdoc Toolbox.



Section
titleApply Document Properties

If checked (true) properties of the document and space are applied to resolve placeholders.

The standard placeholders are supported:

  • ${...} - text replacement
  • $<...> - HTML replacement
  • $[...] - text replacement with link to current document
Version Box
since5.0

This parameter is supported since version 5.0 of the projectdoc Toolbox.



Section
titleRender Counter Context

Defines the context of a render counter sequence. 

This allows to render the same sequence in different contexts.

Version Box
since4.12

This parameter is supported since version 4.12 of the projectdoc Toolbox.



Section
titleRender Counter

Defines a sequence counter to render index numbers.

Specify the name of the sequence and each encounter of the sequence name on a Content Marker Macro will increase the sequence counter by one.

This allows to render the index number of an element for reference. For instance each Content Marker Macro may contain a sentence within a paragraph. The rendered index key allows to easily track each sentence.

The counter element is rendered with a class attribute value of

Static Document Link
documentprojectdoc-render-counter-element
. The render counter will also be added to the class attribute.

Version Box
since4.12

This parameter is supported since version 4.12 of the projectdoc Toolbox.

If the counter should not be rendered as a separate HTML element, use the space property

Static Document Link
documentSkip rendering Counter Element
. Otherwise specify the template to use for rendering by the space property
Static Document Link
documentRender Counter Template
.

The start index number can be set via a document property of the form {render-counter-context}#{render-counter}. The value is expected to be an integer.


Section
titleWrapping Element

Specify the HTML element to enclose the content rendered by this macro.


Section
titleForce Not First Child

Check to prevent the content being considered to be the first child.

This is a workaround for authors who need to force the contents of this macro not to be the first child in a container.

The parameter may be set to a value of true as a page or space property by the name projectdoc.fix.content-marker.firstChild.

Version Box
titleExperimental Feature
since4.2

This feature is available with version 4.2 of the projectdoc Toolbox.

It is considered to be experimental and may be removed in future versions.

Prior to version 4.12 this parameter was called "Force First Child".



...