Skip to content
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.

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

[TASK] Move automatic screenshots from pupeteer to codeception #445

Merged
merged 2 commits into from
Jun 27, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ extension `examples <https://extensions.typo3.org/extension/examples/>`__.
Once the extension t3docs/examples is installed the examples are available
as content elements:

.. image:: Images/DataProcessingExamples.png
.. figure:: /Images/ManualScreenshots/Fluidtemplate/DataProcessingExamples.png
:class: with-shadow
:alt: Overview of all data processing examples

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,6 @@ Output
Using :typoscript:`maximumColumns` limits the amount of columns in the multi dimensional array.
In this example, the field data of the last column will be stripped off. Therefore the output would be:

.. image:: Images/CsvProcessor.png
.. figure:: /Images/ManualScreenshots/Fluidtemplate/CsvProcessor.png
:class: with-shadow
:alt: CSV data as HTML table
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ specific custom data processor, of course.
Example output
==============

.. image:: Images/CustomDataProcessor.png
.. figure:: /Images/ManualScreenshots/Fluidtemplate/CustomDataProcessor.png
:class: with-shadow
:alt: custom data processor output

Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,6 @@ Output
The array of records each contains the data of the table in :php:`data` and
the data of the images in :php:`files`.

.. image:: Images/DatabaseProcessor.png
.. figure:: /Images/ManualScreenshots/Fluidtemplate/DatabaseProcessor.png
:class: with-shadow
:alt: haiku record data dump and output
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ Output

The array :php:`images` contains the data of the files now.

.. image:: Images/FilesProcessor.png
.. figure:: /Images/ManualScreenshots/Fluidtemplate/FilesProcessor.png
:class: with-shadow
:alt: files dump and output

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Options:
in content elements such as text with images. Defaults to the value of the field
`imageorient` / "Position and Alignment" if used with content elements.

.. image:: Images/ImageOrientation.png
.. figure:: /Images/ManualScreenshots/Fluidtemplate/ImageOrientation.png
:alt: Media orientation in the content elements such as text with images
:class: with-shadow

Expand Down Expand Up @@ -85,7 +85,7 @@ Options:
`imagewidth` / "Width of each element (px)"
if used with content elements.

.. image:: Images/MediaHeight.png
.. figure:: /Images/ManualScreenshots/Fluidtemplate/MediaHeight.png
:alt: Media height and width in the content element Text and Images
:class: with-shadow

Expand Down Expand Up @@ -239,6 +239,6 @@ The array now contains the images ordered in rows and columns. For each image th
width and height supplied.


.. image:: Images/GalleryProcessor.png
.. figure:: /Images/ManualScreenshots/Fluidtemplate/GalleryProcessor.png
:class: with-shadow
:alt: Gallery dump and output
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,6 @@ German language has the :php:`item.available` set to false. It therefore
doesn't get linked in the template.


.. image:: Images/LanguageMenuProcessor.png
.. figure:: /Images/ManualScreenshots/Fluidtemplate/LanguageMenuProcessor.png
:class: with-shadow
:alt: language menu dump and output
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,6 @@ Output
The array now contains the menu items on level one. Each item in return has the menu
items of level 2 in an array called :php:`children`.

.. image:: Images/MenuProcessor.png
.. figure:: /Images/ManualScreenshots/Fluidtemplate/MenuProcessor.png
:class: with-shadow
:alt: language menu dump and output
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,6 @@ Output

The array now contains the information from the site configuration:

.. image:: Images/SiteProcessor.png
.. figure:: /Images/ManualScreenshots/Fluidtemplate/SiteProcessor.png
:class: with-shadow
:alt: site configuration dump and output
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,6 @@ Output

The array now contains the split strings:

.. image:: Images/SplitProcessor.png
.. figure:: /Images/ManualScreenshots/Fluidtemplate/SplitProcessor.png
:class: with-shadow
:alt: split dump and output
4 changes: 2 additions & 2 deletions Documentation/ContentObjects/GeneralInformation/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -133,11 +133,11 @@ Example:

The result is this configuration:

.. include:: /Includes/Images/RstIncludes/ContentObjectsExampleMerge1.rst.txt
.. include:: /Images/ManualScreenshots/ContentObjectsExampleMerge1.rst.txt

Notice that :typoscript:`.value` was *not* cleared, because it's simply two arrays
which are joined:

.. include:: /Includes/Images/RstIncludes/ContentObjectsExampleMerge2.rst.txt
.. include:: /Images/ManualScreenshots/ContentObjectsExampleMerge2.rst.txt

So hence the line :typoscript:`page.20.value >` in the above example is useless.
6 changes: 3 additions & 3 deletions Documentation/ContentObjects/Hmenu/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
HMENU
=====

Objects of type HMENU generate hierarchical menus. In a
Objects of type HMENU generate hierarchical menus. In a
:ref:`FLUIDTEMPLATE <cobj-fluidtemplate>` the HMENU can be used as
a DataProcessor called :ref:`MenuProcessor <MenuProcessor>`, which
internally uses the HMENU functionality.
Expand Down Expand Up @@ -970,7 +970,7 @@ list from the property ".items".
work if the parent page of the current page is the root page of the
site.

.. figure:: ../../Images/ContentObjectsHmenuSpecialBrowse.png
.. figure:: /Images/ManualScreenshots/ContentObjectsHmenuSpecialBrowse.png
:alt: Example for the usage of the property "items".

**nextsection\_last** / **prevsection\_last:** Where
Expand Down Expand Up @@ -1612,7 +1612,7 @@ are graphical items:

The menu looks like this on a web page:

.. figure:: ../../Images/ContentObjectsHmenuExampleMenu.png
.. figure:: /Images/ManualScreenshots/ContentObjectsHmenuExampleMenu.png
:alt: Output of the example menu.

The TypoScript code above generates this menu, but the items do not
Expand Down
14 changes: 7 additions & 7 deletions Documentation/Gifbuilder/Examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -393,17 +393,17 @@ create much better quality images:
without the niceText property of the GIFBUILDER
:ref:`TEXT <gifbuilder-text>` object enabled as a side effect).

.. |A Background Image| image:: /Images/GifbuilderExamples/Backimage.jpg
.. |A Background Image| image:: /Images/ManualScreenshots/GifbuilderExamples/Backimage.jpg
:target: /File:Backimage.jpg
.. |A overlay image| image:: /Images/GifbuilderExamples/Logo.png
.. |A overlay image| image:: /Images/ManualScreenshots/GifbuilderExamples/Logo.png
:target: /File:Logo.png
.. |A normal mask| image:: /Images/GifbuilderExamples/Mask.png
.. |A normal mask| image:: /Images/ManualScreenshots/GifbuilderExamples/Mask.png
:target: /File:Mask.png
.. |Description| image:: /Images/GifbuilderExamples/Mask_i.png
.. |Description| image:: /Images/ManualScreenshots/GifbuilderExamples/Mask_i.png
:target: /File:Mask_i.png
.. |image1| image:: /Images/GifbuilderExamples/Result.jpg
.. |image1| image:: /Images/ManualScreenshots/GifbuilderExamples/Result.jpg
:target: /File:Result.jpg
.. |Variant 1| image:: /Images/GifbuilderExamples/Typo3_shadow1.png
.. |Variant 1| image:: /Images/ManualScreenshots/GifbuilderExamples/Typo3_shadow1.png
:target: /File:Typo3_shadow1.png
.. |Variant 2| image:: /Images/GifbuilderExamples/Typo3_shadow2.png
.. |Variant 2| image:: /Images/ManualScreenshots/GifbuilderExamples/Typo3_shadow2.png
:target: /File:Typo3_shadow2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.. Automatic screenshot: Remove this line if you want to manually change this file

.. figure:: /Images/AutomaticScreenshots/TemplatesAnalyzerDetails.png
:alt: Viewing the content of a given template in the Template Analyzer
:class: with-shadow

Viewing the content of a given template in the Template Analyzer
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.. Automatic screenshot: Remove this line if you want to manually change this file

.. figure:: /Images/AutomaticScreenshots/TemplatesConstantEditor.png
:alt: The Constant Editor showing some categories with constants
:class: with-shadow

The Constant Editor showing some categories with constants
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.. Automatic screenshot: Remove this line if you want to manually change this file

.. figure:: /Images/AutomaticScreenshots/TemplatesConstants.png
:alt: Overview of the defined constants
:class: with-shadow

Overview of the defined constants
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.. Automatic screenshot: Remove this line if you want to manually change this file

.. figure:: /Images/AutomaticScreenshots/TemplatesSetup.png
:alt: Overview of the defined constants
:class: with-shadow

Overview of the defined constants
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. Automatic screenshot: Remove this line if you want to manually change this file

.. figure:: /Includes/Images/AutomaticScreenshots/TemplatesStaticIncludes1.png
.. figure:: /Images/AutomaticScreenshots/TemplatesStaticIncludes1.png
:alt: Edit the whole template record
:class: with-shadow

Edit the whole template record
Edit the whole template record
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.. Automatic screenshot: Remove this line if you want to manually change this file

.. figure:: /Images/AutomaticScreenshots/TemplatesStaticIncludes2.png
:alt: Screenshot of table sys_template
:class: with-shadow

Screenshot of table sys_template
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.. Automatic screenshot: Remove this line if you want to manually change this file

.. figure:: /Images/AutomaticScreenshots/TemplatesViewFullListingButton.png
:alt: "View the complete TS listing" button
:class: with-shadow

"View the complete TS listing" button
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
.. Manual Screenshot

.. figure:: /Images/ManualScreenshots/ContentObjectsExampleMerge1.png
:class: with-shadow
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
.. Manual Screenshot

.. figure:: /Images/ManualScreenshots/ContentObjectsExampleMerge2.png
:class: with-shadow
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@
:alt: Screenshot of table sys_template
:class: with-shadow

Screenshot of table sys_template
Screenshot of table sys_template
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. Automatic screenshot: Remove this line if you want to manually change this file

.. figure:: /Includes/Images/AutomaticScreenshots/TemplatesViewFullListingButton.png
.. figure:: /Images/AutomaticScreenshots/TemplatesViewFullListingButton.rst.txt
:alt: "View the complete TS listing" button
:class: with-shadow

Expand Down
2 changes: 1 addition & 1 deletion Documentation/MenuObjects/CommonProperties/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -305,7 +305,7 @@ showAccessRestrictedPages

The result can be seen in the image below:

.. figure:: ../../Images/MenuObjectsCommonPropertiesSubmenuObjSuffixes.png
.. figure:: /Images/ManualScreenshots/MenuObjectsCommonPropertiesSubmenuObjSuffixes.png
:alt: Output of the above example.

Applies to TMENU on >= 2 :sup:`nd` level in a menu.
Expand Down
4 changes: 2 additions & 2 deletions Documentation/UsingSetting/Constants.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
Constants
=========

.. include:: /Includes/Images/RstIncludes/TemplatesConstants.rst.txt
.. include:: /Images/AutomaticScreenshots/TemplatesConstants.rst.txt

Constants are values defined in the :guilabel:`Constants` field of a template. They
follow the :ref:`syntax of ordinary TypoScript
Expand Down Expand Up @@ -136,5 +136,5 @@ Most constants can be edited in the :guilabel:`Template` module using the :guila
If you keep your constants in a sitepackage extension you can also make them :ref:`available for the
constant editor <typoscript-syntax-constant-editor>`.

.. include:: /Includes/Images/RstIncludes/TemplatesConstantEditor.rst.txt
.. include:: /Images/AutomaticScreenshots/TemplatesConstantEditor.rst.txt

8 changes: 4 additions & 4 deletions Documentation/UsingSetting/Debugging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Analyzing defined constants
The *TypoScript Object Browser* provides an tree view to all defined constants
on the currently active page.

.. include:: /Includes/Images/RstIncludes/TemplatesConstants.rst.txt
.. include:: /Images/AutomaticScreenshots/TemplatesConstants.rst.txt


.. index:: TypoScript; Syntax errors
Expand All @@ -34,7 +34,7 @@ Finding errors
There are no tools that will tell whether the given TypoScript code is 100%
correct. The :guilabel:`TypoScript object browser` will warn about syntax errors though:

.. figure:: ../Images/TemplatesSyntaxError.png
.. figure:: /Images/ManualScreenshots/TemplatesSyntaxError.png
:alt: The TypoScript Object Browser showing a syntax error
:class: with-shadow

Expand All @@ -43,12 +43,12 @@ given template. It is also possible to see the full TypoScript code by clicking
on the :guilabel:`View the complete TS listing` button at the bottom of the template
analyzer:

.. include:: /Includes/Images/RstIncludes/TemplatesViewFullListingButton.rst.txt
.. include:: /Images/AutomaticScreenshots/TemplatesViewFullListingButton.rst.txt

The result is a long listing with all compiled line numbers, which makes it
possible to find the error reported by the :guilabel:`TypoScript object browser`.

.. figure:: ../Images/TemplatesFullListing.png
.. figure:: /Images/ManualScreenshots/TemplatesFullListing.png
:alt: The TypoScript Object Browser showing a syntax error
:class: with-shadow

Expand Down
8 changes: 4 additions & 4 deletions Documentation/UsingSetting/Entering.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ If the "t3editor" system extension is not installed or has been
disabled via configuration options, the :guilabel:`Constants` and :guilabel:`Setup` fields
will be normal multi-line text fields.

.. figure:: ../Images/TemplatesInputNoT3Editor.png
.. figure:: /Images/ManualScreenshots/TemplatesInputNoT3Editor.png
:alt: The Constants and Setup fields without the t3editor enabled


Expand Down Expand Up @@ -69,15 +69,15 @@ It is also possible to "Include static" templates from extensions.

#. Click :guilabel:`Edit the whole template record`

.. include:: /Includes/Images/RstIncludes/TemplatesStaticIncludes1.rst.txt
.. include:: /Images/AutomaticScreenshots/TemplatesStaticIncludes1.rst.txt

.. rst-class:: bignums-xxl

#. Chose the tab :guilabel:`Includes`

#. Click the templates to include in :guilabel:`Available Items`.

.. include:: /Includes/Images/RstIncludes/TemplatesStaticIncludes2.rst.txt
.. include:: /Images/AutomaticScreenshots/TemplatesStaticIncludes2.rst.txt

.. tip::

Expand Down Expand Up @@ -108,7 +108,7 @@ of this
structure. It shows all the templates that apply to the currently selected page,
taking into account inclusions and inheritance along the page tree.

.. include:: /Includes/Images/RstIncludes/TemplatesAnalyzerDetails.rst.txt
.. include:: /Images/AutomaticScreenshots/TemplatesAnalyzerDetails.rst.txt

Templates are taken into consideration from top to bottom, which means
that properties defined in one template may be overridden in templates
Expand Down
4 changes: 2 additions & 2 deletions Documentation/UsingSetting/TheConstantEditor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ has the ability to use comments in the constant editor to make simple
configuration of a template even easier than constants already make it
themselves.

.. include:: /Includes/Images/RstIncludes/TemplatesConstantEditor.rst.txt
.. include:: /Images/AutomaticScreenshots/TemplatesConstantEditor.rst.txt

When the "Constant Editor" parses the template, *all* comments before every
constant-definition are registered. A certain syntax is available to define
Expand Down Expand Up @@ -193,7 +193,7 @@ Usage example::

Will look in the Constant Editor like this:

.. figure:: ../Images/TemplatesCustomSubcategory.png
.. figure:: /Images/ManualScreenshots/TemplatesCustomSubcategory.png
:alt: The Constant Editor showing a custom category.


Expand Down
Loading