Tag Definition: caption

Generated by rlextra version 4.4.0

Attributes

Name	Required?	Default_Value	Values
alignment	implied	None
allowOrphans	implied	None	['yes', 'no', '0', '1', 'true', 'false']
allowWidows	implied	None	['yes', 'no', '0', '1', 'true', 'false']
altText	implied	None
autoLeading	implied	None	['min', 'max', 'off']
backColor	implied	None
borderColor	implied	None
borderPadding	implied	None
borderRadius	implied	None
borderWidth	implied	None
bulletAnchor	implied	None	['start', 'middle', 'end', 'numeric']
bulletColor	implied	None
bulletFontName	implied	None
bulletFontSize	implied	None
bulletIndent	implied	None
bulletOffsetY	implied	None
bulletText	implied	None
embeddedHyphenation	implied	None	['yes', 'no', '0', '1', 'true', 'false']
endDots	implied	None
endDotsBackColor	implied	None
endDotsColor	implied	None
endDotsDy	implied	None
endDotsFontName	implied	None
endDotsFontSize	implied	None
firstLineIndent	implied	None
fontName	implied	None
fontSize	implied	None
frameBreakBefore	implied	None
hyphenationLang	implied	None
hyphenationMinWordLength	implied	None
justifyBreaks	implied	None	['yes', 'no', '0', '1', 'true', 'false']
justifyLastLine	implied	None
keepWithNext	implied	None
leading	implied	None
leftIndent	implied	None
pageBreakBefore	implied	None
rightIndent	implied	None
shaping	implied	None	['yes', 'no', '0', '1', 'true', 'false']
spaceAfter	implied	None
spaceBefore	implied	None
spaceShrinkage	implied	None
splitLongWords	implied	None	['yes', 'no', '0', '1', 'true', 'false']
strikeColor	implied	None
strikeOffset	implied	None
strikeWidth	implied	None
style	none	para.defaultStyle
tagType	implied	None
textColor	implied	None
textTransform	implied	None	['none', 'lowercase', 'uppercase', 'capitalize']
underlineColor	implied	None
underlineOffset	implied	None
underlineWidth	implied	None
uriWasteReduce	implied	None
wordWrap	implied	None	['normal', 'CJK', 'RTL']
Can contain (#PCDATA \| b \| a \| u \| greek \| font \| span \| sup \| super \| sub \| br \| strike \| pageNumber \| evalString \| seq \| seqDefault \| seqReset \| seqFormat \| seqChain \| img \| index \| name \| getName \| i \| bullet \| unichar \| link \| setLink \| onDraw \| nobr \| loop_i \| switch_i \| assign_i \| if_i \| expr)*

Purpose

This lets you add a caption to tables, as a part of PDF accessibility guidelines; to help users find, navigate, and understand tables. Read more here and here.

See the relevant rml sample here. And the relevant pdf here.

Example usage

<blockTable  style="basic" align="LEFT" altText="Table's AltText" summary="Table Summary Example">
    <caption style="h1" tagType="H1">Example Table</caption>
    <tr>
        <td tagType="TH scope=column">Col 1</td>
        <td tagType="TH scope=column">Col 2</td>
    </tr>
    <tr>
        <td>Row 1, Col 1</td>
        <td>Row 1, Col 2</td>
    </tr>
    <tr>
        <td>Row 2, Col 1</td>
        <td>Row 2, Col 2</td>
    </tr>
</blockTable>

Note: Only relevant sections are used in this snippet. Some tags were not included. See some of our samples for further insight of how you may go about setting up a full document using rml.

Example of nesting path from the parent tags to the current tag