Index Entries Table Macro

Document Properties Marker

doctype	macro
override	false
delegate-document	Display Table Macro

Doctype

macro

hide

Name

Index Entries Table Macro

Short Description

Renders a table of index entries.

Parent

Parent Property

property-name	Name

Audience

Name List

doctype	role
render-no-hits-as-blank	true
render-list-as-comma-separated-values	true
names	Author, Template Author
property	Audience

Tags

Tag List


css	projectdoc-compact
names	Dynamic List, Query, Glossary, Remote Control, Deep Link, Context Control, Autocomplete, Remote Controller

Flags

debug-mode-support

hide

Type

Name List

doctype	macro-type
names	Dynamic Navigation

Iteration


value	production

hide

Since

1.10

Page Size Support

Sort Key

hide

Section

index	true
show-title	false
title	Description

Render indices sorted by document names. The names of documents are specified as a comma-separated list in the body of the macro.

Note Box
This is a specialized version of the Display Table Macro with predefined parameters to match the use cases for listing documents.

Unlike the Index Card Macro the Index Entries Table Macro renders the documents of the hit list as lines in a table or items in a list.

Section

title	Properties

Section

title	Doctypes

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

title	Select

Section

title	Where

Available since version 1.11.

Transclusion

document	Transclude Documents Macro
ids	Where

Note Box

Section

title	Header Translations

Section

title	Counter Column

Section

title	Space Key

Section

title	Space Keys

Section

title	Render Mode

Section

title	Separator

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.

Available since version 1.15

Section

title	Insert Short Name Entries

If a value different to none is selected, an additional entry is added for each entry that has a short name or an abbreviation.

Note Box

Value	Description
`none`	No additional values are added.
`short-name`	Additional entry for the Short Name is added.
`abbreviation`	Additional entry for the Abbreviation is added.
`all`	Additional entry for Short Name and Abbreviation is added.

Additional entries render a link with a reference to the main entry (identified by the document name).

Section

title	Render 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 Class	Description
`div.projectdoc-index`	The block around the table of index entries.
`span.projectdoc-index`	The text rendering the index key.

The default styles are:

Code Block

language	css

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

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

Section

title	Render 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 Render Index is selected.

The default styles are:

Code Block

language	css

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

title	Caption

Section

title	No Table Heading

Section

title	Restrict to immediate Children

Section

title	Restrict to Favored

Transclusion

document	Display Table Macro
ids	Restrict to Favored

Section

title	Render no hits as blank

Section

title	Render no hits as blank No Hits Text

Section

title	Identifier

Section

title	Identifier Classes

Section

title	Context controlled

Section

title	Remote Controls

Section

title	Details

Section

title	Remote Controlled Documents

Version Box
Remote Controlled Documents are available since version 2.0 of the projectdoc Toolbox.

Remote Controlled Documents allow to control the content at request time. A HTTP request may override parameters of the macro. A request parameter addresses a macro by its identifier. After the identifier the name of the parameter is appended, separated by a colon.

Example Box

title	Override Parameters

Assume that the identifier of the macro is set to 'my', the following call will override the doctype parameter on the page 'MyPage' in space 'MYS'.

Code Block
confluence/display/MYS/MyPage?my:doctype=topic

The list of parameters allowed to override:

doctype
select
where
header-translations
render-counter-column
space-key
space-keys
separator
insert-short-names
render-index
render-index-access-panel
table-caption
suppress-table-heading
restrict-to-immediate-children
render-no-hits-as-blank
render-no-hits-as-blank-text

Section

title	Debugging

If a term specified in the body of the macro does not exist, the term is simply dropped. This makes it difficult for long lists to identify missing term definitions.

If the space property

Static Document Link

document	Debug Mode

is set to true, an error box is rendered that lists all undefined terms.

Version Box

since	4.12

This feature is available since version 4.12 of the projectdoc Toolbox.

Version Box

since	4.13

Since version 4.13 debugging is rendered in the UI only if the user has write access to the page hosting the macro.

See

Static Document Link

document	Debug Access Mode

for details.

Section

index	true
title	Related macros

Display Table

doctype	macro
render-no-hits-as-blank	true
render-mode	definition
select	Name, Short Description
sort-by	Sort Key, Name
where	Categories = "Display / Query"
exclude-self	true

...

Section

title	Notes

Section

title	References

Tour

render-as-definition-list	true
replace-title-with-name	true

Title	Short Description
Limitations on Query Results

Section

title	Resources

Piwik Set Multiple Custom Variables

Name	Value
Department	projectdoc
Category	projectdoc-macro
Type	modular

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 9

New Version Current

Key

About

Keep up-to-date!

Powered by