Configure how to handle the alt value when inserting images

The current DITA Specification states that the alternate text for an image should be stored in the <alt> element of the <image> element. So by default, when you insert an image, its alternate text is automatically added as an <alt> element.

The alternate text is the text that you enter in the Title field of the Show/Edit Image dialog when you create an image object.In DITA 1.0, this information was provided in the alt attribute of the <image> element, which has been deprecated but is still valid. Depending on your requirements, you may want to use the alt attribute of the <image> element when inserting an image, or you may not want the alternate text at all.

You can configure the IXIASOFT CCMS so that when an image is inserted:
  • The alternate text is included in the alt attribute of the <image> element
  • The alternate text is not included in the <image> element, or
  • The alternate text is included in the <alt> element of the <image> element (default)
Note: You should make these configuration changes in the Test environment and test them before copying them to the Production environment. In a dedicated SaaS deployment, after testing the changes, ask IXIASOFT Customer Support to copy the changes to the Production environment.
  1. In the TEXTML Administration perspective, connect to your server.
  2. Locate the mutliimage.xml file in the repository's /system/conf collection.
  3. Check out the file and open it for editing.
  4. Under the <multiimage> element, add the following element:
    <!-- type is [element|attribute|none] -->
    <alternateHandling type="type"/>
    where type is one of the following:
    • attribute: The alternate text is added in the alt attribute of the <image> element
    • none: The alternate text is not added to the <image> element
    • element: The alternate text is added in the <alt> element of the <image> element (default)
    For example, consider the following multiimage.xml file:
    <?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE multiimage PUBLIC "-//ixiasoft.com//cms//config//multiimage" "multiimage.dtd">
    
    ...
       <!-- type is [element|attribute|none] -->
       <alternateHandling type="attribute"/>
    </multiimage>
    When you insert an image with the "Create a Ditaval file" alternate text, the following DITA code will be added:
    <image alt="Create a Ditaval file" href="lar1371584859805.image" 
    id="image_hhn_qyj_4k"/>
  5. Save, close, and check in the file.
  6. Inform users of the changes.
    The changes will be applied automatically once users close and then reopen their IXIASOFT CCMS Desktop. Users can also apply the changes without restarting their CCMS Desktop by clicking IXIASOFT CCMS > Synchronize Configuration.