Skip to content

Commit

Permalink
Merge branch 'DITA-2.0' of https://github.com/oasis-tcs/dita into pro…
Browse files Browse the repository at this point in the history
…posal-647

* 'DITA-2.0' of https://github.com/oasis-tcs/dita:
  Remove title att from reltable oasis-tcs#397
  Update source files in preparation for review 0: accessibility
  Clean up draft comments in a11y topics
  • Loading branch information
keberlein committed Jun 14, 2022
2 parents 2548685 + 3975f10 commit e123841
Show file tree
Hide file tree
Showing 8 changed files with 21 additions and 53 deletions.
5 changes: 1 addition & 4 deletions doctypes/dtd/base/map.mod
Original file line number Diff line number Diff line change
Expand Up @@ -436,10 +436,7 @@ PUBLIC "-//OASIS//ELEMENTS DITA 2.0 Map//EN"
(%relrow;)+)"
>
<!ENTITY % reltable.attributes
"title
CDATA
#IMPLIED
%topicref-atts-for-reltable;
"%topicref-atts-for-reltable;
%univ-atts;"
>
<!ELEMENT reltable %reltable.content;>
Expand Down
3 changes: 0 additions & 3 deletions doctypes/rng/base/mapMod.rng
Original file line number Diff line number Diff line change
Expand Up @@ -607,9 +607,6 @@ PUBLIC "-//OASIS//ELEMENTS DITA 2.0 Map//EN"
</oneOrMore>
</define>
<define name="reltable.attributes">
<optional>
<attribute name="title"/>
</optional>
<ref name="topicref-atts-for-reltable"/>
<ref name="univ-atts"/>
</define>
Expand Down
20 changes: 4 additions & 16 deletions specification/archSpec/base/accessibletablemarkup.dita
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,6 @@
</metadata>
</prolog>
<conbody>
<!--<draft-comment author="Kristen J Eberlein" time="28 March 2022"><p>This topic needs a more extensive edit than I did, including:</p><ul><li>Ensuring that the vocabulary aligns with how we describe complex and simple tables in the element-reference topics</li><li>Introducing the content outlined in the definition list</li><li>Alphabeticizing the entries in the definition list</li><li>Recasting the wording for the column headers and irregular headers to focus on what can be done with markup, instead of specifying what an author should do</li></ul></draft-comment>-->
<draft-comment author="Kristen J Eberlein" time="09 June 2022">
<p>I removed the following sentence from the short description, since
this topic does not really describe accessibility guidelines: "This
topic describes common accessibility guidelines that are related to
tables, along with the DITA markup that is designed to support
them."</p>
</draft-comment>
<!--<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"
Expand Down Expand Up @@ -64,16 +56,12 @@
indicate that it is a header for the entire column.</dd>
<dd>(Other columns) The <xmlelement>colspec</xmlelement>
element can define which columns function as headers. For
that case, set the <xmlatt>rowheader</xmlatt> attribute
<xmlelement/> to <keyword>headers</keyword> on the column
or columns that function as headers. Alternatively, set the
that case, set the <xmlatt>rowheader</xmlatt> attribute 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.<draft-comment
author="Kristen J Eberlein" time="09 June 2022">The last
sentence in "Other columns" seems off; Robert, please
verify that this is what you wanted to
say.</draft-comment></dd>
the entry is a header for the entire column.</dd>
</dlentry>
<dlentry>
<dt>Simple table</dt>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,9 @@
text, but also not sure whether it makes sense to come up with a new
one?</draft-comment>
<draft-comment author="Kristen J Eberlein" time="09 June 2022">
<p>I think we need a realistic example here in this section which
focuses on accessibility. The <xmlelement>imagemap</xmlelement>
topic is in the "Utilities domain," which has not yet been removed.
The example there is old and not very good; it probably dates back
to DITA 1.0.</p>
<p>I think we need a realistic example here in this section which focuses on accessibility.
The <xmlelement>imagemap</xmlelement> topic is in the "Utilities domain," which has not yet
been reviewed. The example there is old and not very good; it dates back to DITA 1.0.</p>
<p>Here are some possible ideas for what to showcase:</p>
<ul>
<li>A simple pie chart of application users by industry
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,13 @@
<conbody>
<p>The following code sample references an image <filepath>workflow.png</filepath>.
Alternate text describes the workflow that is shown in the image.</p>
<draft-comment author="Kristen J Eberlein" time="09 June 2022">
<p>I think we should include the image.</p>
</draft-comment>
<codeblock>&lt;image href="workflow.png">
&lt;alt>The image is a workflow diagram that shows a ticketing workflow.
The initial status is "Open". From there, the ticket can move to
"Closed" or "In progress". A ticket that is "In progress" can move
to "Done" or "Blocked". A "Blocked" ticket can move back to "In
Progress" or directly to "Done". There are no steps beyond "Closed"
or "Done".</codeblock>
or "Done".&lt;/alt>
&lt;/image></codeblock>
</conbody>
</concept>
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,7 @@
values; it also ignores the fact that <xmlelement>thead</xmlelement>
creates a header relationship even when the <xmlatt>id</xmlatt> and
<xmlatt>headers</xmlatt> attributes are not used.</p>
<p>
<draft-comment author="Kristen J Eberlein" time="20 December 2021">
<p>Do we want to use a different example here? It's a bit confusing
to read, since the result output is very similar to the "Example
of a complex table with accessibility markup".</p>
</draft-comment>
</p>
<p/>
<codeblock>&lt;table frame="all"&gt;
&lt;title&gt;Sample with fully manual accessibility control&lt;/title>
&lt;desc>Names are listed in the column c1. Points are listed in both data columns, with
Expand Down
6 changes: 3 additions & 3 deletions specification/dita-2.0-key-definitions-cover-pages.ditamap
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,18 @@
<!-- Make common variable content available -->
<topicref href="common/conref-cover-pages.dita" processing-role="resource-only"/>
<keydef keys="stage">
<!--Used in the master maps as a title-->
<!--Used in the mains maps as a title-->
<!-- Also used in the "Citation format" section.-->
<topicmeta>
<keywords>
<keyword>Working Draft 25</keyword>
<keyword>Working Draft 26</keyword>
</keywords>
</topicmeta>
</keydef>
<keydef keys="stage-date">
<topicmeta>
<keywords>
<keyword>05 April 2022</keyword>
<keyword>13 June 2022</keyword>
</keywords>
</topicmeta>
</keydef>
Expand Down
18 changes: 7 additions & 11 deletions specification/langRef/base/reltable.dita
Original file line number Diff line number Diff line change
Expand Up @@ -65,19 +65,15 @@
</section>
<section id="attributes">
<title>Attributes</title>
<p>The following attributes are available on this element: <ph conkeyref="reuse-attributes/ref-universalatts"/>, <ph conkeyref="reuse-attributes/ref-commonmapatts"/> (without <xmlatt>keyscope</xmlatt> or
<xmlatt>collection-type</xmlatt>), <xref keyref="attributes-common/attr-type"
><xmlatt>type</xmlatt></xref>, <xref keyref="attributes-common/attr-scope"
><xmlatt>scope</xmlatt></xref>, <xref keyref="attributes-common/attr-format"
><xmlatt>format</xmlatt></xref>, and the attributes defined below.</p>
<p>The following attributes are available on this element: <ph
conkeyref="reuse-attributes/ref-universalatts"/>, <ph
conkeyref="reuse-attributes/ref-commonmapatts"/> (without <xmlatt>keyscope</xmlatt> or
<xmlatt>collection-type</xmlatt>), <xref keyref="attributes-common/attr-format"
><xmlatt>format</xmlatt></xref>, <xref keyref="attributes-common/attr-scope"
><xmlatt>scope</xmlatt></xref>, and <xref keyref="attributes-common/attr-type"
><xmlatt>type</xmlatt></xref>.</p>
<p id="attr-exception" outputclass="attr-exception">For this element, the <xmlatt>toc</xmlatt> attribute has a default
value of <keyword>no</keyword>.</p>
<dl>
<dlentry>
<dt id="attr-title"><xmlatt>title</xmlatt></dt>
<dd>Specifies and identifying title for the element.</dd>
</dlentry>
</dl>
</section>
<example id="example" otherprops="examples"><title>Example</title>
<draft-comment author="Kristen J Eberlein" time="22 November 2021">
Expand Down

0 comments on commit e123841

Please sign in to comment.