diff options
Diffstat (limited to 'doc/tables.doc')
| -rw-r--r-- | doc/tables.doc | 95 |
1 files changed, 95 insertions, 0 deletions
diff --git a/doc/tables.doc b/doc/tables.doc new file mode 100644 index 0000000..5dc166d --- /dev/null +++ b/doc/tables.doc @@ -0,0 +1,95 @@ +/****************************************************************************** + * + * + * + * Copyright (C) 1997-2015 by Dimitri van Heesch. + * + * Permission to use, copy, modify, and distribute this software and its + * documentation under the terms of the GNU General Public License is hereby + * granted. No representations are made about the suitability of this software + * for any purpose. It is provided "as is" without express or implied warranty. + * See the GNU General Public License for more details. + * + * Documents produced by Doxygen are derivative works derived from the + * input used in their production; they are not affected by this license. + * + */ +/*! \page tables Including tables + +Doxygen supports two ways to put tables in the documentation. + +The easiest is to use the Markdown format as shown in @ref markdown_extra section @ref md_tables. + +Although this format is easy to use and read, it is also rather limited. +It supports only a simple grid of cells, while each cell is a +single line of plain text. + +For more complex tables the HTML syntax can be used. Doxygen +will process such tables and translate them to the various output formats +(at least for the formats that do support tables such as HTML and \LaTeX). + +Here is an example of a complex table: + +\verbatim +<table> +<caption id="multi_row">Complex table</caption> +<tr><th>Column 1 <th>Column 2 <th>Column 3 +<tr><td rowspan="2">cell row=1+2,col=1<td>cell row=1,col=2<td>cell row=1,col=3 +<tr><td rowspan="2">cell row=2+3,col=2 <td>cell row=2,col=3 +<tr><td>cell row=3,col=1 <td rowspan="2">cell row=3+4,col=3 +<tr><td colspan="2">cell row=4,col=1+2 +<tr><td>cell row=5,col=1 <td colspan="2">cell row=5,col=2+3 +<tr><td colspan="2" rowspan="2">cell row=6+7,col=1+2 <td>cell row=6,col=3 +<tr> <td>cell row=7,col=3 +<tr><td>cell row=8,col=1 <td>cell row=8,col=2\n + <table> + <tr><td>Inner cell row=1,col=1<td>Inner cell row=1,col=2 + <tr><td>Inner cell row=2,col=1<td>Inner cell row=2,col=2 + </table> + <td>cell row=8,col=3 + <ul> + <li>Item 1 + <li>Item 2 + </ul> +</table> +\endverbatim + +It has a caption, table heading, various row and column spans, +a nested table as one of the cells, and a item list in another cell. + +Note that the end tags (like `</td>`) are left out in the example above. +This is allowed, and in the HTML output doxygen will add the end tags again. + +The output will look as follows: + +<table> +<caption id="multi_row">Complex table</caption> +<tr><th>Column 1 <th>Column 2 <th>Column 3 +<tr><td rowspan="2">cell row=1+2,col=1<td>cell row=1,col=2<td>cell row=1,col=3 +<tr><td rowspan="2">cell row=2+3,col=2 <td>cell row=2,col=3 +<tr><td>cell row=3,col=1 <td rowspan="2">cell row=3+4,col=3 +<tr><td colspan="2">cell row=4,col=1+2 +<tr><td>cell row=5,col=1 <td colspan="2">cell row=5,col=2+3 +<tr><td colspan="2" rowspan="2">cell row=6+7,col=1+2 <td>cell row=6,col=3 +<tr> <td>cell row=7,col=3 +<tr><td>cell row=8,col=1 <td>cell row=8,col=2\n + <table> + <tr><td>Inner cell row=1,col=1<td>Inner cell row=1,col=2 + <tr><td>Inner cell row=2,col=1<td>Inner cell row=2,col=2 + </table> + <td>cell row=8,col=3 + <ul> + <li>Item 1 + <li>Item 2 + </ul> +</table> + +One can refer to the caption of the table using \ref cmdref "\\ref" using the caption's +id as the label. + +\htmlonly +Go to the <a href="diagrams.html">next</a> section or return to the + <a href="index.html">index</a>. +\endhtmlonly + +*/ |