Index Key

Document Properties Marker

override	false

Doctype

property

hide

Name

Index Key

Short Description

The key to the lookup the document within its context. The index key is typically the first character of the name. It may be defined by the author as a document property to override the default.

Parent

Parent Property

property-name	Name

Audience

Name List

doctype	role
property	Audience

hide

Tags

Tag List

Identifier

Index Key

Component

Name List

doctype	component
property	Component

Mandatory

Type

String

Default Value

First letter of the Name Property

Value Range

Implementation

Since

1.10

Iteration


value	facadefilled

hide

Sort Key

hide

Section

title	Description

The index key is helpful to define glossaries. Authors may sort the hits of a Display Table Macro using the index key and name.

The index key is typically the first character of the name. It may be defined by the author as a document property within the Document Properties Marker Macro to override the default. Since the value may be overridden the index key is technically a special form of an artificial property.

Note Box

Keep in mind to keep the sort key, the name, and the index key in relation to the reader's expectation.

For glossary items the index key should align with the sort key order. Other doctypes, for instance meeting minutes that are typically have a sort order defined by the date of the meeting, the index key is less important.

Section

title	Example of Usage

...

Section

title	References

Section

title	Resources

Display Properties
document Sort Key
Display Properties
document Name

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 1

New Version 2

Key

About

Keep up-to-date!

Powered by