Configuring and Using Document IDs

Content Layer

name	Page Info
id	278129461
class	watermark-layer

Content Column

name	Page Body
width	100.00001%
id	278129463

Content Block

background-color	transparent
name	Prompt
id	494677873
class	tight manual-prompt-flex

Set up a document identifier to be automatically assigned to page titles in a space.

Content Block

name	Outcome
rich-link-hovers	true
id	1042866408
class	tight manual-outcome-flex

Replace me with a more complete explanation of what this how-to accomplishes.

Content Block

name	Steps
rich-link-hovers	true
id	494842117
class	steps-block numbered manual-steps-flex tight-bottom

Open the Confluence Sidebar and click "Space Tools"

You must be a space or system administrator to perform this action. If using Brikit Theme Press as well, toggle open the Confluence menus to access the Sidebar.

Select "Overview"

Navigate to the "Apps" tab

Click the "Document Identifiers" sub-tab

HTML Wrap

class	docs-screenshot

Image Added

If you haven't done so, click to "Enable Document Identifiers"

Define your Document Identifier

Set a Code and Pattern according to the rules and examples in the right-side informational section. See the Note section below for this same information.

HTML Wrap

class	docs-screenshot

Image Added

Click Save

Document Identifiers are now set up. You will be presented with a summary table of your document identifier.

Take note the special short URLs

A special shortcut URL is created based on the document identifier. You may use this URL to directly access the pages using these IDs (and bypassing the titles). This can be an extraordinarily handy way to reference documents quickly and easily simply by its ID.

Create a new page

For every new page created going forward, a Document Identifier will be added to the Page Title according to the pattern and sequence defined.

Note that the Confluence Page Title does not actually get changed in the Confluence database, so you will not see page identifiers in page titles in the Confluence Sidebar. That said, Document Identifiers are added to the Confluence search index, meaning you can search Document Identifiers to locate a page.

Additionally, if you have Brikit Theme Press, Document Identifiers are included in page title listings in the Navigator and in macro results.

HTML Wrap
Image Added

Use h4 for section headings

If you don't want numbers in the section headings, simply remove the "numbered" class from this block.

Note/Tip/Warning/Info blocks below are collapsed by default. If you want to use any of these, try to keep to just one per page. You may use two if necessary, but in general, try to limit these.

Content Block

name	Note
rich-link-hovers	true
id	495965127
class	manual-note-flex
collapsible	collapse

Note

If using:

Replace me with something to note about this how-to entry that falls outside the scope of all other sections; and
Add the tight-bottom class to the Steps block above to narrow the gap between the two blocks.

Content Block

name	Tip
rich-link-hovers	true
id	894522670
class	manual-tip-flex
collapsible	collapse

Tip

If using:

Replace me with something to note about this how-to entry that falls outside the scope of all other sections; and
Add the tight-bottom class to the next visible/non-collapsed block above this one to narrow the gap between the two blocks.

Content Block

name	Warning
rich-link-hovers	true
id	894530759
class	manual-warning-flex
collapsible	collapse

Warning

If using:

Replace me with something to note about this how-to entry that falls outside the scope of all other sections; and
Add the tight-bottom class to the next visible/non-collapsed block above this one to narrow the gap between the two blocks.

Content Block

name	Info
rich-link-hovers	true
id	894537203
class	manual-info-flex
collapsible	collapse

Info

Document Identifier Pattern Options

The following special characters may be used to define the document identifier:

N - Display document number. Multiple N's will left pad with zeros. (e.g., NNNN -> 0001)
A - Convert numbers to a single, uppercase character. (e.g., 1 = A, 2 = B, etc.)
a - Same as A, but lowercase. (e.g., 1 = a, 2 =b)
All other characters will appear in the document identifier unchanged. See Search Optimization note below for pitfalls.

Pattern examples (all reference same page in tree):

NNNN.NN.N => 0002.02.3
NNNNa.a => 0002b.c
NNNN-vN => 0002-v2
NNNNAa => 0002Bc
Aa.N => Bb.3

Search Optimization

Because the Confluence search engine separates text with spaces and hyphens, to get precise search-by-document-identifier results, spaces and hyphens are not recommended within document identifiers.

For example, use -NNNN.NN instead of -NNNN-NN in the Document Identifier Pattern field below.

A document can be found by searching for the document identifier ("DOC-005.01") or using the document: prefix ("document:DOC-005.01")

Info

If using:

Replace me with something to note about this how-to entry that falls outside the scope of all other sections; and

Add the tight-bottom class to the next visible/non-collapsed block above this one to narrow the gap between the two blocks

.

Content Layer

background-color	$lightGrayColor
name	Related
id	888168050

Content Column

name	Related
width	100%
id	888168051

Content Block

rich-links-hide-description	true
rich-link-hovers	true
rich-links-columns	4
rich-links-vertical	true
rich-links-image-height	100px
rich-links-hide-site-icon	true
rich-links-details-padding	10px
name	Related
rich-links-enable	true
border-width	0
rich-links-details-alignment	left
rich-links-margin	20px 30px 0 0
id	496234544
class	related-block clean manual-related-flex

Document ID
Creating a Review or Archive Policy
Creating and Managing Page Statuses
Replace me with a link
Replace me with a link
Aim for 4 or fewer related links. If we need more, that's okay. Be judicious. Delete me when you're done.

Page tree

Transform Your Digital Workplace

Industry Expertise

Inform Your Strategic Direction

Redefining Work

Documentation and Support

Versions Compared

Old Version 1

New Version Current

Key

Open the Confluence Sidebar and click "Space Tools"

Select "Overview"

Navigate to the "Apps" tab

Click the "Document Identifiers" sub-tab

Define your Document Identifier

Click Save

Take note the special short URLs

Create a new page

Use h4 for section headings

Platform

Company

Support

Brikit Services