Skip to content

Commit

Permalink
[TASK] Set unique names for confvals in Gifbuilder chapter (#1135)
Browse files Browse the repository at this point in the history
releases: main, 12.4
  • Loading branch information
linawolf authored Mar 24, 2024
1 parent ce6330f commit 7db0f30
Show file tree
Hide file tree
Showing 13 changed files with 117 additions and 0 deletions.
5 changes: 5 additions & 0 deletions Documentation/Gifbuilder/ObjectNames/Adjust/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ Example
20.value = inputLevels = 13, 230
.. _gifbuilder-adjust-properties:

Properties
==========

Expand All @@ -35,6 +37,7 @@ inputLevels
-----------

.. confval:: inputLevels
:name: gifbuilder-adjust-inputLevels

:Data type: low, high (int<0,255>, int<0, 255>)

Expand Down Expand Up @@ -66,6 +69,7 @@ outputLevels
------------

.. confval:: outputLevels
:name: gifbuilder-adjust-outputLevels

:Data type: low, high (int<0,255>, int<0, 255>)

Expand Down Expand Up @@ -98,6 +102,7 @@ autoLevels
----------

.. confval:: autoLevels
:name: gifbuilder-adjust-autoLevels

Sets the :ref:`inputLevels <gifbuilder-adjust-inputLevels>` and
:ref:`outputLevels <gifbuilder-adjust-outputLevels>` automatically.
Expand Down
5 changes: 5 additions & 0 deletions Documentation/Gifbuilder/ObjectNames/Box/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ Example
}
}
.. _gifbuilder-box-properties:

Properties
==========
Expand All @@ -42,6 +43,7 @@ align
-----

.. confval:: align
:name: gifbuilder-box-align

:Data type: VHalign / :ref:`stdWrap <stdwrap>`
:Default: l, t
Expand Down Expand Up @@ -89,6 +91,7 @@ color
-----

.. confval:: color
:name: gifbuilder-box-color

:Data type: :ref:`data-type-GraphicColor` / :ref:`stdWrap <stdwrap>`
:Default: black
Expand All @@ -102,6 +105,7 @@ dimensions
----------

.. confval:: dimensions
:name: gifbuilder-box-dimensions

:Data type: x,y,w,h :ref:`+calc <gifbuilder-calc>` / :ref:`stdWrap <stdwrap>`

Expand All @@ -119,6 +123,7 @@ opacity
-------

.. confval:: opacity
:name: gifbuilder-box-opacity

:Data type: positive integer (1-100) / :ref:`stdWrap <stdwrap>`
:Default: 100
Expand Down
5 changes: 5 additions & 0 deletions Documentation/Gifbuilder/ObjectNames/Crop/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ CROP
This object resets :ref:`gifbuilder-properties-workArea` to the
new dimensions of the image!

.. _gifbuilder-properties:

Properties
==========

Expand All @@ -22,6 +24,7 @@ align
-----

.. confval:: align
:name: gifbuilder-crop-align

:Data type: VHalign / :ref:`stdWrap <stdwrap>`
:Default: l, t
Expand Down Expand Up @@ -69,6 +72,7 @@ backColor
---------

.. confval:: backColor
:name: gifbuilder-crop-backColor

:Data type: :ref:`data-type-GraphicColor` / :ref:`stdWrap <stdwrap>`
:Default: The original background color
Expand All @@ -81,6 +85,7 @@ crop
----

.. confval:: crop
:name: gifbuilder-crop-crop

:Data type: x,y,w,h :ref:`+calc <gifbuilder-calc>` /:ref:`stdWrap <stdwrap>`

Expand Down
18 changes: 18 additions & 0 deletions Documentation/Gifbuilder/ObjectNames/Effect/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ The :typoscript:`EFFECT` object allows to apply one or more of the
It has only one property: :typoscript:`value`.
:ref:`stdWrap <stdwrap>` is available for :typoscript:`value`.

.. _gifbuilder-effect-syntax:

Syntax
======
Expand All @@ -26,6 +27,7 @@ All effects are defined as the effect only or as an effect/value pair inside
:typoscript:`value`. Multiple effects or effect/value pairs are separated by
:typoscript:`|`.

.. _gifbuilder-effect-example:

Example
=======
Expand Down Expand Up @@ -62,6 +64,7 @@ blur
----

.. confval:: blur
:name: gifbuilder-effect-blur

:Data type: integer (1-99)
:Default: 0
Expand All @@ -83,6 +86,7 @@ charcoal
--------

.. confval:: charcoal
:name: gifbuilder-effect-charcoal

:Data type: integer (0-100)
:Default: 0
Expand All @@ -105,6 +109,7 @@ colors
------

.. confval:: colors
:name: gifbuilder-effect-colors

:Data type: integer (2-255)

Expand All @@ -125,6 +130,7 @@ edge
----

.. confval:: edge
:name: gifbuilder-effect-edge

:Data type: integer (0-99)
:Default: 0
Expand All @@ -148,6 +154,7 @@ emboss
------

.. confval:: emboss
:name: gifbuilder-effect-emboss

Creates a relief effect: Creates highlights or shadows that replace
light and dark boundaries in the image.
Expand All @@ -167,6 +174,7 @@ flip
----

.. confval:: flip
:name: gifbuilder-effect-flip

Vertical flipping.

Expand All @@ -185,6 +193,7 @@ flop
----

.. confval:: flop
:name: gifbuilder-effect-flop

Horizontal flipping.

Expand All @@ -203,6 +212,7 @@ gamma
-----

.. confval:: gamma
:name: gifbuilder-effect-gamma

:Data type: double (0.5 - 3.0)
:Default: 1.0
Expand All @@ -224,6 +234,7 @@ gray
----

.. confval:: gray
:name: gifbuilder-effect-gray

The image is converted to gray tones.

Expand All @@ -245,6 +256,7 @@ invert
------

.. confval:: invert
:name: gifbuilder-effect-invert

Invert the colors.

Expand All @@ -263,6 +275,7 @@ rotate
------

.. confval:: rotate
:name: gifbuilder-effect-rotate

:Data type: integer (0-360)
:Default: 0
Expand All @@ -287,6 +300,7 @@ sharpen
-------

.. confval:: sharpen
:name: gifbuilder-effect-sharpen

:Data type: integer (0-99)
:Default: 0
Expand All @@ -308,6 +322,7 @@ shear
-----

.. confval:: shear
:name: gifbuilder-effect-shear

:Data type: integer (-90 - 90)
:Default: 0
Expand All @@ -332,6 +347,7 @@ solarize
--------

.. confval:: solarize
:name: gifbuilder-effect-solarize

:Data type: integer (0-99)
:Default: 0
Expand All @@ -357,6 +373,7 @@ swirl
-----

.. confval:: swirl
:name: gifbuilder-effect-swirl

:Data type: integer (0-1000)
:Default: 0
Expand All @@ -378,6 +395,7 @@ wave
----

.. confval:: wave
:name: gifbuilder-effect-wave

:Data type: integer,integer (both 0-99)
:Default: 0,0
Expand Down
4 changes: 4 additions & 0 deletions Documentation/Gifbuilder/ObjectNames/Ellipse/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ ELLIPSE

Prints a filled ellipse.

.. _gifbuilder-ellipse-example:

Example
=======
Expand All @@ -25,6 +26,7 @@ Example
10.color = red
}
.. _gifbuilder-properties:

Properties
==========
Expand All @@ -39,6 +41,7 @@ color
-----

.. confval:: color
:name: gifbuilder-ellipse-color

:Data type: :ref:`data-type-GraphicColor` / :ref:`stdWrap <stdwrap>`
:Default: black
Expand All @@ -52,6 +55,7 @@ dimensions
----------

.. confval:: dimensions
:name: gifbuilder-ellipse-dimensions

:Data type: x,y,w,h :ref:`+calc <gifbuilder-calc>` / :ref:`stdWrap <stdwrap>`

Expand Down
8 changes: 8 additions & 0 deletions Documentation/Gifbuilder/ObjectNames/Emboss/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ The :typoscript:`EMBOSS` object uses two shadow offsets in opposite directions
and with different colors to create an effect of light cast onto an embossed
text.

.. _gifbuilder-emboss-properties:

Properties
==========
Expand All @@ -24,6 +25,7 @@ blur
----

.. confval:: blur
:name: gifbuilder-emboss-blur

:Data type: integer (1-99) / :ref:`stdWrap <stdwrap>`

Expand All @@ -37,6 +39,7 @@ highColor
---------

.. confval:: highColor
:name: gifbuilder-emboss-highColor

:Data type: :ref:`data-type-GraphicColor` / :ref:`stdWrap <stdwrap>`

Expand All @@ -49,6 +52,7 @@ intensity
---------

.. confval:: intensity
:name: gifbuilder-emboss-intensity

:Data type: integer (0-100) / :ref:`stdWrap <stdwrap>`

Expand All @@ -62,6 +66,7 @@ lowColor
--------

.. confval:: lowColor
:name: gifbuilder-emboss-lowColor

:Data type: :ref:`data-type-GraphicColor` / :ref:`stdWrap <stdwrap>`

Expand All @@ -74,6 +79,7 @@ opacity
-------

.. confval:: opacity
:name: gifbuilder-emboss-opacity

:Data type: integer (1-100) / :ref:`stdWrap <stdwrap>`

Expand All @@ -90,6 +96,7 @@ offset
------

.. confval:: offset
:name: gifbuilder-emboss-offset

:Data type: x,y / :ref:`stdWrap <stdwrap>`

Expand All @@ -102,6 +109,7 @@ textObjNum
----------

.. confval:: textObjNum
:name: _gifbuilder-emboss-textObjNum

:Data type: positive integer / :ref:`stdWrap <stdwrap>`

Expand Down
6 changes: 6 additions & 0 deletions Documentation/Gifbuilder/ObjectNames/Image/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ IMAGE

Renders an image file.

.. _gifbuilder-image-properties:

Properties
==========
Expand All @@ -22,6 +23,7 @@ align
-----

.. confval:: align
:name: gifbuilder-image-align

:Data type: VHalign / :ref:`stdWrap <stdwrap>`
:Default: 1,1
Expand Down Expand Up @@ -69,6 +71,7 @@ file
----

.. confval:: file
:name: gifbuilder-image-file

:Data type: :ref:`data-type-imgResource`

Expand All @@ -81,6 +84,7 @@ mask
----

.. confval:: mask
:name: gifbuilder-image-mask

:Data type: :ref:`data-type-imgResource`

Expand All @@ -93,6 +97,7 @@ offset
------

.. confval:: offset
:name: gifbuilder-image-offset

:Data type: x,y :ref:`+calc <gifbuilder-calc>` / :ref:`stdWrap <stdwrap>`
:Default: 0,0
Expand All @@ -106,6 +111,7 @@ tile
----

.. confval:: tile
:name: gifbuilder-image-tile

:Data type: x,y / :ref:`stdWrap <stdwrap>`
:Default: 1,1
Expand Down
Loading

0 comments on commit 7db0f30

Please sign in to comment.