diff --git a/Documentation/Gifbuilder/ObjectNames/Text/Index.rst b/Documentation/Gifbuilder/ObjectNames/Text/Index.rst index 052a76dae..6c72a8734 100644 --- a/Documentation/Gifbuilder/ObjectNames/Text/Index.rst +++ b/Documentation/Gifbuilder/ObjectNames/Text/Index.rst @@ -110,6 +110,7 @@ Properties other way HTML code is removed by default! +.. _gifbuilder-text-fontSize: .. container:: table-row @@ -344,6 +345,8 @@ Properties Gifbuilder Object->OUTLINE +.. _gifbuilder-text-niceText: + .. container:: table-row Property @@ -380,6 +383,8 @@ Properties .scaleFactor = scaling-factor, integer 2-5 +.. _gifbuilder-text-splitRendering: + .. container:: table-row Property diff --git a/Documentation/Gifbuilder/Properties.rst b/Documentation/Gifbuilder/Properties.rst index e9a2e2bce..5749ea4b1 100644 --- a/Documentation/Gifbuilder/Properties.rst +++ b/Documentation/Gifbuilder/Properties.rst @@ -6,285 +6,298 @@ Properties ========== -.. ### BEGIN~OF~TABLE ### +.. contents:: + :local: -.. container:: table-row +.. _gifbuilder-properties-array: - Property - 1,2,3,4... +1,2,3,4... +========== + +.. option:: 1,2,3,4... + + :Data type: :ref:`Gifbuilder Object ` + .if (:ref:`->if `) + + :typoscript:`.if` is a property of all GIFBUILDER objects. If the property + is present and **not** set, the object is **not** rendered! This + corresponds to the functionality of :typoscript:`.if` of the + :ref:`stdWrap ` function. + + +.. _gifbuilder-properties-backColor: + +backColor +========= + +.. option:: backColor + + :Data type: :t3-data-type:`GraphicColor` / :ref:`stdWrap ` + :Default: white + + Background color of the image. - Data type - Gifbuilder Object \+ .if (->if) - Description - .if (->if) is a property of all GIFBUILDER objects. If the property is - present and **not** set, the object is **not** rendered! This - corresponds to the functionality of ".if" of the stdWrap-function. +.. _gifbuilder-properties-charRangeMap: +charRangeMap +============ -.. container:: table-row +.. _gifbuilder-properties-charRangeMap-array: - Property - charRangeMap.[array] +[array] +------- - Data type - string +.. option:: charRangeMap.[array] - Description - Basename of font file to match for this configuration. Notice that - only the *filename* of the font file is used - the path is stripped - off. This is done to make matching easier and avoid problems when font - files might move to other locations in extensions etc. + :Data type: string - So if you use the font file "EXT:myext/fonts/vera.ttf" or - "typo3/sysext/install/Resources/Private/Font/vera.ttf" both of them will - match with this configuration. + Basename of font file to match for this configuration. Notice that + only the *filename* of the font file is used - the path is stripped + off. This is done to make matching easier and avoid problems when font + files might move to other locations in extensions etc. - **The key:** + So if you use the font file + :file:`EXT:my_extension/Resources/Private/Fonts/vera.ttf` or + :file:`EXT:install/Resources/Private/Font/vera.ttf` both of them will + match with this configuration. - The value of the array key will be the key used when forcing the - configuration into "splitRendering" configuration of the individual - GIFBUILDER objects. In the example below the key is "123". + **The key:** - Notice: If the key is already found in the local GIFBUILDER - configuration the content of that key is respected and not overridden. - Thus you can make local configurations which override the global - setting. + The value of the array key will be the key used when forcing the + configuration into :ref:`splitRendering ` + configuration of the individual + :ref:`GIFBUILDER objects `. + In the :ref:`example below ` + the key is :typoscript:`123`. + .. note:: + If the key is already found in the local GIFBUILDER configuration the + content of that key is respected and not overridden. Thus you can make + local configurations which override the global setting. -.. container:: table-row - Property - charRangeMap.[array].charMapConfig +.. _gifbuilder-properties-charRangeMap-charMapConfig: - Data type - TEXT / splitRendering.[array] configuration +[array].charMapConfig +--------------------- - Description - splitRendering configuration to set. See GIFBUILDER TEXT object for - details. +.. option:: charRangeMap.[array].charMapConfig + :Data type: :ref:`TEXT ` / :ref:`splitRendering.[array] ` configuration -.. container:: table-row + splitRendering configuration to set. + See :ref:`GIFBUILDER TEXT object ` for details. - Property - charRangeMap.[array].fontSizeMultiplicator - Data type - double +.. _gifbuilder-properties-charRangeMap-fontSizeMultiplicator: - Description - If set, this will take the font size of the TEXT GIFBUILDER object and - multiply with this amount (xx.xx) and override the "fontSize" property - inside "charMapConfig". +[array].fontSizeMultiplicator +----------------------------- +.. option:: charRangeMap.[array].fontSizeMultiplicator -.. container:: table-row + :Data type: double - Property - charRangeMap.[array].pixelSpaceFontSizeRef + 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 ` + property inside + :ref:`charMapConfig `. - Data type - double - Description - If set, this will multiply the four [x/y]Space[Before/After] - properties of split rendering with the relationship between the - fontsize and this value. +.. _gifbuilder-properties-charRangeMap-pixelSpaceFontSizeRef: - In other words: Since pixel space may vary depending on the font size - used, you can specify by this value at what fontsize the pixel - space settings are optimized and for other font sizes this will - automatically be adjusted according to this font size. +[array].pixelSpaceFontSizeRef +----------------------------- +.. option:: charRangeMap.[array].pixelSpaceFontSizeRef -.. container:: table-row + :Data type: double - Property - XY + If set, this will multiply the four [x/y]Space[Before/After] + properties of split rendering with the relationship between the + font size and this value. - Data type - x,y +calc (1-2000) /:ref:`stdWrap ` + In other words: Since pixel space may vary depending on the font size + used, you can specify by this value at what font size the pixel + space settings are optimized and for other font sizes this will + automatically be adjusted according to this font size. - Default - 120,50 + **Example**: - Description - Size of the image file. + .. code-block:: typoscript - For the usage of "calc" see the according note at the beginning of - the section "GIFBUILDER". + _GIFBUILDER.charRangeMap { + 123 = arial.ttf + 123 { + charMapConfig { + fontFile = EXT:install/Resources/Private/Font/vera.ttf + value = 48-57 + color = green + xSpaceBefore = 3 + xSpaceAfter = 3 + } + pixelSpaceFontSizeRef = 24 + } + } -.. _gifbuilder-format: + In this example :typoscript:`xSpaceBefore` and :typoscript:`xSpaceAfter` + will be "3" when the font size is 24. If this configuration is used on a + :ref:`GIFBUILDER TEXT object ` where the font size is only + 16, the spacing values will be corrected by "16/24", effectively reducing + the pixel space to "2" in that case. -.. container:: table-row - Property - format +.. _gifbuilder-properties-format: - Data type - "gif" / "jpg" / "jpeg" / "png" +format +====== - Default - gif +.. option:: format - Description - File type of the output image. + :Data type: "gif" / "jpg" / "jpeg" / "png" + :Default: gif - It is possible to define the quality of a JPG image globally via - :ref:`$TYPO3_CONF_VARS['GFX']['jpg_quality'] ` - or via the :ref:`quality ` property on a per-image - basis. + File type of the output image. + It is possible to define the quality of a JPG image globally via + :ref:`$TYPO3_CONF_VARS['GFX']['jpg_quality'] ` + or via the :ref:`quality ` property on a per-image + basis. -.. container:: table-row - Property - transparentBackground +.. _gifbuilder-properties-maxHeight: - Data type - boolean /:ref:`stdWrap ` +maxHeight +========= - Description - Set this flag to render the background transparent. TYPO3 makes the - color found at position 0,0 of the image (upper left corner) - transparent. +.. option:: maxHeight - If you render text, you should leave the niceText option OFF as the - result will probably be more precise without the niceText antialiasing - hack. + :Data type: positive integer / :ref:`stdWrap ` + Maximal height of the image file. -.. container:: table-row - Property - transparentColor +.. _gifbuilder-properties-maxWidth: - Data type - *HTMLColor* /:ref:`stdWrap ` +maxWidth +======== - Description - Specify a color that should be transparent +.. option:: maxWidth - **Example-values:** + :Data type: positive integer / :ref:`stdWrap ` - #ffffcc + Maximal width of the image file. - red - 255,255,127 +.. _gifbuilder-properties-offset: - **Option:** +offset +====== - transparentColor.closest = 1 +.. option:: offset - This will allow for the closest color to be matched instead. You may - need this if you image is not guaranteed "clean". + :Data type: x,y :ref:`+calc ` / :ref:`stdWrap ` + :Default: 0,0 - **Note:** You may experience that this does not work, if you render - text with the niceText option. + Offset all objects on the image. -.. _gifbuilder-quality: +.. _gifbuilder-properties-quality: -.. container:: table-row +quality +======= - Property - quality +.. option:: quality - Data type - positive integer (10-100) + :Data type: positive integer (10-100) - Description - JPG-quality (if :ref:`.format ` = jpg/jpeg) + JPG-quality (if :ref:`.format ` = jpg/jpeg) -.. container:: table-row +.. _gifbuilder-properties-workArea: - Property - backColor +workArea +======== - Data type - :t3-data-type:`GraphicColor` /:ref:`stdWrap ` +.. option:: workArea - Default - white + :Data type: x,y,w,h :ref:`+calc ` / :ref:`stdWrap ` - Description - Background color of the image. + Define the work area on the image file. All the + :ref:`GIFBUILDER objects ` will see this as the + dimensions of the image file regarding alignment, overlaying of images and + so on. Only :ref:`TEXT objects ` exceeding the boundaries + of the work area will be printed outside this area. +.. _gifbuilder-properties-transparentBackground: -.. container:: table-row +transparentBackground +===================== - Property - offset +.. option:: transparentBackground - Data type - x,y +calc /:ref:`stdWrap ` + :Data type: boolean / :ref:`stdWrap ` - Default - 0,0 + Set this flag to render the background transparent. TYPO3 makes the + color found at position 0,0 of the image (upper left corner) transparent. - Description - Offset all objects on the image. + If you render text, you should leave the + :ref:`niceText ` option **off** as the result will + probably be more precise without the :typoscript:`niceText` antialiasing + hack. -.. _gifbuilder-properties-workArea: +.. _gifbuilder-properties-transparentColor: -.. container:: table-row +transparentColor +================ - Property - workArea +.. option:: transparentColor - Data type - x,y,w,h + calc /:ref:`stdWrap ` + :Data type: :t3-data-type:`GraphicColor` / :ref:`stdWrap ` - Description - Define the workarea on the image file. All the Gifbuilder Objects will - see this as the dimensions of the image file regarding alignment, - overlaying of images an so on. Only TEXT objects exceeding the - boundaries of the workarea will be printed outside this area. + Specify a color that should be transparent. -.. container:: table-row +.. _gifbuilder-properties-transparentColor-closest: - Property - maxWidth +closest +------- - Data type - pixels /:ref:`stdWrap ` +.. option:: transparentColor.closest - Description - Maximal width of the image file. + :Data Type: boolean + This will allow for the closest color to be matched instead. You may + need this, if your image is not guaranteed "clean". -.. container:: table-row + .. note:: + You may experience that this does not work, if you render text with the + :ref:`niceText ` option. - Property - maxHeight - Data type - pixels /:ref:`stdWrap ` +.. _gifbuilder-properties-XY: - Description - Maximal height of the image file. +XY +== +.. option:: XY -.. container:: table-row + :Data type: x,y :ref:`+calc ` (1-2000) / :ref:`stdWrap ` + :Default: 120,50 - Property - reduceColors + Size of the image file. - Data type - positive integer (1-255) /:ref:`stdWrap ` - Description - .. versionchanged:: 13.0 - This property has been removed. +.. _gifbuilder-properties-reduceColors: +reduceColors +============ -.. ###### END~OF~TABLE ###### +.. option:: reduceColors -[tsref:->GIFBUILDER] + .. versionchanged:: 13.0 + This property has been removed.