Skip to content

Commit

Permalink
[TASK] Update image and screenshot guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
linawolf committed Nov 19, 2024
1 parent 9555354 commit 1360f28
Show file tree
Hide file tree
Showing 5 changed files with 36 additions and 201 deletions.
181 changes: 36 additions & 145 deletions Documentation/Basics/GeneralConventions/GuidelinesForImages.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,167 +9,58 @@
Guidelines for creating images
==============================

When embedding images with reST, please add a shadow,
as described in :ref:`how-to-document-images`.
Read here how to embed an image into ReST: :ref:`Images <h2document:images>`.

There are various kinds of images used in the documentation. The most
common are:
For accessibility reasons always use provide an alt text.

#. Screenshots
#. Screenshots, augmented with graphic elements, the most common being
arrows, texts, boxes and numbers to highlight parts of the screenshot,
add extra explanation etc., with the intention of making the image more
useful for the reader
#. Diagrams, such as UML diagrams


.. index:: Images; Style guide

General guidelines
==================

* In general, comply with the
`TYPO3 web style guide <https://styleguide.typo3.org/patternlab/public/index.html>`__


.. index:: Images; Fonts

Texts & fonts
-------------

* When using fonts, please use recommended: **Primary font: "Source Sans Pro", "Helvetica", "Arial",
sans-serif;**. You can download "Source Sance Pro" as TTF files:
`Assets <https://styleguide.typo3.org/Data/TYPO3_Assets_2017-08-23.zip>`__,
path: :file:`00\ -\ Assets/Fonts/SourceCodePro-Regular.ttf`
* If you use text in an SVG, make sure it can be
displayed on systems that have not installed the used font.
There are a
number of ways to do this. If in doubt, ask for :ref:`help <help>` or save the image
as bitmap (.png). However, if SVG is used, the image can be scaled
better.
* In any case, you should be safe with using a commonly supported font
like Helvetica or Arial. Remember, the Web Style Guide proposes
*Source Sans Pro, Helvetica, Arial*.


.. index::
Images; Formats
Images; PNG
Images; SVG
.. _guidelines-for-images-formats:

Image formats
-------------

* It is recommended to use PNG for bitmaps (for example screenshots, photographs)
and SVG for vector graphics images. In any case, you can use .png.

.. index:: Screenshots; Guidelines

.. _guidelines-for-images-screenshot:

Guidelines for screenshots
==========================

* use PNG format (.png file ending)
* Do not use huge full screen screenshots (except in some cases where it makes sense,
for example when describing the various parts of the backend). Select a portion
of a screen that will reflect what you are trying to show. To save yourself hassle,
use a screenshot tool which can create a screenshot of a portion of a screen.

Here are some :ref:`examples for screenshots <t3contribute:how-to-see-merge-conflicts>`.



.. code-block:: rst
.. image:: images/github-getting-started-raw.png
:class: with-shadow
:scale: 70
How it looks:

.. image:: images/github-getting-started-raw.png
:class: with-shadow
:scale: 70

Another example:

.. image:: images/backend-raw.png
:class: with-shadow
:scale: 70


You may however notice, that it might be helpful to point out some relevant part of the
screenshots. That is what we do by creating images as described in the next section.


.. index:: Screenshots; Adding graphics elements
.. note::
We do not have an automatic screenshot tool working with current TYPO3
versions at the moment. The automatic screenshot tool we were working on
never worked beyond TYPO3 11 LTS.

* Before adding a screenshot consider if one is necessary. Each new screenshot
requires maintenance.
* Use a Composer-based installation of the latest LTS release, or dev-main.
* Turn the backend into light mode and modern look.
* Unless you want to demonstrate features of certain system extensions use
a default installation as described in Getting Started:
:ref:`Installing TYPO3 with DDEV <t3start:installation-ddev-tutorial>`.
* If you need an example site package use :composer:`t3docs/site-package.
* If you need example data use :composer:`t3docs/site-package-data`
* As personalized usernames are considered best practice always use username
"kasper"
* Do not install third party extensions unless what you want to demonstrate
requires one. If possible use one of the extensions from vendor `typo3` or
`t3docs`.
* use PNG format (.png file ending)
* If you take a screenshot of a full page it should have 1400 x 1050 px
* Use only parts of a full page when possible, the flatter the screenshot the
less room it takes.
* When reviewing screenshots take into consideration that taking screenshots
is a lot of effort.

.. _guidelines-for-images-screenshot-with-grafics:

Guidelines for screenshots with graphics elements
=================================================

You will often see a screenshot where additional graphic elements have been added in the
documentation. These additional graphic elements may be boxes, numbers or arrows. Up until,
we did not have guidelines for this, so you may see various shapes in different colors.

.. important::
This still needs some work. If you plan on adding images to a manual, contact
us in the #typo3-documentation channel. Help with optimizing this section is also
appreciated.


.. index::
pair: Screenshots; Icons
pair: TYPO3; Icons

To get the icons
----------------

Either download the zipfile and extract it.
You can find the download link on https://github.com/TYPO3-Documentation/_Images,

Or clone the repository:

.. code-block:: bash
git clone https://github.com/TYPO3-Documentation/_Images
The icons will be in images/final/icons.


Follow these guidelines
-----------------------

* Icons are used for numbers and arrows. The size of the icons should not be changed.
* Simple frames are TYPO3 Orange (#F49700) and have a line thickness of 2 px and a
corner radius of 2 px.
* Text fields are TYPO3 Orange (#F49700) and have a corner radius of 2 px.
* Dividing surfaces have a 2px frame in TYPO3 Orange (#F49700) with a corner radius
of 2 px.
* Icon shadows have an

* horizontal offset of 4 px
* vertical offset of 4 px
* blur radius of 10 px
* spread radius of 0 px
* color of RGBA (0, 0, 0, 0.3)


Examples
--------


.. figure:: images/backend-with-boxes.png
:class: with-shadow

PNG Image with rectangles and numbers

.. figure:: images/backend-with-boxes-2.svg
:class: with-shadow

SVG image with rectangles and numbers

.. figure:: /_Images/edit_me_on_github+shadow.svg
:class: with-shadow
:alt: Image with arrow
documentation. These additional graphic elements may be boxes, numbers or arrows.

SVG Image with arrow
* Use sufficient contrast to ensure additional graphic elements are visible
across devices and for as many readers as possible, even if the do not see
a difference between red and green.
Binary file not shown.

This file was deleted.

Binary file not shown.
Binary file not shown.

0 comments on commit 1360f28

Please sign in to comment.