-
Notifications
You must be signed in to change notification settings - Fork 172
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[TASK] Split GIFBUILDER objects into separate pages
The GIFBUILDER objects are listed on one large page. This makes it difficult to look out for a specific object. Therefore, this "god" page is split up into separate pages - one for each object. This way, the different objects are listed in the navigation and are easily accessible by the reader. Note: This change just splits up the page into multiple pages. Further adjustments on the different objects may be done in consecutive pull request. Releases: main, 12.4, 11.5
- Loading branch information
1 parent
abb3357
commit 28852db
Showing
14 changed files
with
1,911 additions
and
1,862 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,107 @@ | ||
.. include:: /Includes.rst.txt | ||
.. index:: GIFBUILDER; ADJUST | ||
.. _gifbuilder-adjust: | ||
|
||
====== | ||
ADJUST | ||
====== | ||
|
||
This lets you adjust the tonal range like in the "levels"-dialog of | ||
Photoshop. You can set the input- and output-levels and that way remap | ||
the tonal range of the image. If you need to adjust the gamma value, | ||
have a look at the EFFECT object. | ||
|
||
|
||
Example | ||
======= | ||
|
||
.. code-block:: typoscript | ||
:caption: EXT:site_package/Configuration/TypoScript/setup.typoscript | ||
20 = ADJUST | ||
20.value = inputLevels = 13, 230 | ||
Properties | ||
========== | ||
|
||
.. ### BEGIN~OF~TABLE ### | ||
.. container:: table-row | ||
|
||
Property | ||
inputLevels | ||
|
||
Data type | ||
low, high | ||
|
||
Description | ||
With this option you can remap the tone of the image to make shadows | ||
darker, highlights lighter and increase contrast. | ||
|
||
Possible values for "low" and "high" are integers between 0 and 255, | ||
where "high" must be higher than "low". | ||
|
||
The value "low" will then be remapped to a tone of 0, the value "high" | ||
will be remapped to 255. | ||
|
||
**Example:** | ||
|
||
This example will cause the tonal range of the resulting image to | ||
begin at 50 of the original (which is set as 0 for the new image) and | ||
to end at 190 of the original (which is set as 255 for the new image). | ||
|
||
.. code-block:: typoscript | ||
:caption: EXT:site_package/Configuration/TypoScript/setup.typoscript | ||
20 = ADJUST | ||
20.value = inputLevels = 50, 190 | ||
.. container:: table-row | ||
|
||
Property | ||
outputLevels | ||
|
||
Data type | ||
low, high | ||
|
||
Description | ||
With this option you can remap the tone of the image to make shadows | ||
lighter, highlights darker and decrease contrast. | ||
|
||
Possible values for "low" and "high" are integers between 0 and 255, | ||
where "high" must be higher than "low". | ||
|
||
The beginning of the tonal range, which is 0, will then be remapped to | ||
the value "low", the end, which is 255, will be remapped to the value | ||
"high". | ||
|
||
**Example:** | ||
|
||
This example will cause the resulting image to have a tonal range, | ||
where there is no pixel with a tone below 50 and no pixel with a tone | ||
above 190 in the image. | ||
|
||
.. code-block:: typoscript | ||
:caption: EXT:site_package/Configuration/TypoScript/setup.typoscript | ||
20 = ADJUST | ||
20.value = outputLevels = 50, 190 | ||
.. container:: table-row | ||
|
||
Property | ||
autoLevels | ||
|
||
Data type | ||
- | ||
|
||
Description | ||
Sets the levels automatically. | ||
|
||
|
||
.. ###### END~OF~TABLE ###### | ||
[tsref:->GIFBUILDER.(GBObj).ADJUST] | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,101 @@ | ||
.. include:: /Includes.rst.txt | ||
.. index:: GIFBUILDER; BOX | ||
.. _gifbuilder-box: | ||
|
||
=== | ||
BOX | ||
=== | ||
|
||
Prints a filled box. | ||
|
||
Properties | ||
========== | ||
|
||
.. ### BEGIN~OF~TABLE ### | ||
.. container:: table-row | ||
|
||
Property | ||
dimensions | ||
|
||
Data type | ||
x,y,w,h +calc /:ref:`stdWrap <stdwrap>` | ||
|
||
Description | ||
Dimensions of a filled box. | ||
|
||
x,y is the offset. | ||
|
||
w,h are the dimensions. Dimensions of 1 will result in 1-pixel wide | ||
lines! | ||
|
||
|
||
.. container:: table-row | ||
|
||
Property | ||
color | ||
|
||
Data type | ||
:t3-data-type:`GraphicColor` /:ref:`stdWrap <stdwrap>` | ||
|
||
Default | ||
black | ||
|
||
Description | ||
Fill color of the box. | ||
|
||
|
||
|
||
.. container:: table-row | ||
|
||
Property | ||
opacity | ||
|
||
Data type | ||
positive integer (1-100) /:ref:`stdWrap <stdwrap>` | ||
|
||
Default | ||
100 | ||
|
||
Description | ||
The degree to which the box conceals the background. Mathematically | ||
speaking: Opacity = Transparency^-1. E.g. 100% opacity = 0% | ||
transparency. | ||
|
||
|
||
|
||
.. container:: table-row | ||
|
||
Property | ||
align | ||
|
||
Data type | ||
VHalign /:ref:`stdWrap <stdwrap>` | ||
|
||
Default | ||
l, t | ||
|
||
Description | ||
Pair of values, which defines the horizontal and vertical alignment of | ||
the box in the image. | ||
|
||
**Values:** | ||
|
||
Horizontal alignment: r/c/l standing for right, center, left | ||
|
||
Vertical alignment: t/c/b standing for top, center, bottom | ||
|
||
**Example:** | ||
|
||
Horizontally centered, vertically at the bottom: | ||
|
||
.. code-block:: typoscript | ||
:caption: EXT:site_package/Configuration/TypoScript/setup.typoscript | ||
align = c, b | ||
.. ###### END~OF~TABLE ###### | ||
[tsref:->GIFBUILDER.(GBObj).BOX] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
.. include:: /Includes.rst.txt | ||
.. index:: GIFBUILDER; CROP | ||
.. _gifbuilder-crop: | ||
|
||
==== | ||
CROP | ||
==== | ||
|
||
**Note:** This object resets workArea to the new dimensions of the | ||
image! | ||
|
||
Properties | ||
========== | ||
|
||
.. ### BEGIN~OF~TABLE ### | ||
.. container:: table-row | ||
|
||
Property | ||
backColor | ||
|
||
Data type | ||
:t3-data-type:`GraphicColor` /:ref:`stdWrap <stdwrap>` | ||
|
||
Default | ||
The original backColor | ||
|
||
Description | ||
*See "Data types reference".* | ||
|
||
|
||
|
||
.. container:: table-row | ||
|
||
Property | ||
align | ||
|
||
Data type | ||
VHalign /:ref:`stdWrap <stdwrap>` | ||
|
||
Default | ||
l, t | ||
|
||
Description | ||
Horizontal and vertical alignment of the crop frame. | ||
|
||
*See "Data types reference".* | ||
|
||
|
||
|
||
.. container:: table-row | ||
|
||
Property | ||
crop | ||
|
||
Data type | ||
x,y,w,h + calc /:ref:`stdWrap <stdwrap>` | ||
|
||
Description | ||
x,y is the offset of the crop-frame from the position specified by | ||
"align". | ||
|
||
w,h are the dimensions of the frame. | ||
|
||
For the usage of "calc" see the according note at the beginning of the | ||
section "GIFBUILDER". | ||
|
||
|
||
.. ###### END~OF~TABLE ###### | ||
[tsref:->GIFBUILDER.(GBObj).CROP] |
Oops, something went wrong.