Child pages
  • 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.

 

You may define your own formatting.

The following styles are supported:

simpleindent

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

 

If you want to use it with a previous installation, this is the CSS code for this style:

The simpleindent Style
dl.simpleindent{
}
dl.simpleindent > dt {
  font-weight: bold;
}
dl.simpleindent > dd {
    margin-left: 1.6em;
}

meet

 

 

This has been the default for version 1.0.0. From version 1.0.1 on the rendering defaults to simpleindent.

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.

Where can I change the Stylesheet?

 

How you access the stylesheet to add your CSS rules depends on the theme you are using. You may change the styles for a space or for all spaces with the global stylesheet.

Space Stylesheet

In a standard installation you'll find the configuration for your space under the "Stylesheet" tab of the Space Tools.

Global Stylesheet

The global style sheet is accessible for admins on the Confluence Admin page. On the left side, under "LOOK AND FEEL", click "Stylesheet".

Some themes make it more difficult than others to change the global CSS. One workaround is to add the styles as custom HTML. To add your style go to

Confluence Admin > Custom HTML > At the end of the HEAD

Add your CSS rules within an HTML style tag to the text area like this:

<style>
dl.mystyle > dt {
  /* ... add your CSS declarations here */
}
dl.mystyle > dt:after {
  /* ... add your CSS declarations here */
}

dl.mystyle > dd {
  /* ... add your CSS declarations here */
}
</style>

For more information about how to change the styles, please refer to Changing Styles for Definition Lists in Confluence on the smartics blog.

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).

 

Please note:

  • Definition terms are put to the table header column (the first column, with a gray background)
  • Definition data is put to the second table column