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 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.
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
valuefilled

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
show-titlefalse
titleDescription

The 

Static Document Link
documentContent 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
titlePrerequisites


Section
titleUse 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
documentContent 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
titleImplementation

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.

...