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