- Created by Robert Reiner, last modified on 12. Jul 2017
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 5 Next »
projectdoc Toolbox
Renders a table of index entries.
- Audience
- Categories
- Tags
- Type
- Since
- 1.10
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
.
Available since version 1.11.
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 selected, an additional entry is added for each entry that has a short name.
Available since version 1.15.
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; }
Related macros
- Display List Macro
- Lists references to projectdoc documents in a list. List contain names and optional short descriptions.
- Display List Template Macro
- Lists references to projectdoc documents in a list. List items are defined by templates referencing properties.
- Display Table Macro
- Lists references to projectdoc documents in a table. Allows to select document properties for columns. Also non-list representations are provided.
- Index Card Macro
- Renders transcluded content fetched from documents of a result set.
- Index Entries Table Macro
- Renders a table of index entries.
- Tour-by-Property Macro
- Renders a predefined list of documents in a table . Documents are selected by a document property. Allows to select document properties for columns. Also non-list representations are provided.
- Transclude Documents Macro
- Renders transcluded content fetched from documents of a result set.
- No labels