opensource/pandoc
3
0
Fork 0
mirror of https://github.com/jgm/pandoc.git synced 2026-09-21 13:51:29 +08:00
Code Issues Packages Projects Releases Wiki Activity

Clean up implicit_figure documentation.

Browse Source 
Explain how to specify alt text.

See #11082.
This commit is contained in:
John MacFarlane
2025-11-30 13:31:17 +01:00
parent 66cbd2471f
commit 1dcb984453
1 changed files with 16 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
MANUAL.txt
+16 -8
View File
@@ -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: