From 67452c24f0532e58f1e84c7056a627ddb77f7d55 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 14 Nov 2023 08:57:16 +0100 Subject: [PATCH] [TASK] Use custom types for linking object properties in GIFBUILDER chapter (#902) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Releases: main, 12.4, 11.5 Co-authored-by: Chris Müller <2566282+brotkrueml@users.noreply.github.com> --- Documentation/Gifbuilder/Examples.rst | 2 +- .../Gifbuilder/ObjectNames/Adjust/Index.rst | 4 +- .../Gifbuilder/ObjectNames/Box/Index.rst | 2 +- .../Gifbuilder/ObjectNames/Crop/Index.rst | 2 +- .../Gifbuilder/ObjectNames/Effect/Index.rst | 2 +- .../Gifbuilder/ObjectNames/Emboss/Index.rst | 2 +- .../Gifbuilder/ObjectNames/Shadow/Index.rst | 4 +- .../Gifbuilder/ObjectNames/Text/Index.rst | 40 +++++++++---------- Documentation/Gifbuilder/Properties.rst | 8 ++-- 9 files changed, 32 insertions(+), 34 deletions(-) diff --git a/Documentation/Gifbuilder/Examples.rst b/Documentation/Gifbuilder/Examples.rst index 74dd8db1..fd8046d6 100644 --- a/Documentation/Gifbuilder/Examples.rst +++ b/Documentation/Gifbuilder/Examples.rst @@ -455,5 +455,5 @@ create much better quality images: use the :ref:`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 ` object enabled as a side effect). diff --git a/Documentation/Gifbuilder/ObjectNames/Adjust/Index.rst b/Documentation/Gifbuilder/ObjectNames/Adjust/Index.rst index cb1581fb..f2c92421 100644 --- a/Documentation/Gifbuilder/ObjectNames/Adjust/Index.rst +++ b/Documentation/Gifbuilder/ObjectNames/Adjust/Index.rst @@ -99,8 +99,8 @@ autoLevels .. t3-gifbuilder-adjust:: autoLevels - Sets the :ref:`inputLevels ` and - :ref:`outputLevels ` automatically. + Sets the :t3-gifbuilder-adjust:`inputLevels` and + :t3-gifbuilder-adjust:`outputLevels` automatically. **Example:** diff --git a/Documentation/Gifbuilder/ObjectNames/Box/Index.rst b/Documentation/Gifbuilder/ObjectNames/Box/Index.rst index b2070036..7bb9e227 100644 --- a/Documentation/Gifbuilder/ObjectNames/Box/Index.rst +++ b/Documentation/Gifbuilder/ObjectNames/Box/Index.rst @@ -103,7 +103,7 @@ dimensions .. t3-gifbuilder-box:: dimensions - :Data type: x,y,w,h +calc / :ref:`stdWrap ` + :Data type: x,y,w,h :ref:`+calc ` / :ref:`stdWrap ` Dimensions of a filled box. diff --git a/Documentation/Gifbuilder/ObjectNames/Crop/Index.rst b/Documentation/Gifbuilder/ObjectNames/Crop/Index.rst index c943b39c..eee2beb5 100644 --- a/Documentation/Gifbuilder/ObjectNames/Crop/Index.rst +++ b/Documentation/Gifbuilder/ObjectNames/Crop/Index.rst @@ -85,6 +85,6 @@ crop :Data type: x,y,w,h :ref:`+calc ` /:ref:`stdWrap ` x,y is the offset of the crop frame from the position specified by - :ref:`align `. + :t3-gifbuilder-crop:`align`. w,h are the dimensions of the frame. diff --git a/Documentation/Gifbuilder/ObjectNames/Effect/Index.rst b/Documentation/Gifbuilder/ObjectNames/Effect/Index.rst index 8b270248..da7ba307 100644 --- a/Documentation/Gifbuilder/ObjectNames/Effect/Index.rst +++ b/Documentation/Gifbuilder/ObjectNames/Effect/Index.rst @@ -229,7 +229,7 @@ gray **Example:** - This gives the image a slight :ref:`wave ` and + This gives the image a slight :t3-gifbuilder-effect:`wave` and renders it in gray. .. code-block:: typoscript diff --git a/Documentation/Gifbuilder/ObjectNames/Emboss/Index.rst b/Documentation/Gifbuilder/ObjectNames/Emboss/Index.rst index f09c0c75..02886a4b 100644 --- a/Documentation/Gifbuilder/ObjectNames/Emboss/Index.rst +++ b/Documentation/Gifbuilder/ObjectNames/Emboss/Index.rst @@ -81,7 +81,7 @@ opacity speaking: Opacity = Transparency^-1. For example, 100% opacity = 0% transparency. - Only active with a value for :ref:`blur `. + Only active with a value for :t3-gifbuilder-emboss:`blur`. .. _gifbuilder-emboss-offset: diff --git a/Documentation/Gifbuilder/ObjectNames/Shadow/Index.rst b/Documentation/Gifbuilder/ObjectNames/Shadow/Index.rst index cbcf1099..7a82ab1c 100644 --- a/Documentation/Gifbuilder/ObjectNames/Shadow/Index.rst +++ b/Documentation/Gifbuilder/ObjectNames/Shadow/Index.rst @@ -35,7 +35,7 @@ color .. t3-gifbuilder-shadow:: color - :Data type: :t3-data-type:`GraphicColor` /:ref:`stdWrap ` + :Data type: :t3-data-type:`GraphicColor` / :ref:`stdWrap ` The color of the shadow. @@ -78,7 +78,7 @@ opacity speaking: Opacity = Transparency^-1. E.g. 100% opacity = 0% transparency. - Only active with a value for :ref:`blur `. + Only active with a value for :t3-gifbuilder-shadow:`blur`. .. _gifbuilder-shadow-textObjNum: diff --git a/Documentation/Gifbuilder/ObjectNames/Text/Index.rst b/Documentation/Gifbuilder/ObjectNames/Text/Index.rst index e40db777..8ff641f3 100644 --- a/Documentation/Gifbuilder/ObjectNames/Text/Index.rst +++ b/Documentation/Gifbuilder/ObjectNames/Text/Index.rst @@ -26,7 +26,7 @@ align :Data type: align / :ref:`stdWrap ` :Default: left - The alignment of the :ref:`text `. + The alignment of the :t3-gifbuilder-text:`text`. Possible values: @@ -46,11 +46,11 @@ angle :Default: 0 :Range: -90 to 90 - The rotation degree of the :ref:`text `. + The rotation degree of the :t3-gifbuilder-text:`text`. .. note:: - The angle is not available, if :ref:`spacing ` - / :ref:`wordSpacing ` is set. + The angle is not available, if :t3-gifbuilder-text:`spacing` + / :t3-gifbuilder-text:`wordSpacing` is set. .. _gifbuilder-text-antiAlias: @@ -67,11 +67,10 @@ antiAlias .. note:: This option is not available, if - :ref:`niceText ` is enabled. + :t3-gifbuilder-text:`niceText` is enabled. Setting this option to :typoscript:`0` will not work, if - :ref:`fontColor ` is set to black (or - #000000). + :t3-gifbuilder-text:`fontColor` is set to black (or #000000). .. _gifbuilder-text-breakSpace: @@ -111,7 +110,7 @@ doNotStripHTML :Data type: boolean :Default: 0 (false) - If set, HTML tags inserted in the :ref:`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! @@ -192,12 +191,12 @@ iterations :Data type: positive integer / :ref:`stdWrap ` :Default: 1 - How many times the :ref:`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 ` is enabled. + :t3-gifbuilder-text:`niceText` is enabled. .. _gifbuilder-text-maxWidth: @@ -209,12 +208,12 @@ maxWidth :Data type: positive integer / :ref:`stdWrap ` - Sets the maximum width in pixels, the :ref:`text ` - must be. Reduces the :ref:`font size `, 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 ` options. + :t3-gifbuilder-text:`splitRendering` options. .. _gifbuilder-text-niceText: @@ -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 ` 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 @@ -298,7 +296,7 @@ offset :Data type: x,y :ref:`+calc ` / :ref:`stdWrap ` :Default: 0,0 - The offset of the :ref:`text `. + The offset of the :t3-gifbuilder-text:`text`. .. _gifbuilder-text-outline: @@ -377,7 +375,7 @@ splitRendering * **fontSize:** Alternative font size for this rendering. * **color:** Alternative color for this rendering, works *only* - without :ref:`niceText `. + without :t3-gifbuilder-text:`niceText`. * **xSpaceBefore:** x space before this part. @@ -409,7 +407,7 @@ splitRendering **Limitations:** * The pixel compensation values are not corrected for scale factor used - with :ref:`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. @@ -489,7 +487,7 @@ textMaxLength :Data type: integer :Default: 100 - The maximum length of the :ref:`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! @@ -500,7 +498,7 @@ wordSpacing .. t3-gifbuilder-text:: wordSpacing - :Data type: positive integer /:ref:`stdWrap ` + :Data type: positive integer / :ref:`stdWrap ` :Default: :ref:`spacing ` * 2 The pixel distance between words. diff --git a/Documentation/Gifbuilder/Properties.rst b/Documentation/Gifbuilder/Properties.rst index ec29bd15..216fda4b 100644 --- a/Documentation/Gifbuilder/Properties.rst +++ b/Documentation/Gifbuilder/Properties.rst @@ -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 ` + configuration into :t3-gifbuilder-text:`splitRendering` configuration of the individual :ref:`GIFBUILDER objects `. In the :ref:`example below ` @@ -100,7 +100,7 @@ charRangeMap If set, this will take the font size of the :ref:`GIFBUILDER TEXT object ` and multiply with this - amount (xx.xx) and override the :ref:`fontSize ` + amount (xx.xx) and override the :t3-gifbuilder-text:`fontSize` property inside :ref:`charMapConfig `. @@ -257,7 +257,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 ` 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. @@ -288,7 +288,7 @@ closest .. note:: You may experience that this does not work, if you render text with the - :ref:`niceText ` option. + :t3-gifbuilder-text:`niceText` option. .. _gifbuilder-properties-XY: