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