Versions Compared

Key

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

...

Document Properties Marker
doctypetopic
overridefalse


Short DescriptionIn case an author requires to identify document elements to readers, 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 for these consecutive numbers.
NameIdentify Document Elements
Short Name
Parent
Parent Property
property-nameName
hide
Audience

Name List
doctyperole
render-no-hits-as-blanktrue
namesAuthor, Template Author
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
propertyTags

Flagshide
Iteration

Iteration
valuefilledreleased

hide
Type

Name List
doctypetopic-type
render-no-hits-as-blanktrue
namesTip
property-restrict-value-rangetrue
propertyType


Level of Experience

Name List
doctypeexperience-level
render-no-hits-as-blanktrue
namesCompetent
propertyLevel of Experience


Expected Duration
Sponsors
Name List
doctypestakeholder
render-no-hits-as-blanktrue
propertySponsors

Sort Keyhide


...

Section
titlePrerequisites

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


projectdoc-section
titleUse case

For a specification document suppose to add a number on definitions and explanations.

Each definition and each explanation is enclosed on a

Static Document Link
documentContent Marker Macro
. Each definition (Def.1, Def.2, ...) and each explanation (Expl.1, Expl.2, ...) should have its own sequence number for unique identification within a document.

...

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

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 RemovedImage Added


Section
titleRender 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
documentContent 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.

...