Index Card Macro

...

Document Properties Marker

doctype	macro
override	false
extract-short-desc	true
delegate-document	Transclude Documents Macro

Doctype

macro

hide

Name

Index Card Macro

Short Description

Renders transcluded content fetched from documents of a result set.

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, Transclusion, Glossary, Deep Link, Autocomplete

Type

Name List

doctype	macro-type
names	Dynamic Navigation

Iteration

value

focused

finished

hide

Since

1.10

Page Size Support

Sort Key

hide

Section

index	true
show-title	false
title	Description

Renders part of documents for a given type in an index structure.

Use this macro to render a collection of selected documents on a single page.

Note Box
This is similar to the generic Transclude Documents Macro, but preconfigured for rendering indices. It is easier to specify the elements to be part of the index by adding the document names to the body of the macro.

Unlike the Index Entries Table Macro the Index Card Macro renders each entry as an excerpt.

...

Section

title	Properties

Section

title	Doctype(s)

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.

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

Section

title	Identifiers

Section

title	Tags

Section

title	Select

Section

title	Where

Transclusion

document	Transclude Documents Macro
ids	Where

Note Box
Available since version 1.11.

Section

title	Target Heading Level

Section

title	Space Key

Section

title	Space Keys

Section

title	Transitive Transclusion

Transclusion

taget-heading-level	*
document	Index Entries Table Macro
ids	Separator

Transclusion

taget-heading-level	*
document	Index Entries Table Macro
ids	Insert Short Name Entries

Transclusion

taget-heading-level	*
document	Index Entries Table Macro
ids	Render Index

Transclusion

taget-heading-level	*
document	Index Entries Table Macro
ids	Render Index Access Panel

Section

title	Render Mode

Controls how the table should render properties of the document result set.

There are two render modes: table, definition list

Note Box
Available since version 1.11.

Section

title	Table Render Mode

If you want to render the result in a table, leave this parameter value blank. You may also explicitly set this value to table.

Add a CSS class by separating it with a "=".

Example Box
`=mystyle` `table=mystyle`

Section

title	Definition List Render Mode

Set the value to definition to render the properties as a definition list.

You may add a CSS class by separating it with a "=".

Example Box
`definition=mystyle`

Transclusion

taget-heading-level	*
document	Display Table Macro
ids	Render no hits as blank

Transclusion

taget-heading-level	*
document	Display Table Macro
ids	No Hits Text

Section

title	Missing Content Message

Transclusion

taget-heading-level	*
document	Transclusion Macro
ids	Force Show

Section

title	Render Reference Box

Section

title	Extract Short Description

Section

title	Name as Heading

Section

title	Restrict to immediate Children

If checked, only immediate children of the current document are valid as hits.

Transclusion

taget-heading-level	*
document	Transclusion Macro
ids	Identifier

Section

title	Replacements

Specify the document names and replacements in the macro's body.

Lines without '=' are lists of document names to select.
Placeholder/replacement pairs, separated by an '=' character.

...

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