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] Use custom types for linking object properties in GIFBUILDER chapter #900

Merged
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
2 changes: 1 addition & 1 deletion Documentation/Gifbuilder/Examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -446,5 +446,5 @@ create much better quality images:
use the :ref:`SCALE <gifbuilder-scale>`
function in GIFBUILDER as the last object in the list to scale them
down to the desired size. (It will render fonts with anti-aliasing even
without the niceText property of the GIFBUILDER
without the :t3-gifbuilder-text:`niceText` property of the GIFBUILDER
:ref:`TEXT <gifbuilder-text>` object enabled as a side effect).
4 changes: 2 additions & 2 deletions Documentation/Gifbuilder/ObjectNames/Adjust/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,8 @@ autoLevels

.. t3-gifbuilder-adjust:: autoLevels

Sets the :ref:`inputLevels <gifbuilder-adjust-inputLevels>` and
:ref:`outputLevels <gifbuilder-adjust-outputLevels>` automatically.
Sets the :t3-gifbuilder-adjust:`inputLevels` and
:t3-gifbuilder-adjust:`outputLevels` automatically.

**Example:**

Expand Down
2 changes: 1 addition & 1 deletion Documentation/Gifbuilder/ObjectNames/Box/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ dimensions

.. t3-gifbuilder-box:: dimensions

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

Dimensions of a filled box.

Expand Down
2 changes: 1 addition & 1 deletion Documentation/Gifbuilder/ObjectNames/Crop/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,6 @@ crop
:Data type: x,y,w,h :ref:`+calc <gifbuilder-calc>` /:ref:`stdWrap <stdwrap>`

x,y is the offset of the crop frame from the position specified by
:ref:`align <gifbuilder-crop-align>`.
:t3-gifbuilder-crop:`align`.

w,h are the dimensions of the frame.
2 changes: 1 addition & 1 deletion Documentation/Gifbuilder/ObjectNames/Effect/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ gray

**Example:**

This gives the image a slight :ref:`wave <gifbuilder-effect-wave>` and
This gives the image a slight :t3-gifbuilder-effect:`wave` and
renders it in gray.

.. code-block:: typoscript
Expand Down
2 changes: 1 addition & 1 deletion Documentation/Gifbuilder/ObjectNames/Emboss/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ opacity
speaking: Opacity = Transparency^-1. For example, 100% opacity = 0%
transparency.

Only active with a value for :ref:`blur <gifbuilder-emboss-blur>`.
Only active with a value for :t3-gifbuilder-emboss:`blur`.


.. _gifbuilder-emboss-offset:
Expand Down
4 changes: 2 additions & 2 deletions Documentation/Gifbuilder/ObjectNames/Shadow/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ color

.. t3-gifbuilder-shadow:: color

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

The color of the shadow.

Expand Down Expand Up @@ -78,7 +78,7 @@ opacity
speaking: Opacity = Transparency^-1. E.g. 100% opacity = 0%
transparency.

Only active with a value for :ref:`blur <gifbuilder-shadow-blur>`.
Only active with a value for :t3-gifbuilder-shadow:`blur`.


.. _gifbuilder-shadow-textObjNum:
Expand Down
40 changes: 19 additions & 21 deletions Documentation/Gifbuilder/ObjectNames/Text/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ align
:Data type: align / :ref:`stdWrap <stdwrap>`
:Default: left

The alignment of the :ref:`text <gifbuilder-text-text>`.
The alignment of the :t3-gifbuilder-text:`text`.

Possible values:

Expand All @@ -46,11 +46,11 @@ angle
:Default: 0
:Range: -90 to 90

The rotation degree of the :ref:`text <gifbuilder-text-text>`.
The rotation degree of the :t3-gifbuilder-text:`text`.

.. note::
The angle is not available, if :ref:`spacing <gifbuilder-text-spacing>`
/ :ref:`wordSpacing <gifbuilder-text-wordSpacing>` is set.
The angle is not available, if :t3-gifbuilder-text:`spacing`
/ :t3-gifbuilder-text:`wordSpacing` is set.


.. _gifbuilder-text-antiAlias:
Expand All @@ -67,11 +67,10 @@ antiAlias

.. note::
This option is not available, if
:ref:`niceText <gifbuilder-text-niceText>` is enabled.
:t3-gifbuilder-text:`niceText` is enabled.

Setting this option to :typoscript:`0` will not work, if
:ref:`fontColor <gifbuilder-text-fontColor>` is set to black (or
#000000).
:t3-gifbuilder-text:`fontColor` is set to black (or #000000).


.. _gifbuilder-text-breakSpace:
Expand Down Expand Up @@ -111,7 +110,7 @@ doNotStripHTML
:Data type: boolean
:Default: 0 (false)

If set, HTML tags inserted in the :ref:`text <gifbuilder-text-text>` are
If set, HTML tags inserted in the :t3-gifbuilder-text:`text` are
**not** removed. Any other HTML code will be removed by default!


Expand Down Expand Up @@ -192,12 +191,12 @@ iterations
:Data type: positive integer / :ref:`stdWrap <stdwrap>`
:Default: 1

How many times the :ref:`text <gifbuilder-text-text>` should be "printed"
How many times the :t3-gifbuilder-text:`text` should be "printed"
onto it self. This will add the effect of bold text.

.. note::
This option is not available, if
:ref:`niceText <gifbuilder-text-niceText>` is enabled.
:t3-gifbuilder-text:`niceText` is enabled.


.. _gifbuilder-text-maxWidth:
Expand All @@ -209,12 +208,12 @@ maxWidth

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

Sets the maximum width in pixels, the :ref:`text <gifbuilder-text-text>`
must be. Reduces the :ref:`font size <gifbuilder-text-fontSize>`, if the
Sets the maximum width in pixels, the :t3-gifbuilder-text:`text`
must be. Reduces the :t3-gifbuilder-text:`fontSize`, if the
text does not fit within this width.

Does not support setting alternative font sizes in
:ref:`splitRendering <gifbuilder-text-splitRendering>` options.
:t3-gifbuilder-text:`splitRendering` options.


.. _gifbuilder-text-niceText:
Expand All @@ -233,9 +232,8 @@ niceText
The principle of this function is to create a black/white image file in
twice or more times the size of the actual image file and then print the
text onto this in a scaled dimension. Afterwards GraphicsMagick/ImageMagick
scales down the mask and masks the
:ref:`font color <gifbuilder-text-fontColor>` down on the original image
file through the temporary mask.
scales down the mask and masks the :t3-gifbuilder-text:`fontColor` down on
the original image file through the temporary mask.

The fact that the font is actually rendered in the double size and
scaled down adds a more homogeneous shape to the letters. Some fonts
Expand Down Expand Up @@ -298,7 +296,7 @@ offset
:Data type: x,y :ref:`+calc <gifbuilder-calc>` / :ref:`stdWrap <stdwrap>`
:Default: 0,0

The offset of the :ref:`text <gifbuilder-text-text>`.
The offset of the :t3-gifbuilder-text:`text`.


.. _gifbuilder-text-outline:
Expand Down Expand Up @@ -377,7 +375,7 @@ splitRendering
* **fontSize:** Alternative font size for this rendering.

* **color:** Alternative color for this rendering, works *only*
without :ref:`niceText <gifbuilder-text-niceText>`.
without :t3-gifbuilder-text:`niceText`.

* **xSpaceBefore:** x space before this part.

Expand Down Expand Up @@ -409,7 +407,7 @@ splitRendering
**Limitations:**

* The pixel compensation values are not corrected for scale factor used
with :ref:`niceText <gifbuilder-text-niceText>`. Basically this means
with :t3-gifbuilder-text:`niceText`. Basically this means
that when :typoscript:`niceText` is used, these values will have only
the half effect.

Expand Down Expand Up @@ -489,7 +487,7 @@ textMaxLength
:Data type: integer
:Default: 100

The maximum length of the :ref:`text <gifbuilder-text-text>`. This is just a
The maximum length of the :t3-gifbuilder-text:`text`. This is just a
natural break that prevents incidental rendering of very long texts!


Expand All @@ -500,7 +498,7 @@ wordSpacing

.. t3-gifbuilder-text:: wordSpacing

:Data type: positive integer /:ref:`stdWrap <stdwrap>`
:Data type: positive integer / :ref:`stdWrap <stdwrap>`
:Default: :ref:`spacing <gifbuilder-text-spacing>` * 2

The pixel distance between words.
8 changes: 4 additions & 4 deletions Documentation/Gifbuilder/Properties.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ charRangeMap
**The key:**

The value of the array key will be the key used when forcing the
configuration into :ref:`splitRendering <gifbuilder-text-splitRendering>`
configuration into :t3-gifbuilder-text:`splitRendering`
configuration of the individual
:ref:`GIFBUILDER objects <gifbuilder-object-names>`.
In the :ref:`example below <gifbuilder-properties-charRangeMap-pixelSpaceFontSizeRef>`
Expand Down Expand Up @@ -100,7 +100,7 @@ charRangeMap

If set, this will take the font size of the
:ref:`GIFBUILDER TEXT object <gifbuilder-text>` and multiply with this
amount (xx.xx) and override the :ref:`fontSize <gifbuilder-text-fontSize>`
amount (xx.xx) and override the :t3-gifbuilder-text:`fontSize`
property inside
:ref:`charMapConfig <gifbuilder-properties-charRangeMap-charMapConfig>`.

Expand Down Expand Up @@ -245,7 +245,7 @@ transparentBackground
color found at position 0,0 of the image (upper left corner) transparent.

If you render text, you should leave the
:ref:`niceText <gifbuilder-text-niceText>` option **off** as the result will
:t3-gifbuilder-text:`niceText` option **off** as the result will
probably be more precise without the :typoscript:`niceText` antialiasing
hack.

Expand Down Expand Up @@ -276,7 +276,7 @@ closest

.. note::
You may experience that this does not work, if you render text with the
:ref:`niceText <gifbuilder-text-niceText>` option.
:t3-gifbuilder-text:`niceText` option.


.. _gifbuilder-properties-XY:
Expand Down