Skip to content

spelling in guidelines for creating images #520

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
franzholz wants to merge 1 commit into
base: main
Choose a base branch
from
Open

spelling in guidelines for creating images #520

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
16 changes: 8 additions & 8 deletions Documentation/Advanced/GuidelinesForImages.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ For accessibility reasons **always** provide an alt text:

.. literalinclude:: /_CodeSnippets/_Figure.rts.txt

More option for embedding images into ReST: :ref:`Images <h2document:images>`.
More optional parameters for embedding images into ReST: :ref:`Images <h2document:images>`.

.. _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.
and SVG for vector graphics images. In any case, you can use :file:`.png`.

.. _guidelines-for-images-screenshot:
.. _automatic-screenshots:
Expand All @@ -32,7 +32,7 @@ Guidelines for screenshots
.. note::
You can use the `The example screenshot project <https://docs.typo3.org/permalink/h2document: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.
screenshot tool since TYPO3 v11 as it proved to be too complicated to maintain.

* Before adding a screenshot consider if one is necessary. Each new screenshot
requires maintenance.
Expand All @@ -41,15 +41,15 @@ Guidelines for screenshots
* 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 `t3docs/site-package`.
* If you need example data use :composer:`t3docs/site-package-data`
* 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
"j.doe"
"j.doe".
* 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 or AVIF format (.png or .avif file ending)
* If you take a screenshot of a full page it should have 1400 x 1050 px
* Use PNG or AVIF format (:file:`.png` or :file:`.avif` 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
Expand Down
Loading