- Created by Robert Reiner on 05. Jan 2024
Renders a table of index entries.
- Audience
- Categories
- Tags
- Type
- Dynamic Navigation
- Since
- 1.10
- Page Size Support
Render indices sorted by document names. The names of documents are specified as a comma-separated list in the body of the macro.
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.
Properties
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
A Lucene search expression to filter on the results. If the property contains spaces, remove them or use $[...]
.
Examples:
Name = "foo" AND ShortDescription NOT \"bar\"
Name = "foo" AND $[Short Description] NOT \"bar\"
Please refer to Search Tips for information on limitations and extensions on the search expression syntax provided by projectdoc.
Since 4.13
Since version 4.13 the parameter supports to reference a space property. The name of the space property has to be prefixed with the paragraph sign ('§
').
For instance, if the value for the where parameter is specified by the space property my-where
, then the value of the select parameter is §my-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.
Available since version 1.17.
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.
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).
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:
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; }
Restrict to Favored
If checked, only documents marked with a star are valid hits.
This feature allows to filter documents in the result set that are not marked as favored.
Pages that are marked with are star a currently defined as "Saved for Later" and where previously deemed as favorite (or favourite).
Since 7.0
This feature is available since version 7.0 of the projectdoc Toolbox.
Details
Remote Controlled Documents
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.
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'.
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.
Since 4.12
This feature is available since version 4.12 of the projectdoc Toolbox.
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 Debug Access Mode for details.