Skip to main content

Design an accessible layout

Layouts in ArcGIS Pro can be exported as tagged PDF documents, also called accessible PDFs. These files allow anyone to use assistive technologies such as screen readers to read through the file. This is done by assigning an accessibility tag to each element on the layout during the PDF export. Accessibility tags are internal to the PDF structure and tell assistive technology what an element is and how it should be read. For example, a table frame is tagged as a table so a screen reader can correctly interpret rows, columns, and headers.

Creating an accessible layout begins by checking the accessibility properties for each layout element. Then once you are ready to export the layout to PDF, you can add document metadata and set a logical reading order for tagged elements to ensure the PDF is discoverable and understandable.

Set accessibility properties for layout elements

Text, table frames, map frames, chart frames, and pictures are all tagged so that they are read by a screen reader. Text elements are tagged as text, table frames are tagged as tables, and map frames, chart frames, and picture are tagged as graphics with alt text. Additional accessibility properties for these elements can be set for each element under the Accessibility heading in the Element pane.

Text tags

Text tags help define the logical reading structure. Anyone using assistive technologies can use text headings to navigate and understand the PDF. By default, all text elements are tagged with the Paragraph (P) tag. To set a different tag type, complete the following steps:

  1. In the Contents pane, right-click a text element and click Properties to open the Element pane.

  2. If necessary, expand the Accessibility heading.

  3. Choose a tag from the Tag Type drop-down menu.

    Paragraph (P)

    Used for body text

    Heading 1 (H1)

    Used for titles

    Heading 2 (H2)

    Used for major sections

    Heading 3 (H3)

    Used for subsections

Important:

Rasterized text is always tagged as a graphic, regardless of the tag type chosen. The alt text of the graphic is automatically populated with the text string in the element so that it is read by a screen reader.

Alt text

Alt text is a text description of a graphic element that a screen reader uses to describe the element. Map frames, chart frames, and pictures each support alt text. To add alt text to an element, complete the following steps:

  1. In the Contents pane, right-click a map frame, chart frame, or picture element and click Properties to open the Element pane.

  2. If necessary, expand the Accessibility heading.

  3. Add a description of the element to the Alt Text field.

    Optionally, include dynamic text tags to make the alt text description dynamic in a map series.

Alt text descriptions for elements also support dynamic text tags for use in a map series. Add dynamic text tags to the alt text description for map frames, chart frames, and pictures so that the alt text updates for each map series page when read by a screen reader. The following is an example of a dynamic text tag for the map series page name, which can be added to the Alt Text field in the Element pane:

<dyn type="page" property="name"/>

Note:

The variable in the dynamic text tag does not update in the alt text description in the Element pane. The variable updates only when the PDF is read by a screen reader.

For example, a map series that shows population per U.S. state that includes a map frame with the alt text description, "The state of <dyn type="page" property="name"/> has a population of <dyn type="page" property="attribute" field="pop"/> " would be read by a screen reader as, "The state of Alabama has a population of 5,200,000" for the first page. The second page would be read as, "The state of Alaska has a population of 700,000", and so on. As an individual reads through the PDF with a screen reader, the state name and population values will update for each page.

Tag as decorative

Elements that convey no meaning, or that you do not want read by a screen reader, should be tagged as decorative. Tagging an element as decorative ensures it is ignored by assistive technologies. For elements that support alt text, leaving the alt text field empty may cause automated accessibility checkers to fail. To avoid failures, tag the element as decorative to indicate the element is intentionally being ignored.

North arrows, legends, scale bars, and graphics are automatically tagged as decorative so that they are not read by a screen reader. You cannot change this. Information conveyed visually by these elements can be included in text form using dynamic text elements on the layout or in the alt text description for map frames, chart frames, and pictures. You can mark additional elements—text, table frames, chart frames, map frames, and pictures—as decorative. To tag an element as decorative, complete the following steps:

  1. In the Contents pane, right-click an element and click Properties to open the Element pane.

  2. If necessary, expand the Accessibility heading.

  3. Check Tag as decorative.

Tagging an element as decorative does not affect its appearance on the page. The element remains visible, but is removed from the reading order for assistive technologies.

Export an accessible layout

Once accessibility properties have been configured in the layout, you can export the layout as an accessible PDF. The Accessibility tab in the Export pane provides options for creating a tagged PDF that can be read by screen readers and other assistive technologies. You must check the Include accessibility tags check box during export to create an accessible PDF. To maximize accessibility, set a logical reading order for the PDF content and provide PDF metadata.

How to export

To export an accessible PDF, complete the following steps:

  1. On the Share tab, click Export Layout to open the Export pane.

  2. In the Export pane, select PDF from the File Type drop-down list.

    Optionally, click the lower half of the Export Layout button to open the preset gallery and select a PDF preset.

  3. In the Export pane, select the Accessibility tab to set accessible properties for the PDF export.

  4. Check the Include accessibility tags property to ensure that a screen reader can read the PDF export.

    Warning:

    If the Output as Image option is checked on the Properties tab in the Export pane, elements will not get tagged in the PDF export even if the Include accessibility tags option is checked.

  5. Fill out all sections of the PDF metadata.

  6. Optionally, adjust the Reading Order for layout elements to ensure content is presented in a logical sequence.

  7. Click the Export button to export the PDF.

Reading order

Accessibility tags ensure a screen reader can read the content of a PDF, but that content should be presented in a logical order. By default, the order that elements are read in an accessible PDF is the same as the order the elements are listed in the Contents pane of the layout. This may not always be the most logical way to present information. You can change this by ordering elements in the Reading Order list in the Export pane. To set this reading order, complete the following steps:

  1. On the Accessibility tab in the Export pane, check the Include accessibility tags property to enable the Reading Order list.

  2. Click an element in the list to select it, and use the navigation arrows next to the list to change the order of elements.

    Optionally, use Ctrl and click to select and move multiple elements in the list.

  3. Save the project to save the set order in the list. Saving the project will save the set reading order for all layouts in the project.

    Caution:

    Unsaved changes in the Reading Order list are lost when elements that support accessibility properties are added, deleted, or grouped in the Contents pane.

The order of elements in the Reading Order list does not affect the drawing order of elements listed in the Contents pane. All elements that support tagging and are visible in the Contents pane are included in the Reading Order list. If an element is tagged as decorative, or is not visible in the Contents pane, it is not included in the list. Elements added to or deleted from a layout are added to or deleted from this list as well.

Elements in the Reading Order list are identified by name. Give elements meaningful names instead of their default names to make them easier to locate and manage. Hover over an element in the Reading Order list to view its element type. Hover over a text element to display a preview of the text it contains. Text elements also show the text tag type in parentheses after the element name.

PDF metadata

PDF metadata provides descriptive information about the file including the title, language, author, subject, and keywords. This information helps individuals locate and understand PDF documents. To ensure your PDF is discoverable, fill in all of the metadata fields before exporting the PDF. PDF metadata is included in the exported file even when the Include accessibility tags property is not checked.