Using images in ReST documentation

You can use the The example screenshot project. It already follows most of the rules stated below. There has been no automatic screenshot tool since TYPO3 v11 as it proved to be to complicated to maintain.

Attention

For official and Core manuals please follow the Guidelines for creating images.

Images and figures in Rest

We recommend to use the .. figure:: directive. It works just like .. image:: save that you can add a descriptive text as content.

Always use the parameter :alt: to add a descriptive text for visually impaired and search engine / artificial intelligence bots scanning our docs.

Example:

..  figure:: /_Images/a4.jpg
    :alt: some image

    This is the image caption

Optional parameters for images and figures:

:target: link target
:width: : width of image, use for example px (for example :width: 100px
:scale: : scale images, for example :scale: 65

Additional parameters can be found on the docutils page reStructuredText Directives

Example 1: Scaled image with shadow and link target

..  figure:: /_Images/a4.jpg
    :alt: some image
    :target: https://typo3.org
    :class: with-shadow
    :scale: 50

Example 2: Image with caption and fixed width

..  figure:: /_Images/a4.jpg
    :alt: some image
    :target: https://typo3.org
    :width: 100px

    This is the image caption