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