Versions Compared

Key

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

...

Document Properties Marker
doctypemacro
overridefalse
delegate-documentDisplay Table Macro


Doctypemacrohide
NameIndex Entries Table Macro
Short DescriptionRenders a table of index entries.
Parent
Parent Property
property-nameName

Audience
Name List
doctyperole
render-no-hits-as-blanktrue
render-list-as-comma-separated-valuestrue
namesAuthor, Template Author
propertyAudience

Categories
Name List
doctypecategory
namesDisplay / Query

Tags

Tag List
cssprojectdoc-compact
namesDynamic List, Query, Glossary, Remote Control, Deep Link, Context Control


Type

Name List
doctypemacro-type
namesDynamic Navigation


Iteration
Iteration
valueproduction
hide
Since1.10
Sort Keyhide


...

Section
titleProperties


Section
titleDoctypes

Specify the type of the documents to select. If documents from more than one document type are to be selected, enumerate them in a comma-separated list. Leave blank to select documents from any doctypes.

If a property selected from a document is not supported by a doctype, a blank cell will be rendered.

Defaults to select Glossary Items.


Section
titleSelect
 


Section
titleWhere


Transclusion
documentTransclude Documents Macro
idsWhere


Note Box

Available since version 1.11.



Section
titleHeader Translations



Section
titleCounter Column



Section
titleSpace Key
 


Section
titleSpace Keys
 


 
Section
titleRender Mode


Section
titleSeparator

The default separator for the index items specified in the body of this macro is the comma (','). The items may be specified on multiple lines, but each line is split by the commas in this line.

If your index entries have commas in their names, the separator may defined to something different than a comma. If you have one entry on each line, specify '\n' as a special separator. Note that a separator can only have one character. The special separator for newlines is an exception.

Note Box

Available since version 1.17.



Section
titleInsert Short Name Entries

If selected, an additional entry is added for each entry that has a short name.

Note Box

Available since version 1.15.



Section
titleRender Index

Render sections for index keys.

The elements associated with an index key are enclosed in an element and the index key is rendered.

CSS ClassDescription
div.projectdoc-indexThe block around the table of index entries.
span.projectdoc-indexThe text rendering the index key.

The default styles are:

Code Block
languagecss
div.projectdoc-index {
  margin-top: 2em;
}

span.projectdoc-index {
  font-size: larger;
  font-weight: bold;
}



Section
titleRender Index Access Panel

Render links to index keys above the index for quick access of the index key from the top of the page.

The value of this parameter is only taken into account, when 81035737 is selected.

The default styles are:

Code Block
languagecss
div.projectdoc-index-access-panel {
    border-radius: 10px;
    border: 2px solid #036;
}

.projectdoc-index-access-panel ul {
    margin: 3px;
    padding: 3px;
    list-style-type: none;
    text-align: center;
}

.projectdoc-index-access-panel ul li {
    display: inline;
}

.projectdoc-index-access-panel ul li a {
    border-radius: 10px;
    text-decoration: none;
    padding: .2em 1em;
    color: white;
    font-weight: bold;
    background-color: #369;
}

.projectdoc-index-access-panel ul li a:visited {
    color: white;
    background-color: #369;
}

.projectdoc-index-access-panel ul li a:link {
    color: white;
    background-color: #369;
}

.projectdoc-index-access-panel ul li a:hover {
    color: white;
    background-color: #036;
}



Section
titleCaption



Section
titleNo Table Heading



 
Section
titleRestrict to immediate Children


Section
titleRender no hits as blank



Section
titleNo Hits Text



...