[FEATURE][t3editor] Update TypoScript reference for TYPO3 4.6
authorSteffen Gebert <steffen.gebert@typo3.org>
Sun, 18 Sep 2011 18:10:40 +0000 (20:10 +0200)
committerJigal van Hemert <jigal@xs4all.nl>
Tue, 20 Sep 2011 06:23:16 +0000 (08:23 +0200)
Updated the syntax completion database of t3editor to the changes of
TYPO3 4.6.

Change-Id: I798196aafd16c75f924f49c2f01389e43fb901c5
Resolves: #29995
Releases: 4.6
Reviewed-on: http://review.typo3.org/5037
Tested-by: Stephan Petzl
Tested-by: Jigal van Hemert
Reviewed-by: Björn Pedersen
Reviewed-by: Jigal van Hemert
typo3/sysext/t3editor/res/tsref/tsref.xml

index f458a92..29edcbf 100644 (file)
@@ -375,6 +375,22 @@ Example:
                        <default><![CDATA[
 ]]></default>
                </property>
+               <property name="cache" type="array">
+                       <description><![CDATA[The maximum cache lifetime of a page can not only be determined the start and stop times of content elements on the page itself, but also by arbitrary records on any other page. However, the page has to be configured so that TYPO3 knows, which records' start and stop times to include. Otherwise, the cache entry will be used although a start/stop date already passed by.
+
+To include records of type <tablename> on page <pid> into the cache lifetime calculation of page <page-id>, add the following TypoScript:
+config.cache.<page-id> = <tablename>:<pid>
+
+Thus, if you want to include the fe_users records on page 2 in the cache lifetime calculation for page 10, add the following TypoScript:
+config.cache.10 = fe_users:2
+
+Multiple record sources can be added as comma-separated list, e.g.
+config.cache.10 = fe_users:2,tt_news:11
+
+In order to consider records for the cache lifetime of all pages, use the *all* keyword:
+config.cache.all = fe_users:2]]></description>
+                       <default><![CDATA[]]></default>
+               </property>
                <property name="cache_clearAtMidnight" type="boolean">
                        <description><![CDATA[With this setting the cache always expires at midnight of the day, the page is scheduled to expire.]]></description>
                        <default><![CDATA[false]]></default>
@@ -812,6 +828,10 @@ Keywords are the same as for "xhtml_cleaning", see above.]]></description>
                        <default><![CDATA[
 ]]></default>
                </property>
+               <property name="removeDefaultCss" type="boolean">
+                       <description><![CDATA[Remove CSS generated by _CSS_DEFAULT_STYLE configuration of extensions.]]></description>
+                       <default><![CDATA[false]]></default>
+               </property>
                <property name="removeDefaultJS" type="string">
                        <description><![CDATA[If set, the default JavaScript in the header will be removed.
 The default JavaScript is the blurLink function and browser detection variables.
@@ -828,6 +848,74 @@ config.removeDefaultJS = 1]]></description>
                        <default><![CDATA[
 ]]></default>
                </property>
+               <property name="minifyJS" type="boolean">
+                       <description><![CDATA[If set, inline or externalized (see removeDefaultJS above) JavaScript will be minified. Minification will remove all excess space and will cause faster page loading. Together with removeDefaultJS = external it will significantly lower web site traffic.
+
+Example:
+
+config.minifyJS = 1
+
+Note: The built-in compression handler will compress files only if $GLOBALS['TYPO3_CONF_VARS']['FE']['compressionLevel'] is set to a value higher then "0". Otherwise the files will only be minified. This requires the same options as for ['BE']['compressionLevel'] to be set in .htaccess.
+
+Example:
+
+$GLOBALS['TYPO3_CONF_VARS']['FE']['compressionLevel'] = 9;
+
+Note: TYPO3 comes with a built-in compression handler but you can also register your own one using $GLOBALS['TYPO3_CONF_VARS']['FE']['jsCompressHandler'].
+
+Example:
+
+$GLOBALS['TYPO3_CONF_VARS']['FE']['jsCompressHandler'] = t3lib_extMgm::extPath($_EXTKEY) . 'Classes/class.tx_myext_jsCompressHandler.php:tx_myext_jsCompressHandler->minifyJs';]]></description>
+                       <default><![CDATA[false]]></default>
+               </property>
+               <property name="minifyCSS" type="boolean">
+                       <description><![CDATA[Setting this option will activate CSS minification.
+
+Example:
+
+config.minifyCSS = 1
+
+Note: The built-in compression handler will compress files only, if $GLOBALS['TYPO3_CONF_VARS']['FE']['compressionLevel'] is set to a value higher then "0". Otherwise the files will only be minified. This requires the same options as for ['BE']['compressionLevel'] to be set in .htaccess.
+
+Example:
+
+$GLOBALS['TYPO3_CONF_VARS']['FE']['compressionLevel'] = 9;
+
+Note: TYPO3 comes with a built-in compression handler but you can also register your own one using $GLOBALS['TYPO3_CONF_VARS']['FE']['cssCompressHandler'].
+
+Example:
+
+$GLOBALS['TYPO3_CONF_VARS']['FE']['cssCompressHandler'] = t3lib_extMgm::extPath($_EXTKEY) . 'Classes/class.tx_myext_cssCompressHandler.php:tx_myext_cssCompressHandler->minifyJs';]]></description>
+                       <default><![CDATA[false]]></default>
+               </property>
+               <property name="concatenateJs" type="boolean">
+                       <description><![CDATA[Setting config.concatenateJs merges Javascript files referenced in the Frontend together.
+
+Example:
+
+config.concatenateJs = 1
+
+Note: TYPO3 comes with a built-in concatenation handler, but you can also register your own one using $GLOBALS['TYPO3_CONF_VARS']['FE']['jsConcatenateHandler'].
+
+Example:
+
+$GLOBALS['TYPO3_CONF_VARS']['FE']['jsConcatenateHandler'] = t3lib_extMgm::extPath($_EXTKEY) . 'Classes/class.tx_myext_jsConcatenateHandler.php:tx_myext_jsConcatenateHandler->concatenateJs';]]></description>
+                       <default><![CDATA[false]]></default>
+               </property>
+               <property name="concatenateCss" type="boolean">
+                       <description><![CDATA[Setting config.concatenateCss merges Stylesheet files referenced in the Frontend together.
+
+Example:
+
+config.concatenateCss = 1
+
+Note: TYPO3 comes with a built-in concatenation handler, but you can also register your own using $GLOBALS['TYPO3_CONF_VARS']['FE']['cssConcatenateHandler'].
+
+Example:
+
+$GLOBALS['TYPO3_CONF_VARS']['FE']['cssConcatenateHandler'] = t3lib_extMgm::extPath($_EXTKEY) . 'Classes/class.tx_myext_cssConcatenateHandler.php:tx_myext_cssConcatenateHandler->concatenateCss';]]></description>
+                       <default><![CDATA[false]]></default>
+               </property>
                <property name="renderCharset" type="string">
                        <description><![CDATA[Charset used for rendering internally of the page content. It is highly recommended that this value is the same as the charset of the content coming from the main data source (eg. the database). Thus you don't need to do any other conversion.
 All strings from locallang files and locale strings are (and should be) converted to "renderCharset" during rendering.
@@ -1173,6 +1261,24 @@ If found (another domain), then that domain is prepended the link, the external
                        <default><![CDATA[
 ]]></default>
                </property>
+               <property name="typolinkEnableLinksAcrossDomains" type="boolean">
+                       <description><![CDATA[This option enables to create links across domains using current domain's linking scheme.
+
+If this option is not set, then all cross-domain links will be generated as
+
+"http://domain.tld/index.php?id=12345" (where 12345 is page id). If this option is set and current site uses, for example, simulateStatic, then links will be generated as "http://domain.tld/PageTitle.12345.html" (includes RTE links too). Setting this option requires that domains, where pages are linked, have the same configuration for:
+
+- linking scheme (i.e. all use simulateStatic or RealURL or CoolURI but not any mixture)
+
+- all domains have identical localization settings (config.sys_language_XXX directives)
+
+- all domains have the same set of languages defined
+
+This option implies "config.typolinkCheckRootline=1", which will be activated automatically. Setting value of "config. typolinkCheckRootline" inside TS template will have no effect.
+
+Disclaimer: it must be understood that while link is generated to another domain, it is still generated in the context of current domain. No side effects are known at the time of writing of this documentation but they may exist. If any side effects are found, this documentation will be updated to include them.]]></description>
+                       <default><![CDATA[false]]></default>
+               </property>
                <property name="typolinkLinkAccessRestrictedPages" type="string">
                        <description><![CDATA[integer (page id) / keyword "NONE"
                        If set, typolinks pointing to access restricted pages will still link to the page even though the page cannot be accessed. If the value of this setting is an integer it will be interpreted as a page id to which the link will be directed.
@@ -5162,7 +5268,7 @@ Additional Note: ONLY active if linkWrap is NOT set and file is NOT GIFBUILDER (
                        <default><![CDATA[
 ]]></default>
                </property>
-               <property name="params" type="string">
+               <property name="params" type="stdWrap">
                        <description><![CDATA[
 ]]></description>
                        <default><![CDATA[
@@ -6261,6 +6367,10 @@ Each file has optional properties:
 
 .external - If set, there is no file existence check. Useful for inclusion of external files.
 
+.disableCompression - If config.minifyCSS is enabled, this disables the compression of this file.
+
+.excludeFromConcatenation - If config.concatenateCss is enabled, this prevents the file from being concatenated.
+
 Example:
 
 includeCSS {
@@ -6289,14 +6399,16 @@ Each file has optional properties:
 
 .type - setting the MIME type of the script (default: text/javascript)
 
-.compressed - boolean flag. This will be used by external compressors to see if the file is already compressed.
-
-.forceOnTop - boolean flag. If set, this file will be added on top of all other files
+.forceOnTop - boolean flag. If set, this file will be added on top of all other files.
 
 .allWrap - wraps the complete tag, useful for conditional comments.
 
 .external - If set, there is no file existence check. Useful for inclusion of external files.
 
+.disableCompression - If config.minifyJS is enabled, this disables the compression of this file.
+
+.excludeFromConcatenation - If config.concatenateJs is enabled, this prevents the file from being concatenated.
+
 Example:
 
 includeJS {
@@ -7658,6 +7770,10 @@ bytes.labels = " | K| M| G"]]></description>
                <property name="case" type="case">
                        <description><![CDATA[Converts case
 
+- upper: Converts to upper case (default)
+- lower: Converts to lower case
+- capitalize: Capitalize words
+
 Uses "renderCharset" for the operation.]]></description>
                        <default><![CDATA[
 ]]></default>
@@ -7817,6 +7933,19 @@ The value is exploded by "|" into parameters:
                        <default><![CDATA[
 ]]></default>
                </property>
+               <property name="hash" type="stdWrap">
+                       <description><![CDATA[Returns a hashed value of the current content. Use one of the alogrithms which are available in PHP. For a list of supported algorithms see http://www.php.net/manual/en/function.hash-algos.php
+
+Example:
+
+page.10 = TEXT
+page.10 {
+    value = test@example.com
+    hash = md5
+    wrap = <img src="http://www.gravatar.com/avatar/|" />
+}]]></description>
+                       <default><![CDATA[]]></default>
+               </property>
                <property name="htmlSpecialChars" type="boolean">
                        <description><![CDATA[Passes the content through htmlspecialchars()-PHP-function
 Additional property ".preserveEntities" will preserve entities so only non-entity chars are affected.]]></description>
@@ -7892,13 +8021,30 @@ Special keyword: "last" is set to the last element of the array!
 .splitChar (string):
 Defines the string used to explode the value. If splitChar is an integer, the character with that number is used (eg. "10" to split lines...).
 Default: "," (comma)
+
+.listNum = rand:
+Returns a random item out of th elist
+
 .stdWrap (stdWrap properties):
 stdWrap properties of the listNum...
 
 Examples:
+
 We have a value of "item 1, item 2, item 3, item 4":
 This would return "item 3":
-.listNum = last - 1]]></description>
+.listNum = last - 1
+
+
+This way, the subtitle field changes on every reload:
+page.5 = COA_INT
+page.5 {
+  10 = TEXT
+  10 {
+    field = subtitle
+    stdWrap.listNum = rand
+  }
+}
+]]></description>
                        <default><![CDATA[
 ]]></default>
                </property>
@@ -8082,12 +8228,64 @@ Examples:
                        <default><![CDATA[
 ]]></default>
                </property>
+               <property name="replacement" type="boolean">
+                       <description><![CDATA[Allows to execute search/replace-functionality. Optionally PCRE-regex are supported (see: http://www.php.net/manual/en/function.preg-replace.php) A numeric index allows multiple replacements at once.
+
+Example:
+
+20 = TEXT
+20 {
+  value = There_is_a_cat,_a_dog_and_a_tiger_in_da_hood!_Yeah!
+  stdWrap.replacement {
+    10 {
+      search = _
+      replace.char = 32
+    }
+    20 {
+      search = in da hood
+      replace = around the block
+    }
+    30 {
+      search = #a (Cat|Dog|Tiger)#i
+      replace = an animal
+      useRegExp = 1
+    }
+  }
+}
+]]></description>
+                       <default><![CDATA[]]></default>
+               </property>
                <property name="required" type="boolean">
                        <description><![CDATA[This flag requires the content to be set to some value after any content-import and treatment that might have happend now (data, field, current, listNum, trim). Zero's is NOT regarded as empty! Use "if" instead!
 If the content i empty, "" is returned immediately.]]></description>
                        <default><![CDATA[
 ]]></default>
                </property>
+               <property name="round" type="array">
+                       <description><![CDATA[Round a number.
+
+Additional properties:
+
+.roundType = round (default) | ceil | floor
+.decimals = 0 (default) or number of digits after decimal separator (only with roundType = round)
+
+
+Example:
+temp.number = TEXT
+temp.number {
+  value = 3.14159
+  round.roundType = round
+}
+
+or
+
+temp.number = TEXT
+temp.number {
+  value = 3.14159
+  round.decimals = 2
+}]]></description>
+                       <default><![CDATA[]]></default>
+               </property>
                <property name="setContentToCurrent" type="boolean">
                        <description><![CDATA[Sets the current value to the incoming content of the function.]]></description>
                        <default><![CDATA[