From 4ad0624d6a7d247dba4556536a8ca65fa6140823 Mon Sep 17 00:00:00 2001 From: Franz Holzinger Date: Thu, 9 Apr 2026 22:05:06 +0200 Subject: [PATCH 1/2] spelling in guidelines for creating images I have added some dots, too. --- Documentation/Advanced/GuidelinesForImages.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/Documentation/Advanced/GuidelinesForImages.rst b/Documentation/Advanced/GuidelinesForImages.rst index f5defcd9..99db9bf7 100644 --- a/Documentation/Advanced/GuidelinesForImages.rst +++ b/Documentation/Advanced/GuidelinesForImages.rst @@ -13,7 +13,7 @@ For accessibility reasons **always** provide an alt text: .. literalinclude:: /_CodeSnippets/_Figure.rts.txt -More option for embedding images into ReST: :ref:`Images `. +More optional parameters for embedding images into ReST: :ref:`Images `. .. _guidelines-for-images-formats: @@ -21,7 +21,7 @@ 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: @@ -32,7 +32,7 @@ Guidelines for screenshots .. note:: 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. + 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. @@ -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 `. -* 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 From 10c0b7044825a1de3670af310e7458829b8dd6f4 Mon Sep 17 00:00:00 2001 From: Lina Wolf <48202465+linawolf@users.noreply.github.com> Date: Mon, 11 May 2026 15:13:50 +0200 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Lina Wolf <48202465+linawolf@users.noreply.github.com> --- Documentation/Advanced/GuidelinesForImages.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/Advanced/GuidelinesForImages.rst b/Documentation/Advanced/GuidelinesForImages.rst index 99db9bf7..051469ad 100644 --- a/Documentation/Advanced/GuidelinesForImages.rst +++ b/Documentation/Advanced/GuidelinesForImages.rst @@ -41,7 +41,7 @@ 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 `. -* If you need an example site package use :composer:`t3docs/site-package`. +* If you need an example site package use `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".