Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
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

names
Tag List
propertyTags


FlagsConfluence, projectdoc Toolbox, heading numbers, sectionspropertyTagsFlagshide
Iteration

Iteration
valuefilled


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
titlePrerequisites

This tip assumes that you know

  1. what a space is
  2. the basic use cases for the Section Macro
  3. how to use document and space properties.
Section
titleUse Sections

Authors need to use sections to organize content in a projectdoc Document. This is required to use the numbering feature of the projectdoc Toolbox.

The screenshot from the Confluence editor shows a section with two subsections

The subsections are contained in their parent section. The level of each section is defines as '*'. Therefore the projectdoc Toolbox will calculate the correct heading level automatically.

In order for heading numbers are shown, the numbering parameter must be activated for a section.

Shows a screenshot of the macro editor with the parameter of the Section Macro to control heading numbers

This is the default value. Therefore authors do only need to configure the macro here, if the heading numbers for the sections must not be shown. Please note that checking this checkbox only tells the projectdoc Toolbox that in case heading numbers are activated that this sections should have a number. If heading numbers are not activated, then this parameter has no effect.

...

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 documetdocument. 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 contentsImage RemovedScreenshot of a page where the Summary section has a heading number, but is not shown in the table of contentsImage Added

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

Screenshot of the document with the heading number alignedImage Added

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
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
titleExtracting 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 sectionsImage Addede

A section document looks like this:

The first section of the document as a separate documentImage Added

Section
titleConfiguration of Section Documents

To create the same heading number as in the transcluding document, you need to set the number start (heading-number-start) to 1.0 and the heading starting level (heading-starting-level) to 2.

Two properties to control the heading numbersImage Added

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

The aligned heading numbers of the first sectionImage Added

Note Box
titleOnly 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 since in this case the numbering would be different for each transcluding document.

The configuration for the second transcluded section requires the number start (heading-number-start) to be set to 2.0.

Configuration of document properties for the second sectionImage Added

The rendered document would render like this:

Screenshot of the second section in its own documentImage Added

Section
titlePage Title Numbering

As you may already have notices, the numbering of the section does still not align. Headings have no numbers per default.

To change this you need to apply a CSS style to your Confluence site configuration or to your space configuration. This CSS may be different according to your layout tool you employ.

Here is one way to achieve the heading numbering for the transcluding document and all its sections for a standard Confluence environment. Using a layout tool may make the issue much simpler.

Section
titleActivate the HTML Macro

To add additional CSS styles you need to activate the HTML Macro provided by Confluence as a system plugin.

Caution Box

HTML macros are disabled by default

The HTML macro will only be available if it has been enabled by an administrator. Enabling these macros can make your Confluence site vulnerable to cross-site scripting attacks.

Shows the enabled HTML MacroImage Added

Section
titleOption 1: Set Heading Number per Default

If you set the heading number per default, then each page will have a heading number.

Section
titleSpace Look and Feel

Using the Space Tools you are able to configure the CSS for a single space in Confluence.

Stylesheet configuration for the space look and feelImage Added

Code Block
languagecss
h1#title-text:before {  
   counter-increment: h1;  
   content: counter(h1) " ";  
}

If you use level one headings on the page, these will continue with the second number. So you would need to use only level two headings on your pages. Besides that you also have numbers where you probably do not want them as in the screenshot shown above. "Space Tools" also uses the "title-text" identifier and therefore has a heading number.

Section
titleSuppress Heading Numbers on Transcluding Page

To remedy some of the issues above, use the following CSS

Code Block
languagecss
h1#title-text:before {  
counter-reset: h1 !important;
counter-increment: none !important;
content: "" !important;
}

with the HTML Macro.

HTML Macro with style element and CSSImage Added

Section
titleOption 2: Use Custom CSS on every transcluded Page

Add the following CSS to every page you need a heading number in the title.

HTML Macro for transcluded DocumentsImage Added

Since you already use level 2 headings (heading-starting-level) these won't interfere with the h1 used for the title.



Section
titleSubordinate Topics
Display Table
doctypetopic
render-no-hits-as-blanktrue
render-modedefinition
selectName, Short Description
restrict-to-immediate-childrentrue
sort-bySort Key, Name

...

Section
titleResources
Tour
render-no-hits-as-blanktrue
render-as-definition-listtrue
marker-column-property-nameTitle
replace-title-with-nametrue