Here is the text of the proposed topic change:
<li>Otherwise, if <xmlelement>linktext</xmlelement> is specified inside of
<xmlelement>topicmeta</xmlelement>, the contents of
<xmlelement>linktext</xmlelement> are used as the effective content.
<note>Because all elements that <ph>get effective content</ph> will eventually
look for content in the <xmlelement>linktext</xmlelement> element, using
<xmlelement>linktext</xmlelement> for effective content is a best practice
for cases where all elements getting text from a key definition should result in
the same value.</note><p>For example, given the following key definition,
<codeblock><keydef keys="fg_weather-notams" href= format="png">
<topicmeta><linktext>Weather &amp; NOTAMs dialog box showing a station report</linktext></topicmeta>
</keydef>
</codeblock>
and the image reference, <codeph><image placement="break"
keyref="fg_weather-notams" width="5in" id="image_weather-notams"/></codeph>,
would result in the matching content "Weather &amp; NOTAMs dialog box
showing a station report" as the image alt text.</p></li>
Thanks and best regards,
--Scott
Voting member:
Boeing Data Standards Technical Advisory Board
OASIS DocBook TC, Publishers SC (Chair)
OASIS DITA TC, Tech Comm SC, LW DITA SC, Learning Content SC (Secretary)
OASIS DITA Adoption TC
OASIS Augmented Reality in Information Products (ARIP) TC
Scott Hudson
Content Strategist, Digital Aviation Learning and Development
Jeppesen, A Boeing Company
55 Inverness Drive East
Englewood, CO 80112
303-328-6228 Cell: 303-350-7934
This document contains only administrative, uncontrolled data under U.S. International Traffic in Arms Regulations.
From:
<
dita@lists.oasis-open.org> on behalf of Scott Hudson <
scott.hudson@jeppesen.com>
Date: Wednesday, August 23, 2017 at 10:42 AM
To: Kristen James Eberlein <
kris@eberleinconsulting.com>, DITA TC <
dita@lists.oasis-open.org>
Subject: Re: [dita] Action items from 22 August 2017 meeting
Per my action item, here is an example of alt text using keys for images:
<keydef keys="fg_weather-notams" href= format="png">
<topicmeta><linktext>Weather & NOTAMs dialog box showing a station report</linktext></topicmeta>
</keydef>
This example incorporates the guidance from:
http://docs.oasis-open.org/dita/dita/v1.3/errata01/os/complete/part1-base/archSpec/base/processing-keyref-for-text.html Otherwise, if <linktext> is specified inside of <topicmeta>, the contents of <linktext> are used as the effective content.
Note: Because all elements that get effective content will eventually look for content in the <linktext> element,
using <linktext> for effective content is a best practice for cases where all elements getting text from a key definition should result in the same value.
Question: should this be added to the
dita.oasis-open.org/spec/archSpec/base/processing-keyref-for-text.dita topic, or are we managing errata02 differently?
Thanks and best regards,
--Scott
Voting member:
Boeing Data Standards Technical Advisory Board
OASIS DocBook TC, Publishers SC (Chair)
OASIS DITA TC, Tech Comm SC, LW DITA SC, Learning Content SC (Secretary)
OASIS DITA Adoption TC
OASIS Augmented Reality in Information Products (ARIP) TC
Scott Hudson
Content Strategist, Digital Aviation Learning and Development
Jeppesen, A Boeing Company
55 Inverness Drive East
Englewood, CO 80112
303-328-6228 Cell: 303-350-7934
This document contains only administrative, uncontrolled data under U.S. International Traffic in Arms Regulations.
From:
<
dita@lists.oasis-open.org> on behalf of Kristen James Eberlein <
kris@eberleinconsulting.com>
Date: Tuesday, August 22, 2017 at 3:30 PM
To: DITA TC <
dita@lists.oasis-open.org>
Subject: [dita] Action items from 22 August 2017 meeting
22 August 2017:
·
Kris: Develop troubleshooting topic about what occurs if you don't filter out the notices platform="external-publishing" element (COMPLETED)
·
Bob: Add Kris and Robert to list of committers for TechComm SC
GitHub repo
·
Carlos: Add Kris and Robert to list of committers for LwDITA SC GitHub repo
·
Scott: Develop new example topic for errata 02 that covers alt text and using keys for images
·
Eliot: Respond to George Bina's e-mail on dita-comment list
·
Kris: Fix error in subjectScheme example (keys value "win98" vs. "winvis") for errata 02 (COMPLETED)
--
Best,
Kris
Kristen James Eberlein
Chair, OASIS DITA Technical Committee
Principal consultant, Eberlein Consulting
www.eberleinconsulting.com +1 919 682-2290; kriseberlein (skype)
--------------------------------------------------------------------- To unsubscribe from this mail list, you must leave the OASIS TC that generates this mail. Follow this link to all your TCs in OASIS at:
https://www.oasis-open.org/apps/org/workgroup/portal/my_workgroups.php