3.1.1.3.1 table

The <table> element organizes arbitrarily complex relationships of tabular information. This standard table markup allows column or row spanning and table captions or descriptions. An optional title allowed inside the table element provides a caption to describe the table.

The DITA table is based on the OASIS Exchange Table Model, augmented with DITA attributes that enable it for specialization, conref, and other DITA processing. In addition, the table includes a desc element, which enables table description that is parallel with figure description. See 3.1.1.3.8 simpletable for a simplified table model that can be specialized to represent more regular relationships of data.

In DITA tables, in place of the expanse attribute used by other DITA elements, the pgwide attribute is used in order to conform to the OASIS Exchange Table Model. This attribute has a similar semantic (1=page width; 0=resize to galley or column).

The scale attribute represents a stylistic markup property that is maintained (for now) in tables for legacy purposes. External stylesheets should enable less dependency on this attribute. You should use the scale attribute judiciously in your topics.

Contains

Doctype

Content model

topic, map, concept, ditabase, glossary, glossentry, glossgroup, reference, task, bookmap, classifyMap, subjectScheme, machineryTask, learningAssessment, learningBookmap, learningContent, learningMap, learningOverview, learningPlan, learningSummary

( ( (title) (optional) then (desc) (optional) ) (optional) then (tgroup) (one or more) )

Contained by

Doctype

Content model

topic (base)

p, note, lq, li, itemgroup, dd, draft-comment, abstract, body, bodydiv, section, sectiondiv, example

map (base), classifyMap, subjectScheme, learningBookmap, learningMap

p, note, lq, li, itemgroup, dd, draft-comment

topic (technical content)

p, note, lq, li, itemgroup, dd, draft-comment, abstract, body, bodydiv, section, sectiondiv, example, pd

map (technical content), bookmap

p, note, lq, li, itemgroup, dd, draft-comment, pd

concept

p, note, lq, li, itemgroup, dd, draft-comment, abstract, body, bodydiv, section, sectiondiv, example, conbody, pd

ditabase

p, note, lq, li, itemgroup, dd, draft-comment, abstract, body, bodydiv, section, sectiondiv, example, conbody, prereq, context, steps-informal, stepsection, info, tutorialinfo, stepxmp, choice, stepresult, result, postreq, refbody, refbodydiv, refsyn, glossdef, glossUsage, glossScopeNote, pd

glossary, glossentry, glossgroup

p, note, lq, li, itemgroup, dd, draft-comment, abstract, body, bodydiv, section, sectiondiv, example, conbody, glossdef, glossUsage, glossScopeNote, pd

reference

p, note, lq, li, itemgroup, dd, draft-comment, abstract, body, bodydiv, section, sectiondiv, example, refbody, refbodydiv, refsyn, pd

task (strict), task (general)

p, note, lq, li, itemgroup, dd, draft-comment, abstract, body, bodydiv, section, sectiondiv, example, prereq, context, steps-informal, stepsection, info, tutorialinfo, stepxmp, choice, stepresult, result, postreq, pd

machineryTask

p, note, lq, li, itemgroup, dd, draft-comment, abstract, body, bodydiv, section, sectiondiv, example, prereq, context, steps-informal, stepsection, info, tutorialinfo, stepxmp, choice, stepresult, result, postreq, reqcond, reqcontp, personnel, perscat, perskill, esttime, supequi, supply, spare, safecond

learningAssessment, learningOverview, learningSummary

p, note, lq, li, itemgroup, dd, draft-comment, abstract, body, bodydiv, section, sectiondiv, example, lcIntro, lcAudience, lcPrereqs, lcSummary, lcNextSteps, lcReview, lcResources, lcChallenge, lcInstruction, lcInstructornote

learningContent

p, note, lq, li, itemgroup, dd, draft-comment, abstract, body, bodydiv, section, sectiondiv, example, lcIntro, lcAudience, lcPrereqs, lcSummary, lcNextSteps, lcReview, lcResources, lcChallenge, lcInstruction, prereq, context, steps-informal, stepsection, info, tutorialinfo, stepxmp, choice, stepresult, result, postreq, conbody, refbody, refbodydiv, refsyn, lcInstructornote

learningPlan

p, note, lq, li, itemgroup, dd, draft-comment, abstract, body, bodydiv, section, sectiondiv, example, lcIntro, lcAudience, lcPrereqs, lcSummary, lcNextSteps, lcReview, lcResources, lcChallenge, lcInstruction, lcGeneralDescription, lcGoals, lcNeeds, lcValues, lcOrgConstraints, lcEdLevel, lcAge, lcBackground, lcSkills, lcKnowledge, lcMotivation, lcSpecChars, lcWorkEnvDescription, lcPlanResources, lcProcesses, lcTaskItem, lcAttitude, lcPlanObjective, lcJtaItem, lcGapItemDelta, lcLearnStrat, lcAssessment, lcDelivery, lcInstructornote

Inheritance

- topic/table

Example

Source:

<table>
<tgroup cols="2">
<colspec colname="COLSPEC0" colwidth="121*"/>
<colspec colname="COLSPEC1" colwidth="76*"/>
<thead>
<row>
<entry colname="COLSPEC0" valign="top">Animal</entry>
<entry colname="COLSPEC1" valign="top">Gestation</entry>
</row>
</thead>
<tbody>
<row>
<entry>Elephant (African and Asian)</entry>
<entry>19-22 months</entry>
</row>
<row>
<entry>Giraffe</entry>
<entry>15 months</entry>
</row>
<row>
<entry>Rhinoceros</entry>
<entry>14-16 months</entry>
</row>
<row>
<entry>Hippopotamus</entry>
<entry>7 1/2 months</entry>
</row>
</tbody>
</tgroup>
</table>

Formatted output:

Animal

Gestation

Elephant (African and Asian)

19-22 months

Giraffe

15 months

Rhinoceros

14-16 months

Hippopotamus

7 1/2 months

Attributes

Name

Description

Data Type

Default Value

Required?

frame

Specifies which portion of a border should surround the element. Allowable values are:

top

Draw a line before the element

bottom

Draw a line after the element

topbot

Draw a line both before and after the element

all

Draw a box around the element

sides

Draw a line at each side of the element

none

Don't draw any lines around this element

Some DITA processors or output formats may not be able to support all values.

(top | bottom | topbot | all | sides | none | -dita-use-​conref-​target)

#IMPLIED

No

colsep

Column separator. A value of 0 indicates no separators; 1 indicates separators.

NMTOKEN

#IMPLIED

No

rowsep

Row separator. A value of 0 indicates no separators; 1 indicates separators.

NMTOKEN

#IMPLIED

No

pgwide

Determines the horizontal placement of the element. Supported values are 1 and 0, although these are not mandated by the DTD or Schema. For print-oriented display, the value "1" places the element on the left page margin; "0" aligns the element with the left margin of the current text line and takes indention into account.

For XHTML, the table surrounds the table data. Either value sets the table width to 100%.

NMTOKEN

#IMPLIED

No

rowheader

This attribute specifies whether the content of the first column in a table contains row headings. In the same way that a column header introduces a table column, the row header introduces the table row. This attribute makes tables whose first column contains row headings more readable on output. Allowable values are:

firstcol

The first column contains the row headings.

norowheader

Indicates that no column contains row headings. This is the processing default.

Note that this attribute is not part of the OASIS Exchange Table model upon which DITA tables are based; because of this, some DITA processors or output formats may not be able to support all values.

(firstCol | norowheader| -dita-use-​conref-​target)

#IMPLIED

No

scale

Specifies a percentage, selected from an enumerated list, that is used to resize fonts in relation to the normal text size. This attribute is primarily useful for print-oriented display.

The scale attribute provides an acknowledged style-based property directly on DITA elements. For the table and fig elements, the intent of the property is to allow authors to adjust font sizes on the content of the containing element, primarily for print accomodation. An image in these contexts is to be scaled only by its own direct scale property. If not specifically scaled, such an image is unchanged by the scale property of its parent table or fig.

Some DITA processors or output formats may not be able to support all values.

(50 | 60 | 70 | 80 | 90 | 100 | 110 | 120 | 140 | 160 | 180 | 200 | -dita-use-​conref-​target)

#IMPLIED

No

univ-atts attribute group (includes select-atts, id-atts, and localization-atts groups)

A set of related attributes, described in 3.4.1.3 univ-atts attribute group

     

global-atts attribute group (xtrf, xtrc)

A set of related attributes, described in 3.4.1.2 global-atts attribute group

     

class, outputclass

Common attributes described in 3.4.1.9 Other common DITA attributes

     

Previous Topic:  3.1.1.3 Table elements

Next Topic:  3.1.1.3.2 tgroup

Parent Topic:  3.1.1.3 Table elements

Sibling Topics:

3.1.1.3.2 tgroup

3.1.1.3.3 colspec

3.1.1.3.4 thead

3.1.1.3.5 tbody

3.1.1.3.6 row

3.1.1.3.7 entry

3.1.1.3.8 simpletable

3.1.1.3.9 sthead

3.1.1.3.10 strow

3.1.1.3.11 stentry