# Providing replacement text using the `/Alt` entry for links in PDF documents

ID: PDF13

Technology: pdf

Type: Technique

## When to Use

Tagged PDF documents that contain links.

## Description

The objective of this technique is to provide replacement link text via the `/Alt` entry in the property list for a tag. This is usually not necessary, but in some situations, additional information beyond the visible link text is needed, particularly for screen reader users. Screen readers can read visible link text, but replacing the screen text with meaningful alternate text for links in a PDF document can make links more accessible.

Links in PDF documents are represented by a `Link` tag and objects in its sub-tree, consisting of a link object reference (or Link annotation) and one or more text objects. The text object or objects inside the Link tag are used by assistive technologies to provide a name for the link.

Authors can replace the default link text by providing an `/Alt` entry for the `Link` tag. When the `Link` tag has an `/Alt` entry, screen readers ignore the value of any visible text objects in the `Link` tag and use the `/Alt` entry value for the link text.

The simplest way to provide context-independent link text that complies with the WCAG 2.0 success criteria is to create them when authoring the document, before conversion to PDF. In some cases, it may not be possible to create the links using the original authoring tool. When editing PDF documents with Adobe Acrobat Pro, the best way to create accessible links is to use the Create Link command.

Authors should make sure that the alternate text makes sense in context of the screen text before and after the link.

## Examples

### Adding alternate link text using Adobe Acrobat 9 Pro

This example is shown with Adobe Acrobat Pro. There are other software tools that perform similar functions.

The image below shows a document converted to PDF from Oracle Open Office. Note that the visible link text is the URL for the link target. A screen reader will read the entire URI as the link text.

To create more accessible link text for assistive technology:

1. In the View menu, open the Tag panel by selecting Navigation Panels → Tags.
2. Locate the Link tag in the tag tree, access the context menu for the link, and select Properties.
3. In the TouchUp Properties dialog, in the Tags tab, enter replacement text in the Alternate Text field. Screen readers will read this text instead of the entire URI.

The next image shows the Link tag structure in the Tag panel.

The last image shows the Alternate Text specified in the Link tag's TouchUp Properties dialog. A screen reader will read the Alternate Text as the link text.

This example is shown in operation in the working example of adding alternate link text (OpenOffice file) and working example of adding alternate link text (PDF file).

### Adding alternate link text in a PDF document using the `/Alt` entry

The following code fragment illustrates code that is typical for alternative text for a link. This is typically accomplished by an authoring tool.

    32 0 obj
    <<
      /S/URI                                       %Action type (required), must be URI for a URI action
      /URI(http://www.boston.com/business/technology/)  %Uniform resource identifier(required), the URI to be resolved
    >>
    endobj

The following illustrates how to specify alternate text for the URL in the above link:

    11 0 obj
    <<
      /Alt(Boston Globe technology page)    %Alternate text entry
      /K [ 1
           <<
             /Obj 27 0 R
             /Type /OBJR            %Object reference to the link
           >>
           ]
      /P 12 0 R
      /Pg 18 0 R
      /S
      /Link
    >>
    endobj

## Tests

### Procedure

1. For the hyperlink, verify that the alternate link text is properly coded by one of the following:

   - Read the PDF document with a screen reader, listening to hear that the alternate link text is read correctly.
   - Use a tool that is capable of showing the `/Alt` entry to open the PDF document and view the hyperlink and alternate link text.
   - Use a tool that exposes the document through the accessibility API and verify that the alternate link text is the text for the link.

### Expected Results

- #1 is true.

## Related Techniques

- G53
- G91
- G149
- PDF11

## Resources

- Section 14.9.4 (Replacement Text) in PDF 1.7 (ISO 32000-1) (PDF)
- Create and verify PDF accessibility (Acrobat Pro)