Using Heading Numbers

Section

Column

width	60%

Document Properties Marker

override	false

Short Description

A short introduction to use heading numbers with the projectdoc Toolbox.

Doctype

topic

hide

Name

Using Heading Numbers

Short Name

Parent

Parent Property

property-name	Name

hide

Audience

Name List

doctype	role
render-no-hits-as-blank	true
names	Author
property	Audience

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

Using heading numbers with the projectdoc Toolbox for Confluence is based on the Section Macro and a couple of space properties.

This short tip shows how to use this feature.

Some features are only available since version 3.0.

Section

title	Summary

Using heading numbers for sections in your projectdoc Document is very easy. Heading numbers are controlled by the use of properties on space and document level.

Section

title	Prerequisites

This tip assumes that you know

what a space is
the basic use cases for the Section Macro
how to use document properties and space properties

Column

Panel

title	Contents

Table of Contents

maxLevel	1
indent	15px
exclude	Summary\|Prerequisites\|References\|Resources
style	none

...

Section

title	Suppress Heading Number on a Section

You may not need a heading number on a section for your document. 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.

Now the heading numbers are aligned.

Screenshot of the document with the heading number aligned

Note Box

Note that in case you need to print the document, the summary has a numbered heading.

To prevent this issue, you may choose to not show the title and have the Description and the Summary section collapsed. Printing is then no issue since there is no heading.

Section

title	Number and Level StartControl the starting Number on a Document

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

title	Extracting Section

Suppose you need to extract the sections Space Relation, Providing Spaces, and Collaboration Spaces to their own documents. This way you may have easier content reuse, you may collaborate easier if each content is created by another author, any you may reference the individual sections easier if they have their own unique URL.

Let's use the Section Doctype to create a document for each of the three sections we extract and the Transclude Documents Macro to integrate them with the original document.

Screenshot of the document using transclusion to include sections e

A section document looks like this:

The first section of the document as a separate document

Section

title	Configuration of Section Documents

To create the same heading number in the section documents as shown in the transcluding document, you need to set the number start (heading-number-start) to 1 and switch on the numbering of the document title (set use-document-heading-number to true).

Now the section headings align with the numbers shown in the transcluding document.

Note Box

title	Only works for strict structures

Now the topic is closely bound to the document it is transcluding. In the case of sections this is typically okay. But you would need to update the document properties in case you alter the position of a section in the transcluding document.

There is no control in case you have a Module or a Topic that is used by more than one document. In this case the numbering would need to be different for each transcluding document, which is not possible for the same document.

...

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 16

New Version 17

Key

About

Keep up-to-date!

Powered by