Skip to content

Commit

Permalink
Merge pull request oasis-tcs#854 from keberlein/accessibility
Browse files Browse the repository at this point in the history
Review O updates
  • Loading branch information
keberlein authored Oct 31, 2022
2 parents dc7258f + 7773b99 commit 0485766
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 15 deletions.
23 changes: 11 additions & 12 deletions specification/archSpec/base/accessibletablemarkup.dita
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<shortdesc>The complexity of table rendering requires authors and
processors to be aware of several table-specific elements and
attributes if they want to ensure that tables are
accessible.<!--This topic describes common accessibility guidelines that are related to tables, along with the DITA markup that is designed to support them.--></shortdesc>
accessible.</shortdesc>
<prolog>
<metadata>
<keywords>
Expand All @@ -14,7 +14,6 @@
</metadata>
</prolog>
<conbody>
<!--<p>DITA provides two table models, a more complex one using the <xmlelement>table</xmlelement> element and a simple one that used the <xmlelement>simpletable</xmlelement> element. The <xmlelement>table</xmlelement> element is based on the OASIS Exchange Table Model, while the <xmlelement>simpletable</xmlelement> element reflects a simpler model that is closer to an HTML table. Each table model is addressed here. </p>-->
<p><ph
conref="../../langRef/containers/table-elements.dita#table2/table-types"
/></p>
Expand All @@ -32,13 +31,15 @@
</dlentry>
<dlentry>
<dt>Cell headers</dt>
<dd>(Complex table only) When entries within a table function as headers, but do not fall
into the categories of column or row headers, the <xmlatt>id</xmlatt> and
<xmlatt>headers</xmlatt> attributes on <xmlelement>table</xmlelement> cells can be used.
Specifying the <xmlatt>id</xmlatt> attribute on the cell that functions as a header, and
setting the <xmlatt>headers</xmlatt> attribute to that ID value on <ph rev="review-o"
>the</ph> table cell for which it acts as a header serves to relate table cells to
headers.</dd>
<dd>When entries within a table function as headers, but do not
fall into the categories of column or row headers, the
<xmlatt>id</xmlatt> and <xmlatt>headers</xmlatt> attributes on
table cells can be used <ph rev="review-o">to related table cells
to headers</ph>. Specifying the <xmlatt>id</xmlatt> attribute
on the cell that functions as a header, and setting the
<xmlatt>headers</xmlatt> attribute to that ID value on <ph
rev="review-o">the</ph> table cell for which it acts as a
header serves to relate table cells to headers.</dd>
</dlentry>
<!--<dlentry><dt>Column headers (first column)</dt><dd>Both table models provide support for column headers for the first column in the table:<dl><dlentry><dt>Complex table</dt><dd>The <xmlatt>rowheader</xmlatt> attribute can be set to <keyword>firstcol</keyword> to indicate that the first column is a header. Alternatively, the <xmlatt>scope</xmlatt> attribute in the first entry in the first row to can be set to <keyword>col</keyword> to indicate that it is a header for the entire column.</dd></dlentry><dlentry><dt>Simple table</dt><dd/></dlentry></dl></dd></dlentry>-->
<!--<dlentry><dt>Column headers (other columns)</dt><dd>When using a <xmlelement>table</xmlelement> element, use the column specifications (<xmlelement>colspec</xmlelement>) to define which columns function as headers. For that case, set the attribute <xmlelement>rowheader</xmlelement> to <keyword>headers</keyword> on the column or columns that function as headers. Alternatively, set the <xmlatt>scope</xmlatt> attribute on each relevant entry in the first row to <keyword>col</keyword>, indicating that the entry is a header for the entire column.<p>When using a <xmlelement>simpletable</xmlelement> element, set the <xmlatt>keycol</xmlatt> attribute to the number of the column that functions as a header.</p></dd></dlentry>-->
Expand All @@ -51,13 +52,11 @@
<dl>
<dlentry>
<dt>Complex table</dt>
<dt><!--<xmlelement>table</xmlelement>--></dt>
<dd>The <xmlelement>thead</xmlelement> element can provide
one or more header rows.</dd>
</dlentry>
<dlentry>
<dt>Simple
table<!--<xmlelement>simpletable</xmlelement>--></dt>
<dt>Simple table</dt>
<dd>The <xmlelement>sthead</xmlelement> element can provide a single row header.</dd>
</dlentry>
</dl>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,35 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
<concept id="example-simple-table-and-accessibility" rev="review-o">
<title>Example: Simple table and accessibility</title>
<shortdesc/>
<title>Example: Simple table with accessibility markup</title>
<shortdesc>In this scenario, the topic author uses a header row and the
<xmlatt>keycol</xmlatt> attribute to ensure that the table is
accessible</shortdesc>
<conbody>
<p/>
<p>In the following code sample, the <xmlatt>sthead</xmlatt> element
identifies the header row, and <xmlatt>keycol</xmlatt> attribute
identifies the header column:</p>
<!--<simpletable frame="all" relcolwidth="1* 1*" keycol="1"><sthead><stentry>Type of room</stentry><stentry>Price per day</stentry></sthead><strow><stentry>Single bed</stentry><stentry>$125.00</stentry></strow><strow><stentry>Two double beds</stentry><stentry>$150.00</stentry></strow><strow><stentry>Queen or king size bed</stentry><stentry>$165.00</stentry></strow></simpletable>-->
<codeblock>&lt;simpletable frame="all" relcolwidth="1* 1*" <b>keycol="1"</b>>
<b>&lt;sthead>
&lt;stentry>Type of room&lt;/stentry>
&lt;stentry>Price per day&lt;/stentry>
&lt;/sthead></b>
&lt;strow>
&lt;stentry>Single bed&lt;/stentry>
&lt;stentry>$125.00&lt;/stentry>
&lt;/strow>
&lt;strow>
&lt;stentry>Two double beds&lt;/stentry>
&lt;stentry>$150.00&lt;/stentry>
&lt;/strow>
&lt;strow>
&lt;stentry>Queen or king bed&lt;/stentry>
&lt;stentry>$165.00&lt;/stentry>
&lt;/strow>
&lt;/simpletable></codeblock>
<p>This table might be rendered in the following way:</p>
<image placement="break"
href="../../images/simple-table-accessibility.jpg" scale="70"/>
</conbody>
</concept>
Binary file modified specification/resources/screen-captures.docx
Binary file not shown.

0 comments on commit 0485766

Please sign in to comment.