Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Document Properties Marker
overridefalse


Doctypepropertyhide
NameIndex Key
 

Short DescriptionThe 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-nameName
 

Audience
Name List
doctyperole
propertyAudience
hide
Categories
Name List
doctypecategory
propertyCategories
 

Tags
Tag List
 

IdentifierIndex Key
 

Component
Name List
doctypecomponent
propertyComponent
 

Mandatory
 

Data TypeString
 

Default ValueFirst letter of the Name Property
 

Value Range
 

Implementation
 

Since1.10
 

Iteration
Iteration
valuefilled
hide
Sort Keyhide



Section
titleDescription

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.


...