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