Documentation Primer/Manual/DocBook Reference/Tables

Documentation Primer/Manual | DocBook Reference
Revision as of 11:30, 9 September 2012 by Claus chr (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
Other languages:English 100%

Tables

<informaltable>

This is the table type used most in KDE Documentation. Please be very sure that what you are marking up as a table, is actually tabular data, as in many cases a <variablelist> is more appropriate. Please do not use any of the presentation attributes to make tables "look nice". The only attribute currently allowed in KDE Documents is pgwide.
An <informaltable> must contain a <tgroup cols=""> entry. Informal tables have no specific title, if you wish the table to be titled and to have an entry in the table of contents, you should use <table>. Do not use any attributes other than pgwide on tables or informal tables for KDE documentation.

<table>

A formal table with a title. Tables will have their own separate entry in the table of contents. Other than the addition of a title, they are marked up the same as an <informaltable>.

<tgroup cols="">

A <tgroup> is a required element in a table. The cols attribute is required, and should be completed with the number of columns the table is to hold. No other attributes used in KDE Documentation.
A tgroup must contain a tbody

<tbody>

A tbody is a required element in a table. There are no attributes. The tbody contains rows.

<row>

A row corresponds directly with the rows of the table. Rows contain <entry> tags, one for each column in the table, as specified by the cols attribute on the <tgroup> tag.

<entry>

The entry is the basic building block of a table. Each entry corresponds to one "data cell" in the table. There must be as many <entry> tags in each row as the cols attribute on the <tgroup> tag. There are no attributes used in KDE Documentation.

<thead>

<thead> can be used to create a heading row for the table. It must appear before the tbody element, and should normally contain one row and as many entry elements as the rest of the table.

<tfoot>

<tfoot> is not currently used in KDE Documentation. If you want to use it, please see the Duck book for information.

Example: An <informaltable> template

<informaltable>
<tgroup cols="2">
<tbody>
<row>
<entry></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</informaltable>

Example: A <table> template

<table>
<title></title>
<tgroup cols="2">
<tbody>
<row>
<entry></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>

This page was last modified on 9 September 2012, at 11:30. This page has been accessed 1,175 times. Content is available under Creative Commons License SA 3.0 as well as the GNU Free Documentation License 1.2.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V.Legal