diff --git a/docs/en/designers/language-custom-functions/language-function-assign.xml b/docs/en/designers/language-custom-functions/language-function-assign.xml index 64eed001..267d0bff 100644 --- a/docs/en/designers/language-custom-functions/language-function-assign.xml +++ b/docs/en/designers/language-custom-functions/language-function-assign.xml @@ -1,56 +1,63 @@ - - assign - - - - - - - - - - Attribute Name - Type - Required - Default - Description - - - - - var - string - Yes - n/a - The name of the variable being assigned - - - value - string - Yes - n/a - The value being assigned - - - - - - assign is used for assigning template variables during the execution - of the template. - - -assign - + + assign + + + + + + + + + + Attribute Name + Type + Required + Default + Description + + + + + var + string + Yes + n/a + The name of the variable being assigned + + + value + string + Yes + n/a + The value being assigned + + + + + + assign is used for assigning template variables during the execution + of the template. + + + assign + + - +]]> + + + The above example will output: + + + + + - - math - - - - - - - - - - Attribute Name - Type - Required - Default - Description - - - - - equation - string - Yes - n/a - the equation to execute - - - format - string - No - n/a - the format of the result (sprintf) - - - var - numeric - Yes - n/a - equation variable value - - - assign - string - No - n/a - template variable the output will be assigned to - - - [var ...] - numeric - Yes - n/a - equation variable value - - - - - - math allows the template designer to do math equations in the - template. Any numeric template variables may be used in the - equations, and the result is printed in place of the tag. The - variables used in the equation are passed as parameters, which can - be template variables or static values. +, -, /, *, abs, ceil, cos, - exp, floor, log, log10, max, min, pi, pow, rand, round, sin, sqrt, - srans and tan are all valid operators. Check the PHP documentation - for further information on these math functions. - - - If you supply the special "assign" attribute, the output of the - math function will be assigned to this template variable instead of - being output to the template. - - - Technical Note - - math is an expensive function in performance due to its use of - the php eval() function. Doing the math in PHP is much more - efficient, so whenever possible do the math calculations in PHP - and assign the results to the template. Definately avoid - repetitive math function calls, like within section loops. - - - -math - -{* $height=4, $width=5 *} + + math + + + + + + + + + + Attribute Name + Type + Required + Default + Description + + + + + equation + string + Yes + n/a + the equation to execute + + + format + string + No + n/a + the format of the result (sprintf) + + + var + numeric + Yes + n/a + equation variable value + + + assign + string + No + n/a + template variable the output will be assigned to + + + [var ...] + numeric + Yes + n/a + equation variable value + + + + + + math allows the template designer to do math equations in the + template. Any numeric template variables may be used in the + equations, and the result is printed in place of the tag. The + variables used in the equation are passed as parameters, which can + be template variables or static values. +, -, /, *, abs, ceil, cos, + exp, floor, log, log10, max, min, pi, pow, rand, round, sin, sqrt, + srans and tan are all valid operators. Check the PHP documentation + for further information on these math functions. + + + If you supply the special "assign" attribute, the output of the + math function will be assigned to this template variable instead of + being output to the template. + + + Technical Note + + math is an expensive function in performance due to its use of + the php eval() function. Doing the math in PHP is much more + efficient, so whenever possible do the math calculations in PHP + and assign the results to the template. Definately avoid + repetitive math function calls, like within section loops. + + + + math + + + + + The above example will output: + + + + + + + + + The above example will output: + + + + + + + + + The above example will output: + + + + + + - + {math equation="x + y" x=4.4444 y=5.0000 format="%.2f"} + ]]> + + + The above example will output: + + + + + - popup + popup @@ -390,9 +390,9 @@ - - popup is used to create javascript popup windows. - + + popup is used to create javascript popup windows. + popup diff --git a/docs/en/designers/language-custom-functions/language-function-textformat.xml b/docs/en/designers/language-custom-functions/language-function-textformat.xml index e28709c3..f8e755c0 100644 --- a/docs/en/designers/language-custom-functions/language-function-textformat.xml +++ b/docs/en/designers/language-custom-functions/language-function-textformat.xml @@ -1,236 +1,269 @@ - - textformat - - - - - - - - - - Attribute Name - Type - Required - Default - Description - - - - - style - string - No - n/a - preset style - - - indent - number - No - 0 - The number of chars to indent every line - - - indent_first - number - No - 0 - The number of chars to indent the first line - - - indent_char - string - No - (single space) - The character (or string of chars) to indent with - - - wrap - number - No - 80 - How many characters to wrap each line to - - - wrap_char - string - No - \n - The character (or string of chars) to break each - line with - - - wrap_cut - boolean - No - false - If true, wrap will break the line at the exact - character instead of at a word boundary - - - assign - string - No - n/a - the template variable the output will be assigned - to - - - - - - textformat is a block function used to format text. It basically - cleans up spaces and special characters, and formats paragraphs by - wrapping at a boundary and indenting lines. - - - You can set the parameters explicitly, or use a preset style. - Currently "email" is the only available style. - - -textformat - -{textformat wrap=40} + + textformat + + + + + + + + + + Attribute Name + Type + Required + Default + Description + + + + + style + string + No + n/a + preset style + + + indent + number + No + 0 + The number of chars to indent every line + + + indent_first + number + No + 0 + The number of chars to indent the first line + + + indent_char + string + No + (single space) + The character (or string of chars) to indent with + + + wrap + number + No + 80 + How many characters to wrap each line to + + + wrap_char + string + No + \n + The character (or string of chars) to break each + line with + + + wrap_cut + boolean + No + false + If true, wrap will break the line at the exact + character instead of at a word boundary + + + assign + string + No + n/a + the template variable the output will be assigned + to + + + + + + textformat is a block function used to format text. It basically + cleans up spaces and special characters, and formats paragraphs by + wrapping at a boundary and indenting lines. + + + You can set the parameters explicitly, or use a preset style. + Currently "email" is the only available style. + + + textformat + + + + + The above example will output: + + + + + + + + + The above example will output: + + + + + + + + + The above example will output: + + + + + + + + + The above example will output: + + + - +]]> + +