Paragraph elements MlDoC dot commands

In this section, all generic paragraph elements like lists are described.
There are three different kinds of list you can use:

Lists

Lists of different kind can be mixed and stacked to an arbitrary depth.

Lists
Name begin end Comment
Ordered (numbered) List .OL .LO
Unordered List .UL .LU
Option List .PL .LP First command in List item must be a Name.
List item .LI .IL Used inside lists only.

  1. 1
  2. 2

Here is an example for an option list:
Options

-a
This program option is used to show all available options. It's not needed in the server mode, but it's possible use this option in client mode.
-b
This program option is used to build all available options.
-c
This program option is used to convert all available options.

The required source code for this option list is shown below: 

.PL 
    .LI 
        .NA -a .AN 
        This program option is used to show all available options. 
    .IL 
    .LI 
        .NA -b .AN 
        This program option is used to build all available options. 
    .IL 
.LP

The Option List header can be changed with the Name argument, too.

Tables

There is support for simple tables, too. A MlDoC table is comparable with HTML tables. You need to specifiy the table body, an optional table head, table rows and in each table row the table column data.

Tables
Name begin end Comment
Table body .TB .BT
NoRulers .NR Don't put boxes around the table cells.
Table head .TH .HT Optional table head row.
Table row .TR .RT
Table columns .TC .CT Must be included between the row command.

Here is a small example for a generic table:

1 2
3 4

and the required source code: 

.TB 
    .TR 
        .TC 1 .CT 
        .TC 2 .CT 
    .RT 
    .TR 
        .TC 3 .CT 
        .TC 4 .CT 
    .RT 
.BT

The horizontal and vertical rulers are always present and can be removed with the NoRulers command. The .NR command must follow the TableBody command immediately. The above table looks then like:

1 2
3 4

Misc. elements:

Name begin end Description
Name .NA .AN Outside from special interfaces, this command emphasize names of functions, types or other important names.
Link .LK .KL A link to another section or document



UP MlDoC dot commands