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