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.

Where

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.

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.

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

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.

The default styles are:

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

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

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

The default styles are:

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;
}

Remote Controlled Documents

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.

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

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 Debug Mode is set to true, an error box is rendered that lists all undefined terms.