Next in thread → Next in month →

Re: [dita-comment] Possible improvement for DITA 2.0

From
Kristen James Eberlein <>
Date
2017-07-18T13:21:04+00:00
ID
Thread
Re: [dita-comment] Possible improvement for DITA 2.0
I think the spec covers this issue -- But it certainly is not
      obvious. (I know I queried Robert about this exact case at
      some point in the last few years.)

    

    
Robert, I think we should consider how to make this particular
      use case more visible. Would it be worth adding an example topic
      to our next errata?

    

    
Best,

      Kris

      

      Kristen James Eberlein

      Chair, OASIS DITA Technical Committee

      Principal consultant, Eberlein Consulting

      www.eberleinconsulting.com

      +1 919 682-2290; kriseberlein (skype)

      

    

    
On 7/18/2017 8:50 AM, Radu Coravu
      wrote:

    

    Hi Robert,
      

      

      Thanks for the fast reply.
      

      It's great that the specs has this provision in it.
      

      I added this DITA OT issue:
      

      

      https://github.com/dita-ot/dita-ot/issues/2752
      

      

      Regards,
      

      Radu
      

      

      Radu Coravu
      

      <oXygen/>  XML Editor, Schema Editor and XSLT
      Editor/Debugger
      

      http://www.oxygenxml.com
      

      

      On 7/18/2017 3:18 PM, Robert D Anderson wrote:
      

      Hi Radu,
        

        

        According to the 1.3 specification, when key references are
        resolved on
        

        an image, text in the key definition that would normally become
        link
        

        text should be treated as the alternate text.
        

        

        See:
        

http://docs.oasis-open.org/dita/dita/v1.3/errata01/os/complete/part1-base/archSpec/base/processing-keyref-for-text.html
        

        

        The relevant text is here:
        

        For empty <image> elements,
          effective content is used as alternate
          

        
        text, equivalent to creating an <alt> sub-element to hold
        that content.
        

        

        Speaking on behalf of the DITA-OT team, I'm pretty sure that is
        not
        

        working properly right now, and should be treated as a bug in
        the
        

        processor. I'm not sure if other processors handle this
        condition.
        

        

        When properly implemented, I believe this would address the
        issue you're
        

        seeing; updating your sample key definition, the following would
        result
        

        in the proper alternate text:
        

          <keydef keys="myImage"
          href="">
          

              <topicmeta>
          

                <linktext>Alternate text</linktext>
          

              </topicmeta>
          

            </keydef>
          

        
        

        Regards,
        

        

        *Robert D. Anderson* *
        

        **DITA-OT* <http://dita-ot.org/>*lead and Co-editor **DITA
        1.3
        

        specification*
        

<http://docs.oasis-open.org/dita/dita/v1.3/os/part0-overview/dita-v1.3-os-part0-overview.html>*,
        

        Digital Services Group*
        

        

            
        

------------------------------------------------------------------------
        

        *E-mail: ***
        <mailto:>
        

        *Digital Services Group*<https://w3.ibm.com/digital/>    

        *11501 BURNET RD,, TX, 78758-3400, AUSTIN, USA*
        

        

        

        

        Inactive hide details for Radu Coravu ---07/18/2017 12:26:27
        AM---Hello,
        

        One of our users uses in topics DITA <image> elements Radu
        Coravu
        

        ---07/18/2017 12:26:27 AM---Hello, One of our users uses in
        topics DITA
        

        <image> elements with @keyref in
        

        

        From: Radu Coravu <>
        

        To: ""
        <>
        

        Date: 07/18/2017 12:26 AM
        

        Subject: [dita-comment] Possible improvement for DITA 2.0
        

        

------------------------------------------------------------------------
        

        

        

        

        Hello,
        

        

        One of our users uses in topics DITA <image> elements with
        @keyref in
        

        order to be able to switch between different target images.
        

        But she also needs to set alternate text for each image. And
        when
        

        changing the @keyref on the image she also wants the alternate
        text to
        

        change based on the new target image.
        

        How about if we allow defining the <alt> element in the
        <topicmeta>:
        

        

          <keydef keys="myImage"
          href="">
          

              <topicmeta>
          

                <alt>Alternate text</alt>
          

              </topicmeta>
          

            </keydef>
          

        
        

        so that when an image has a @keyref pointing to the definition,
        the
        

        <alt> element can be inherited from there if not directly
        specified
        

        inside the <image>?
        

        

        Regards,
        

        Radu
        

        

        Radu Coravu
        

        <oXygen/>  XML Editor, Schema Editor and XSLT
        Editor/Debugger
        

        http://www.oxygenxml.com
        

        

        --
        

        This publicly archived list offers a means to provide input to
        the
        

        OASIS Darwin Information Typing Architecture (DITA) TC.
        

        

        In order to verify user consent to the Feedback License terms
        and
        

        to minimize spam in the list archive, subscription is required
        

        before posting.
        

        

        Subscribe: 
        

        Unsubscribe: 
        

        List help: 
        

        List archive: http://lists.oasis-open.org/archives/dita-comment/
        

        Feedback License:
        http://www.oasis-open.org/who/ipr/feedback_license.pdf
        

        List Guidelines:
        http://www.oasis-open.org/maillists/guidelines.php
        

        Committee:
        http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=dita
        

        Join OASIS: http://www.oasis-open.org/join/
Next in thread → Next in month →