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

Render no hits as blank

If the query found no hits, the result is rendered as a short text message. If a result with no hits should not be rendered at all, check this box.

No Hits Text

Text to be rendered if no hits are shown.

This allows to customize the text message.

Force Show

If checked then content that is hidden in its original location is shown.

This effectively overrides the hide parameter of a Section Macro or Content Marker Macro.

Identifier

The identifier is rendered with the encosing HTML element.

It is also useful to uniquely identify the macro in a page.