aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn MacFarlane <[email protected]>2025-11-30 13:31:17 +0100
committerJohn MacFarlane <[email protected]>2025-11-30 13:31:17 +0100
commit1dcb984453a61cb37d091df7a0fba404207327d3 (patch)
tree3b79d92eefaa358fdf76fe497937485ea85db8cd
parent66cbd2471fd2ad4e0aeb8c71c85ff319976ad587 (diff)
Clean up `implicit_figure` documentation.
Explain how to specify alt text. See #11082.
-rw-r--r--MANUAL.txt24
1 files changed, 16 insertions, 8 deletions
diff --git a/MANUAL.txt b/MANUAL.txt
index fe7e19bbf..3dc4f0551 100644
--- a/MANUAL.txt
+++ b/MANUAL.txt
@@ -5712,29 +5712,37 @@ 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 description will be used as the caption.
- ![This is the caption](/url/of/image.png)
+ ![This is the caption.](image.png)
How this is rendered depends on the output format. Some output
formats (e.g. RTF) do not yet support figures. In those
formats, you'll just get an image in a paragraph by itself, with
-no caption. For LaTeX output, you can specify a [figure's
-positioning](https://www.overleaf.com/learn/latex/Positioning_images_and_tables#The_figure_environment)
-by adding the `latex-placement` attribute.
-
- ![This is the caption](/url/of/image.png){latex-placement="ht"}
+no caption.
If you just want a regular inline image, just make sure it is not
the only thing in the paragraph. One way to do this is to insert a
nonbreaking space after the image:
- ![This image won't be a figure](/url/of/image.png)\
+ ![This image won't be a figure](image.png)\
Note that in reveal.js slide shows, an image in a paragraph
by itself that has the `r-stretch` class will fill the screen,
and the caption and figure tags will be omitted.
+To specify an alt text for the image that is different
+from the caption, you can use an explicit attribute (assuming the
+`link_attributes` extension is set):
+
+ ![The caption.](image.png){alt="description of image"}
+
+For LaTeX output, you can specify a [figure's
+positioning](https://www.overleaf.com/learn/latex/Positioning_images_and_tables#The_figure_environment)
+by adding the `latex-placement` attribute.
+
+ ![The caption.](image.png){latex-placement="ht"}
+
### Extension: `link_attributes` ###
Attributes can be set on links and images: