Skip to content
代码片段 群组 项目
未验证 提交 00521202 编辑于 作者: Fiona Neill's avatar Fiona Neill 提交者: GitLab
浏览文件

Merge branch 'alt-text-guidelines' into 'master'

Update alt text guidelines

See merge request https://gitlab.com/gitlab-org/gitlab/-/merge_requests/167754



Merged-by: default avatarFiona Neill <fneill@gitlab.com>
Approved-by: default avatarFiona Neill <fneill@gitlab.com>
Co-authored-by: default avatarAshraf Khamis <akhamis@gitlab.com>
No related branches found
No related tags found
无相关合并请求
...@@ -1280,7 +1280,7 @@ if you were helping someone read and interact with the page and they couldn't se ...@@ -1280,7 +1280,7 @@ if you were helping someone read and interact with the page and they couldn't se
Do: Do:
`![A runner sending a request to the Docker API.](img/document_image_title_vX_Y.png)` `![A runner sending a request to the Docker API](img/document_image_title_vX_Y.png)`
Do not: Do not:
...@@ -1292,14 +1292,13 @@ When writing alt text: ...@@ -1292,14 +1292,13 @@ When writing alt text:
typically stop reading after this amount. typically stop reading after this amount.
- If the image has complex information, like a workflow diagram, use a short alt text to identify the image and - If the image has complex information, like a workflow diagram, use a short alt text to identify the image and
include detailed information in the text. include detailed information in the text.
- Use complete sentences. - Use end punctuation.
- Use punctuation. - Use sentence case and avoid using all-caps. Some screen readers read capitals as individual letters.
- Use sentence case and avoid using all-caps. Some screenreaders read capitals as individual letters.
- Don't use phrases like **Image of** or **Graphic of**. - Don't use phrases like **Image of** or **Graphic of**.
- Don't use a string of keywords. Include keywords in a complete sentence to enhance context. - Don't use a string of keywords. Include keywords in phrases or sentences to enhance context.
- Introduce the image in the section text, not the alt text. - Introduce the image in the section text, not the alt text.
- Try to avoid repeating content that you've already used in the section text. - Try to avoid repeating content that you've already used in the section text.
- Don't use inline styling, like bold, italics, or backticks. Screen readers will read `**text**` as `star star text star star`. - Don't use inline styling, like bold, italics, or backticks. Screen readers read `**text**` as `star star text star star`.
#### Automatic screenshot generator #### Automatic screenshot generator
......
0% 加载中 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册