f2ccb938f8ccbd0d8b7568e14b14e6158a312c36
[Packages/TYPO3.CMS.git] / typo3 / sysext / t3editor / Resources / Private / tsref.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <tsRef>
3 <type id="cObj"/>
4 <type id="array"/>
5 <type id="int"/>
6 <type id="intList"/>
7 <type id="double"/>
8 <type id="boolean"/>
9 <type id="string"/>
10 <type id="ADMPANEL"/>
11 <type id="ARR_languages_strings" name="ARR_languages_strings">
12 <property name="default" type="string"/>
13 <property name="en" type="string"/>
14 <property name="dk" type="string"/>
15 <property name="de" type="string"/>
16 <property name="no" type="string"/>
17 <property name="it" type="string"/>
18 <property name="fr" type="string"/>
19 <property name="nl" type="string"/>
20 <property name="cz" type="string"/>
21 <property name="pl" type="string"/>
22 <property name="si" type="string"/>
23 <property name="fi" type="string"/>
24 <property name="tr" type="string"/>
25 <property name="se" type="string"/>
26 <property name="pt" type="string"/>
27 <property name="ru" type="string"/>
28 <property name="ro" type="string"/>
29 <property name="ch" type="string"/>
30 <property name="sk" type="string"/>
31 <property name="lt" type="string"/>
32 <property name="is" type="string"/>
33 <property name="hr" type="string"/>
34 <property name="hu" type="string"/>
35 <property name="gl" type="string"/>
36 <property name="th" type="string"/>
37 <property name="gr" type="string"/>
38 <property name="hk" type="string"/>
39 <property name="eu" type="string"/>
40 <property name="bg" type="string"/>
41 <property name="br" type="string"/>
42 <property name="et" type="string"/>
43 <property name="ar" type="string"/>
44 <property name="he" type="string"/>
45 <property name="ua" type="string"/>
46 <property name="lv" type="string"/>
47 <property name="jp" type="string"/>
48 <property name="vn" type="string"/>
49 <property name="ca" type="string"/>
50 <property name="ba" type="string"/>
51 <property name="kr" type="string"/>
52 <property name="eo" type="string"/>
53 <property name="my" type="string"/>
54 <property name="hi" type="string"/>
55 </type>
56 <type id="CARRAY" extends="stdWrap" name="CARRAY">
57 <property name="1" type="cObj">
58 <description><![CDATA[This is a numerical "array" of content-objects (cObjects). The order by which you specific the objects is not important as the array will be sorted before it's parsed!
59
60 ]]></description>
61 </property>
62 <property name="2" type="cObj">
63 <description><![CDATA[This is a numerical "array" of content-objects (cObjects). The order by which you specific the objects is not important as the array will be sorted before it's parsed!
64
65 ]]></description>
66 </property>
67 <property name="3" type="cObj">
68 <description><![CDATA[This is a numerical "array" of content-objects (cObjects). The order by which you specific the objects is not important as the array will be sorted before it's parsed!
69
70 ]]></description>
71 </property>
72 <property name="4" type="cObj">
73 <description><![CDATA[This is a numerical "array" of content-objects (cObjects). The order by which you specific the objects is not important as the array will be sorted before it's parsed!
74
75 ]]></description>
76 </property>
77 </type>
78 <type id="CARRAY+TDParams" extends="CARRAY" name="CARRAY+TDParams">
79 <property name="TDParams" type="string">
80 <description><![CDATA[<TD>-params
81 NOTE: This applies ONLY if "CARRAY +TDParams" is set to be data type
82 This property is used only in some cases where CARRAY is used. Please look out for a note about that in the various cases.
83 ]]></description>
84 <default><![CDATA[
85 ]]></default>
86 </property>
87 </type>
88 <type id="CASE" extends="cObjArray" name="CASE">
89 <property name="default" type="cObj">
90 <description><![CDATA[The default object, if not defined, nothing is returned in the default case.
91 ]]></description>
92 </property>
93 <property name="if" type="if">
94 <description><![CDATA[if "if" returns false nothing is returned
95
96 ]]></description>
97 </property>
98 <property name="key" type="stdWrap">
99 <description><![CDATA[If the value of this key is defined, that object will be returned, otherwise the default-object will be returned.
100 <pre>key = helloWorld
101 helloWorld = <a href="/index.php/TSref/TEXT" title="TSref/TEXT">TEXT</a>
102
103 helloWorld.value = this item will be returned
104 </pre>
105 ]]></description>
106 </property>
107 <property name="setCurrent" type="stdWrap">
108 <description><![CDATA[Sets the "current"-value.
109
110 ]]></description>
111 </property>
112 <property name="stdWrap" type="stdWrap">
113 <description><![CDATA[stdwrap properties, applied on the returned object.
114 ]]></description>
115 </property>
116 </type>
117 <type id="cObjArray">
118 <property name="1" type="cObj">
119 <description><![CDATA[This is a numerical "array" of content-objects (cObjects).
120 ]]></description>
121 </property>
122 <property name="2" type="cObj">
123 <description><![CDATA[This is a numerical "array" of content-objects (cObjects).
124 ]]></description>
125 </property>
126 <property name="3" type="cObj">
127 <description><![CDATA[This is a numerical "array" of content-objects (cObjects).
128 ]]></description>
129 </property>
130 <property name="4" type="cObj">
131 <description><![CDATA[This is a numerical "array" of content-objects (cObjects).
132 ]]></description>
133 </property>
134 </type>
135 <type id="COBJ_ARRAY" extends="cObjArray">
136 <property name="if" type="if">
137 <description><![CDATA[if "if" returns false the COA is NOT rendered]]></description>
138 <default><![CDATA[
139 ]]></default>
140 </property>
141 <property name="stdWrap" type="stdWrap">
142 <description><![CDATA[
143 ]]></description>
144 <default><![CDATA[
145 ]]></default>
146 </property>
147 <property name="wrap" type="stdWrap">
148 <description><![CDATA[wrap/stdWrap
149 ]]></description>
150 <default><![CDATA[
151 ]]></default>
152 </property>
153 </type>
154 <type id="COA" extends="COBJ_ARRAY">
155 </type>
156 <type id="COA_INT" extends="COBJ_ARRAY">
157 </type>
158 <type id="CONFIG">
159 <property name="ATagParams" type="string">
160 <description><![CDATA[<A>-params
161 Additional parameters to all links in TYPO3 (excluding menu-links)
162 ]]></description>
163 <default><![CDATA[
164 ]]></default>
165 </property>
166 <property name="MP_defaults" type="string">
167 <description><![CDATA[Allows you to set a list of page id numbers which will always have a certain "&MP=..." parameter added.
168
169 Syntax:
170 [id],[id],... : [MP-var] | [id],[id],... : [MP-var] | ...
171
172 Example:
173 config.MP_defaults = 36,37,48 : 2-207
174
175 This will by default add "&MP=2-207" to all links pointing to pages 36,37 and 48]]></description>
176 <default><![CDATA[
177 ]]></default>
178 </property>
179 <property name="MP_disableTypolinkClosestMPvalue" type="boolean">
180 <description><![CDATA[If set, the typolink function will not try to find the closest MP value for the id.]]></description>
181 <default><![CDATA[
182 ]]></default>
183 </property>
184 <property name="MP_mapRootPoints" type="string">
185 <description><![CDATA[list of PIDs/string
186 Defines a list of ID numbers from which the MP-vars are automatically calculated for the branch.
187 The result is used just like MP_defaults are used to find MP-vars if none has been specified prior to the call to \TYPO3\CMS\Core\TypoScript\TemplateService::linkData().
188 You can specify "root" as a special keyword in the list of IDs and that will create a map-tree for the whole site (but this may be VERY processing intensive if there are many pages!).
189 The order of IDs specified may have a significance; Any ID in a branch which is processed already (by a previous ID root point) will not be processed again.]]></description>
190 <default><![CDATA[
191 ]]></default>
192 </property>
193 <property name="USERNAME_substToken" type="string">
194 <description><![CDATA[The is the token used on the page, which should be substituted with the current username IF a front-end user is logged in! If no login, the substitution will not happen.]]></description>
195 <default><![CDATA[<!--###USERNAME###-->]]></default>
196 </property>
197 <property name="USERUID_substToken" type="string">
198 <description><![CDATA[The is the token used on the page, which should be substituted with the current users UID IF a front-end user is logged in! If no login, the substitution will not happen.
199 This value has no default value and only if you specify a value for this token will a substitution process take place.]]></description>
200 <default><![CDATA[
201 ]]></default>
202 </property>
203 <property name="absRefPrefix" type="string">
204 <description><![CDATA[If this value is set, then all relative links in TypoScript are prepended with this string. Used to convert relative paths to absolute paths.
205
206 Note: If you're working on a server where you have both internal and external access, you might to yourself a favour and set the absRefPrefix to the url and path of you site, eg. http://www.typo3.org/. If you do not, you risk to render pages to cache from the internal network and thereby prefix image-references and links with a non-accessible path from outside.]]></description>
207 <default><![CDATA[
208 ]]></default>
209 </property>
210 <property name="additionalHeaders" type="additionalHeadersArray">
211 <description><![CDATA[This property can be used to define additional HTTP headers.
212
213 For each numeric index, there are the following sub-properties:
214
215 header: The header string.
216
217 replace: Optional. If set, previous headers with the same name are replaced with the current one. Default is "1".
218
219 httpResponseCode: Optional. HTTP status code as an integer.
220
221 Example:
222
223 config.additionalHeaders {
224 10 {
225 # The header string
226 header = WWW-Authenticate: Negotiate
227
228 # Do not replace previous headers with the same name.
229 replace = 0
230
231 # Force a 401 HTTP response code
232 httpResponseCode = 401
233 }
234 # Always set cache headers to private, overwriting the default TYPO3 Cache-control header
235 20.header = Cache-control: Private
236 }]]></description>
237 <default><![CDATA[
238 ]]></default>
239 </property>
240 <property name="admPanel" type="ADMPANEL">
241 <description><![CDATA[boolean / ADMPANEL properties
242 If set, the admin panel appears in the bottom of pages.
243
244 NOTE: In addition the panel must be enabled for the user as well, using the TSconfig for the user! See adminguide documentation.
245
246 SEE: Admin Panel section]]></description>
247 <default><![CDATA[
248 ]]></default>
249 </property>
250 <property name="baseURL" type="string">
251 <description><![CDATA[This writes the <base> tag in the header of the document. Set this to the value that is expected to be the URL, and append a "/" to the end of the string.
252
253 Example:
254 config.baseURL = https://typo3.org/sub_dir/]]></description>
255 <default><![CDATA[
256 ]]></default>
257 </property>
258 <property name="cache" type="array">
259 <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.
260
261 To include records of type <tablename> on page <pid> into the cache lifetime calculation of page <page-id>, add the following TypoScript:
262 config.cache.<page-id> = <tablename>:<pid>
263
264 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:
265 config.cache.10 = fe_users:2
266
267 Multiple record sources can be added as comma-separated list, e.g.
268 config.cache.10 = fe_users:2,tt_news:11
269
270 In order to consider records for the cache lifetime of all pages, use the *all* keyword:
271 config.cache.all = fe_users:2]]></description>
272 <default><![CDATA[]]></default>
273 </property>
274 <property name="cache_clearAtMidnight" type="boolean">
275 <description><![CDATA[With this setting the cache always expires at midnight of the day, the page is scheduled to expire.]]></description>
276 <default><![CDATA[false]]></default>
277 </property>
278 <property name="cache_period" type="int">
279 <description><![CDATA[int, seconds
280 The number of second a page may remain in cache.
281 This value is overridden by the value set in the page-record (field="cache_timeout") if this value is greater than zero.]]></description>
282 <default><![CDATA[86400 (=24H)]]></default>
283 </property>
284 <property name="content_from_pid_allowOutsideDomain" type="boolean">
285 <description><![CDATA[Using the "Show content from this page instead" feature allows you to insert content from the current domain only. Setting this option will allow content included from anywhere in the page tree!]]></description>
286 <default><![CDATA[
287 ]]></default>
288 </property>
289 <property name="contentObjectExceptionHandler" type="array">
290 <description><![CDATA[Exceptions which occur during rendering of content objects (typically plugins) will now be caught by default in production context and an error message is shown along with the rendered output.
291
292 Use "1" for the default exception handler (enabled by default in production context)
293 Use "0" to disable the default exception handler
294 Use a class name for individual exception handlers
295
296 See TSref for details:
297 https://docs.typo3.org/typo3cms/TyposcriptReference/Setup/Config/Index.html#contentobjectexceptionhandler
298 ]]></description>
299 <default><![CDATA[
300 ]]></default>
301 </property>
302 <property name="debug" type="boolean">
303 <description><![CDATA[If set any debug-information in the TypoScript code is output. Currently this applies only to the menu-objects]]></description>
304 <default><![CDATA[
305 ]]></default>
306 </property>
307 <property name="defaultGetVars" type="array">
308 <description><![CDATA[Allows to set default values for GET parameters. Default value is taken only if the GET parameter isn't defined. Array notation is done with dots, e.g.:
309
310 test[var1] will be written as text.var1
311
312 Example:
313
314 config.defaultgetVars {
315 test.var1.var2.p3 = 15
316 L = 3
317 }
318 ]]></description>
319 <default><![CDATA[
320 ]]></default>
321 </property>
322 <property name="disableAllHeaderCode" type="boolean">
323 <description><![CDATA[If this is set, none of the features of the PAGE-object is processed and the content of the page will be the result of the cObject array (1,2,3,4...) of the PAGE-object.  This means that the result of the cObject should include everything from the <HTML> .... to the </HTML> tag !!
324 Use this feature in templates supplying other content-types than HTML. That could be an image or a WAP-page!]]></description>
325 <default><![CDATA[false]]></default>
326 </property>
327 <property name="disableCharsetHeader" type="boolean">
328 <description><![CDATA[By default a HTTP header "Content-Type: text/html; charset..." is sent. This option will disable that.]]></description>
329 <default><![CDATA[
330 ]]></default>
331 </property>
332 <property name="disablePageExternalUrl" type="boolean">
333 <description><![CDATA[If set, pages with doktype "External Url" will not trigger jumpUrl in TSFE. This may help you to have external urls open inside you framesets.]]></description>
334 <default><![CDATA[
335 ]]></default>
336 </property>
337 <property name="disablePrefixComment" type="boolean">
338 <description><![CDATA[If set, the stdWrap property "prefixComment" will be disabled, thus preventing any revealing and spaceconsuming comments in the HTML source code.]]></description>
339 <default><![CDATA[
340 ]]></default>
341 </property>
342 <property name="disablePreviewNotification" type="boolean">
343 <description><![CDATA[Disables the "preview" notification box completely]]></description>
344 <default><![CDATA[
345 ]]></default>
346 </property>
347 <property name="doctype" type="string">
348 <description><![CDATA[If set, then a document type declaration (and an XML prologue) will be generated. The value can either be a complete doctype or one of the following keywords:
349
350 "xhtml_trans" for XHTML 1.0 Transitional doctype.
351 "xhtml_strict" for XHTML 1.0 Strict doctype.
352 "xhtml_basic" for XHTML basic doctype.
353 "xhtml_11" for XHTML 1.1 doctype.
354 "xhtml+rdf_10" for XHTML+RDFa 1.0 doctype.
355 "html5" for HTML5
356 "none" for NO doctype at all.
357
358 Note that the keywords also change the way TYPO3 generates some of the XHTML tags to ensure valid XML. If you set doctype to a string, then you must also set config.xhtmlDoctype (see below).
359
360 See "config.htmlTag_setParams" and "config.htmlTag_langKey" for more details on the effect on the html tag.
361 ]]></description>
362 <default><![CDATA[Default is a DOCTYPE like this:
363 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
364 ]]></default>
365 </property>
366 <property name="doctypeSwitch" type="boolean">
367 <description><![CDATA[If set, the order of <?xml...> and <!DOCTYPE...> will be reversed. This is needed for MSIE to be standards compliant with XHTML.
368
369 Background:
370 By default TYPO3 outputs the XML/DOCTYPE in compliance with the standards of XHTML. However a browser like MSIE will still run in "quirks-mode" unless the <?xml> and <DOCTYPE> tags are ordered opposite. But this breaks CSS validation...
371 With this option designers can decide for themselves what they want then.
372
373 If you want to check the compatibility-mode of your webbrowser you can do so with a simple JavaScript that can be inserted on a TYPO3 page like this:
374
375 page.headerData.1 = TEXT
376 page.headerData.1.value = <script>alert(document.compatMode);</script>
377
378 If your browser has detected the DOCTYPE correctly it will report "CSS1Compat"
379 If you are not running in compliance mode you will get some other message. MSIE will report "BackCompat" for instance - this means it runs in quirks-mode, supporting all the old "browser-bugs".]]></description>
380 <default><![CDATA[
381 ]]></default>
382 </property>
383 <property name="enableContentLengthHeader" type="boolean">
384 <description><![CDATA[If set, a header "content-length: [bytes of content]" is sent.]]></description>
385 <default><![CDATA[
386 ]]></default>
387 </property>
388 <property name="extTarget" type="string">
389 <description><![CDATA[default external target. Used by typolink if no extTarget is set]]></description>
390 <default><![CDATA[_top]]></default>
391 </property>
392 <property name="fileTarget" type="string">
393 <description><![CDATA[Default file link target. Used by typolink if no fileTarget is set. ]]></description>
394 <default><![CDATA[
395 ]]></default>
396 </property>
397 <property name="forceTypeValue" type="int">
398 <description><![CDATA[Force the &type value of all TYPO3 generated links to a specific value (except if overruled by local forceTypeValue values).
399 Useful if you run a template with special content at - say &type=95 - but still wants to keep your targets neutral. Then you set your targets to blank and this value to the type value you wish.]]></description>
400 <default><![CDATA[
401 ]]></default>
402 </property>
403 <property name="frontend_editing" type="boolean">
404 <description><![CDATA[If set, then frontend editing is enabled (requires EXT:frontend_editing being installed).]]></description>
405 <default><![CDATA[false]]></default>
406 </property>
407 <property name="ftu" type="boolean">
408 <description><![CDATA[If set, the "&ftu=...." GET-fallback identification is inserted.
409 "&ftu=[hash]" is always inserted in the links on the first page a user hits. If it turns out in the next hit that the user has cookies enabled, this variable is not set anymore as the cookies does the job. If no cookies is accepted the "ftu" remains set for all links on the site and thereby we can still track the user.
410
411 You should not set this feature if grabber-spiders like Teleport are going to grab your site!
412 You should not set this feature if you want search-engines to index your site.
413
414 You can also ignore this feature if you're certain, website users will use cookies.
415  "ftu" means fe_typo_user ("fe" is "frontend").]]></description>
416 <default><![CDATA[false]]></default>
417 </property>
418 <property name="headerComment " type="string">
419 <description><![CDATA[The content is added before the "TYPO3 Content Management Framework" comment in the <head> section of the page. Use this to insert a note like that "Programmed by My-Agency" ...]]></description>
420 <default><![CDATA[
421 ]]></default>
422 </property>
423 <property name="htmlTag_dir" type="string">
424 <description><![CDATA[Sets text direction for whole document (useful for display of Arabic, Hebrew pages).
425
426 Basically the value becomes the attribute value of "dir" for the <html> tag.
427
428 Values:
429 rtl = Right-To-Left (for Arabic / Hebrew)
430 ltr = Left-To-Right (Default for other languages)
431
432 Example:
433 config.htmlTag_dir = rtl]]></description>
434 <default><![CDATA[
435 ]]></default>
436 </property>
437 <property name="htmlTag_langKey" type="string">
438 <description><![CDATA[Allows you to set the language value for the attributes "xml:lang" and "lang" in the <html> tag (when using "config.doctype = xhtml*").
439
440 The values must follow the format specified in IETF RFC 3066
441
442 Example:
443 config.htmlTag_langKey = en-US]]></description>
444 <default><![CDATA[en]]></default>
445 </property>
446 <property name="htmlTag_setParams" type="string">
447 <description><![CDATA[Sets the attributes for the <html> tag on the page. If you set "config.doctype" to a keyword enabling XHTML then some attributes are already set. This property allows you to override any preset attributes with you own content if needed.
448
449 Special: If you set it to "none" then no attributes will be set at any event.
450
451 Example:
452 config.htmlTag_setParams =  xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US"]]></description>
453 <default><![CDATA[
454 ]]></default>
455 </property>
456 <property name="includeLibrary" type="string">
457 <description><![CDATA[This includes a phpfile.]]></description>
458 <default><![CDATA[
459 ]]></default>
460 </property>
461 <property name="index_descrLgd" type="int">
462 <description><![CDATA[This indicates how many chars to preserve as description for an indexed page. This may be used in the search result display.]]></description>
463 <default><![CDATA[200]]></default>
464 </property>
465 <property name="index_enable" type="boolean">
466 <description><![CDATA[Enables cached pages to be indexed.]]></description>
467 <default><![CDATA[
468 ]]></default>
469 </property>
470 <property name="index_externals" type="boolean">
471 <description><![CDATA[If set, external media linked to on the pages is indexed as well.]]></description>
472 <default><![CDATA[
473 ]]></default>
474 </property>
475 <property name="inlineStyle2TempFile" type="boolean">
476 <description><![CDATA[If set, the inline styles TYPO3 controls in the core are written to a file,  typo3temp/assets/css/stylesheet_[hashstring].css, and the header will only contain the link to the stylesheet.
477 The file hash is based solely on the content of the styles.
478
479 Depends on the compatibility mode (see Tools>Install>Update wizard):
480 compatibility mode < 4.0:   0
481 compatibility mode >= 4.0:   1
482
483 Example:
484 config.inlineStyle2TempFile = 1]]></description>
485 <default><![CDATA[
486 ]]></default>
487 </property>
488 <property name="intTarget" type="string">
489 <description><![CDATA[default internal target. Used by typolink if no target is set]]></description>
490 <default><![CDATA[
491 ]]></default>
492 </property>
493 <property name="language" type="string">
494 <description><![CDATA[Language key. See stdWrap.lang for more information.
495 Select between:
496 English  (default) = [empty]
497 Danish = dk
498 German = de
499 Norwegian = no
500 Italian = it
501 etc...
502
503 Value must correspond with the key used for backend system language if there is one. Look at the translation page on TYPO3.org for the official 2-byte key for a given language. Notice that selecting the official key is important if you want labels in the correct language from "locallang" files.
504 If the language you need is not yet a system language in TYPO3 you can use an artificial string of your choice and provide values for it via the TypoScript template where the property "_LOCAL_LANG" for most plugins will provide a way to override/add values for labels. The keys to use must be looked up in the locallang-file used by the plugin of course.]]></description>
505 <default><![CDATA[
506 ]]></default>
507 </property>
508 <property name="language_alt" type="string">
509 <description><![CDATA[If "config.language" (above) is used, this can be set to another language key which will be used for labels if a label was not found for the main language. For instance a brazil portuguese website might specify "pt" as alternative language which means the portuguese label will be shown if none was available in the main language, brazil portuguese. This feature makes sense if one language is incompletely translated and close to another language.]]></description>
510 <default><![CDATA[
511 ]]></default>
512 </property>
513 <property name="linkVars" type="string">
514 <description><![CDATA[HTTP_GET_VARS, which should be passed on with links in TYPO3. This is compiled into a string stored in $GLOBALS["TSFE"]->linkVars
515
516 The values are rawurlencoded in PHP.
517
518 You can specify a range of valid values by appending a () after each value. If this range does not match, the variable won't be appended to links. This is very important to prevent that the cache system gets flooded with forged values.
519
520 The range may containing one of these values:
521 [a]-[b] - A range of allowed integer valuesint - Only integer values are allowed[a]|[b]|[c] - A list of allowed strings (whitespaces will be removed)/[regex]/ - Match against a regular expression (PCRE style)
522
523 Example:
524 config.linkVars = L, print
525 This will add "&L=[L-value]&print=[print-value]" to all links in TYPO3.
526
527 config.linkVars = L(1-3), print
528 Same as above, but "&L=[L-value]" will only be added if the current value is 1, 2 or 3.
529 ]]></description>
530 <default><![CDATA[
531 ]]></default>
532 </property>
533 <property name="locale_all" type="string">
534 <description><![CDATA[PHP: setlocale("LC_ALL", [value]);
535 value-examples: deutsch, de_DE, danish, portuguese, spanish, french, norwegian, italian. See www.php.net for other value. Also on linux, look at /usr/share/locale/
536
537 Example:
538 This will render dates in danish made with stdWrap/strftime:
539 locale_all = danish
540 locale_all = da_DK]]></description>
541 <default><![CDATA[
542 ]]></default>
543 </property>
544 <property name="lockFilePath" type="string">
545 <description><![CDATA[This is used to lock paths to be "inside" this path.
546 Used by "filelist" in stdWrap]]></description>
547 <default><![CDATA[fileadmin/]]></default>
548 </property>
549 <property name="message_page_is_being_generated" type="string">
550 <description><![CDATA[Alternative HTML message that appears if a page is being generated.
551 Normally when a page is being generated a temporary copy is stored in the cache-table with an expire-time of 30 seconds.
552
553 It is possible to use some keywords that are replaced with the corresponding values. Possible keywords are: ###TITLE###, ###REQUEST_URI###]]></description>
554 <default><![CDATA[
555 ]]></default>
556 </property>
557 <property name="message_preview" type="string">
558 <description><![CDATA[Alternative message in HTML that appears when the preview function is active!]]></description>
559 <default><![CDATA[
560 ]]></default>
561 </property>
562 <property name="message_preview_workspace" type="string ">
563 <description><![CDATA[Alternative message in HTML that appears when the preview function is active in a draft workspace. You can use sprintf() placeholders for Workspace title (first) and number (second).
564
565 Examples:
566 config.message_preview_workspace = <div class="previewbox">Displaying workspace named "%s" (number %s)!</div>
567 config.message_preview_workspace = <div class="previewbox">Displaying workspace number %2$s named "%1$s"!</div>]]></description>
568 <default><![CDATA[
569 ]]></default>
570 </property>
571 <property name="metaCharset" type="string">
572 <description><![CDATA[Charset used for the output document. For example in the meta tag:
573 <meta http-equiv="Content-Type" content="text/html; charset=...>
574
575 Is used for a) HTML meta-tag, b) HTTP header (unless disabled with .disableCharsetHeader) and c) xhtml prologues (if available)
576
577 If metaCharset is different than utf-8 the output content is automatically converted to metaCharset before output and likewise are values posted back to the page converted from metaCharset to utf-8 for internal processing. This conversion takes time of course so there is another good reason to use the same charset for both.]]></description>
578 <default><![CDATA[utf-8]]></default>
579 </property>
580 <property name="moveJsFromHeaderToFooter" type="boolean">
581 <description><![CDATA[
582 If set, all Javascript (includes and inline) will be moved to the bottom of the HTML document, which is after content and before the closing body tag
583 ]]></description>
584 <default><![CDATA[
585 ]]></default>
586 </property>
587 <property name="namespaces" type="array">
588 <description><![CDATA[array of strings
589 This property enables you to add xml namespaces (xmlns) to the html tag. The configuration
590
591 namespaces.dc = http://purl.org/dc/elements/1.1/
592 namespaces.foaf = http://xmlns.com/foaf/0.1/
593
594 will result in a html tag like
595
596 <html xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:foaf="http://xmlns.com/foaf/0.1/">
597
598 This is especially useful if you want to add RDFa or microformats to your html.
599 ]]></description>
600 <default><![CDATA[
601 ]]></default>
602 </property>
603 <property name="noPageTitle" type="int">
604 <description><![CDATA[If you only want to have the sitename (from the template record) in your <title> tag, set this to 1. If the value is 2 then the <title> tag is not printed at all.
605 Please take note that this tag is required for XHTML compliant output, so you should only disable this tag if you generate it manually already.]]></description>
606 <default><![CDATA[0]]></default>
607 </property>
608 <property name="no_cache" type="boolean">
609 <description><![CDATA[If this is set to true, the page will not be cached. If set to false, it's ignored. Other parameters may have set it to true of other reasons.]]></description>
610 <default><![CDATA[-]]></default>
611 </property>
612 <property name="pageRendererTemplateFile" type="string">
613 <description><![CDATA[
614 Sets the template for page renderer class (\TYPO3\CMS\Core\Page\PageRenderer).
615
616 Example:
617
618 pageRendererTemplateFile = fileadmin/test_pagerender.html
619 ]]></description>
620 <default><![CDATA[
621 ]]></default>
622 </property>
623 <property name="pageTitleFirst" type="boolean">
624 <description><![CDATA[If set (and the page title is printed) then the page-title will be printed BEFORE the template title.]]></description>
625 <default><![CDATA[
626 ]]></default>
627 </property>
628 <property name="pageTitleSeparator" type="string">
629 <description><![CDATA[The signs which should be printed in the title tag between the website name and the page title.]]></description>
630 <default><![CDATA[:]]></default>
631 </property>
632 <property name="prefixLocalAnchors" type="string">
633 <description><![CDATA[If set to one of the keywords, the content will have all local anchors in links prefixed with the path of the script. Basically this means that <a href="#"> will be transformed to <a href="path/path/script?params#">. This procedure is necessary if the <base> tag is set in the script (eg. if "realurl" extension is used to produce Speaking URLs).
634
635 Keywords are the same as for "xhtml_cleaning", see above.]]></description>
636 <default><![CDATA[
637 ]]></default>
638 </property>
639 <property name="removeDefaultCss" type="boolean">
640 <description><![CDATA[Remove CSS generated by _CSS_DEFAULT_STYLE configuration of extensions.]]></description>
641 <default><![CDATA[false]]></default>
642 </property>
643 <property name="removePageCss" type="boolean">
644 <description><![CDATA[Remove CSS generated by _CSS_PAGE_STYLE configuration of extensions.]]></description>
645 <default><![CDATA[false]]></default>
646 </property>
647 <property name="removeDefaultJS" type="string">
648 <description><![CDATA[If set, the default JavaScript in the header will be removed.
649 The default JavaScript is the decryption function for email addresses.
650
651 Special case: if the value is "external" then the default JavaScript is written to a temporary file and included from that file. See "inlineStyle2TempFile" below.
652
653 Depends on the compatibility mode (see Tools>Install>Update wizard):
654 compatibility mode < 4.0:   0
655 compatibility mode >= 4.0:   1
656
657 Example:
658 config.removeDefaultJS = external
659 config.removeDefaultJS = 1]]></description>
660 <default><![CDATA[
661 ]]></default>
662 </property>
663 <property name="compressJs" type="boolean">
664 <description><![CDATA[Enabling this option together with $TYPO3_CONF_VARS['FE']['compressionLevel'] in the Install Tool delivers Frontend JavaScript files using GZIP compression.
665
666 This can significantly reduce file sizes of linked JavaScript files and thus decrease loading times.
667
668 Please not that this requires .htaccess to be adjusted, as otherwise the files will not be readable by the user agent. Please see the description of $TYPO3_CONF_VARS['FE']['compressionLevel'] in the Install Tool.
669
670 Example:
671
672 config.compressJs = 1
673 ]]></description>
674 <default><![CDATA[false]]></default>
675 </property>
676 <property name="compressCss" type="boolean">
677 <description><![CDATA[If set, CSS files will be minified and compressed.
678
679 Minification will remove all excess space. The more significant compression step (using Gzip compression) requires $TYPO3_CONF_VARS['FE']['compressionLevel'] to be enabled in the Install Tool together with the gzip-related compressionLevel options in .htaccess, as otherwise the files will not be readable by the user agent.
680
681 Example:
682
683 config.compressCss = 1]]></description>
684 <default><![CDATA[false]]></default>
685 </property>
686 <property name="concatenateJs" type="boolean">
687 <description><![CDATA[Setting config.concatenateJs merges Javascript files referenced in the Frontend together.
688
689 Example:
690
691 config.concatenateJs = 1
692
693 Note: TYPO3 comes with a built-in concatenation handler, but you can also register your own one using $GLOBALS['TYPO3_CONF_VARS']['FE']['jsConcatenateHandler'].
694
695 Example:
696
697 $GLOBALS['TYPO3_CONF_VARS']['FE']['jsConcatenateHandler'] = \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extPath($_EXTKEY) . 'Classes/class.tx_myext_jsConcatenateHandler.php:tx_myext_jsConcatenateHandler->concatenateJs';]]></description>
698 <default><![CDATA[false]]></default>
699 </property>
700 <property name="concatenateCss" type="boolean">
701 <description><![CDATA[Setting config.concatenateCss merges Stylesheet files referenced in the Frontend together.
702
703 Example:
704
705 config.concatenateCss = 1
706
707 Note: TYPO3 comes with a built-in concatenation handler, but you can also register your own using $GLOBALS['TYPO3_CONF_VARS']['FE']['cssConcatenateHandler'].
708
709 Example:
710
711 $GLOBALS['TYPO3_CONF_VARS']['FE']['cssConcatenateHandler'] = \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extPath($_EXTKEY) . 'Classes/class.tx_myext_cssConcatenateHandler.php:tx_myext_cssConcatenateHandler->concatenateCss';]]></description>
712 <default><![CDATA[false]]></default>
713 </property>
714 <property name="sendCacheHeaders" type="boolean">
715 <description><![CDATA[If set, TYPO3 will output cache-control headers to the client based mainly on  whether the page was cached internally. This feature allows client browsers and/or reverse proxies to take load of TYPO3 websites.
716
717 The conditions for allowing client caching are:
718 page was cachedNo *_INT or *_EXT objects were on the page (eg. USER_INT)No frontend user is logged inNo backend user is logged in
719
720 If these conditions are met, the headers sent are:
721 Last-Modified [SYS_LASTCHANGED of page id]Expires [expire time of page cache]ETag [md5 of content]Cache-Control: max-age: [seconds til expiretime]Pragma: public
722
723 In case caching is not allowed, these headers are sent to avoid client caching:
724 Cache-Control: private
725
726 Notice that enabling the browser caches means you have to consider how log files are written. Because when a page is cached on the client it will not invoke a request to the webserver, thus not writing the request to the log. There should be ways to circumvent these problems but they are outside the domain of TYPO3 in any case.
727
728 Tip: Enabling cache-control headers might confuse editors seeing old content served from the browser cache. "Shift-Reload" will bypass both browser- and reverse-proxy caches and even make TYPO3 regenerate the page. Teach them that trick!
729
730 Thanks to Ole Tange, www.forbrug.dk for co-authoring this feature.]]></description>
731 <default><![CDATA[
732 ]]></default>
733 </property>
734 <property name="sendCacheHeaders_onlyWhenLoginDeniedInBranch" type="boolean">
735 <description><![CDATA[If this is set, then cache-control headers allowing client caching is sent only if user-logins are disabled for the branch. This feature makes it easier to manage client caching on sites where you have a mixture of static pages and dynamic sections with user logins.
736
737 The background problem is this: In TYPO3 the same URL can show different content depending on whether a user is logged in or not. If a user is logged in, cache-headers will never allow client caching. But if the same URL was visited without a login prior to the login (allowing caching) the user will still see the page from cache when logged in (and so thinks he is not logged in anyway)! The only general way to prevent this is to have a different URL for pages when users are logged in (which the extension "realurl" can accomplish).
738
739 Another way to solve the problem is using this option in combination with disabling and enabling logins in various sections of the site. In the page records ("Advanced" page types) you can disable frontend user logins for branches of the page tree. Since many sites only needs the login in a certain branch of the page tree, disabling it in all other branches makes it much easier to use cache-headers in combination with logins; Cache-headers should simply be sent when logins are not allowed and never be send when logins are allowed! Then there will never be problems with logins and same-URLs.]]></description>
740 <default><![CDATA[
741 ]]></default>
742 </property>
743 <property name="spamProtectEmailAddresses" type="string">
744 <description><![CDATA["ascii" / -10 to 10
745 If set, then all email addresses in typolinks will be encrypted so spam bots cannot detect them.
746
747 If you set this value to a number, then the encryption is simply an
748 offset of character values. If you set this value to "-2" then all
749 characters will have their ASCII value offset by "-2". To make this
750 possible, a little JavaScript code is added to every generated web page!
751 (It is recommended to set the value in the range from -5 to 1 since setting it to >= 2 means a "z" is converted to "|" which is a special character in TYPO3 tables syntax – and that might confuse columns in tables. Now hardcoded range)
752
753 Alternatively you can set this value to the keyword "ascii". This way every
754 character of the "mailto:" address will be translated to a Unicode HTML
755 notation. Have a look at the example to see how this works.
756
757 Example:
758 mailto:a@b.c will be converted to
759 mailto:&#97;&#64;&#98;&#46;&#99;
760 The big advantage of this method is that it doesn't need any JavaScript!]]></description>
761 <default><![CDATA[
762 ]]></default>
763 </property>
764 <property name="spamProtectEmailAddresses_atSubst" type="string">
765 <description><![CDATA[Substitute label for the at-sign (@).]]></description>
766 <default><![CDATA[(at)]]></default>
767 </property>
768 <property name="spamProtectEmailAddresses_lastDotSubst" type="string">
769 <description><![CDATA[Substitute label for the last dot in the email address.
770 Example: (dot)]]></description>
771 <default><![CDATA[Default: . ( <= just a simple dot)]]></default>
772 </property>
773 <property name="sword_noMixedCase" type="boolean">
774 <description><![CDATA[Used by the parseFunc-substitution of search Words (sword):
775 If set, the words MUST be the exact same case as the search word was.]]></description>
776 <default><![CDATA[
777 ]]></default>
778 </property>
779 <property name="sword_standAlone" type="boolean">
780 <description><![CDATA[Used by the parseFunc-substitution of search Words (sword):
781 If set, the words MUST be surrounded by whitespace in order to be marked up.]]></description>
782 <default><![CDATA[
783 ]]></default>
784 </property>
785 <property name="sys_language_mode" type="string">
786 <description><![CDATA[Setting various modes of handling localization.
787 The syntax is "[keyword] ; [value]".
788
789 Possible keywords are:
790
791 [default] - The system will look for a translation of the page (from "Alternative Page Language" table) and if it is not found it will fall back to the default language and display that.
792
793 content_fallback - [ Recommended ] The system will always operate with the selected language even if the page is not translated with a page overlay record. This will keep menus etc. translated. However, the content on the page can still fall back to another language, defined by the value of this keyword, eg. "content_fallback ; 1,0" to fall back to the content of sys_language_uid 1 and if that is not present either, to default (0)
794
795 strict - The system will report an error if the requested translation does not exist. Basically this means that all pages with gray background in the Web>Info / Localization overview module will fail (they would otherwise fall back to default language in one or another way)
796
797 ignore - The system will stay with the selected language even if the page is not translated and there's no content available in this language, so you can handle that situation on your own then.]]></description>
798 <default><![CDATA[
799 ]]></default>
800 </property>
801 <property name="sys_language_overlay" type="string">
802 <description><![CDATA[boolean / keyword
803 If set, records from certain tables selected by the CONTENT cObject using the "languageField" setting will select the default language (0) instead of any language set by sys_language_uid / sys_language_mode. In addition the system will look for a translation of the selected record and overlay configured fields.
804 The requirements for this is that the table is configured with "languageField" and "transOrigPointerField" in the [ctrl] section of $TCA. Also, exclusion of certain fields can be done with the "l10n_mode" directive in the field-configuration of $TCA.
805
806 For backend administration this requires that you configure the "Web>Page" module to display content elements accordingly; That each default element is shown and next to it any translation found. This configuration can be done with Page TSconfig for a section of the website using the object path "mod.web_layout.defLangBinding = 1".
807
808 Keyword:
809 hideNonTranslated : If this keyword is used a record that has no translation will not be shown. The default is that records with no translation will show up in the default language.]]></description>
810 <default><![CDATA[
811 ]]></default>
812 </property>
813 <property name="sys_language_uid" type="int">
814 <description><![CDATA[This value points to the uid of a record from the "sys_language" table and if set, this means that various parts of the frontend display code will select records which are assigned to this language. See ->SELECT
815
816 Internally, the value is depending on whether a Alternative Page Language record can be found with that language. If not, the value will default to zero (default language) except if "sys_language_mode" is set to a value like "content_fallback".]]></description>
817 <default><![CDATA[
818 ]]></default>
819 </property>
820 <property name="titleTagFunction " type="string">
821 <description><![CDATA[function-name
822 Passes the default <title>-tag content to this function. No typoScript parameters are passed though.]]></description>
823 <default><![CDATA[
824 ]]></default>
825 </property>
826 <property name="typolinkEnableLinksAcrossDomains" type="boolean">
827 <description><![CDATA[This option enables to create links across domains using current domain's linking scheme.
828
829 If this option is not set, then all cross-domain links will be generated as
830
831 "http://domain.tld/index.php?id=12345" (where 12345 is page id). Setting this option requires that domains, where pages are linked, have the same configuration for:
832
833 - linking scheme (i.e. all use RealURL or CoolURI but not any mixture)
834 - all domains have identical localization settings (config.sys_language_XXX directives)
835 - all domains have the same set of languages defined
836
837 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>
838 <default><![CDATA[
839 ]]></default>
840 </property>
841 <property name="typolinkLinkAccessRestrictedPages" type="string">
842 <description><![CDATA[integer (page id) / keyword "NONE"
843 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.
844 If the value is "NONE" the original link to the page will be kept although it will generate a page-not-found situation (which can of course be picked up properly by the page-not-found handler and present a nice login form).
845
846 See "showAccessRestrictedPages" for menu objects as well (similar feature for menus)
847
848 Example:
849 config.typolinkLinkAccessRestrictedPages = 29
850 config.typolinkLinkAccessRestrictedPages_addParams = &return_url=###RETURN_URL###&pageId=###PAGE_ID###
851
852 Will create a link to page with id 29 and add GET parameters where the return URL and original page id is a part of it.]]></description>
853 <default><![CDATA[
854 ]]></default>
855 </property>
856 <property name="typolinkLinkAccessRestrictedPages_addParams" type="string">
857 <description><![CDATA[See "typolinkLinkAccessRestrictedPages" above]]></description>
858 <default><![CDATA[
859 ]]></default>
860 </property>
861 <property name="xhtmlDoctype" type="string">
862 <description><![CDATA[Sets the document type for the XHTML version of the generated page.
863
864 If config.doctype is set to a string then config.xhtmlDoctype must be set to one of these keywords:
865
866 "xhtml_trans" for XHTML 1.0 Transitional doctype.
867 "xhtml_strict" for XHTML 1.0 Strict doctype.
868 "xhtml_basic" for XHTML basic doctype.
869 "xhtml_11" for XHTML 1.1 doctype.
870
871
872 This is an example to use MathML 2.0 in an XHTML 1.1 document:
873
874 config.doctype (
875 <!DOCTYPE html
876 PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0//EN"
877 "http://www.w3.org/Math/DTD/mathml2/xhtml-math11-f.dtd">
878 )
879 config.xhtmlDoctype = xhtml_11
880
881 Default:
882 same as config.doctype if set to a keyword]]></description>
883 <default><![CDATA[
884 ]]></default>
885 </property>
886 <property name="xhtml_cleaning" type="string">
887 <description><![CDATA[Tries to clean up the output to make it XHTML compliant and a bit more. THIS IS NOT COMPLETE YET, but a "pilot" to see if it makes sense anyways. For now this is what is done:
888
889 What it does at this point:
890 - All tags (img,br,hr) is ended with "/>" - others?
891 - Lowercase for elements and attributes
892 - All attributes in quotes
893 - Add "alt" attribute to img-tags if it's not there already.
894
895 What it does NOT do (yet) according to XHTML specs.:
896 - Wellformedness: Nesting is NOT checked
897 - name/id attribute issue is not observed at this point.
898 - Certain nesting of elements not allowed. Most interesting, <PRE> cannot contain img, big,small,sub,sup ...
899 - Wrapping scripts and style element contents in CDATA - or alternatively they should have entitites converted.
900 - Setting charsets may put some special requirements on both XML declaration/ meta-http-equiv. (C.9)
901 - UTF-8 encoding is in fact expected by XML!!
902 - stylesheet element and attribute names are NOT converted to lowercase
903 - ampersands (and entities in general I think) MUST be converted to an entity reference! (&amps;). This may mean further conversion of non-tag content before output to page. May be related to the charset issue as a whole.
904 - Minimized values not allowed: Must do this: selected="selected"
905
906 Please see the class \TYPO3\CMS\Core\Html\HtmlParser for details.
907 You can enable this function by the following values:
908
909 all = the content is always processed before it may be stored in cache.
910 cached = only if the page is put into the cache,
911 output = only the output code just before it's echoed out.]]></description>
912 <default><![CDATA[
913 ]]></default>
914 </property>
915 <property name="xmlprologue" type="string">
916 <description><![CDATA[If empty (not set) then the default XML 1.0 prologue is set, when the doctype is set to a known keyword (eg xhtml_11):
917
918 <?xml version="1.0" encoding="utf-8">
919
920 If set to one of the know keywords then a standard prologue will be set:
921 "xml_10" XML 1.0 prologue (see above)
922 "xml_11" XML 1.1 prologue
923
924 If "none" then the default XML prologue is not set.
925 Any other string is used as the XML prologue itself.]]></description>
926 <default><![CDATA[
927 ]]></default>
928 </property>
929 </type>
930 <type id="CONTENT">
931 <property name="renderObj" type="cObj">
932 <description><![CDATA[
933 ]]></description>
934 <default><![CDATA[< [tablename]]]></default>
935 </property>
936 <property name="select" type="select">
937 <description><![CDATA[The SQL-statement is set here!]]></description>
938 <default><![CDATA[
939 ]]></default>
940 </property>
941 <property name="slide" type="slide">
942 <description><![CDATA[int/stdWrap
943 If set and no content element is found by the select command, then the rootLine will be traversed back until some content is found.
944
945 Possible values are "-1" (slide back up to the siteroot), "1" (only the current level) and "2" (up from one level back).
946
947 Use -1 in combination with collect.
948
949 .collect (integer/stdWrap): If set, all content elements found on current and parent pages will be collected. Otherwise, the sliding would stop after the first hit. Set this value to the amount of levels to collect on, or use "-1" to collect up to the siteroot.
950 .collectFuzzy (boolean/stdWrap): Only useful in collect mode. If no content elements have been found for the specified depth in collect mode, traverse further until at least one match has occurred.
951 .collectReverse (boolean/stdWrap): Change order of elements in collect mode. If set, elements of the current page will be on the bottom.]]></description>
952 <default><![CDATA[
953 ]]></default>
954 </property>
955 <property name="stdWrap" type="stdWrap">
956 <description><![CDATA[
957 ]]></description>
958 <default><![CDATA[
959 ]]></default>
960 </property>
961 <property name="table" type="stdWrap">
962 <description><![CDATA[TableName/stdWrap
963 The table, the content should come from.
964 In standard-configurations this will be "tt_content"
965 NOTE: Only tables allowed are "pages" or tables prefixed with one of these: "tt_", "tx_", "ttx_", "fe_", "user_" or "static_"]]></description>
966 <default><![CDATA[
967 ]]></default>
968 </property>
969 <property name="wrap" type="stdWrap">
970 <description><![CDATA[wrap/stdWrap
971 Wrap the whole content-story...]]></description>
972 <default><![CDATA[
973 ]]></default>
974 </property>
975 </type>
976 <type id="slide" extends="stdWrap">
977 <property name="collect" type="stdWrap">
978 <description><![CDATA[int/stdWrap
979 If set, all content elements found on current and parent pages will be collected. Otherwise, the sliding would stop after the first hit. Set this value to the amount of levels to collect on, or use “-1” to collect up to the siteroot.
980 ]]></description>
981 <default><![CDATA[
982 ]]></default>
983 </property>
984 <property name="collectFuzzy" type="stdWrap">
985 <description><![CDATA[boolean/stdWrap
986 Only useful in collect mode. If no content elements have been found for the specified depth in collect mode, traverse further until at least one match has occurred.
987 ]]></description>
988 <default><![CDATA[
989 ]]></default>
990 </property>
991 <property name="collectReverse" type="stdWrap">
992 <description><![CDATA[boolean/stdWrap
993 Change order of elements in collect mode. If set, elements of the current page will be at the bottom.
994 ]]></description>
995 <default><![CDATA[
996 ]]></default>
997 </property>
998 </type>
999 <type id="EDITPANEL">
1000 <property name="allow" type="string">
1001 <description><![CDATA[Define which functions are accessible. Further this list may be reduced, if the BE_USER does not have permission to perform the action
1002 Values should be listed separated by comma. This is the options you can choose between:
1003 toolbar,edit,new,delete,move,hide
1004 (toolbar is a general list of icons regarding the page, so use this for pagerecords only)]]></description>
1005 <default><![CDATA[
1006 ]]></default>
1007 </property>
1008 <property name="edit.displayRecord" type="boolean">
1009 <description><![CDATA[If set, then the record edited is displayed above the editing form.]]></description>
1010 <default><![CDATA[
1011 ]]></default>
1012 </property>
1013 <property name="innerWrap" type="wrap">
1014 <description><![CDATA[Wraps the edit panel]]></description>
1015 <default><![CDATA[
1016 ]]></default>
1017 </property>
1018 <property name="label" type="string">
1019 <description><![CDATA[Title for the panel. You can insert the record title with %s
1020
1021 Example:
1022 Section: <B>%s</B>]]></description>
1023 <default><![CDATA[
1024 ]]></default>
1025 </property>
1026 <property name="line" type="int">
1027 <description><![CDATA[boolean / int
1028 If set, a black line will appear after the panel. This value will indicate the distance from the black line to the panel]]></description>
1029 <default><![CDATA[
1030 ]]></default>
1031 </property>
1032 <property name="newRecordFromTable" type="string">
1033 <description><![CDATA[Will display a panel for creation of new element (in the top of list) on the page from that table.]]></description>
1034 <default><![CDATA[
1035 ]]></default>
1036 </property>
1037 <property name="newRecordInPid" type="int">
1038 <description><![CDATA[Define a page ID where new records (except new pages) will be created.]]></description>
1039 <default><![CDATA[
1040 ]]></default>
1041 </property>
1042 <property name="onlyCurrentPid" type="boolean">
1043 <description><![CDATA[If set, only records with a pid matching the current id (TSFE->id) will be shown with the panel.]]></description>
1044 <default><![CDATA[
1045 ]]></default>
1046 </property>
1047 <property name="outerWrap" type="wrap">
1048 <description><![CDATA[Wraps the whole edit panel including the black line (if configured)]]></description>
1049 <default><![CDATA[
1050 ]]></default>
1051 </property>
1052 <property name="previewBorder" type="int">
1053 <description><![CDATA[boolean / int
1054 If set, the hidden/starttime/endtime/fe_user elements which are previewed will have a border around.
1055 The integer value denotes the thickness of the border]]></description>
1056 <default><![CDATA[
1057 ]]></default>
1058 </property>
1059 <property name="previewBorder.innerWrap" type="string">
1060 <description><![CDATA[wrap / HTML color
1061 innerWrap wraps the content elements (including the icons) inside the preview border (an HTML table).
1062
1063 outerWrap wraps the whole content element including the border.
1064
1065 color denotes the color of the border.]]></description>
1066 <default><![CDATA[
1067 ]]></default>
1068 </property>
1069 </type>
1070 <type id="extbase" name="extbase">
1071 <property name="pluginName" type="stdWrap">
1072 <description><![CDATA[string/stdWrap
1073 Sets variables for initializing extbase.]]></description>
1074 <default><![CDATA[]]></default>
1075 </property>
1076 <property name="controllerExtensionName" type="stdWrap">
1077 <description><![CDATA[string/stdWrap
1078 Sets the extension name of the controller.
1079 Important: This is for example essential if you have translations at the usual paths in your extension and want to use them right away in your template via <f:translate/>.]]></description>
1080 <default><![CDATA[]]></default>
1081 </property>
1082 <property name="controllerName" type="stdWrap">
1083 <description><![CDATA[string/stdWrap
1084 Sets the name of the controller.]]></description>
1085 <default><![CDATA[]]></default>
1086 </property>
1087 <property name="controllerActionName" type="stdWrap">
1088 <description><![CDATA[string/stdWrap
1089 Sets the name of the action.]]></description>
1090 <default><![CDATA[]]></default>
1091 </property>
1092 </type>
1093 <type id="FILE">
1094 <property name="altText" type="stdWrap">
1095 <description><![CDATA[For <img> output only!
1096
1097 If no alttext is specified, it will use an empty alttext]]></description>
1098 <default><![CDATA[
1099 ]]></default>
1100 </property>
1101 <property name="emptyTitleHandling" type="string">
1102 <description><![CDATA[Value can be "keepEmpty" to preserve an empty title attribute, or "useAlt" to use the alt attribute instead.
1103 ]]></description>
1104 <default><![CDATA[useAlt
1105 ]]></default>
1106 </property>
1107 <property name="file" type="stdWrap">
1108 <description><![CDATA[resource/stdWrap
1109 If the resource is jpg,gif,jpeg,png the image is inserted as an image-tag. Al other formats is read and inserted into the HTML-code.
1110 The maximum filesize of documents to be read is set to 1024 kb internally!]]></description>
1111 <default><![CDATA[
1112 ]]></default>
1113 </property>
1114 <property name="linkWrap" type="stdWrap">
1115 <description><![CDATA[wrap/stdWrap
1116 (before ".wrap")]]></description>
1117 <default><![CDATA[
1118 ]]></default>
1119 </property>
1120 <property name="longdescURL" type="stdWrap">
1121 <description><![CDATA[For <img> output only!
1122
1123 "longdesc" attribute (URL pointing to document with extensive details about image).]]></description>
1124 <default><![CDATA[
1125 ]]></default>
1126 </property>
1127 <property name="stdWrap" type="stdWrap">
1128 <description><![CDATA[
1129 ]]></description>
1130 <default><![CDATA[
1131 ]]></default>
1132 </property>
1133 <property name="wrap" type="stdWrap">
1134 <description><![CDATA[wrap/stdWrap
1135 ]]></description>
1136 <default><![CDATA[
1137 ]]></default>
1138 </property>
1139 </type>
1140 <type id="FILES">
1141 <property name="references" type="stdWrap">
1142 <description><![CDATA[string/stdWrap or array
1143 Provides a way to load files from a file field (of type IRRE with sys_file_reference as child table).
1144 You can either provide a UID or a comma-separated list of UIDs from the database table sys_file_reference
1145 or you have to specify a table, uid and field name in the according sub-properties of "references".
1146 See further documentation of these sub-properties in the table below.]]></description>
1147 <default><![CDATA[]]></default>
1148 </property>
1149 <property name="files" type="stdWrap">
1150 <description><![CDATA[string/stdWrap
1151 Comma-separated list of sys_file UIDs, which are loaded into the FILES object.]]></description>
1152 <default><![CDATA[]]></default>
1153 </property>
1154 <property name="collections" type="stdWrap">
1155 <description><![CDATA[string/stdWrap
1156 Comma-separated list of sys_file_collection UIDs, which are loaded into the FILES object.]]></description>
1157 <default><![CDATA[]]></default>
1158 </property>
1159 <property name="folders" type="stdWrap">
1160 <description><![CDATA[string/stdWrap
1161 Comma-separated list of combined folder identifiers which are loaded into the FILES object.
1162 A combined folder identifier looks like this: [storageUid]:[folderIdentifier].
1163 The first part is the UID of the storage and the second part the identifier of the folder.
1164 The identifier of the folder is often equivalent to the relative path of the folder.]]></description>
1165 <default><![CDATA[]]></default>
1166 </property>
1167 <property name="sorting" type="stdWrap">
1168 <description><![CDATA[string/stdWrap
1169 You can sort in revers order with: sorting.direction = DESC]]></description>
1170 <default><![CDATA[]]></default>
1171 </property>
1172 <property name="begin" type="integer">
1173 <description><![CDATA[integer]]></description>
1174 <default><![CDATA[]]></default>
1175 </property>
1176 <property name="maxItems" type="integer">
1177 <description><![CDATA[integer]]></description>
1178 <default><![CDATA[]]></default>
1179 </property>
1180 <property name="renderObj" type="cObj">
1181 <description><![CDATA[cObject + optionSplit
1182 The cObject used for rendering the files. It is executed once for every file.
1183 Note that during each execution you can find information about the current file using
1184 the getText property "file" with the "current" keyword.]]></description>
1185 <default><![CDATA[]]></default>
1186 </property>
1187 <property name="stdWrap" type="stdWrap">
1188 <description><![CDATA[stdWrap]]></description>
1189 <default><![CDATA[]]></default>
1190 </property>
1191 </type>
1192 <type id="FLUIDTEMPLATE">
1193 <property name="templateName" type="stdWrap">
1194 <description><![CDATA[string/stdwrap
1195 This name is used together with the set format to find the template in the given templateRootPaths. Use this property to define a content object, which should be used as template file. It is an alternative to ".file". If ".templateName" is set, it takes precedence.]]></description>
1196 <default><![CDATA[]]></default>
1197 </property>
1198 <property name="template" type="cObject">
1199 <description><![CDATA[cObject
1200 Use this property to define a content object, which should be used as template file. It is an alternative to ".file"; if ".template" is set, it takes precedence. While any content object can be used here, the cObject FILE might be the usual choice.]]></description>
1201 <default><![CDATA[]]></default>
1202 </property>
1203 <property name="file" type="stdWrap">
1204 <description><![CDATA[string/stdWrap
1205 The fluid template file. It is an alternative to ".template" and is used only, if ".template" is not set.]]></description>
1206 <default><![CDATA[]]></default>
1207 </property>
1208 <property name="templateRootPaths" type="array">
1209 <description><![CDATA[array of file paths with stdWrap
1210 Used to define several paths for templates, which will be tried in reversed order (the paths are searched from bottom to top). The first folder where the desired layout is found, is used. If the array keys are numeric, they are first sorted and then tried in reversed order.
1211 Useful in combination with the templateName property.]]></description>
1212 <default><![CDATA[]]></default>
1213 </property>
1214 <property name="layoutRootPath" type="stdWrap">
1215 <description><![CDATA[file path/stdWrap
1216 Sets a specific layout path; usually it is Layouts/ underneath the template file.]]></description>
1217 <default><![CDATA[]]></default>
1218 </property>
1219 <property name="layoutRootPaths" type="array">
1220 <description><![CDATA[array of file paths with stdWrap
1221 Used to define several paths for layouts, which will be tried in reversed order (the paths are searched from bottom to top). The first folder where the desired layout is found, is used. If the array keys are numeric, they are first sorted and then tried in reversed order.
1222 If property layoutRootPath (singular) is also used, it will be placed as the first option in the list of fall back paths.]]></description>
1223 <default><![CDATA[]]></default>
1224 </property>
1225 <property name="partialRootPath" type="stdWrap">
1226 <description><![CDATA[file path/stdWrap
1227 Sets a specific partials path; usually it is Partials/ underneath the template file.]]></description>
1228 <default><![CDATA[]]></default>
1229 </property>
1230 <property name="layoutRootPaths" type="array">
1231 <description><![CDATA[array of file paths with stdWrap
1232 Sets the format of the current request.]]></description>
1233 <default><![CDATA[]]></default>
1234 </property>
1235 <property name="format" type="stdWrap">
1236 <description><![CDATA[keyword / stdWrap
1237 Used to define several paths for partials, which will be tried in reversed order. The first folder where the desired partial is found, is used. The keys of the array define the order.
1238 See layoutRootPaths for more details.]]></description>
1239 <default><![CDATA[html]]></default>
1240 </property>
1241 <property name="extbase" type="extbase">
1242 <description><![CDATA[Additional Extbase configuration]]></description>
1243 <default><![CDATA[]]></default>
1244 </property>
1245 <property name="variables" type="array">
1246 <description><![CDATA[array
1247 Sets variables that should be available in the fluid template. The keys are the variable names in Fluid.
1248 Reserved variables are "data" and "current", which are filled automatically with the current data set.]]></description>
1249 <default><![CDATA[]]></default>
1250 </property>
1251 <property name="settings" type="array">
1252 <description><![CDATA[array
1253 Sets the given settings array in the fluid template. In the view, the value can then be used.
1254
1255 Example:
1256
1257 page = PAGE
1258 page {
1259 10 = FLUIDTEMPLATE
1260 10 {
1261 file = fileadmin/templates/MyTemplate.html
1262 settings {
1263 copyrightYear = 2013
1264 }
1265 }
1266 }
1267
1268 To access copyrightYear in the template file use this:
1269
1270 {settings.copyrightYear}
1271
1272 Apart from just setting a key-value pair as done in the example, you can also reference objects or access constants as well.]]></description>
1273 <default><![CDATA[]]></default>
1274 </property>
1275 <property name="dataProcessing" type="array">
1276 <description><![CDATA[array
1277 Add one or multiple processors to manipulate the $data variable of the currently rendered content object, like tt_content or page. The sub-property options can be used to pass parameters to the processor class.]]></description>
1278 <default><![CDATA[]]></default>
1279 </property>
1280 <property name="stdWrap" type="stdWrap">
1281 <description><![CDATA[stdWrap]]></description>
1282 <default><![CDATA[]]></default>
1283 </property>
1284 </type>
1285 <type id="FORM_dataArray">
1286 <property name="10" type="FORM_dataArray_element">
1287 <description><![CDATA[alternative way to define form Elements]]></description>
1288 <default><![CDATA[]]></default>
1289 </property>
1290 <property name="20" type="FORM_dataArray_element">
1291 <description><![CDATA[alternative way to define form Elements]]></description>
1292 <default><![CDATA[]]></default>
1293 </property>
1294 <property name="30" type="FORM_dataArray_element">
1295 <description><![CDATA[alternative way to define form Elements]]></description>
1296 <default><![CDATA[]]></default>
1297 </property>
1298 <property name="40" type="FORM_dataArray_element">
1299 <description><![CDATA[alternative way to define form Elements]]></description>
1300 <default><![CDATA[]]></default>
1301 </property>
1302 </type>
1303 <type id="FORM_dataArray_element">
1304 <property name="label" type="string">
1305 <description><![CDATA[]]></description>
1306 <default><![CDATA[]]></default>
1307 </property>
1308 <property name="type" type="string">
1309 <description><![CDATA[]]></description>
1310 <default><![CDATA[]]></default>
1311 </property>
1312 <property name="name" type="string">
1313 <description><![CDATA[]]></description>
1314 <default><![CDATA[]]></default>
1315 </property>
1316 <property name="value" type="string">
1317 <description><![CDATA[]]></description>
1318 <default><![CDATA[]]></default>
1319 </property>
1320 <property name="required" type="boolean">
1321 <description><![CDATA[]]></description>
1322 <default><![CDATA[]]></default>
1323 </property>
1324 </type>
1325 <type id="FORM">
1326 <property name="CHECK.layout" type="string">
1327 <description><![CDATA[Alternative layout for checkboxes]]></description>
1328 <default><![CDATA[the "layout"-property]]></default>
1329 </property>
1330 <property name="COMMENT.layout" type="string">
1331 <description><![CDATA[Alternative layout for comments.]]></description>
1332 <default><![CDATA[the "layout"-property]]></default>
1333 </property>
1334 <property name="LABEL.layout" type="string">
1335 <description><![CDATA[Alternative layout for label types]]></description>
1336 <default><![CDATA[the "layout"-property]]></default>
1337 </property>
1338 <property name="RADIO.layout" type="string">
1339 <description><![CDATA[Alternative layout for radiobuttons]]></description>
1340 <default><![CDATA[the "layout"-property]]></default>
1341 </property>
1342 <property name="REQ" type="REQ">
1343 <description><![CDATA[boolean
1344 Defines if required-fields should be checked and marked up]]></description>
1345 <default><![CDATA[
1346 ]]></default>
1347 </property>
1348 <property name="accessibility" type="boolean">
1349 <description><![CDATA[If set, then the form will be compliant with accessibility guidelines (XHTML compliant). This includes:
1350
1351 label string will be wrapped in <label for="formname[fieldname-hash]"> ... </label>All form elements will have an id-attribute carrying the formname with the md5-hashed fieldname appended
1352
1353 Notice: In TYPO3 4.0 and later, CSS Styled Content is configured to produce accessible forms by default.]]></description>
1354 <default><![CDATA[
1355 ]]></default>
1356 </property>
1357 <property name="commentWrap" type="stdWrap">
1358 <description><![CDATA[Comments: Wrap for comments IF you use ###COMMENT###]]></description>
1359 <default><![CDATA[
1360 ]]></default>
1361 </property>
1362 <property name="data" type="stdWrap">
1363 <description><![CDATA[This is the data that sets up the form. See above.
1364 "||" can be used instead of linebreaks]]></description>
1365 <default><![CDATA[
1366 ]]></default>
1367 </property>
1368 <property name="dataArray" type="FORM_dataArray">
1369 <description><![CDATA[This is an alternative way to define the form-fields. Instead of using the syntax with vertical separator bars suggested by the .data property, you can define the elements in regular TypoScript style arrays.
1370 .dataArray is added to the input in .data if any.
1371 Every entry in the dataArray is numeric and has three main properties, label, type, value and required. 'label' and 'value' has stdWrap properties.
1372 There is an alternative property to .value, which is .valueArray. This is also an array in the same style with numeric entries which has properties label, value and selected. 'label' has stdWrap properties.
1373
1374 Example:
1375   dataArray {
1376     10.label = Name:
1377     10.type = name=input
1378     10.value = [Enter name]
1379     10.required = 1
1380     20.label = Eyecolor
1381     20.type = eyecolor=select
1382     20.valueArray {
1383       10.label = Blue
1384       10.value = 1
1385       20.label = Red
1386       20.value = 2
1387       20.selected = 1
1388     }
1389     40.type = submit=submit
1390     40.value = Submit
1391   }
1392
1393
1394 This is the same as this line in the .data property:
1395
1396 Name: | *name=input | [Enter name]
1397 Eyecolor: | eyecolor=select | Blue=1, *Red=2
1398 | submit=submit | Submit
1399
1400 Why do it this way?  Good question, but doing it this way has a tremendous advantage because labels are all separated from the codes. In addition it's much easier to pull out or insert new elements in the form.
1401 Inserting an email-field after the name field would be like this:
1402   dataArray {
1403     15.label = Email:
1404     15.type = input
1405     15.value = your@email.com
1406     15.specialEval = EMAIL
1407   }
1408
1409 Or translating the form to danish (setting config.language to 'dk'):
1410
1411   dataArray {
1412     10.label.lang.dk = Navn:
1413     10.value.lang.dk = [Indtast dit navn]
1414     20.label.lang.dk = Øjenfarve
1415     20.valueArray {
1416       10.label.lang.dk = Blå
1417       20.label.lang.dk = Rød
1418     }
1419     40.value.lang.dk = Send
1420   }
1421 ]]></description>
1422 <default><![CDATA[
1423 ]]></default>
1424 </property>
1425 <property name="dontMd5FieldNames" type="boolean">
1426 <description><![CDATA[The IDs generated for all elements in a form are md5 hashes from the fieldname. Setting this to true will disable this behaviour and use a cleaned fieldname, prefixed with the form name as the ID, instead.
1427 This can be useful to style specifically named fields with CSS.]]></description>
1428 <default><![CDATA[
1429 ]]></default>
1430 </property>
1431 <property name="emailMess" type="string">
1432 <description><![CDATA[Message if a field evaluated to be an email adresse did not validate.
1433
1434 NOTE: May be overridden by the property override feature of the formdata (see above)]]></description>
1435 <default><![CDATA[
1436 ]]></default>
1437 </property>
1438 <property name="fieldPrefix" type="string">
1439 <description><![CDATA[Alternative prefix for the name of the fields in this form. Otherwise, all fields are prefixed with the form name (either a unique hash or the name set in the "formName" property). If set to "0", there will be no prefix at all.]]></description>
1440 <default><![CDATA[
1441 ]]></default>
1442 </property>
1443 <property name="fieldWrap" type="stdWrap">
1444 <description><![CDATA[Field: Wraps the fields]]></description>
1445 <default><![CDATA[
1446 ]]></default>
1447 </property>
1448 <property name="formName" type="string">
1449 <description><![CDATA[An alternative name for this form. Default will be a unique (random) hash.
1450
1451 <form name="...">]]></description>
1452 <default><![CDATA[
1453 ]]></default>
1454 </property>
1455 <property name="hiddenFields" type="cObjArray">
1456 <description><![CDATA[Used to set hiddenFields from TS.
1457
1458 Example:
1459 hiddenFields.pid = TEXT
1460 hiddenFields.pid.value = 2
1461
1462 This makes a hidden-field with the name "pid" and value "2".]]></description>
1463 <default><![CDATA[
1464 ]]></default>
1465 </property>
1466 <property name="image" type="IMAGE">
1467 <description><![CDATA[If this is a valid image the submitbutton is rendered as this image!!
1468
1469 NOTE: CurrentValue is set to the caption-label before generating the image.]]></description>
1470 <default><![CDATA[
1471 ]]></default>
1472 </property>
1473 <property name="labelWrap" type="stdWrap">
1474 <description><![CDATA[Labels: Wraps the label]]></description>
1475 <default><![CDATA[
1476 ]]></default>
1477 </property>
1478 <property name="layout" type="string">
1479 <description><![CDATA[This defines how the label and the field are placed towards each other.
1480
1481 Example:
1482 This substitutes the "###FIELD###" with the field data and the "###LABEL###' with labeldata.
1483
1484 <tr><td>###FIELD###</td><td> ###LABEL###</td></tr>
1485
1486 You can also use the marker ###COMMENT### which is ALSO the label value inserted, but wrapped in .commentWrap stdWrap-properties (see below)]]></description>
1487 <default><![CDATA[
1488 ]]></default>
1489 </property>
1490 <property name="locationData" type="string">
1491 <description><![CDATA[boolean / string
1492 If this value is true, then a hidden-field called "locationData" is added to the form. This field wil be loaded with a value like this:
1493 [page id]:[current record table]:[current record id]
1494 For example, if a formfield is inserted on page with uid = "100", as a page-content item from the table "tt_content" with id "120", then the value would be "100:tt_content:120".
1495 The value is use by eg. the cObject SEARCHRESULT. If the value $GLOBALS["HTTP_POST_VARS"]["locationData"] is detected here, the search is done as if it was performed on this page! This is very useful if you want a search functionality implemented on a page with the "stype" field set to "L1" which means that the search is carried out from the first level in the rootline.
1496 Suppose you want the search to submit to a dedicated searchpage where ever. This page will then know - because of locationData - that the search was submittet from another place on the website.
1497 If "locationData" is not only true but also set to "HTTP_POST_VARS" then the value will insert the content of $GLOBALS["HTTP_POST_VARS"]["locationData"] instead of the true location data of the page. This should be done with search-fields as this will carry the initial searching start point with.
1498 NOTE: May be overridden by the property override feature of the formdata (see above)]]></description>
1499 <default><![CDATA[
1500 ]]></default>
1501 </property>
1502 <property name="method" type="string">
1503 <description><![CDATA[form-method
1504
1505 Example:
1506 GET]]></description>
1507 <default><![CDATA[POST]]></default>
1508 </property>
1509 <property name="noValueInsert" type="boolean">
1510 <description><![CDATA[By default values that are submitted to the same page (and thereby same form, eg. at searchforms) are re-inserted in the form instead of any default-data that might be set up.
1511 This, however, applies ONLY if the "no_cache=1" is set! (a page being cached may not include user-specific defaults in the fields of course...)
1512 If you set this flag, "noValueInsert", the content will always be the default content.]]></description>
1513 <default><![CDATA[
1514 ]]></default>
1515 </property>
1516 <property name="noWrapAttr" type="boolean">
1517 <description><![CDATA[If this value is true then all wrap attributes of textarea elements are suppressed. This is needed for XHTML-compliancy.
1518
1519 The wrap attributes can also be disabled on a per-field basis by using the special keyword "disabled" as the value of the wrap attribute.]]></description>
1520 <default><![CDATA[
1521 ]]></default>
1522 </property>
1523 <property name="no_cache" type="string">
1524 <description><![CDATA[Default no_cache-option]]></description>
1525 <default><![CDATA[
1526 ]]></default>
1527 </property>
1528 <property name="params" type="string">
1529 <description><![CDATA[form-element tag parameters
1530 Extra parameters to form elements
1531
1532 Example:
1533 params = style="width:200px;"
1534 params.textarea = style="width:300px;"
1535 params.check =
1536
1537 This sets the default to 200 px width, but excludes check-boxes and sets textareas to 300.]]></description>
1538 <default><![CDATA[
1539 ]]></default>
1540 </property>
1541 <property name="radioWrap" type="stdWrap">
1542 <description><![CDATA[Wraps the labels for radiobuttons]]></description>
1543 <default><![CDATA[
1544 ]]></default>
1545 </property>
1546 <property name="radioWrap.accessibilityWrap" type="wrap">
1547 <description><![CDATA[Defines how radio buttons are wrapped when accessibility mode is turned on (see below “accessibility” property)
1548 default:
1549
1550 <fieldset###RADIO_FIELD_ID###><legend>###RADIO_GROUP_LABEL###</legend>|</fieldset>
1551 ]]></description>
1552 <default><![CDATA[<fieldset###RADIO_FIELD_ID###><legend>###RADIO_GROUP_LABEL###</legend>|</fieldset>
1553 ]]></default>
1554 </property>
1555 <property name="radioInputWrap" type="stdWrap">
1556 <description><![CDATA[Wraps the input element and label of a radio button.]]></description>
1557 <default><![CDATA[
1558 ]]></default>
1559 </property>
1560 <property name="recipient" type="stdWrap">
1561 <description><![CDATA[(list of) string /stdWrap
1562 Email recipient of the formmail content (generates the hiddenfield "recipient")]]></description>
1563 <default><![CDATA[No email]]></default>
1564 </property>
1565 <property name="redirect" type="stdWrap">
1566 <description><![CDATA[URL to redirect to (generates the hidden field "redirect")
1567
1568 Integer: this is regarded to be a page in TYPO3
1569 String: this is regarded to be a normal url
1570 Empty; the current page is chosen.
1571
1572 NOTE: If this value is set the target of this overriddes the target of the "type".]]></description>
1573 <default><![CDATA[
1574 ]]></default>
1575 </property>
1576 <property name="stdWrap" type="stdWrap">
1577 <description><![CDATA[Wraps the hole form (before formtags is added)]]></description>
1578 <default><![CDATA[
1579 ]]></default>
1580 </property>
1581 <property name="target" type="string">
1582 <description><![CDATA[target
1583 Default target of the form. ]]></description>
1584 <default><![CDATA[
1585 ]]></default>
1586 </property>
1587 <property name="type" type="int">
1588 <description><![CDATA[Type (action="" of the form):
1589
1590 Integer: this is regarded to be a page in TYPO3
1591 String: this is regarded to be a normal URL (eg. "formmail.php")
1592 Empty: the current page is chosen.
1593
1594 NOTE: If type is integer/empty the form will be submitted to a page in TYPO3 and if this page has a value for target/no_cache, then this will be used instead of the default target/no_cache below.
1595
1596 NOTE: If the redirect-value is set, the redirect-target overrides the target set by the action-url
1597
1598 NOTE: May be overridden by the property override feature of the formdata (see above)]]></description>
1599 <default><![CDATA[
1600 ]]></default>
1601 </property>
1602 <property name="wrapFieldName" type="wrap">
1603 <description><![CDATA[This wraps  the fieldnames before they are applied to the form-field tags.
1604
1605 Example:
1606 If value is tx_myextension[input][  |  ]  then the fieldname "email" would be wrapped to this value: tx_myextension[input][email]]]></description>
1607 <default><![CDATA[
1608 ]]></default>
1609 </property>
1610 </type>
1611 <type id="REQ">
1612 <property name="fieldWrap" type="stdWrap">
1613 <description><![CDATA[Field: Wraps the fields, but for reuired fields]]></description>
1614 <default><![CDATA[the "fieldWrap"-property]]></default>
1615 </property>
1616 <property name="labelWrap" type="stdWrap">
1617 <description><![CDATA[Labels: Wraps the label, but for reuired fields]]></description>
1618 <default><![CDATA[the "labelWrap"-property]]></default>
1619 </property>
1620 <property name="layout" type="string">
1621 <description><![CDATA[The same as "layout" above, but for reuired fields]]></description>
1622 <default><![CDATA[the "layout"-property]]></default>
1623 </property>
1624 </type>
1625 <type id="GifBuilderObj">
1626 <property name="if" type="if">
1627 <description><![CDATA[.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 functionallity of ".if" of the stdWrap-function.]]></description>
1628 </property>
1629 </type>
1630 <type id="GIFBUILDER">
1631 <property name="1" type="GifBuilderObj">
1632 <description><![CDATA[.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 functionallity of ".if" of the stdWrap-function.]]></description>
1633 <default><![CDATA[
1634 ]]></default>
1635 </property>
1636 <property name="2" type="GifBuilderObj">
1637 <description><![CDATA[.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 functionallity of ".if" of the stdWrap-function.]]></description>
1638 <default><![CDATA[
1639 ]]></default>
1640 </property>
1641 <property name="3" type="GifBuilderObj">
1642 <description><![CDATA[.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 functionallity of ".if" of the stdWrap-function.]]></description>
1643 <default><![CDATA[
1644 ]]></default>
1645 </property>
1646 <property name="4" type="GifBuilderObj">
1647 <description><![CDATA[.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 functionallity of ".if" of the stdWrap-function.]]></description>
1648 <default><![CDATA[
1649 ]]></default>
1650 </property>
1651 <property name="XY" type="string">
1652 <description><![CDATA[x,y +calc
1653 Size of the gif-file. ]]></description>
1654 <default><![CDATA[100,20]]></default>
1655 </property>
1656 <property name="backColor" type="string">
1657 <description><![CDATA[GraphicColor
1658 Background color for the gif]]></description>
1659 <default><![CDATA[white]]></default>
1660 </property>
1661 <property name="format" type="string">
1662 <description><![CDATA["gif" / "jpg"
1663 Output type.
1664 "jpg"/"jpeg" = jpg-image]]></description>
1665 <default><![CDATA[gif]]></default>
1666 </property>
1667 <property name="maxHeight" type="int">
1668 <description><![CDATA[pixels
1669 Maximal heigth of gif-file]]></description>
1670 <default><![CDATA[
1671 ]]></default>
1672 </property>
1673 <property name="maxWidth" type="int">
1674 <description><![CDATA[pixels
1675 Maximal width of gif-file]]></description>
1676 <default><![CDATA[
1677 ]]></default>
1678 </property>
1679 <property name="offset" type="string">
1680 <description><![CDATA[x,y +calc
1681 Offset all objects on the gif.]]></description>
1682 <default><![CDATA[0,0]]></default>
1683 </property>
1684 <property name="quality" type="int">
1685 <description><![CDATA[posint (10-100)
1686 JPG-quality (if ".format" = jpg/jpeg)]]></description>
1687 <default><![CDATA[
1688 ]]></default>
1689 </property>
1690 <property name="reduceColors" type="int">
1691 <description><![CDATA[posint (1-255)
1692 Reduce the number of colors (if gif-file)]]></description>
1693 <default><![CDATA[
1694 ]]></default>
1695 </property>
1696 <property name="transparentBackground" type="boolean">
1697 <description><![CDATA[Set this flag to render the background transparent. TYPO3 makes the color found at position 0,0 of the image (upper left corner) transparent.
1698 If you render text you should leave the niceText option OFF as the result with probably be more precise without the niceText antialiasing hack]]></description>
1699 <default><![CDATA[
1700 ]]></default>
1701 </property>
1702 <property name="transparentColor" type="stdWrap">
1703 <description><![CDATA[HTMLColor /stdWrap
1704 Specify a color that should be transparent
1705
1706 Example-values:
1707 #ffffcc
1708 red
1709 255,255,127
1710
1711 Option:
1712 transparentColor.closest = 1
1713 This will allow for the closest color to be matched instead. You may need this if you image is not guaranteed "clean".
1714
1715 NOTE: You may experience that this doesn't work if you use reduceColors-option or render text with niceText-option.]]></description>
1716 <default><![CDATA[
1717 ]]></default>
1718 </property>
1719 <property name="workArea" type="string">
1720 <description><![CDATA[x,y,w,h + calc
1721 Define the workarea on the giffile. All the GifBuilderObj's will see this as the dimensions of the gif-file regarding alignment, overlaying of images an so on. Only will TEXT-objects exceeding the boundaries of the workarea print outside this area.]]></description>
1722 <default><![CDATA[
1723 ]]></default>
1724 </property>
1725 </type>
1726 <type id="ADJUST" extends="GifBuilderObj">
1727 <property name="value" type="string">
1728 <description><![CDATA[This lets you adjust the input-levels like in Photoshops "levels"-dialog. If you need to adjust gamma, look at the EFFECT-object.
1729 Example:
1730
1731 20 = ADJUST
1732 20.value = inputLevels = 13,230
1733
1734 properties:
1735
1736 inputLevels: low,high
1737 outputLevels: low, high
1738 autoLevels: -
1739 ]]></description>
1740 <default><![CDATA[
1741 ]]></default>
1742 </property>
1743 </type>
1744 <type id="BOX" extends="GifBuilderObj">
1745 <property name="align" type="string">
1746 <description><![CDATA[VHalign
1747 ]]></description>
1748 <default><![CDATA[
1749 ]]></default>
1750 </property>
1751 <property name="color" type="string">
1752 <description><![CDATA[GraphicColor
1753 fill-color]]></description>
1754 <default><![CDATA[black]]></default>
1755 </property>
1756 <property name="dimensions" type="string">
1757 <description><![CDATA[x,y,w,h +calc
1758 Dimensions of a filled box.
1759 x,y    is the offset.
1760 w,h    is the dimensions. Dimensions of 1 will result in 1-pixel wide lines!]]></description>
1761 <default><![CDATA[
1762 ]]></default>
1763 </property>
1764 <property name="opacity" type="int">
1765 <description><![CDATA[pos-int (1-100)
1766 Dimensions of a filled box.
1767 Opacity (i.e. inverse of transparency, e.g. 100% opacity = 0% transparency)]]></description>
1768 <default><![CDATA[100
1769 ]]></default>
1770 </property>
1771 </type>
1772 <type id="CROP" extends="GifBuilderObj">
1773 <property name="align" type="string">
1774 <description><![CDATA[VHalign
1775 ]]></description>
1776 <default><![CDATA[
1777 ]]></default>
1778 </property>
1779 <property name="backColor" type="string">
1780 <description><![CDATA[GraphicColor
1781 ]]></description>
1782 <default><![CDATA[The original backColor]]></default>
1783 </property>
1784 <property name="crop" type="string">
1785 <description><![CDATA[x,y,v,h + calc
1786 x,y is offset of the crop-frame,
1787 v,h  is the dimensions]]></description>
1788 <default><![CDATA[
1789 ]]></default>
1790 </property>
1791 </type>
1792 <type id="ELLIPSE" extends="GifBuilderObj">
1793 <property name="dimensions" type="string">
1794 <description><![CDATA[x,y,w,h +calc
1795 Dimensions of a filled ellipse.
1796 x,y is the offset.
1797 w,h is the dimensions. Dimensions of 1 will result in 1-pixel wide lines!
1798
1799 Example:
1800 file = GIFBUILDER
1801 file {
1802 XY = 200,200
1803 format = jpg
1804 quality = 100
1805 10 = ELLIPSE
1806 10.dimensions = 100,100,50,50
1807 10.color = red
1808
1809 ]]></description>
1810 <default><![CDATA[
1811 ]]></default>
1812 </property>
1813 <property name="color" type="string">
1814 <description><![CDATA[GraphicColor
1815 fill-color
1816
1817 Example:
1818 file = GIFBUILDER
1819 file {
1820 XY = 200,200
1821 format = jpg
1822 quality = 100
1823 10 = ELLIPSE
1824 10.dimensions = 100,100,50,50
1825 10.color = red
1826
1827 ]]></description>
1828 <default><![CDATA[
1829 ]]></default>
1830 </property>
1831 </type>
1832 <type id="EFFECT" extends="GifBuilderObj">
1833 <property name="value" type="string">
1834 <description><![CDATA[.value = [Varnavn] = [value] | [Varnavn] = [value]
1835
1836 Example:
1837 20 = EFFECT
1838 20.value = gamme=1.3 | flip | rotate=180
1839
1840
1841 gamma: 0.5 - 3.0
1842 blur: 1-99
1843 sharpen: 1-99
1844 solarize: 0-99
1845 swirl: 0-100
1846 wave: ampli , length
1847 charcoal: 0-100
1848 gray: -
1849 edge: 0-99
1850 emboss: -
1851 flip: - (Vertical flipping)
1852 flop: - (Horizontal flipping)
1853 rotate: 0-360 (Rotation)
1854 colors: 2-255
1855 shear: -90 - 90 (Horizontal shearing)
1856 invert: - (invert the colors)
1857 ]]></description>
1858 <default><![CDATA[
1859 ]]></default>
1860 </property>
1861 </type>
1862 <type id="EMBOSS" extends="GifBuilderObj">
1863 <property name="blur" type="int">
1864 <description><![CDATA[posint (1-99)
1865 Blurring of the shadow. Above 40 only values of 40,50,60,70,80,90 means something.]]></description>
1866 <default><![CDATA[
1867 ]]></default>
1868 </property>
1869 <property name="highColor" type="string">
1870 <description><![CDATA[GraphicColor
1871 Upper border-color]]></description>
1872 <default><![CDATA[
1873 ]]></default>
1874 </property>
1875 <property name="intensity" type="int">
1876 <description><![CDATA[posint(0-100)
1877 How "massive" the emboss is. This value can - if it has a high value combined with a blurred shadow - create a kind of soft-edged outline.]]></description>
1878 <default><![CDATA[
1879 ]]></default>
1880 </property>
1881 <property name="lowColor" type="string">
1882 <description><![CDATA[GraphicColor
1883 lower border-color]]></description>
1884 <default><![CDATA[
1885 ]]></default>
1886 </property>
1887 <property name="offset" type="string">
1888 <description><![CDATA[x,y
1889 Offset of the emboss]]></description>
1890 <default><![CDATA[
1891 ]]></default>
1892 </property>
1893 <property name="opacity" type="int">
1894 <description><![CDATA[posint (1-100)
1895 Opacity (transparency^-1)
1896 100% opacity = 0% transparency). Only active with a value for blur.]]></description>
1897 <default><![CDATA[
1898 ]]></default>
1899 </property>
1900 <property name="textObjNum" type="int">
1901 <description><![CDATA[pos-int
1902 Must point to the TEXT-object if these shadow-properties are not properties to a TEXT-object directly ("stand-alone-shadow"). Then the shadow needs to know which TEXT-object it should be a shadow of!
1903 If - on the other hand - the shadow is a property to a text-object, this property is not needed.]]></description>
1904 <default><![CDATA[
1905 ]]></default>
1906 </property>
1907 </type>
1908 <type id="GB_IMAGE" extends="GifBuilderObj">
1909 <property name="align" type="string">
1910 <description><![CDATA[VHalign
1911 ]]></description>
1912 <default><![CDATA[
1913 ]]></default>
1914 </property>
1915 <property name="file" type="imgResource">
1916 <description><![CDATA[The imagefile]]></description>
1917 <default><![CDATA[
1918 ]]></default>
1919 </property>
1920 <property name="mask" type="imgResource">
1921 <description><![CDATA[Optional mask-image for the imagefile.]]></description>
1922 <default><![CDATA[
1923 ]]></default>
1924 </property>
1925 <property name="offset" type="string">
1926 <description><![CDATA[x,y +calc
1927 Offset ]]></description>
1928 <default><![CDATA[0,0]]></default>
1929 </property>
1930 <property name="tile" type="string">
1931 <description><![CDATA[x,y
1932 tile x,y times.
1933 Maximum times is 20 each direction. If you need more, use a larger image.]]></description>
1934 <default><![CDATA[
1935 ]]></default>
1936 </property>
1937 </type>
1938 <type id="OUTLINE" extends="GifBuilderObj">
1939 <property name="color" type="string">
1940 <description><![CDATA[GraphicColor
1941 Outline color]]></description>
1942 <default><![CDATA[
1943 ]]></default>
1944 </property>
1945 <property name="textObjNum" type="int">
1946 <description><![CDATA[pos-int
1947 Must point to the TEXT-object if these shadow-properties are not properties to a TEXT-object directly ("stand-alone-shadow"). Then the shadow needs to know which TEXT-object it should be a shadow of!
1948 If - on the other hand - the shadow is a property to a text-object, this property is not needed.]]></description>
1949 <default><![CDATA[
1950 ]]></default>
1951 </property>
1952 <property name="thickness" type="string">
1953 <description><![CDATA[x,y
1954 Thickness in each direction, range 1-2]]></description>
1955 <default><![CDATA[
1956 ]]></default>
1957 </property>
1958 </type>
1959 <type id="SCALE" extends="GifBuilderObj">
1960 <property name="height" type="string">
1961 <description><![CDATA[pixels + calc
1962 ]]></description>
1963 <default><![CDATA[
1964 ]]></default>
1965 </property>
1966 <property name="params" type="string">
1967 <description><![CDATA[ImageMagickParams
1968 ]]></description>
1969 <default><![CDATA[
1970 ]]></default>
1971 </property>
1972 <property name="width" type="string">
1973 <description><![CDATA[pixels + calc
1974 ]]></description>
1975 <default><![CDATA[
1976 ]]></default>
1977 </property>
1978 </type>
1979 <type id="SHADOW" extends="GifBuilderObj">
1980 <property name="blur" type="int">
1981 <description><![CDATA[posint (1-99)
1982 Blurring of the shadow. Above 40 only values of 40,50,60,70,80,90 means something.
1983
1984 NOTE: Unfortunately the blurring capabilities of ImageMagick is not very mature in the version 4.2.9. This is addressed in the later version 5.2.0 where a gaussian blur-function is added. BUT as we do cannot use the latest ImageMagick development yet, this is not utilized so far.]]></description>
1985 <default><![CDATA[
1986 ]]></default>
1987 </property>
1988 <property name="color" type="string">
1989 <description><![CDATA[GraphicColor
1990 Shadow color]]></description>
1991 <default><![CDATA[
1992 ]]></default>
1993 </property>
1994 <property name="intensity" type="int">
1995 <description><![CDATA[posint(0-100)
1996 How "massive" the shadow is. This value can - if it has a high value combined with a blurred shadow - create a kind of soft-edged outline.]]></description>
1997 <default><![CDATA[
1998 ]]></default>
1999 </property>
2000 <property name="offset" type="string">
2001 <description><![CDATA[x,y
2002 Shadow offset]]></description>
2003 <default><![CDATA[
2004 ]]></default>
2005 </property>
2006 <property name="opacity" type="int">
2007 <description><![CDATA[posint (1-100)
2008 Opacity (transparency^-1)
2009 100% opacity = 0% transparency). Only active with a value for blur.]]></description>
2010 <default><![CDATA[
2011 ]]></default>
2012 </property>
2013 <property name="textObjNum" type="int">
2014 <description><![CDATA[pos-int
2015 Must point to the TEXT-object if these shadow-properties are not properties to a TEXT-object directly ("stand-alone-shadow"). Then the shadow needs to know which TEXT-object it should be a shadow of!
2016 If - on the other hand - the shadow is a property to a text-object, this property is not needed.]]></description>
2017 <default><![CDATA[
2018 ]]></default>
2019 </property>
2020 </type>
2021 <type id="GB_TEXT" extends="GifBuilderObj">
2022 <property name="align" type="string">
2023 <description><![CDATA[align
2024 Alignment of the text]]></description>
2025 <default><![CDATA[left]]></default>
2026 </property>
2027 <property name="angle" type="string">
2028 <description><![CDATA[degree
2029 Rotation degrees of the text.
2030
2031 NOTE: Angle is not available if spacing/wordSpacing is set.]]></description>
2032 <default><![CDATA[0
2033 Range: -90 til 90]]></default>
2034 </property>
2035 <property name="antiAlias" type="boolean">
2036 <description><![CDATA[FreeType antialiasing. Notice, the default mode is "on"!
2037
2038 Note: This option is not available if .niceText is enabled]]></description>
2039 <default><![CDATA[1]]></default>
2040 </property>
2041 <property name="breakWidth" type="int">
2042 <description><![CDATA[Defines the maximum width for an object, overlapping elements will force an automatic line break.
2043 ]]></description>
2044 <default><![CDATA[
2045 ]]></default>
2046 </property>
2047 <property name="breakSpace" type="float">
2048 <description><![CDATA[Defines a value that is multiplied by the line height of the current element.
2049 ]]></description>
2050 <default><![CDATA[1.0]]></default>
2051 </property>
2052 <property name="doNotStripHTML" type="boolean">
2053 <description><![CDATA[If set, HTML-tags in the string inserted are NOT removed. Any other way HTML-code is removed by default!]]></description>
2054 <default><![CDATA[0]]></default>
2055 </property>
2056 <property name="emboss" type="EMBOSS">
2057 <description><![CDATA[
2058 ]]></description>
2059 <default><![CDATA[
2060 ]]></default>
2061 </property>
2062 <property name="fontColor" type="stdWrap">
2063 <description><![CDATA[GraphicColor /stdWrap
2064 Font color]]></description>
2065 <default><![CDATA[black]]></default>
2066 </property>
2067 <property name="fontFile" type="string">
2068 <description><![CDATA[Font face (truetype font you can upload!!)]]></description>
2069 <default><![CDATA[Nimbus (Arial-clone)]]></default>
2070 </property>
2071 <property name="fontSize" type="int">
2072 <description><![CDATA[posint
2073 Font size]]></description>
2074 <default><![CDATA[12]]></default>
2075 </property>
2076 <property name="hide" type="boolean">
2077 <description><![CDATA[If this is true, the text is NOT printed.
2078 This feature may be used if you need a shadow-object to base a shadow on the text, but do not want the text to print.]]></description>
2079 <default><![CDATA[0]]></default>
2080 </property>
2081 <property name="hideButCreateMap" type="boolean">
2082 <description><![CDATA[If this option is set, the text will not be rendered. Shadows and emboss will, though, so don't apply these!! But this feature is also meant only to enable a text to generate the imageMap coordinates without rendering itself.]]></description>
2083 <default><![CDATA[
2084 ]]></default>
2085 </property>
2086 <property name="imgMap" type="IMGMAP">
2087 <description><![CDATA[
2088 ]]></description>
2089 <default><![CDATA[
2090 ]]></default>
2091 </property>
2092 <property name="iterations" type="int">
2093 <description><![CDATA[posint
2094 How many times the text should be "printed" onto it self. This will add the effect of bold text.
2095
2096 Note: This option is not available if .niceText is enabled]]></description>
2097 <default><![CDATA[1]]></default>
2098 </property>
2099 <property name="maxWidth" type="int">
2100 <description><![CDATA[pixels
2101 Sets the maximum width in pixels, the text must be. Reduces the fontSize if the text does not fit within this width.
2102
2103 Does not support setting alternative fontSizes in splitRendering options.
2104
2105 (By Rene Fritz <r.fritz@colorcube.de>)]]></description>
2106 <default><![CDATA[
2107 ]]></default>
2108 </property>
2109 <property name="niceText" type="boolean">
2110 <description><![CDATA[This is a very popular feature that helps to render small letters much nicer than the freetype library can normally do. But it also loads the system very much!
2111 The principle of this function is to create a black/white giffile in twice or more times the size of the actual gif-file and then print the text onto this is a scaled dimension. Afterwards ImageMagick (IM) scales down the mask and masks the font color down on the original gif-file through the temporary mask.
2112 The fact that the font  is  actually rendered in the double size and scaled down adds a more homogenous shape to the lettes. Some fonts are more critical than others though.  If you do not need the quality, then don't use the function.
2113
2114 Some properties:
2115 .before = IM-params before scale
2116 .after = IM-params after scale
2117 .sharpen = sharpen-value for the mask (after scaling), integer 0-99 (this enables you to make the text crisper if it's too blurred!)
2118 .scaleFactor = scaling-factor, int 2-5]]></description>
2119 <default><![CDATA[
2120 ]]></default>
2121 </property>
2122 <property name="offset" type="string">
2123 <description><![CDATA[x,y +calc
2124 Offset of the text]]></description>
2125 <default><![CDATA[0,0]]></default>
2126 </property>
2127 <property name="outline" type="OUTLINE">
2128 <description><![CDATA[
2129 ]]></description>
2130 <default><![CDATA[
2131 ]]></default>
2132 </property>
2133 <property name="shadow" type="SHADOW">
2134 <description><![CDATA[
2135 ]]></description>
2136 <default><![CDATA[
2137 ]]></default>
2138 </property>
2139 <property name="spacing" type="int">
2140 <description><![CDATA[posint
2141 Pixel-distance between letters. This may render ugly!]]></description>
2142 <default><![CDATA[0]]></default>
2143 </property>
2144 <property name="splitRendering.compX" type="string">
2145 <description><![CDATA[Split the rendering of a string into separate processes with individual configurations. By this method a certain range of characters can be rendered with another font face or size. This is very useful if you want to use separate fonts for strings where you have latin characters combined with eg. Japanese and there is a separate font file for each.
2146 You can also render keywords in another font/size/color.
2147
2148 Properties:
2149 splitRendering.compX = Additional pixelspace between parts, x direction
2150 splitRendering.compY = Additional pixelspace between parts, y direction
2151 splitRendering.[array] = keyword  [charRange, highlightWord]
2152 splitRendering.[array] {
2153   fontFile = Alternative font file for this rendering
2154   fontSize = Alternative font size for this rendering
2155   color = Alternative color for this rendering, works ONLY without "niceText"
2156   xSpaceBefore = x-Space before this part
2157   xSpaceAfter = x-Space after this part
2158   ySpaceBefore = y-Space before this part
2159   ySpaceAfter =  y-Space after this part
2160 }
2161
2162 Keyword: charRange
2163 splitRendering.[array].value = Commaseparated list of character ranges (eg. "100-200") given as Unicode character numbers. The list accepts optional starting and ending points, eg. " - 200" or " 200 -" and single values, eg. "65, 66, 67"
2164
2165 Keyword: highlightWord
2166 splitRendering.[array].value = Word to highlight, makes a case sensitive search for this.
2167
2168 Limitations:
2169 The pixelcompensation values are not corrected for scale factor used with niceText. Basically this means that when niceText is used, these values will have only the half effect.When word spacing is used the "highlightWord" mode doesn't work.The color override works only without "niceText".
2170
2171 Example:
2172   10.splitRendering.compX = 2
2173   10.splitRendering.compY = -2
2174   10.splitRendering.10 = charRange
2175   10.splitRendering.10 {
2176     value = 200-380 , 65, 66
2177     fontSize = 50
2178     fontFile =  typo3/sysext/core/Resources/Private/Font/nimbus.ttf
2179     xSpaceBefore = 30
2180   }
2181   10.splitRendering.20 = highlightWord
2182   10.splitRendering.20 {
2183     value = TheWord
2184     color = red
2185   }]]></description>
2186 <default><![CDATA[
2187 ]]></default>
2188 </property>
2189 <property name="splitRendering.compY" type="string">
2190 <description><![CDATA[Split the rendering of a string into separate processes with individual configurations. By this method a certain range of characters can be rendered with another font face or size. This is very useful if you want to use separate fonts for strings where you have latin characters combined with eg. Japanese and there is a separate font file for each.
2191 You can also render keywords in another font/size/color.
2192
2193 Properties:
2194 splitRendering.compX = Additional pixelspace between parts, x direction
2195 splitRendering.compY = Additional pixelspace between parts, y direction
2196 splitRendering.[array] = keyword  [charRange, highlightWord]
2197 splitRendering.[array] {
2198   fontFile = Alternative font file for this rendering
2199   fontSize = Alternative font size for this rendering
2200   color = Alternative color for this rendering, works ONLY without "niceText"
2201   xSpaceBefore = x-Space before this part
2202   xSpaceAfter = x-Space after this part
2203   ySpaceBefore = y-Space before this part
2204   ySpaceAfter =  y-Space after this part
2205 }
2206
2207 Keyword: charRange
2208 splitRendering.[array].value = Commaseparated list of character ranges (eg. "100-200") given as Unicode character numbers. The list accepts optional starting and ending points, eg. " - 200" or " 200 -" and single values, eg. "65, 66, 67"
2209
2210 Keyword: highlightWord
2211 splitRendering.[array].value = Word to highlight, makes a case sensitive search for this.
2212
2213 Limitations:
2214 The pixelcompensation values are not corrected for scale factor used with niceText. Basically this means that when niceText is used, these values will have only the half effect.When word spacing is used the "highlightWord" mode doesn't work.The color override works only without "niceText".
2215
2216 Example:
2217   10.splitRendering.compX = 2
2218   10.splitRendering.compY = -2
2219   10.splitRendering.10 = charRange
2220   10.splitRendering.10 {
2221     value = 200-380 , 65, 66
2222     fontSize = 50
2223     fontFile =  typo3/sysext/core/Resources/Private/Font/nimbus.ttf
2224     xSpaceBefore = 30
2225   }
2226   10.splitRendering.20 = highlightWord
2227   10.splitRendering.20 {
2228     value = TheWord
2229     color = red
2230   }]]></description>
2231 <default><![CDATA[
2232 ]]></default>
2233 </property>
2234 <property name="text" type="stdWrap">
2235 <description><![CDATA[This is text text-string on the gif-file. The item is rendered only if this string is not empty.
2236 The cObj->data-array is loaded with the page-record, if for example the GIFBUILDER-object is used by GMENU or IMGMENU]]></description>
2237 <default><![CDATA[
2238 ]]></default>
2239 </property>
2240 <property name="textMaxLength" type="int">
2241 <description><![CDATA[The maximum length of the text.  This is just a natural break that prevents incidental rendering of very long texts!]]></description>
2242 <default><![CDATA[100]]></default>
2243 </property>
2244 <property name="wordSpacing" type="int">
2245 <description><![CDATA[posint
2246 Pixel-distance between words.]]></description>
2247 <default><![CDATA[= ".spacing"*2]]></default>
2248 </property>
2249 </type>
2250 <type id="WORKAREA" extends="GifBuilderObj">
2251 <property name="clear" type="string">(isset)
2252 <description><![CDATA[
2253 ]]></description>
2254 <default><![CDATA[
2255 ]]></default>
2256 </property>
2257 <property name="set" type="string">
2258 <description><![CDATA[x,y,w,h + calc
2259 Sets another workarea
2260 ]]></description>
2261 <default><![CDATA[
2262 ]]></default>
2263 </property>
2264 </type>
2265 <type id="HMENU">
2266 <property name="1" type="mObj">
2267 <description><![CDATA[Required!
2268 Defines which menuObj that should render the menuitems on the various levels.
2269 1 is the first level, 2 is the second level, 3 is the third level, 4 is ....
2270
2271 Example:
2272 temp.sidemenu = HMENU
2273 temp.sidemenu.1 = GMENU  ]]></description>
2274 <default><![CDATA[ (no menu)]]></default>
2275 </property>
2276 <property name="2" type="mObj">
2277 <description><![CDATA[Defines which menuObj that should render the menuitems on the various levels.
2278 1 is the first level, 2 is the second level, 3 is the third level, 4 is ....
2279
2280 Example:
2281 temp.sidemenu = HMENU
2282 temp.sidemenu.1 = GMENU  ]]></description>
2283 <default><![CDATA[ (no menu)]]></default>
2284 </property>
2285 <property name="3" type="mObj">
2286 <description><![CDATA[Defines which menuObj that should render the menuitems on the various levels.
2287 1 is the first level, 2 is the second level, 3 is the third level, 4 is ....
2288
2289 Example:
2290 temp.sidemenu = HMENU
2291 temp.sidemenu.1 = GMENU  ]]></description>
2292 <default><![CDATA[ (no menu)]]></default>
2293 </property>
2294 <property name="4" type="mObj">
2295 <description><![CDATA[Defines which menuObj that should render the menuitems on the various levels.
2296 1 is the first level, 2 is the second level, 3 is the third level, 4 is ....
2297
2298 Example:
2299 temp.sidemenu = HMENU
2300 temp.sidemenu.1 = GMENU  ]]></description>
2301 <default><![CDATA[ (no menu)]]></default>
2302 </property>
2303 <property name="addQueryString" type="string">
2304 <description><![CDATA[see typolink.addQueryString
2305
2306 Notice: This works only for special=language.]]></description>
2307 <default><![CDATA[
2308 ]]></default>
2309 </property>
2310 <property name="alwaysActivePIDlist" type="stdWrap">
2311 <description><![CDATA[List of Integers /stdWrap
2312 This is a list of page UID numbers that will always be regarded as active menu items and thereby automatically opened regardless of the rootline.]]></description>
2313 <default><![CDATA[
2314 ]]></default>
2315 </property>
2316 <property name="begin" type="int">
2317 <description><![CDATA[int +calc
2318 The first item in the menu.
2319
2320 Example:
2321 This results in a menu, where the first two items are skipped starting with item number 3:
2322   begin = 3
2323
2324 Notice: Affects all sub menus as well. (See "minItems" for notice)]]></description>
2325 <default><![CDATA[
2326 ]]></default>
2327 </property>
2328 <property name="entryLevel" type="int">
2329 <description><![CDATA[Defines at which level in the rootLine, the menu should start.
2330 Default is "0" which gives us a menu of the very first pages on the site.
2331 If the value is < 0, entryLevel is chosen from "behind" in the rootLine. Thus "-1" is a menu with items from the outermost level, "-2" is the level before the outermost...]]></description>
2332 <default><![CDATA[0]]></default>
2333 </property>
2334 <property name="excludeDoktypes" type="intList">
2335 <description><![CDATA[list of integers
2336 Enter the list of page document types (doktype) to exclude from menus. By default pages that are "not in menu" (5) are excluded and those marked for backend user access only (6). ]]></description>
2337 <default><![CDATA[5,6]]></default>
2338 </property>
2339 <property name="excludeUidList" type="int">
2340 <description><![CDATA[list of integers
2341 This is a list of page uid's to exclude when the select statement is done. Comma-separated. You may add "current" to the list to exclude the current page.
2342
2343 Example:
2344 The pages with these uid-number will NOT be within the menu!! Additionally the current page is always excluded too.
2345   excludeUidList = 34,2,current]]></description>
2346 <default><![CDATA[
2347 ]]></default>
2348 </property>
2349 <property name="if" type="if">
2350 <description><![CDATA[If "if" returns false, the menu is not generated]]></description>
2351 <default><![CDATA[
2352 ]]></default>
2353 </property>
2354 <property name="includeNotInMenu" type="boolean">
2355 <description><![CDATA[If set, pages with type "Not in menu" will be included in menus.
2356 The number "5" will simply be removed from the current dok-type list (which is by default "5,6" but can be changed by "excludeDoktypes", see above).]]></description>
2357 <default><![CDATA[
2358 ]]></default>
2359 </property>
2360 <property name="maxItems" type="int">
2361 <description><![CDATA[The maximum items in the menu. More items will be ignored.
2362
2363 Notice: Affects all sub menus as well. (See "minItems" for notice)]]></description>
2364 <default><![CDATA[
2365 ]]></default>
2366 </property>
2367 <property name="minItems" type="int">
2368 <description><![CDATA[The minimum items in the menu. If the number of pages does not reach this level, a dummy-page with the title "..." and uid=[currentpage_id] is inserted.
2369
2370 Notice: Affects all sub menus as well. To set the value for each menu level individually, set the properties in the menu objects (see "Common properties" table).]]></description>
2371 <default><![CDATA[
2372 ]]></default>
2373 </property>
2374 <property name="protectLvar" type="string">
2375 <description><![CDATA[boolean / keyword
2376 If set, then for each page in the menu it will be checked if an Alternative Page Language record for the language defined in "config.sys_language_uid" (typically defined via &L) exists for the page. If that is not the case and the pages "Localization settings" have the "Hide page if no translation for current language exists" flag set, then the menu item will link to a non accessible page that will yield an error page to the user. Setting this option will prevent that situation by simply adding "&L=0" for such pages, meaning that they will switch to the default language rather than keeping the current language.
2377 The check is only carried out if a translation is requested ("config.sys_language_uid" is not zero).
2378
2379 Keyword: "all"
2380 When set to "all" the same check is carried out but it will not look if "Hide page if no translation for current language exists" is set - it always reverts to default language if no translation is found.
2381
2382 For these options to make sense, they should only be used when "config.sys_language_mode" is not set to "content_fallback".]]></description>
2383 <default><![CDATA[
2384 ]]></default>
2385 </property>
2386 <property name="special" type="HMENU_SPECIAL">
2387 <description><![CDATA["directory" / "list" / "updated" / "browse" / "rootline" / "keywords" / "language"
2388 (See TSref for details:
2389 <a href="https://docs.typo3.org/typo3cms/TyposcriptReference/ContentObjects/Hmenu/#hmenu-special-property">
2390 https://docs.typo3.org/typo3cms/TyposcriptReference/ContentObjects/Hmenu/#hmenu-special-property</a> )]]></description>
2391 <default><![CDATA[
2392 ]]></default>
2393 </property>
2394 <property name="stdWrap" type="stdWrap">
2395 <description><![CDATA[
2396 ]]></description>
2397 <default><![CDATA[
2398 ]]></default>
2399 </property>
2400 <property name="wrap" type="stdWrap">
2401 <description>wrap/stdWrap<![CDATA[
2402 ]]></description>
2403 <default><![CDATA[
2404 ]]></default>
2405 </property>
2406 </type>
2407 <type id="HMENU_SPECIAL">
2408 <property name="value" type="stdWrap">
2409 <description><![CDATA[list of page-uid's /stdWrap]]></description>
2410 <default><![CDATA[
2411 ]]></default>
2412 </property>
2413 </type>
2414 <type id="directory" extends="HMENU_SPECIAL"/>
2415 <type id="list" extends="HMENU_SPECIAL"/>
2416 <type id="updated" extends="HMENU_SPECIAL">
2417 <property name="mode" type="string">
2418 <description><![CDATA[Which field in the pages-table to use. Default is "SYS_LASTCHANGED" (which is updated when a page is generated to the youngest tstamp of the records on the page), "manual" or "lastUpdated" will use the field "lastUpdated" (set manually in the page-record) and "tstamp" will use the "tstamp"-field of the pagerecord, which is set automatically when the record is changed. "crdate" will use "crdate"-field of the pagerecord. "starttime" will use the starttime field.
2419
2420 Fields with zero value is not selected anyway.]]></description>
2421 <default><![CDATA[
2422 ]]></default>
2423 </property>
2424 <property name="depth" type="string">
2425 <description><![CDATA[By default (if the value is not an integer) the depth is 20 levels. The range is 1-20. A depth of 1 means only the start id, depth of 2 means start-id + first level. NOTE: depth is relative to beginAtLevel.
2426 ]]></description>
2427 <default><![CDATA[
2428 ]]></default>
2429 </property>
2430 <property name="beginAtLevel" type="int">
2431 <description><![CDATA[Determines starting level for the pagetrees generated based on .value and .depth. Zero is default and includes the start id. 1=starts with the first row of subpages, 2=starts with the second row of subpages. Depth is relative to this starting point.
2432 ]]></description>
2433 <default><![CDATA[
2434 ]]></default>
2435 </property>
2436 <property name="maxAge" type="string">
2437 <description><![CDATA[Seconds+calc.
2438 Pages with update-dates older than currenttime minus this number of seconds will not be shown in the menu no matter what. Default is "not used". You may use +-*/ for calculations.
2439 ]]></description>
2440 <default><![CDATA[
2441 ]]></default>
2442 </property>
2443 <property name="limit" type="int">
2444 <description><![CDATA[Max number of items in the menu. Default is 10, max is 100.
2445 ]]></description>
2446 <default><![CDATA[10
2447 ]]></default>
2448 </property>
2449 <property name="excludeNoSearchPages" type="boolean">
2450 <description><![CDATA[If set, pages marked "No search" is not included into special-menus.
2451 Support for Mount Pages: Yes.
2452 ]]></description>
2453 <default><![CDATA[
2454 ]]></default>
2455 </property>
2456 </type>
2457 <type id="rootline" extends="HMENU_SPECIAL">
2458 <property name="range" type="string">
2459 <description><![CDATA[rootline creates a menu with pages from the "rootline" (see earlier in this reference)
2460
2461 .range = [begin-level] | [end-level] (same way as you reference the .entryLevel for HMENU)
2462
2463 This...
2464
2465 page.2 = HMENU
2466 page.2.special = rootline
2467 page.2.special.range = 1|-2
2468 page.2.special.targets.3 = page
2469 page.2.1 = TMENU
2470 page.2.1.target = _top
2471 page.2.1.wrap = <HR> | <HR>
2472 page.2.1.NO {
2473 linkWrap = | >
2474 }
2475 ... creates a menu like this:
2476
2477 Page level 1 > Page level 2 > Page level 3 > Page level 4 >
2478
2479 (The menu starts at level 1 and does NOT link to the current page (-2 is the level before). Further all pages on level 3 will have "page" as target and all other "_top")
2480 ]]></description>
2481 <default><![CDATA[
2482 ]]></default>
2483 </property>
2484 <property name="reverseOrder" type="boolean">
2485 <description><![CDATA[If set to true, the order of the rootline menu elements will be reversed.
2486 ]]></description>
2487 <default><![CDATA[false]]></default>
2488 </property>
2489 <property name="targets" type="string">
2490 <description><![CDATA[.targets.[0-x] targets
2491
2492 This...
2493
2494 page.2 = HMENU
2495 page.2.special = rootline
2496 page.2.special.range = 1|-2
2497 page.2.special.targets.3 = page
2498 page.2.1 = TMENU
2499 page.2.1.target = _top
2500 page.2.1.wrap = <HR> | <HR>
2501 page.2.1.NO {
2502 linkWrap = | >
2503 }
2504
2505 ... creates a menu like this:
2506
2507 Page level 1 > Page level 2 > Page level 3 > Page level 4 >
2508
2509 (The menu starts at level 1 and does NOT link to the current page (-2 is the level before). Further all pages on level 3 will have "page" as target and all other "_top")
2510
2511 ]]></description>
2512 <default><![CDATA[
2513 ]]></default>
2514 </property>
2515 </type>
2516 <type id="browse" extends="HMENU_SPECIAL">
2517 <property name="items" type="string">
2518 <description><![CDATA[.items ( "|" separated list of "itemnames")
2519 This kind of menu is built of items given by a list from the property ".item". Each element in the list (sep. by "|") is either a reserved itemname (see list) with a predefined function or a userdefined name which you can assign a link to any page. Note that the current page cannot be the root-page of a site.
2520 ]]></description>
2521 <default><![CDATA[
2522 ]]></default>
2523 </property>
2524 <property name="items.prevnextToSection" type="boolean">
2525 <description><![CDATA[items.prevnextToSection (boolean) - if set, the "prev" and "next" navigation will jump to the next section when it reaches the end of pages in the current section.
2526 ]]></description>
2527 <default><![CDATA[
2528 ]]></default>
2529 </property>
2530 <property name="next" type="HMENU_SPECIAL_browseItem">
2531 <description><![CDATA[next / prev : links to next page / previous page. Next and previous pages are from the same "pid" as the current page id (or "value") - that is the next item in a menu with the current page. Also referred to as current level.
2532
2533 If ".prevnextToSection" is set then next/prev will link to the first page of next section / last page of previous section.
2534 ]]></description>
2535 <default><![CDATA[
2536 ]]></default>
2537 </property>
2538 <property name="prev" type="HMENU_SPECIAL_browseItem">
2539 <description><![CDATA[next / prev : links to next page / previous page. Next and previous pages are from the same "pid" as the current page id (or "value") - that is the next item in a menu with the current page. Also referred to as current level.
2540
2541 If ".prevnextToSection" is set then next/prev will link to the first page of next section / last page of previous section.
2542 ]]></description>
2543 <default><![CDATA[
2544 ]]></default>
2545 </property>
2546 <property name="nextsection" type="HMENU_SPECIAL_browseItem">
2547 <description><![CDATA[nextsection / prevsection : links to next section / previous section. A section is defined as the subpages of a page on the same level as the parent (pid) page of the current page. Will not work if parent page of current page is the root page of the site.
2548 ]]></description>
2549 <default><![CDATA[
2550 ]]></default>
2551 </property>
2552 <property name="prevsection" type="HMENU_SPECIAL_browseItem">
2553 <description><![CDATA[nextsection / prevsection : links to next section / previous section. A section is defined as the subpages of a page on the same level as the parent (pid) page of the current page. Will not work if parent page of current page is the root page of the site.
2554 ]]></description>
2555 <default><![CDATA[
2556 ]]></default>
2557 </property>
2558 <property name="nextsection_last" type="HMENU_SPECIAL_browseItem">
2559 <description><![CDATA[Where nextsection/prevsection links to the first page in a section, these links to the last pages. If there is only one page in the section that will be both first and last. Will not work if parent page of current page is the root page of the site.
2560 ]]></description>
2561 <default><![CDATA[
2562 ]]></default>
2563 </property>
2564 <property name="prevsection_last" type="HMENU_SPECIAL_browseItem">
2565 <description><![CDATA[Where nextsection/prevsection links to the first page in a section, these links to the last pages. If there is only one page in the section that will be both first and last. Will not work if parent page of current page is the root page of the site.
2566 ]]></description>
2567 <default><![CDATA[
2568 ]]></default>
2569 </property>
2570 <property name="first" type="HMENU_SPECIAL_browseItem">
2571 <description><![CDATA[First / Last page on current level. If there is only one page on the current level that page will be both first and last.
2572 ]]></description>
2573 <default><![CDATA[
2574 ]]></default>
2575 </property>
2576 <property name="last" type="HMENU_SPECIAL_browseItem">
2577 <description><![CDATA[First / Last page on current level. If there is only one page on the current level that page will be both first and last.
2578 ]]></description>
2579 <default><![CDATA[
2580 ]]></default>
2581 </property>
2582 <property name="up" type="HMENU_SPECIAL_browseItem">
2583 <description><![CDATA[Links to the parent (pid) page of the current page. (up 1 level) Will always be available
2584 ]]></description>
2585 <default><![CDATA[
2586 ]]></default>
2587 </property>
2588 <property name="index" type="HMENU_SPECIAL_browseItem">
2589 <description><![CDATA[Links to the parent of the parent page of the current page (up 2 levels). May not be available if that page is out of the rootline.
2590 ]]></description>
2591 <default><![CDATA[
2592 ]]></default>
2593 </property>
2594 </type>
2595 <type id="HMENU_SPECIAL_browseItem">
2596 <property name="target" type="string">
2597 <description><![CDATA[optional/alternative target of the item]]></description>
2598 <default><![CDATA[
2599 ]]></default>
2600 </property>
2601 <property name="uid" type="int">
2602 <description><![CDATA[. (uid of page) - optional/alternative page-uid to link to
2603 ]]></description>
2604 <default><![CDATA[
2605 ]]></default>
2606 </property>
2607 <property name="fields" type="string">
2608 <description><![CDATA[.[itemnames].fields.[fieldname] (string)
2609 override field "fieldname" in pagerecord.]]></description>
2610 <default><![CDATA[
2611 ]]></default>
2612 </property>
2613 </type>
2614 <type id="keywords" extends="HMENU_SPECIAL">
2615 <property name="mode" type="string">
2616 <description><![CDATA[Which field in the pages-table to use for sorting. Default is "SYS_LASTCHANGED" (which is updated when a page is generated to the youngest tstamp of the records on the page), "manual" or "lastUpdated" will use the field "lastUpdated" (set manually in the page-record) and "tstamp" will use the "tstamp"-field of the pagerecord, which is set automatically when the record is changed. "crdate" will use "crdate"-field of the pagerecord. "starttime" will use the starttime field.
2617 ]]></description>
2618 <default><![CDATA[
2619 ]]></default>
2620 </property>
2621 <property name="depth" type="string">
2622 <description><![CDATA[By default (if the value is not an integer) the depth is 20 levels. The range is 1-20. A depth of 1 means only the start id, depth of 2 means start-id + first level. NOTE: depth is relative to beginAtLevel.
2623 ]]></description>
2624 <default><![CDATA[
2625 ]]></default>
2626 </property>
2627 <property name="beginAtLevel" type="int">
2628 <description><![CDATA[Determines starting level for the pagetrees generated based on .value and .depth. Zero is default and includes the start id. 1=starts with the first row of subpages, 2=starts with the second row of subpages. Depth is relative to this starting point.
2629 ]]></description>
2630 <default><![CDATA[
2631 ]]></default>
2632 </property>
2633 <property name="limit" type="int">
2634 <description><![CDATA[Max number of items in the menu. Default is 10, max is 100.
2635 ]]></description>
2636 <default><![CDATA[10
2637 ]]></default>
2638 </property>
2639 <property name="excludeNoSearchPages" type="boolean">
2640 <description><![CDATA[If set, pages marked "No search" is not included into special-menus.
2641 Support for Mount Pages: Yes.
2642 ]]></description>
2643 <default><![CDATA[
2644 ]]></default>
2645 </property>
2646 <property name="entryLevel" type="string">
2647 <description><![CDATA[.entryLevel = where in the rootline the search begins. Standard rootline syntax (-x to x)]]></description>
2648 <default><![CDATA[
2649 ]]></default>
2650 </property>
2651 <property name="setKeywords" type="stdWrap">
2652 <description><![CDATA[.setKeywords (/stdWrap) = lets you define the keywords manually by defining them as a commaseparated list. If this property is defined, it overrides the default, which is the keywords of the current page.
2653 ]]></description>
2654 <default><![CDATA[
2655 ]]></default>
2656 </property>
2657 <property name="keywordsField" type="string">
2658 <description><![CDATA[.keywordsField = defines the field in the pages-table in which to search for the keywords. Default is the fieldname "keyword". No check is done to see if the field you enter here exists, so enter an existing field, OK?!]]></description>
2659 <default><![CDATA["keyword"
2660 ]]></default>
2661 </property>
2662 <property name="keywordsField.sourceField" type="string">
2663 <description><![CDATA[.keywordsField.sourceField = defines the field from the current page from which to take the keywords being matched. The default is "keyword". (Notice that ".keywordsField" is only setting the page-record field to search in !)]]></description>
2664 <default><![CDATA["keyword"
2665 ]]></default>
2666 </property>
2667 </type>
2668 <type id="language" extends="HMENU_SPECIAL"/>
2669 <type id="userdefined" extends="HMENU_SPECIAL">
2670 <property name="file" type="string">
2671 <description><![CDATA[.file [resource] = filename of the php-file to include.
2672 ]]></description>
2673 <default><![CDATA[
2674 ]]></default>
2675 </property>
2676 </type>
2677 <type id="userfunction" extends="HMENU_SPECIAL">
2678 <property name="userFunc" type="string">
2679 <description><![CDATA[.userFunc = function-name
2680 Calls a user function/method in class which should (as with "userdefined" above) return an array with page records for the menu.
2681 ]]></description>
2682 <default><![CDATA[
2683 ]]></default>
2684 </property>
2685 </type>
2686 <type id="mObj">
2687 <property name="alternativeSortingField" type="string">
2688 <description><![CDATA[Normally the menuitems are sorted by the fields "sorting" in the pages- and tt_content-table. Here you can enter a list of fields that is used in the SQL- "ORDER BY" statement instead.
2689
2690 Examples (for "pages" table):
2691 alternativeSortingField = title desc
2692 (This will render the menu in reversed alphabetical order)
2693
2694 LIMITATIONS:
2695 This property works with normal menus, sectionsIndex menus and special-menus of type "directory".]]></description>
2696 <default><![CDATA[
2697 ]]></default>
2698 </property>
2699 <property name="begin" type="int">
2700 <description><![CDATA[int +calc
2701 The first item in the menu.
2702
2703 Example:
2704 This results in a menu, where the first two items are skipped starting with item number 3:
2705   begin = 3
2706
2707 Takes precedence over HMENU.begin]]></description>
2708 <default><![CDATA[
2709 ]]></default>
2710 </property>
2711 <property name="imgNameNotRandom" type="boolean">
2712 <description><![CDATA[If set, the image names of menuitems is not randomly assigned. Useful switch if you're manipulating these images with some external JavaScript
2713
2714 NOTE: Don't set this if you're working with a menu with sectionIndex! In that case you need special unique names of items based on something else than the uid of the parent page of course!]]></description>
2715 <default><![CDATA[
2716 ]]></default>
2717 </property>
2718 <property name="imgNamePrefix" type="string">
2719 <description><![CDATA[prefix for the imagenames. This prefix is appended with the uid of the page.]]></description>
2720 <default><![CDATA["img"]]></default>
2721 </property>
2722 <property name="itemArrayProcFunc" type="string">
2723 <description><![CDATA[function-name
2724 The first variable passed to this function is the "menuArr" array with the menuitems as they are collected based on the type of menu.
2725 You're free to manipulate or add to this array as you like. Just remember to return the array again!
2726
2727 Note:
2728 .parentObj property is hardcoded to be a reference to the calling AbstractMenuContentObject object. Here you'll find eg. ->id to be the uid of the menu item generating a submenu and such.
2729
2730 Presetting element state
2731 You can override element states like SPC, IFSUB, ACT, CUR or USR by setting the key ITEM_STATE in the page records. See cObject HMENU/special=userdefined for more information.]]></description>
2732 <default><![CDATA[
2733 ]]></default>
2734 </property>
2735 <property name="maxItems" type="int">
2736 <description><![CDATA[The maximum items in the menu. More items will be ignored.
2737
2738 Takes precedence over HMENU.maxItems]]></description>
2739 <default><![CDATA[
2740 ]]></default>
2741 </property>
2742 <property name="minItems" type="int">
2743 <description><![CDATA[The minimum items in the menu. If the number of pages does not reach this level, a dummy-page with the title "..." and uid=[currentpage_id] is inserted.
2744
2745 Takes precedence over HMENU.minItems]]></description>
2746 <default><![CDATA[
2747 ]]></default>
2748 </property>
2749 <property name="sectionIndex" type="string">
2750 <description><![CDATA[This is a property that all menuObj's share. If it's set, then the menu will not consist of links to pages on the "next level" but rather links to the parent page to the menu, but in addition "#"-links to the cObjects rendered on the page. In other words, the menuitems will be links to the content elements (with colPos=0!) on the page. A section index.
2751
2752 .sectionIndex = [boolean]
2753
2754 If you set this, all content elements (from tt_content table) of "Column" = "Normal" and the "Index"-check box clicked are selected. This corresponds to the "Menu/Sitemap" content element when "Section index" is selected as type.
2755
2756 .sectionIndex.type = "all" / "header"
2757
2758 If you set this additional property to "all", then the "Index"-checkbox is not considered and all content elements with colPos=0 is selected.
2759
2760 If this property is "header" then only content elements with a visible header-layout (and a non-empty 'header'-field!) is selected. In other words, if the header layout of an element is set to "Hidden" then the page will not appear in the menu.
2761
2762 The data-record /Behind the scene:
2763
2764 When the menu-records are selected it works like this: The parent page record is used as the "base" for the menu-record. That means that any "no_cache" or "target"-properties of the parent page is used for the whole menu.
2765
2766 But of course some fields from the tt_content records are transferred: This is how it mapped:
2767
2768 $temp[$row[uid]]=$basePageRow;
2769
2770 $temp[$row[uid]]["title"]=$row["header"];
2771
2772 $temp[$row[uid]]["subtitle"]=$row["subheader"];
2773
2774 $temp[$row[uid]]["starttime"]=$row["starttime"];
2775
2776 $temp[$row[uid]]["endtime"]=$row["endtime"];
2777
2778 $temp[$row[uid]]["fe_group"]=$row["fe_group"];
2779
2780 $temp[$row[uid]]["media"]=$row["media"];
2781
2782 $temp[$row[uid]]["header_layout"]=$row["header_layout"];
2783
2784 $temp[$row[uid]]["bodytext"]=$row["bodytext"];
2785
2786 $temp[$row[uid]]["image"]=$row["image"];
2787
2788 $temp[$row[uid]]["sectionIndex_uid"]=$row["uid"];
2789
2790 Basically this shows that
2791
2792 - the field "header" and "subheader" from tt_content are mapped to "title" and "subtitle" in the pages-record. Thus you shouldn't need to change your standard menu-objects to fit this thing...
2793
2794 - the fields "starttime", "endtime", "fe_group", "media" from tt_content are mapped to the same fields in a pages-record.
2795
2796 - the fields "header_layout", "bodytext" and "image" are mapped to non-existing fields in the page-record
2797
2798 - a new field, "sectionIndex_uid" is introduced in the page-record which is detected by the function \TYPO3\CMS\Core\TypoScript\TemplateService->linkData(). If this field is present in a pagerecord, the linkData()-function will prepend a hash-mark and the number of the field.
2799
2800 NOTE:
2801
2802 You cannot create submenus to sectionIndex-menus. That doesn't make any sense as these elements are not pages and thereby have no "childs".
2803 ]]></description>
2804 <default><![CDATA[
2805 ]]></default>
2806 </property>
2807 <property name="showAccessRestrictedPages" type="string">
2808 <description><![CDATA[integer (page id) / keyword "NONE"
2809 If set, pages in the menu will include pages with frontend user group access enabled.  However the page is of course not accessible and therefore the URL in the menu will be linked to the page with the ID of this value. On that page you could put a login form or other message.
2810 If the value is "NONE" the link will not be changed and the site will perform page-not-found handling when clicked (which can be used to capture the event and act accordingly of course).
2811
2812 Properties:
2813 .addParam = Additional parameter for the URL, which can hold two markers; ###RETURN_URL### which will be substituted with the link the page would have had if it had been accessible and ###PAGE_ID### holding the page id of the page coming from (could be used to look up which fe_groups was required for access.
2814
2815 Example:
2816 showAccessRestrictedPages = 22
2817 showAccessRestrictedPages.addParams = &return_url=###RETURN_URL###&pageId=###PAGE_ID###
2818
2819 The example will link access restricted menu items to page id 22 with the return URL in the GET var "return_url" and the page id in the GET var "pageId".]]></description>
2820 <default><![CDATA[
2821 ]]></default>
2822 </property>
2823 <property name="submenuObjSuffixes" type="string">
2824 <description><![CDATA[Defines a suffix for alternative sub-level menu objects. Useful to create special submenus depending on their parent menu element. See example below.
2825
2826 Example:
2827 This example will generate a menu where the menu objects for the second level will differ depending on the number of the first level item for which the submenu is rendered. The second level objects used are "2" (the default), "2a" and "2b" (the alternatives). Which of them is used is defined by "1.submenuObjSuffixes" which has the configuration "a |*| |*| b". This configuration means that the first menu element will use configuration "2a" and the last will use "2b" while anything in between will use "2" (no suffix applied)
2828
2829 page.200 = HMENU
2830 page.200 {
2831   1 = TMENU
2832   1.wrap = <div style="width:200px; border: 1px solid;">|</div>
2833   1.expAll = 1
2834   1.submenuObjSuffixes = a |*|  |*| b
2835   1.NO.allWrap = <b>|</b><br/>
2836
2837   2 = TMENU
2838   2.NO.allWrap = <div style="background:red;">|</div>
2839
2840   2a = TMENU
2841   2a.NO.allWrap = <div style="background:yellow;">|</div>
2842
2843   2b = TMENU
2844   2b.NO.allWrap = <div style="background:green;">|</div>
2845 }
2846
2847 The result can be seen in the image below (applied on the testsite package):
2848
2849
2850
2851 Applies to GMENU, TMENU on >= 2nd level in a menu.]]></description>
2852 <default><![CDATA[
2853 ]]></default>
2854 </property>
2855 </type>
2856 <type id="GMENU" extends="mObj">
2857 <property name="ACT" type="GMENU_itemState">
2858 <description><![CDATA[Boolean / (config)
2859 Enable/Configuration for menu items which are found in the rootLine]]></description>
2860 <default><![CDATA[0]]></default>
2861 </property>
2862 <property name="ACTRO" type="GMENU_itemState">
2863 <description><![CDATA[Boolean / (config)
2864 Enable/Configuration for menu items which are found in the rootLine]]></description>
2865 <default><![CDATA[0]]></default>
2866 </property>
2867 <property name="ACTIFSUB" type="GMENU_itemState">
2868 <description><![CDATA[Boolean / (config)
2869 Enable/Configuration for menu items which are found in the rootLine and has subpages]]></description>
2870 <default><![CDATA[0]]></default>
2871 </property>
2872 <property name="ACTIFSUBRO" type="GMENU_itemState">
2873 <description><![CDATA[Boolean / (config)
2874 Enable/Configuration for menu items which are found in the rootLine and has subpages]]></description>
2875 <default><![CDATA[0]]></default>
2876 </property>
2877 <property name="CUR" type="GMENU_itemState">
2878 <description><![CDATA[Boolean / (config)
2879 Enable/Configuration for a menu item if the item is the current page.]]></description>
2880 <default><![CDATA[0]]></default>
2881 </property>
2882 <property name="CURRO" type="GMENU_itemState">
2883 <description><![CDATA[Boolean / (config)
2884 Enable/Configuration for a menu item if the item is the current page.]]></description>
2885 <default><![CDATA[0]]></default>
2886 </property>
2887 <property name="CURIFSUB" type="GMENU_itemState">
2888 <description><![CDATA[Boolean / (config)
2889 Enable/Configuration for a menu item if the item is the current page and has subpages.]]></description>
2890 <default><![CDATA[0]]></default>
2891 </property>
2892 <property name="CURIFSUBRO" type="GMENU_itemState">
2893 <description><![CDATA[Boolean / (config)
2894 Enable/Configuration for a menu item if the item is the current page and has subpages.]]></description>
2895 <default><![CDATA[0]]></default>
2896 </property>
2897 <property name="IFSUB" type="GMENU_itemState">
2898 <description><![CDATA[Boolean / (config)
2899 Enable/Configuration for menu items which has subpages]]></description>
2900 <default><![CDATA[0]]></default>
2901 </property>
2902 <property name="IFSUBRO" type="GMENU_itemState">
2903 <description><![CDATA[Boolean / (config)
2904 Enable/Configuration for menu items which has subpages]]></description>
2905 <default><![CDATA[0]]></default>
2906 </property>
2907 <property name="NO" type="GMENU_itemState">
2908 <description><![CDATA[Boolean / (config)
2909 The default "Normal" state rendering of Item. This is required for all menus.
2910 If you specify properties for the "NO" property you do not have to set it "1". Otherwise with no properties setting "NO=1" will render the menu anyways (for TMENU this may make sense).
2911
2912 The simplest menu TYPO3 can generate is then:
2913
2914 page.20 = HMENU
2915 page.20.1 = TMENU
2916 page.20.1.NO = 1
2917
2918 That will be pure <a> tags wrapped around page titles.]]></description>
2919 <default><![CDATA[1]]></default>
2920 </property>
2921 <property name="SPC" type="GMENU_itemState">
2922 <description><![CDATA[Boolean / (config)
2923 Enable/Configuration for 'Spacer' pages.
2924 Spacers are pages of the doktype "Spacer". These are not viewable pages but "placeholders" which can be used to divide menuitems.
2925
2926 Note: Rollovers doesn't work with spacers, if you use GMENU!]]></description>
2927 <default><![CDATA[0]]></default>
2928 </property>
2929 <property name="USERDEF1" type="GMENU_itemState">
2930 <description><![CDATA[Boolean / (config)
2931 Userdefined, see .itemArrayProcFunc for details on how to use this.
2932 You can set the ITEM_STATE values USERDEF1 and USERDEF2 (+...RO) from a script/userfunction processing the menu item array. See HMENU/special=userdefined or the property .itemArrayProcFunc of the menu objects.]]></description>
2933 <default><![CDATA[
2934 ]]></default>
2935 </property>
2936 <property name="USERDEF1RO" type="GMENU_itemState">
2937 <description><![CDATA[Boolean / (config)
2938 Userdefined, see .itemArrayProcFunc for details on how to use this.
2939 You can set the ITEM_STATE values USERDEF1 and USERDEF2 (+...RO) from a script/userfunction processing the menu item array. See HMENU/special=userdefined or the property .itemArrayProcFunc of the menu objects.]]></description>
2940 <default><![CDATA[
2941 ]]></default>
2942 </property>
2943 <property name="USERDEF2" type="GMENU_itemState">
2944 <description><![CDATA[Boolean / (config)
2945 (See above)]]></description>
2946 <default><![CDATA[
2947 ]]></default>
2948 </property>
2949 <property name="USERDEF2RO" type="GMENU_itemState">
2950 <description><![CDATA[Boolean / (config)
2951 (See above)]]></description>
2952 <default><![CDATA[
2953 ]]></default>
2954 </property>
2955 <property name="USR" type="GMENU_itemState">
2956 <description><![CDATA[Boolean / (config)
2957 Enable/Configuration for menu items which are access restricted pages that a user has access to.]]></description>
2958 <default><![CDATA[0]]></default>
2959 </property>
2960 <property name="USRRO" type="GMENU_itemState">
2961 <description><![CDATA[Boolean / (config)
2962 Enable/Configuration for menu items which are access restricted pages that a user has access to.]]></description>
2963 <default><![CDATA[0]]></default>
2964 </property>
2965 <property name="addParams" type="string">
2966 <description><![CDATA[Additional parameter for the menu-links.
2967 Example:
2968 "&some_var=some%20value"
2969 Must be rawurlencoded.
2970 Applies to GMENU, TMENU, IMGMENU]]></description>
2971 <default><![CDATA[
2972 ]]></default>
2973 </property>
2974 <property name="IProcFunc" type="string">
2975 <description><![CDATA[The internal array "I" is passed to this function and expected returned as well. Subsequent to this function call the menu item is compiled by implode()'ing the array $I[parts] in the passed array. Thus you may modify this if you need to.
2976 See example on the testsite and in media/scripts/example_itemArrayProcFunc.php]]></description>
2977 <default><![CDATA[
2978 ]]></default>
2979 </property>
2980 <property name="RO" type="boolean">
2981 <description><![CDATA[RollOver configuration enabled / disabled.
2982 If this is true, RO becomes a GIFBUILDER-object defining the layout of the menuitem when the mouse rolls over it]]></description>
2983 <default><![CDATA[0]]></default>
2984 </property>
2985 <property name="accessKey" type="boolean">
2986 <description><![CDATA[If set access-keys are set on the menu-links]]></description>
2987 <default><![CDATA[
2988 ]]></default>
2989 </property>
2990 <property name="applyTotalH" type="string">
2991 <description><![CDATA[objNumsList (offset)
2992
2993 This adds the total height of the previously generated menuitems to the offset of the GifBuilderObj's mentioned in this list.
2994
2995 Example:
2996 This is useful it you want to create a menu with individual items but a common background image that extends to the whole area behind the menu. Then you should setup the background image in each GIFBUILDER-object and include the object-number in this list.
2997 ]]></description>
2998 <default><![CDATA[
2999 ]]></default>
3000 </property>
3001 <property name="applyTotalW" type="string">
3002 <description><![CDATA[objNumsList (offset)
3003 This adds the total width of the previously generated menuitems to the offset of the GifBuilderObj's mentioned in this list.]]></description>
3004 <default><![CDATA[
3005 ]]></default>
3006 </property>
3007 <property name="collapse" type="boolean">
3008 <description><![CDATA[If set, "active" menuitems that has expanded the next level on the menu will now collapse that menu again.]]></description>
3009 <default><![CDATA[
3010 ]]></default>
3011 </property>
3012 <property name="debugItemConf" type="string">
3013 <description><![CDATA[Outputs (by the debug()-function) the configuration arrays for each menuitem. Useful to debug optionSplit things and such...
3014 Applies to GMENU, TMENU, IMGMENU]]></description>
3015 <default><![CDATA[
3016 ]]></default>
3017 </property>
3018 <property name="disableAltText" type="boolean">
3019 <description><![CDATA[If set, the alt-parameter of the images are not set. You can do it manually by "imgParams" (see below)]]></description>
3020 <default><![CDATA[
3021 ]]></default>
3022 </property>
3023 <property name="distributeX" type="int">
3024 <description><![CDATA[int+
3025 If set, the total width of all the menuitems will be equal to this number of pixels by adding/subtracting an equal amount of pixels to each menu items width.
3026 Will overrule any setting for ".useLargestItemX"]]></description>
3027 <default><![CDATA[
3028 ]]></default>
3029 </property>
3030 <property name="distributeY" type="int">
3031 <description><![CDATA[int+
3032 If set, the total height of all the menuitems will be equal to this number of pixels by adding/subtracting an equal amount of pixels to each menu items height.
3033 Will overrule any setting for ".useLargestItemY"]]></description>
3034 <default><![CDATA[
3035 ]]></default>
3036 </property>
3037 <property name="expAll" type="Boolean">
3038 <description><![CDATA[If this is true, the menu will always show the menu on the level underneath the menuitem. This corresponds to a situation where a user has clicked a menuitem and the menu folds out the next level. This can enable that to happen on all items as default.]]></description>
3039 <default><![CDATA[
3040 ]]></default>
3041 </property>
3042 <property name="forceTypeValue" type="int">
3043 <description><![CDATA[If set, the &type parameter of the link is forced to this value regardless of target. Overrides the global equivalent in 'config' if set.]]></description>
3044 <default><![CDATA[
3045 ]]></default>
3046 </property>
3047 <property name="JSWindow" type="boolean">
3048 <description><![CDATA[If set, the links of the menu-items will open by JavaScript in a pop-up window.
3049
3050 .newWindow boolean, that lets every menuitem open in its own window opposite to opening in the same window for each click.
3051
3052 .params is the list of parameters sent to the JavaScript open-window function, eg:
3053 width=200,height=300,status=0,menubar=0
3054 ]]></description>
3055 <default><![CDATA[
3056 ]]></default>
3057 </property>
3058 <property name="max" type="string">
3059 <description><![CDATA[x,y (calcInt)"
3060
3061 Forces the menu as a whole to these maximum dimensions]]></description>
3062 <default><![CDATA[
3063 ]]></default>
3064 </property>
3065 <property name="min" type="x,y (calcInt)">
3066 <description><![CDATA[Forces the menu as a whole to these minimum dimensions]]></description>
3067 <default><![CDATA[
3068 ]]></default>
3069 </property>
3070 <property name="overrideId" type="int">
3071 <description><![CDATA[integer (page-id)
3072 If set, then all links in the menu will point to this pageid. Instead the real uid of the page is sent by the parameter "&real_uid=[uid]".
3073 This feature is smart, if you have inserted a menu from somewhere else, perhaps a shared menu, but wants the menuitems to call the same page, which then generates a proper output based on the real_uid.
3074 Applies to GMENU, TMENU, IMGMENU]]></description>
3075 <default><![CDATA[
3076 ]]></default>
3077 </property>
3078 <property name="removeObjectsOfDummy" type="string">
3079 <description><![CDATA[objNumsList
3080
3081 If the menu is forced to a certain minimum dimension, this is a list of objects in the gifbuilder-object that is removed for this last item. This is important to do if the menuitems has elements that should only be applied if the item is actually a menuitem!!]]></description>
3082 <default><![CDATA[
3083 ]]></default>
3084 </property>
3085 <property name="stdWrap" type="stdWrap">
3086 <description><![CDATA[Wraps the whole item using stdWrap
3087
3088 Example:
3089 2 = TMENU
3090 2 {
3091   stdWrap.dataWrap = <ul class="{register :
3092      parentProperty}"> | </ul>
3093   NO {
3094     ...
3095   }
3096 }]]></description>
3097 <default><![CDATA[
3098 ]]></default>
3099 </property>
3100 <property name="target" type="string">
3101 <description><![CDATA[target
3102
3103 Target of the menulinks]]></description>
3104 <default><![CDATA[self]]></default>
3105 </property>
3106 <property name="submenuObjSuffixes" type="string">
3107 <description><![CDATA[Defines a suffix for alternative sub-level menu objects. Useful to create special submenus depending on their parent menu element. See example below.
3108
3109 Example:
3110 This example will generate a menu where the menu objects for the second level will differ depending on the number of the first level item for which the submenu is rendered. The second level objects used are "2" (the default), "2a" and "2b" (the alternatives). Which of them is used is defined by "1.submenuObjSuffixes" which has the configuration "a |*| |*| b". This configuration means that the first menu element will use configuration "2a" and the last will use "2b" while anything in between will use "2" (no suffix applied)
3111
3112 page.200 = HMENU
3113 page.200 {
3114   1 = TMENU
3115   1.wrap = <div style="width:200px; border: 1px solid;">|</div>
3116   1.expAll = 1
3117   1.submenuObjSuffixes = a |*|  |*| b
3118   1.NO.allWrap = <b>|</b><br/>
3119
3120   2 = TMENU
3121   2.NO.allWrap = <div style="background:red;">|</div>
3122
3123   2a = TMENU
3124   2a.NO.allWrap = <div style="background:yellow;">|</div>
3125
3126   2b = TMENU
3127   2b.NO.allWrap = <div style="background:green;">|</div>
3128 }
3129
3130 The result can be seen in the image below (applied on the testsite package):
3131
3132
3133
3134 Applies to GMENU, TMENU on >= 2nd level in a menu.]]></description>
3135 <default><![CDATA[
3136 ]]></default>
3137 </property>
3138 <property name="useLargestItemX" type="boolean">
3139 <description><![CDATA[If set, then the width of all menuitems will be equal to the largest of them all.]]></description>
3140 <default><![CDATA[
3141 ]]></default>
3142 </property>
3143 <property name="useLargestItemY" type="boolean">
3144 <description><![CDATA[If set, then the height of all menuitems will be equal to the largest of them all.]]></description>
3145 <default><![CDATA[
3146 ]]></default>
3147 </property>
3148 <property name="wrap" type="wrap">
3149 <description><![CDATA[Wraps only if there were items in the menu!]]></description>
3150 <default><![CDATA[
3151 ]]></default>
3152 </property>
3153 </type>
3154 <type id="GMENU_itemState" extends="GIFBUILDER">
3155 <property name="ATagParams" type="string">
3156 <description><![CDATA[Additional parameters]]></description>
3157 <default><![CDATA[
3158 ]]></default>
3159 </property>
3160 <property name="ATagTitle" type="stdWrap">
3161 <description><![CDATA[string /stdWrap
3162
3163 which defines the title attribute of the a-tag. (See TMENUITEM also)]]></description>
3164 <default><![CDATA[
3165 ]]></default>
3166 </property>
3167 <property name="additionalParams" type="string">
3168 <description><![CDATA[string /stdWrap
3169
3170 Define parameters that are added to the end of the URL. This must be code ready to insert after the last parameter.
3171
3172 For details, see typolink->additionalParams]]></description>
3173 <default><![CDATA[
3174 ]]></default>
3175 </property>
3176 <property name="allStdWrap" type="stdWrap">
3177 <description><![CDATA[stdWrap of the whole item]]></description>
3178 <default><![CDATA[
3179 ]]></default>
3180 </property>
3181 <property name="allWrap" type="stdWrap">
3182 <description><![CDATA[wrap /stdWrap
3183
3184 Wraps the whole item]]></description>
3185 <default><![CDATA[
3186 ]]></default>
3187 </property>
3188 <property name="altImgResource" type="imgResouce">
3189 <description><![CDATA[Defines an alternative image to use. If an image returns here, it will override any GIFBUILDER configuration.]]></description>
3190 <default><![CDATA[
3191 ]]></default>
3192 </property>
3193 <property name="altTarget" type="string">
3194 <description><![CDATA[Alternative target which overrides the target defined for the GMENU]]></description>
3195 <default><![CDATA[
3196 ]]></default>
3197 </property>
3198 <property name="imgParams" type="string">
3199 <description><![CDATA[params
3200
3201 Parameters for the <img>-tag]]></description>
3202 <default><![CDATA[
3203 ]]></default>
3204 </property>
3205 <property name="noLink" type="boolean">
3206 <description><![CDATA[If set, the item is NOT linked!]]></description>
3207 <default><![CDATA[
3208 ]]></default>
3209 </property>
3210 <property name="subst_elementUid" type="boolean">
3211 <description><![CDATA[If set, "{elementUid}" is substituted with the item uid.]]></description>
3212 <default><![CDATA[
3213 ]]></default>
3214 </property>
3215 <property name="wrap" type="wrap">
3216 <description><![CDATA[Wrap of the menu item]]></description>
3217 <default><![CDATA[
3218 ]]></default>
3219 </property>
3220 </type>
3221 <type id="IMGMENU" extends="mObj">
3222 <property name="ACT" type="IMGMENUITEM">
3223 <description><![CDATA[Boolean / (config)
3224 Enable/Configuration for menu items which are found in the rootLine]]></description>
3225 <default><![CDATA[0]]></default>
3226 </property>
3227 <property name="ACTRO" type="IMGMENUITEM">
3228 <description><![CDATA[Boolean / (config)
3229 Enable/Configuration for menu items which are found in the rootLine]]></description>
3230 <default><![CDATA[0]]></default>
3231 </property>
3232 <property name="ACTIFSUB" type="IMGMENUITEM">
3233 <description><![CDATA[Boolean / (config)
3234 Enable/Configuration for menu items which are found in the rootLine and has subpages]]></description>
3235 <default><![CDATA[0]]></default>
3236 </property>
3237 <property name="ACTIFSUBRO" type="IMGMENUITEM">
3238 <description><![CDATA[Boolean / (config)
3239 Enable/Configuration for menu items which are found in the rootLine and has subpages]]></description>
3240 <default><![CDATA[0]]></default>
3241 </property>
3242 <property name="CUR" type="IMGMENUITEM">
3243 <description><![CDATA[Boolean / (config)
3244 Enable/Configuration for a menu item if the item is the current page.]]></description>
3245 <default><![CDATA[0]]></default>
3246 </property>
3247 <property name="CURRO" type="IMGMENUITEM">
3248 <description><![CDATA[Boolean / (config)
3249 Enable/Configuration for a menu item if the item is the current page.]]></description>
3250 <default><![CDATA[0]]></default>
3251 </property>
3252 <property name="CURIFSUB" type="IMGMENUITEM">
3253 <description><![CDATA[Boolean / (config)
3254 Enable/Configuration for a menu item if the item is the current page and has subpages.]]></description>
3255 <default><![CDATA[0]]></default>
3256 </property>
3257 <property name="CURIFSUBRO" type="IMGMENUITEM">
3258 <description><![CDATA[Boolean / (config)
3259 Enable/Configuration for a menu item if the item is the current page and has subpages.]]></description>
3260 <default><![CDATA[0]]></default>
3261 </property>
3262 <property name="IFSUB" type="IMGMENUITEM">
3263 <description><![CDATA[Boolean / (config)
3264 Enable/Configuration for menu items which has subpages]]></description>
3265 <default><![CDATA[0]]></default>
3266 </property>
3267 <property name="IFSUBRO" type="IMGMENUITEM">
3268 <description><![CDATA[Boolean / (config)
3269 Enable/Configuration for menu items which has subpages]]></description>
3270 <default><![CDATA[0]]></default>
3271 </property>
3272 <property name="NO" type="IMGMENUITEM">
3273 <description><![CDATA[Boolean / (config)
3274 The default "Normal" state rendering of Item. This is required for all menus.
3275 If you specify properties for the "NO" property you do not have to set it "1". Otherwise with no properties setting "NO=1" will render the menu anyways (for TMENU this may make sense).
3276
3277 The simplest menu TYPO3 can generate is then:
3278
3279 page.20 = HMENU
3280 page.20.1 = TMENU
3281 page.20.1.NO = 1
3282
3283 That will be pure <a> tags wrapped around page titles.]]></description>
3284 <default><![CDATA[1]]></default>
3285 </property>
3286 <property name="SPC" type="IMGMENUITEM">
3287 <description><![CDATA[Boolean / (config)
3288 Enable/Configuration for 'Spacer' pages.
3289 Spacers are pages of the doktype "Spacer". These are not viewable pages but "placeholders" which can be used to divide menuitems.
3290
3291 Note: Rollovers doesn't work with spacers, if you use GMENU!]]></description>
3292 <default><![CDATA[0]]></default>
3293 </property>
3294 <property name="USERDEF1" type="IMGMENUITEM">
3295 <description><![CDATA[Boolean / (config)
3296 Userdefined, see .itemArrayProcFunc for details on how to use this.
3297 You can set the ITEM_STATE values USERDEF1 and USERDEF2 (+...RO) from a script/userfunction processing the menu item array. See HMENU/special=userdefined or the property .itemArrayProcFunc of the menu objects.]]></description>
3298 <default><![CDATA[
3299 ]]></default>
3300 </property>
3301 <property name="USERDEF1RO" type="IMGMENUITEM">
3302 <description><![CDATA[Boolean / (config)
3303 Userdefined, see .itemArrayProcFunc for details on how to use this.
3304 You can set the ITEM_STATE values USERDEF1 and USERDEF2 (+...RO) from a script/userfunction processing the menu item array. See HMENU/special=userdefined or the property .itemArrayProcFunc of the menu objects.]]></description>
3305 <default><![CDATA[
3306 ]]></default>
3307 </property>
3308 <property name="USERDEF2" type="IMGMENUITEM">
3309 <description><![CDATA[Boolean / (config)
3310 (See above)]]></description>
3311 <default><![CDATA[
3312 ]]></default>
3313 </property>
3314 <property name="USERDEF2RO" type="IMGMENUITEM">
3315 <description><![CDATA[Boolean / (config)
3316 (See above)]]></description>
3317 <default><![CDATA[
3318 ]]></default>
3319 </property>
3320 <property name="USR" type="IMGMENUITEM">
3321 <description><![CDATA[Boolean / (config)
3322 Enable/Configuration for menu items which are access restricted pages that a user has access to.]]></description>
3323 <default><![CDATA[0]]></default>
3324 </property>
3325 <property name="USRRO" type="IMGMENUITEM">
3326 <description><![CDATA[Boolean / (config)
3327 Enable/Configuration for menu items which are access restricted pages that a user has access to.]]></description>
3328 <default><![CDATA[0]]></default>
3329 </property>
3330 <property name="addParams" type="string">
3331 <description><![CDATA[Additional parameter for the menu-links.
3332 Example:
3333 "&some_var=some%20value"
3334 Must be rawurlencoded.
3335 Applies to GMENU, TMENU, IMGMENU]]></description>
3336 <default><![CDATA[
3337 ]]></default>
3338 </property>
3339 <property name="dWorkArea" type="string">
3340 <description><![CDATA[offset + calc
3341 Main offset of the GIFBUILDER-items (also called the "distribution")]]></description>
3342 <default><![CDATA[
3343 ]]></default>
3344 </property>
3345 <property name="debugItemConf" type="string">
3346 <description><![CDATA[Outputs (by the debug()-function) the configuration arrays for each menuitem. Useful to debug optionSplit things and such...
3347 Applies to GMENU, TMENU, IMGMENU]]></description>
3348 <default><![CDATA[
3349 ]]></default>
3350 </property>
3351 <property name="debugRenumberedObject" type="boolean">
3352 <description><![CDATA[if set, the final GIFBUILDER object configuration is output in order for you to debug your configuration]]></description>
3353 <default><![CDATA[
3354 ]]></default>
3355 </property>
3356 <property name="forceTypeValue" type="int">
3357 <description><![CDATA[If set, the &type parameter of the link is forced to this value regardless of target.]]></description>
3358 <default><![CDATA[
3359 ]]></default>
3360 </property>