Identify Document Elements

...

Document Properties Marker

doctype	topic
override	false

Short Description

In case an author requires to identify a document element elements to the readerreaders, for instance a numbering of paragraphs or sentences, the Content Marker Macro allows to employ a page-related auto-numbering and provides means to specify the format in which for these consecutive numbers are rendered.

Name

Identify Document Elements

Short Name

Parent

Parent Property

property-name	Name

hide

Audience

Name List

doctype	role

render-no-hits-as-blank	true
names	Author, Template Author
property-restrict-value-range	true
property	Audience
empty-as-none	true

Subject

Name List

doctype	subject
property	Subject

Sponsors

Name List

doctype	stakeholder
render-no-hits-as-blank	true
property	Sponsors

Sort Key

hide

...

Section

show-title	false
title	Description

The

Static Document Link

document	Content Marker Macro

allows to wrap content with an identifier to form a content element. It also allows to associate the content element with a sequence number. The projectdoc Toolbox then auto-numbers the content elements and allows to render this number with the content element.

This is useful helpful for documents where readers need to identify content elements like paragraphs or sentences.

This tip shows a use case where the Content Marker Macro is used to track the definitions and explanations within a specification document.

...

Section

title	Prerequisites

This feature is supported with version 4.12 of the projectdoc Toolbox.

projectdoc-section

title	Use case

Suppose you need For a specification document suppose to add a number on your definitions and explanations.

Each definition and each explanation is enclosed on a

Static Document Link

document	Content Marker Macro

. Each definition should have a number to be uniquely identified within the document, like (Def.1, Def.2, and so on. The same is true for explanations: ...) and each explanation (Expl.1, Expl.2, and so on...) should have its own sequence number for unique identification within a document.

Section

title	Implementation

For this example there are three definition and two explanations within a chapter of the specification document.

Each content marker has an identifier (D.1, E.1, D.2, D.3, and Example.1) and a Render Counter (definition or explanation).

The identifier is not related to the render counter. It is probably more stable to identify the element not by the sequence name. If they are not related, references to the content need not to be changed if another content of the same type is added in front at a later time. You may either use a text phrase or some arbitrary identifier.

...

Section

title	Styling the Render Counter

Without any formatting, the rendered content looks like this:

You may add appropriate styles for your design to you space or site style sheet. Alternatively you may use a render template or combine the two approaches.

Section

title	CSS Styles

Each counter is rendered with the class

projectdoc-static-document-link-macro

document	projectdoc-render-counter-element

plus plus the name of the render counter.

Code Block

language	text
title	CSS Class Names

projectdoc-render-counter-element definition

Section

title	Render Counter Template

Add the style information as a space property

Static Document Link

document	Render Counter Template

named projectdoc.renderCounterElement.template. and append your render counter name (e.g. projectdoc.renderCounterElement.template.definition).

For a layout with tooltip you may use the

Static Document Link

document	Layout Element Macro

.

Define the label for the counter in the body of the Layout Element Macro.

Note the use of {} as a placeholder for the consecutive element counters.

The rendered content is now:

Section

title	Multiple Elements

It is possible to add multiple elements within one paragraph. In the following example we assume that D.1 and E.1 belong together and D2, D.3, and Example.1 also should be part of one paragraph.

Image Added

The Content Marker Macros are enclosed in additional Content Marker Macros where the Merge Block Elements parameter is set to true.

This is the rendered content:

Image Added

Section

title	Render Counter Context

The render counter context allows to define render counter sequences with the same name in different contexts. Each context is identified by its name. A

Static Document Link

document	Content Marker Macro

is associated with a Render Counter and optional with a Render Counter Context, defined by parameters.

The render counter context is especially useful if the Content Marker Macros are transcluded on the same page. In this case set the Render Counter Context on a wrapping Content Marker Macro around the source content.

Image Added

Section

title	Multiple Documents

In case the chapters of a document are on separate pages, the start value may be specified by a document property of the following format:

Code Block
{render-counter-context}#{render-counter}

Example Box

title	Example for valid Values

#definition
source#definition

Section

ignore-template-buttons	true
title	Subordinate Topics

Hide From Reader

Create from template

blueprintModuleCompleteKey	de.smartics.atlassian.confluence.smartics-projectdoc-confluence-space-core:projectdoc-blueprint-doctype-topic
buttonLabel	Create Topic

Display Table

doctype	topic
render-no-hits-as-blank	true
render-mode	definition
select	Name, Short Description
restrict-to-immediate-children	true
sort-by	Sort Key, Name

...

Section

title	References

Tour

render-no-hits-as-blank	true
render-as-definition-list	true
marker-column-property-name	Title
replace-title-with-name	true

Title	Short Description
Content Marker Macro
Render Counter Template
projectdoc-render-counter-element
Skip rendering Counter Element

Section

title	Resources

Tour

render-no-hits-as-blank	true
render-as-definition-list	true
marker-column-property-name	Title
replace-title-with-name	true

Title	Short Description

...

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 2

New Version Current

Key

About

Keep up-to-date!

Powered by