Skip to content

Explain how to set descriptive alt text as well as caption #11082

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Explain how to set descriptive alt text as well as caption #11082

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions MANUAL.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5634,7 +5634,8 @@ The link text will be used as the image's alt text:

An image with nonempty alt text, occurring by itself in a
paragraph, will be rendered as a figure with a caption. The
image's alt text will be used as the caption.
image's alt text will be used as the caption. To set alt text
as well as a caption, use the 'alt' link_attribute (see below).
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd suggest using `alt` instead of 'alt'.


![This is the caption](/url/of/image.png)

Expand All @@ -5657,7 +5658,7 @@ and the caption and figure tags will be omitted.

Attributes can be set on links and images:

An inline ![image](foo.jpg){#id .class width=30 height=20px}
An inline ![image](foo.jpg){#id .class width=30 height=20px alt="Alt text"}
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not a good example, because in this inline image, the alt text will be set from the image description. Thus, you can just do ![alt text](foo.jpg). You would only have a reason to use alt= when the image is by itself in a paragraph, when the implicit_figures extension is set.

and a reference ![image][ref] with attributes.

[ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
Expand Down