Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Reverted from v. 2
Document Properties Marker
overridefalse
Short DescriptionA short introduction to use heading numbers with the projectdoc Toolbox.
Doctypetopichide
NameUsing Heading Numbers
Short Name
Parent
Parent Property
property-nameName
hide
Audience

Name List
doctyperole
render-no-hits-as-blanktrue
namesAuthor
propertyAudience


Subject
Name List
doctypesubject
propertySubject

Categories
Name List
doctypecategory
propertyCategories

Tags

Tag List
namesConfluence, projectdoc Toolbox, heading numbers, sections
propertyTags


Flagshide
Iteration

Iteration
valuefilled

hide
Type

Name List
doctypetopic-type
render-no-hits-as-blanktrue
namesTip
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
titleAdditional Control

For some use cases you may need additional control on heading numbers.

Section
titleSuppress Heading Number per Doctype

If you choose to have heading numbers for all documents you have enabled the heading numbers on space level. You may not want numbers on page that have purely navigation purposes such as documents of type Space Index.

In this case use the space property suppress-heading-numbers-on-doctypes to switch off heading numbers for a selected set of document types. Per default

Display Property
documentsuppress-heading-numbers-on-doctypes
property-nameDefault Value
are included in the set of documents that should not have heading numbers.

Controls to suppress heading number for all documents of type 'topic' in this space

Not that this configuration can be overruled by enabling heading numbers on a particular document using enable-heading-numbers.

Section
titleSuppress Heading Number on a Section

You may not need a heading number on a section for your documet. Like in the following example where the table of contents does not show the summary (and therefore does not number it).

Screenshot of a page where the Summary section has a heading number, but is not shown in the table of contents

Since the Summary section is not referenced in the table of contents (upper right side of the screenshot), the numbers differ. To align them, you either need to show the Summary section in the table of contents or suppress the heading number for the Summary.

Deselect the parameter Numbering in the macro editor for the Section Macro showing the Summary.

Shows a screenshot of the Numbering parameter is set to 'false' (unchecked)

Now the heading numbers are aligned.

Screenshot of the document with the heading number alignedImage Added

Section
titleNumber and Level Start

In case you have a large document, like a specification or a architecture description using the arc42 Template, you may need more fine grained control of the numbering of a page.

...

Section
titleResources
Tour
render-no-hits-as-blanktrue
render-as-definition-listtrue
marker-column-property-nameTitle
replace-title-with-nametrue
TitleShort Description
enable-heading-numbers
suppress-heading-numbers-on-doctypesUsing SpacesThe article we use in this tip.