Definition List Macro

Renders term and definition information as a definition list. Currently Conflucene does not easily support authors to write definition lists. But definition lists allow to render this form of information efficiently.

Audience
Iteration
Production
Category
Formatting
Since
1.0
projectdoc Toolbox Version

Renders a table as a definition list.

Definition lists allow compact representation of term and data information. Especially useful for glossaries.

Add a table to the body of the macro. Mark the first column as header, all other columns as data.

Here is a simple example:

The first column contains the definition terms, the second the data.

This is how it is rendered:

Properties

Definition List CSS Class

The class to add to the definition list. This is usually the only class you want to provide to select the formatting style.

The following styles are supported:

simpleindent

This style is available since version 1.0.1 (and from this version the default style).

meet

 

simple

 

tabular

 

margin

 

Definition Term CSS Class

The class to add to the definition terms.

Users who need to provide a style to a specific element, may find this helpful. It allows to make the selector of a CSS rule more specific than global rules.

Definition Data CSS Class

The class to add to the definition data elements.

Users who need to provide a style to a specific element, may find this helpful. It allows to make the selector of a CSS rule more specific than global rules.

Details

Provide your own Formatting

Add these CSS rules to your configuration and adjust it to your needs.

dl.mystyle {
}
dl.mystyle > dt {
}
dl.mystyle > dd {
}

Set the definition list style to mystyle.

Demo Video

The screencast shows how to create a definition list with the Definition List Macro.

A definition list (HTML tag: dl) contains tuples of definition terms (HTML tag: dt) and definition data (HTML tag: dd).