DIPlib documentation guide

This document gives some guidance as to how elements are rendered in the DIPlib documentation. See the dox++ documentation for basics, differences are shown here.

Boxes

There are too many box colors. The DIPlib CSS make some of them the same to avoid headaches.

Tables

To modify the properties of a table, we need to use HTML, we cannot use the {} syntax.

<div markdown="1" class="m-smaller-font m-spaced m-block m-flat">
   (insert Markdown table here)
</div>

For example here we created a DIV with classes "m-smaller-font" and "m-spaced", so that the font used in the table is smaller, and the rows are spaced apart a bit more. However, this causes the table to be the last child of its container (the new DIV), and therefore will not have a bottom margin. The table will but up against the next element. So we add also "m-block", which will have a bottom margin. To make the block not visible (it would normally add a frame), we add also class "m-flat". A flat block has a transparent frame, it looks just like it's not there!