From ebcaa143d300ff9e88cf32bbfdcf985f54447f72 Mon Sep 17 00:00:00 2001 From: "Robert D. Anderson" Date: Mon, 13 Jun 2022 14:57:20 -0500 Subject: [PATCH 1/3] Clean up draft comments in a11y topics --- .../archSpec/base/accessibletablemarkup.dita | 20 ++++++++----------- ...ample-alternate-text-for-an-image-map.dita | 8 +++----- .../example-alternate-text-for-an-image.dita | 3 ++- ...able-with-manual-accessibility-markup.dita | 8 +------- 4 files changed, 14 insertions(+), 25 deletions(-) diff --git a/specification/archSpec/base/accessibletablemarkup.dita b/specification/archSpec/base/accessibletablemarkup.dita index d2e6eca4..f6798942 100644 --- a/specification/archSpec/base/accessibletablemarkup.dita +++ b/specification/archSpec/base/accessibletablemarkup.dita @@ -62,18 +62,14 @@ scope attribute in the first entry in the first row to can be set to col to indicate that it is a header for the entire column. -
(Other columns) The colspec - element can define which columns function as headers. For - that case, set the rowheader attribute - to headers on the column - or columns that function as headers. Alternatively, set the - scope attribute on each relevant entry - in the first row to col, indicating that - the entry is a header for the entire column.The last - sentence in "Other columns" seems off; Robert, please - verify that this is what you wanted to - say.
+
(Other columns) The colspec element can define which + columns function as headers. For that case, set the rowheader + attribute to headers on the column or columns that function as + headers. Alternatively, set the scope attribute on each relevant + entry in the first row to col, indicating that the entry is a + header for the entire column.The last sentence in "Other columns" seems off; Robert, please + verify that this is what you wanted to say.
Simple table
diff --git a/specification/archSpec/base/example-alternate-text-for-an-image-map.dita b/specification/archSpec/base/example-alternate-text-for-an-image-map.dita index 9af06a7a..aa966d46 100644 --- a/specification/archSpec/base/example-alternate-text-for-an-image-map.dita +++ b/specification/archSpec/base/example-alternate-text-for-an-image-map.dita @@ -9,11 +9,9 @@ text, but also not sure whether it makes sense to come up with a new one? -

I think we need a realistic example here in this section which - focuses on accessibility. The imagemap - 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.

+

I think we need a realistic example here in this section which focuses on accessibility. + The imagemap 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.

Here are some possible ideas for what to showcase:

  • A simple pie chart of application users by industry diff --git a/specification/archSpec/base/example-alternate-text-for-an-image.dita b/specification/archSpec/base/example-alternate-text-for-an-image.dita index c724c4aa..52b736a5 100644 --- a/specification/archSpec/base/example-alternate-text-for-an-image.dita +++ b/specification/archSpec/base/example-alternate-text-for-an-image.dita @@ -16,6 +16,7 @@ "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". + or "Done".</alt> +</image> diff --git a/specification/archSpec/base/example-complex-table-with-manual-accessibility-markup.dita b/specification/archSpec/base/example-complex-table-with-manual-accessibility-markup.dita index b45fa773..9eeb79d2 100644 --- a/specification/archSpec/base/example-complex-table-with-manual-accessibility-markup.dita +++ b/specification/archSpec/base/example-complex-table-with-manual-accessibility-markup.dita @@ -18,13 +18,7 @@ values; it also ignores the fact that thead creates a header relationship even when the id and headers attributes are not used.

    -

    - -

    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".

    - -

    +

    <table frame="all"> <title>Sample with fully manual accessibility control</title> <desc>Names are listed in the column c1. Points are listed in both data columns, with From 76ea1d25b1efb87c2a212aec9bf8b2c123906d1d Mon Sep 17 00:00:00 2001 From: Kristen James Eberlein Date: Mon, 13 Jun 2022 17:36:16 -0400 Subject: [PATCH 2/3] Update source files in preparation for review 0: accessibility --- .../archSpec/base/accessibletablemarkup.dita | 24 +++++++------------ .../example-alternate-text-for-an-image.dita | 3 --- ...ta-2.0-key-definitions-cover-pages.ditamap | 6 ++--- 3 files changed, 11 insertions(+), 22 deletions(-) diff --git a/specification/archSpec/base/accessibletablemarkup.dita b/specification/archSpec/base/accessibletablemarkup.dita index f6798942..e95ccf05 100644 --- a/specification/archSpec/base/accessibletablemarkup.dita +++ b/specification/archSpec/base/accessibletablemarkup.dita @@ -14,14 +14,6 @@ - - -

    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."

    -

    scope attribute in the first entry in the first row to can be set to col to indicate that it is a header for the entire column. -

    (Other columns) The colspec element can define which - columns function as headers. For that case, set the rowheader - attribute to headers on the column or columns that function as - headers. Alternatively, set the scope attribute on each relevant - entry in the first row to col, indicating that the entry is a - header for the entire column.The last sentence in "Other columns" seems off; Robert, please - verify that this is what you wanted to say.
    +
    (Other columns) The colspec + element can define which columns function as headers. For + that case, set the rowheader attribute to + headers on the column or columns that + function as headers. Alternatively, set the + scope attribute on each relevant entry + in the first row to col, indicating that + the entry is a header for the entire column.
    Simple table
    diff --git a/specification/archSpec/base/example-alternate-text-for-an-image.dita b/specification/archSpec/base/example-alternate-text-for-an-image.dita index 52b736a5..d9512c2f 100644 --- a/specification/archSpec/base/example-alternate-text-for-an-image.dita +++ b/specification/archSpec/base/example-alternate-text-for-an-image.dita @@ -7,9 +7,6 @@

    The following code sample references an image workflow.png. Alternate text describes the workflow that is shown in the image.

    - -

    I think we should include the image.

    -     <image href="workflow.png"> <alt>The image is a workflow diagram that shows a ticketing workflow. The initial status is "Open". From there, the ticket can move to diff --git a/specification/dita-2.0-key-definitions-cover-pages.ditamap b/specification/dita-2.0-key-definitions-cover-pages.ditamap index ea9a8c03..ca8a8cc7 100644 --- a/specification/dita-2.0-key-definitions-cover-pages.ditamap +++ b/specification/dita-2.0-key-definitions-cover-pages.ditamap @@ -9,18 +9,18 @@ - + - Working Draft 25 + Working Draft 26 - 05 April 2022 + 13 June 2022 From 068e5d4261809e787870c5bb852c59e11c0d1a3c Mon Sep 17 00:00:00 2001 From: Robert D Anderson Date: Mon, 13 Jun 2022 20:42:52 -0500 Subject: [PATCH 3/3] Remove title att from reltable #397 --- doctypes/dtd/base/map.mod | 5 +---- doctypes/rng/base/mapMod.rng | 3 --- specification/langRef/base/reltable.dita | 18 +++++++----------- 3 files changed, 8 insertions(+), 18 deletions(-) diff --git a/doctypes/dtd/base/map.mod b/doctypes/dtd/base/map.mod index ff5ac4f4..45aa0878 100644 --- a/doctypes/dtd/base/map.mod +++ b/doctypes/dtd/base/map.mod @@ -436,10 +436,7 @@ PUBLIC "-//OASIS//ELEMENTS DITA 2.0 Map//EN" (%relrow;)+)" > diff --git a/doctypes/rng/base/mapMod.rng b/doctypes/rng/base/mapMod.rng index 86d4bada..d27133dd 100644 --- a/doctypes/rng/base/mapMod.rng +++ b/doctypes/rng/base/mapMod.rng @@ -607,9 +607,6 @@ PUBLIC "-//OASIS//ELEMENTS DITA 2.0 Map//EN" - - - diff --git a/specification/langRef/base/reltable.dita b/specification/langRef/base/reltable.dita index 73eae553..7b09d870 100644 --- a/specification/langRef/base/reltable.dita +++ b/specification/langRef/base/reltable.dita @@ -65,19 +65,15 @@
    Attributes -

    The following attributes are available on this element: , (without keyscope or - collection-type), type, scope, format, and the attributes defined below.

    +

    The following attributes are available on this element: , (without keyscope or + collection-type), format, scope, and type.

    For this element, the toc attribute has a default value of no.

    -
    - -
    title
    -
    Specifies and identifying title for the element.
    -     -
    Example