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