Skip to main content

External links and resources

Ask AI
Copy a prompt to ask an AI assistant about this page.

External links point users to information outside the application or to other resources. In order to make these links and resources accessible, we add alternative text (ALT-text) to icons and write clear link text.

Use brief, meaningful link text to explain the function of the target web page or resource.

  • SIMATIC S7-1500 firmware updates
  • Roles and permissions in the documentation
  • Demonstration projects
  • Learn about the latest device firmware updates
  • https://www.company.com/s7-1500-firmware
  • Remote access

Pair link text with universal icons, e.g. the open-external or application-screen icons.

  • Company Digital ID
  • Manage your software licenses in one place

Use descriptive link text instead of long, full URLs and remove the prefix https://www.

  • Company homepage
  • acronymfinder.com
  • https://www.company.com/s9-1600-firmware
  • https://support.com/us/en/view/107826255

Avoid generic link text, e.g. "click here" without context or information regarding what opens.

  • Description: The details regarding the collection and use of Analytics Data are described in Software Analytics Notice contained in the Application Function Manual.

    Link text: Open Application Function Manual
  • Click here
  • Read more

Use unique link text for each link destination so assistive technology users can distinguish between links (if all links have the same text, it makes it hard to know where each one leads).

  • Open Assembly Manual
    Open Demonstration Project App
    Explore Manual
  • Click here
    Click here
    Click here

General rules for resource texts​

Use brief, meaningful resource texts and explain the function and type of the resource.

  • Generative AI chat privacy information
  • Interface module IM 155-5 MF HF Equipment Manual
  • Industrial Copilots with Agentic AI
  • example.company.com/downloads/file.pdf
  • You can read more in the User Documentation

Pair resource text with icons, e.g. PDF-document or video-file icons.

  • Data Privacy Organization
  • Industrial Copilots with Agentic AI

Downloading resources​

Pair the download of resources with both file type and size whenever possible.

  • Download User Manual (54 MB)

Text alternatives (ALT-text) for icons​

Describe link behavior and type in ALT-texts instead of repeating icon and visible link text.

  • Link text: Visit our homepage
    ALT-text: external
  • Resource text: Function Manual
    ALT-text: external PDF
  • Resource text:
    Industrial Copilots with Agentic AI
    ALT-text: external video in new tab
  • Link text: Visit our homepage
    ALT-text: Visit our homepage.

Icon legend​

IconALT-text
Option 1: external
Option 2: open external link in new tab
Option 1: external application
Option 2: open external application
Option 1: PDF
Option 2: external PDF
Video

Language​

Specify the language when the resource language differs from the app language (WCAG 3.1.2).

  • Application Function Manual (German)
  • German web page (German)

Layout​

Separate external links from body text with lists to avoid disrupting user reading flow.

  • Our platform integrates with various tools to enhance productivity.
    External resources:
    Documentation portal
    GitHub repository
    Support community

Split external links from body text with separate paragraphs for faster scanning and enhanced transparency.

  • Description: Our new automation system improves efficiency by 40% and reduces downtime through predictive maintenance algorithms.

    Link text: Efficiency report
  • For more technical details, visit Automation Whitepaper .

Emails and telephone numbers​

Avoid adding the "mailto" text and for email addresses as this is no longer visible in the UI.

  • mailto:name@examples.com

Ensure email addresses and phone numbers are clickable.

  • You can reach us at the following telephone number +1 555-0100.
  • 555 0100

Dos and Don'ts​

  • Do add link text for transparency
  • Do pair link and resource icons with clear texts
  • Do use icons to visualize what will open, e.g. external link, PDF, etc.
  • Do use ALT-text to explain icons
  • Don't include https://, http: or www in URL text
  • Don't add links in headings or sub-headings