Pending Documentation

From TYPO3Wiki

Jump to: navigation, search
Teams  R&D-Committee This page belongs to Core Team (Members|Contact). see our current activities
Current development and maintenance of the TYPO3 core is our mission.

Contents

[edit] Pending documentation

Warning   Enter here any documentation changes related to changed that are committed to Core SVN repository. Please don't insert any documentation for features that have not yet been committed. They will be removed.

Also don't forget to put the reference to the related RFC using the <bug>[bug number]</bug> syntax.

[edit] doc_inst_upgr

Needs to be applied by document owner (it is not in CoreDocs)

Dmitry, 29.01.2007: Re: [TYPO3-core] RFC: performance improvemenets for database:

 Starting from version 4.1 TYPO3 uses InnoDB as database engine for several tables. This helps to prevent
 locks and to increase performance. 
 Also InnoDB is more crash-resistant compared to MyISAM. We recommend to review your MySQL configuration
 and to ensure that your table space has the "autoexpand" option enabled. See MySQL manual for more information
 about configuring InnDB. If you do not have InnoDB enabled, MySQL will use MyISAM automatically and you
 need not take any actions"

 I think it can go to section 2.1 before "Very Important: Changing...".

[edit] doc_core_api

We should add a description about the cli_dispatch.phpsh script to the core api:

 [1]. 
 See Re: TYPO3-dev HowTo: Running a cronscript using TYPO3 with CLI


Stucki: adding new languages to TYPO3: see Ingmars note, copy text from config_default.php: http://lists.netfielders.de/pipermail/typo3-team-core/2007-August/008851.html


Benni: Add a new option to the Extension API => ext_emconf.php, see 9167: Feature: Mark extension as write protected [resolved to Dmitry Dulepov]

In the table of the parameters in the ext_emconf.php, add a new row containing:

* Column 1 (Key): "excludeFromUpdates" 
* Column 2 (Data Type): "Boolean"
* Column 3 (Description): If set, it is not possible to update the extension through the extension manager (neither by the Update mechanism, nor by uploading a newer version to the installation). This is very useful if you made local changes to an extension for a specific installation and don't want any admin to overwrite them.


Olly: IRRE - Integrate possibility to define enabledControls in TCA, see 8523: Integrate possibility to define enabledControls in TCA [resolved to Oliver Hader]

In doc_core_api, $TCA array reference, TYPE: "inline" -> new property for ['columns'][fieldname]['config']['appearance']

* enabledControls (array): Associative array with the keys 'info', 'new', 'dragdrop', 'sort', 'hide', 'delete', 'localize'. If the accordant values are set to a booelan value (true or false), the control is shown or hidden in the header of each record.


Ries:
Wrong link on http://typo3.org/documentation/document-library/core-documentation/doc_core_api/4.1.0/view/4/1/

the link Loading the full $TCA dynamically on this page


François: Custom subcategories for extension configuration, see 10333: Configurable Subcategories for ext_conf_template.txt [resolved to Francois Suter]

To insert in Chapter 2. TYPO3 Extension API, 2.1. Extension Architecture, before "ext_emconf.php"

ext_conf_template.txt

The role of this file was explained above, in the list of reserved filenames. The syntax used in this file is similar to the syntax used for the TypoScript constants files. This syntax is described in the "TypoScript Syntax and In-depth Study" manual (doc_core_ts). A typical configuration declaration will look like this:

#cat=basic//; type=integer; label=Number of entries per page: Set the number of log entries to display per page, when viewing all log entries
entriesPerPage = 25

Using custom subcategories is also possible for extension configuration options. Extending the previous example:

#customsubcategory=limits=LLL:EXT:devlog/locallang.xml:limits

#cat=basic/limits/; type=integer; label=Number of entries per page: Set the number of log entries to display per page, when viewing all log entries
entriesPerPage = 25

The syntax description in "TypoScript Syntax and In-depth Study" actually doesn't exist yet. I'm working on it, since there was no description of TS constants at all in this doc. The draft version is being prepared in the wiki: TypoScript_Constants

Steffen: 10144: enable JS-Libs in BE [resolved to Steffen Kamper]

== Using 3rd Party JS-Libraries in Backend  ==

Now using JS-libs in BE is very easy if you use template.php (as all modules does). 

Normally you have an instance of template.php in $this->doc (which will be used in the following examples) 

=== 1) Using Prototype library:  ===

use this syntax: 
<pre> 
$this->doc->loadPrototype();
</pre> 

that's all, prototype will be added to head of your document, any double inclusion will be prevented. 

=== 2) Using Scriptaculous  ===

use this syntax: 
<pre> $this->doc->loadScriptaculous();<br> </pre>
You want modules? any of this modules are valid: builder, effects, dragdrop, controls, slider 

use one or more like: 
<pre>
$this->doc->loadScriptaculous('slider');
$this->doc->loadScriptaculous('effects,dragdrop');
</pre>
If modules depend on other modules, it will automatically be added. Don't care order of calling, you can call this as often as you want, it will be included once with the correct modules. 

If you want all available modules, just call it with keyword 'all'<br>If you include Scriptaculous, Prototype will be added automatically. 

=== 3) Using extJS  ===

use this syntax: 
<pre>
$this->doc->loadExtJS();
</pre> 
There are 2 (optional) Parameters in this call: 
<pre> 
$this->doc->loadExtJS($css=true, $theme=true);

first parameter $css (boolean): if set, ext-all.css will be added automatically 
second parameter $theme (boolean): if set, theme-grey will be added automatically 
</pre> 
Additionally the function takes care of: 

*adding correct adapter 
*adding localization file of BE-User language 
*adding Ext.BLANK_IMAGE_URL

If you want to debug in extJS-lib, you can force debug-variant by calling 
<pre> 
$this->doc->setExtJSdebug();
</pre> 



Steffen, 2009-06-02 11019: User Setup Rewrite #4 [resolved to Steffen Kamper]

 Chapter 7 (new after 6)
User Settings ($GLOBALS['TYPO3_USER_SETTINGS'])

User settings have a configuration array that is quite similar to the $TCA, but has less options.

$GLOBALS['TYPO3_USER_SETTINGS']['ctrl']
property: dividers2tabs
data type: int
description: Render user setup with(out) tabs, settings are as in TCA: 0 = no tabs, 1 = tabs, empty tabs are hidden, 2 = tabs, empty tabs are disabled
default: 1

$GLOBALS['TYPO3_USER_SETTINGS']['columns'][fieldname]
This contains the configuration array for single fields in the user settings. This array allows the following configurations:

property: type
data type: string
description: defines the type of the input field
allowed: text, password, check, select

property: label
data type: string
description: label for the input field

property: csh
data type: string
description: CSH key for the input field

property: access
data type: string
description: access control. At the moment only a admin-check is implemented
allowed: admin

property: table
data type: string
description: if the user setting is saved in a DB table, this property sets the table. At the moment only be_users is implemented 
allowed: be_users


property: eval
data type: string
description: eval field to md5 (used for password field)
allowed: md5

property: items
data type: array
description: array of key-value pair for select items 
allowed: only used by type=select


property: itemsProcFunc
data type: string
description: define extern method for render items of select. Other than TCA you have to render the <select> tag too 
allowed: only for type=select, use class->method syntax


$GLOBALS['TYPO3_USER_SETTINGS']['showitem']
This string is used for rendering the FORM in the user setup module. Fields are rendered in the order of this string containing the commalist of fieldnames.
To use a tab insert a "--div--;LABEL" item in the commalist.

[edit] doc_core_cgl

Olly: Missing documentation for new getRecordTitle() in TYPO3 4.1.0 (committed 2007-12-12 by Ingmar):

(add to the end of "TYPO3 specific practices" on page 18)
Backend: Always use the function t3lib_BEfunc::getRecordTitle() to get the
title of a specific record. Using $TCA[“tablename”][“ctrl”][“label”] directly
is not allowed, since it bypasses the other settings related to record-title-building (such as “label_alt” or “label_userFunc”).

Benni: Missing subsection about deprecation.

 How and When To Deprecate APIs
 Here are some general rules on how to remove existing functions or parameters from TYPO3. Generally, functions or parameters are removed two major versions after they were set to be deprecated.
 
 If you want to remove a parameter of a TYPO3 core function, please note it within the phpDoc param part:
 
 /**
  * ...
  * @param	string	DEPRECATED since TYPO3 4.X - is not used anymore because...
  * ... 
  */
 
 For removing a whole function in one of the TYPO3 core classes, you can use the phpDoc @deprecated parameter. Use it like this:
 
 /**
  * ...
  * @return...
  * @deprecated since TYPO3 4.X - is not used anymore, use FUNCNAME instead 
  */
 
 The release-manager of version TYPO3 4.X+2 will remove deprecated parameters or functions then.

[edit] doc_core_tsref

Benjamin Mack, 2009-06-19

Feature #10673: CSS-Styled-Content "uploads" - the filelist can now be manipulated by TS, added a new property "tt_content.uploads.20.filePath" with stdWrap properties to dynamically fetch all files from a filePath

Although this is a change in css_styled_content it is available here:

tt_content.uploads.20.filePath
string + stdWrap
This allows you to set the filepath where images are taken from to be set via TypoScript, with a stdWrap option to dynamically set this value. By default this is set to get the value from the data record field "select_key" (to have the same behaviour as before but the value always taken from the TypoScript value) 
default:
  tt_content.uploads.20.filePath.field = select_key


Yannick Pavard, 2009-05-08

in TSref [tsref:Content Objects (cObject)/->IMAGE] Property table

Please add emptyTitleHandling propriety and new value "remove" for remote title attribute

Thanks

Sonja Scholz, 2009-03-19

Change in TSref [tsref:(cObject).FORM]
Add to example mailform:
| from_name=hidden | Website XY 
| from_email=hidden | noreply@website.com
| organisation=hidden | Organisation XY
| redirect=hidden | 16
| priority=hidden | 5

Replace this example rows:
Name: | *the name = input | Enter your name here
Email: | *email=input | 
with this:
Name: | *replyto_name=input | Enter your name here
Email: | *replyto_email=input

Add the following explanations for the example rows:
"from_name": With this option you can set the mail header from name, which will be shown in the mail software.
"from_email": With this option you can set the mail header from email, which will be shown in the mail software as sender address.
"organisation": With this option you can set the mail header organisation param, which won't be shown in the mail but in the mail header.
"redirect": With this option you can define a TYPO3 page (page id) or external URL (www.example.com) as redirect url after submit. If this option isn't set the form will be shown again.
"priority": With this option you can set the priority of the mail from 1(not important) to 5(very important). Default is 3.
"replyto_name": If the field is named like this the value is used as reply to name in the email software and will not be shown in the mail content. Choose another field name like the_name to use the value as a normal field.
"replyto_email": If the field is named like this the value is used as reply to email address in the email software and will not be shown in the mail content. To get the value as sender address in the mail software use "email" as field name.


Georg Ringer, 2008-03-10 7812: cObj CONTENT should be allowed with static_* tables [resolved to Martin Kutschker]

Change in TSref [tsref:Content Objects (cObject)/->CONTENT] Property table
NOTE: Only tables allowed are “pages” or tables prefixed with one of these: “tt_”, “tx_”, “ttx_”, “fe_”, “user_”
to
NOTE: The only tables allowed are “pages” or tables prefixed with one of these: “tt_”, “tx_”, “ttx_”, “fe_”, “user_”,  “static_”


Georg Ringer, 2007-11-14 6711: Enable stdWrap for the image in imageLinkWrap [resolved to Martin Kutschker]: stdWrap for imageLinkWrap (Ingmar: Has this been committed yet? François: No)

TSref [tsref:(functions).imageLinkWrap]
Property: stdWrap
Data type: stdWrap
Description: Enable stdWrap for the image


Ernesto Baschny, 2008-10-01 6525: wrapItemAndSub for GMENU [resolved to Ernesto Baschny]: added .wrapItemAndSub for GMENU (commited to trunk, will be in 4.3, rev. 4264).

TSref [tsref:(cObject).HMENU.(mObj).GMENU.(itemState)]
Property: wrapItemAndSub
Data type: wrap /+stdWrap
Description: Wraps the whole item and any submenu concatenated to it.


Steffen Kamper 9901: Enable stdWrap for expAll [resolved to Steffen Kamper]

TSref
TMENU
Property: expAll
Data type: boolean / stdWrap


François Suter, on behalf of Ralf Hettinger, 2008-10-31 6626: config.fileTarget for default link target on files [resolved to Jeff Segars]

TSref [tsref:config/->CONFIG] 

Add after extTarget: 

Property: fileTarget 

Data type: target 

Description: default file link target. Used by typolink if no fileTarget is set. 

[tsref:->typolink] 

Add after extTarget: 

Property: fileTarget 

Data type: target/stdWrap 

Description: target used for file links 


Oliver Hader, on behalf of Ralf Hettinger, 2008-11-01 6637: Integrate possibility to reverse order of rootline HMENU [resolved to Oliver Hader]

TSref [tsref:(cObject).HMENU.special]

Add to description field for type 'rootline':

If .reverseOrder=[boolean] is set, the order of rootline menu elements will be reversed. Default: false


Steffen Kamper 9661: Extend condition operators for globalVar [resolved to Oliver Hader]

TSref Conditions, globalVars:

Change section header from "globalVars:" to "globalVar:"

"Syntax:" - replace with:

[hour = hour1, > hour2, < hour3, <= hour4 , >= hour5, != hour6, ...]

"Comparison:" - replace table data with:

Operator: Function:
=         Requires exact match       
>         The var must be greather than the value
<         The var must be less than the value
<=        The var must be less or equal than the value
>=        The var mast be greater or equal than the value
!=        The var must be not equal to the value

Add new examples below the table:

This will match, if the page-id is higher than or equal 10:
[globalVar = TSFE:id >= 10] 

This will match, if the page-id is not equal to 316:
[globalVar = TSFE:id != 316] 

This will match the not-existing GPvar style:
[globalVar = GPvar:style = ] </pre>


Oliver Hader, on behalf of Susanne Moog, 2008-12-20 5835: get rid of clear.gif with space [resolved to Thorsten Kahler]

TSref [tsref:(functions).stdWrap]
For property "space" change data type to "space / stdWrap"


Oliver Hader, 2009-01-08 4427: Enable stdWrap for HMENU.alwaysActivePIDlist [resolved to Oliver Hader]

TSref, Content Objects (cObject), HMENU:
For property "alwaysActivePIDlist" change data type to "list of integers / stdWrap"


Steffen Müller, 2009-02-06 10357: Add gp as an alternative to gpvar in TS getText for a more consistent naming scheme [resolved to Ingo Renner]

TSref, Conditions, globalString:
Example:

 Change from (old):
Caring about this means that you would get values like HTTP_HOST by getenv(), you would retrieve GET/POST values with t3lib_div::GPvar().

 Change to (new):
Caring about this means that you would get values like HTTP_HOST by getenv(), you would retrieve GET/POST values with t3lib_div::_GP().


TSref, Data types, getText:

Data-type: getText

Example:

 Change from (old):
get input value from query string, (&stuff=)
= GPvar : stuff
get input value from query string, (&stuff[key]=)
= GPvar : stuff | key

 Change to (new):
get input value from query string, (&stuff=) DEPRECATED since 4.3, use GP
= GPvar : stuff
get input value from query string, (&stuff[key]=) DEPRECATED since 4.3, use GP
= GPvar : stuff | key

get input value from query string, (&stuff=) (use this instead of GPvar)
= GP : stuff
get input value from query string, (&stuff[key]=) (use this instead of GPvar)
= GP : stuff | key

Comment:

 Change from (old):
global : [GLOBAL-var, split with | if you want to get from an array! DEPRECATED, use GPvar, TSFE or getenv]
GPvar: Value from GET or POST method. Use this instead of global

 Change to (new):
global : [GLOBAL-var, split with | if you want to get from an array! DEPRECATED, use GP, TSFE or getenv]
GPvar: Value from GET or POST method. DEPRECATED since 4.3, use GP
GP: Value from GET or POST method. Use this instead of global or GPvar.

Steffen Kamper, 2009-03-27, 10025: ImageMagick generates larger than necessary files [resolved to Steffen Kamper] TSref, IMG_RESOURCE, file:

IMAGE, file:
stripProfile	
Boolean		
If set, IM-comand will use a stripProfile-command which shrinks the generated thumbs. See install tool for options and details. 
If im_useStripProfileByDefault is set in the install tool, you can deactivate it by setting stripProfile=0 
Example:
10 = IMAGE
10.file = fileadmin/images/image1.jpg
10.file.stripProfile = 1

Note: i wonder where the other params are described, maxW,maxH etc i only saw in texpic. I'm missing something?

Oliver Hader, 2009-04-16, 10725: Integrate possibility to determine maximum of multiple values in GIFBUILDER [resolved to Oliver Hader]

TSref: GIFBUILDER, section "NOTE (+calc)"
Add after first paragraph and before example starts:
On using the special function max(), the maximum of multiple values can
be determined.
Example: XY: [10.w]+[20.w], max([10.h], [20.h])


Oliver Hader, 2009-05-03, 10666: Integrate automatic line breaks in GIFBUILDER [resolved to Oliver Hader]

TSref: GIFBUILDER, NOTE (+calc):
Add to first paragraph:
The property "lineHeight" (e.g. "[10.lineHeight]") uses the the height a
single line of text would take.

TSref: GIFBUILDER, [tsref:->GIFBUILDER.(GBObj).TEXT]:
Add new properties after "text":
1) Property: breakWidth
   Data type: integer
   Description: Defines the maximum width for an object, overlapping
   elements will force an automatic line break.

2) Property: breakSpace
   Data type: float
   Description: Defines a value that is multiplied by the line height of
   the current element.
   Default: 1.0



Georg Ringer, 2009-05-31 11229: stdwrap to override image of imageLinkWrap [resolved to Christian Kuhn]: new option file for imageLinkWrap

TSref [tsref:(functions).imageLinkWrap]
add somewhere in the beginning the new option file
Property: file
Data type: stdWrap
Description: Override the path of the image which is displayed

[edit] doc_core_tsconfig

9140: Options from extra_page_cm_options should be able to be hidden individually [resolved to Oliver Hader] & 3687: Disable "versioning"-menuitem via contextMenu.[key].disableItems in User TSconfig [resolved to Jeff Segars]

doc_core_tsconfig -> userTS -> OPTIONS

http://typo3.org/documentation/document-library/core-documentation/doc_core_tsconfig/4.2.0/view/1/2/

change description of contextMenu.[key].disableItems to

Property: contextMenu.[key].disableItems
Description:[...]Items to disable are (for “page” type - that is database records):
view,edit,hide,new,info,copy,cut,paste,delete,move_wizard,
history,perms,new_wizard,hide,edit_access,edit_pageheader,db_list,versioning,moreoptions[...]

Steffen, 2008-10-20, 8899: [feature] Configuration of uploads and create folder in linkbrowser [resolved to Steffen Kamper]

doc_core_tsconfig -> userTS -> OPTIONS

http://typo3.org/documentation/document-library/core-documentation/doc_core_tsconfig/4.1.0/view/1/2/#id3927218

add following properties:

Property: folderTree.uploadFieldsInLinkBrowser
Data type: int
Description: This value defines the number of upload fields in the element browser. Default value is 3, if set to 0, no upload form will be shown.
Default: 3
Property: folderTree.hideCreateFolder

Data type: boolean Description: If set, the user can't create new folders. Default: false








Olly, 2008-12-30, 5610: Extend TCEFORM_confObj on Page TSconfig by property keepItems [resolved to Oliver Hader]

Insert in doc_core_tsconfig, Page TSconfig, section TCEFORM_confObj, before property "removeItems":

Property:
keepItems

Data type:
list of values

Description:
Reduce/filter a given set of elements to fit the condition defined here.
No elements will be set, only those that were set before will be kept and everything else gets removed (mathematical "intersection").

Example:
TCEFORM.pages.doktype {
  keepItems = 1,2,255
}

Steffen, 2008-02-17 10338: Feature: NewRecordWizard with grouping and sorting [resolved to Steffen Kamper]

Documentation of New Record Wizard

pageTS config
mod.wizards.newRecord.order = [list of extensionkeys]

System Records are using the key "system"
If you want to have system records and news placed on top, use this setting:

mod.wizards.newRecord.order = system,tt_news

Steffen, 2008-02-05 9439: New Element Wizard has no option for hiding Elements via pageTS [resolved to Steffen Kamper]

Documentation of New Content Element Wizard

pageTS config
mod.wizards.newContentElement

renderMode				string		Alternative render mode; set to tabs, if you want tabs. Default: empty
wizardItems				array		Array of wizards
wizardItems.[group]			array		Group for wizards. Default groups are: common, special, forms, plugins
wizardItems.[group].header		string		Header string for the wizard group
wizardItems.[group].show		string		Comma-seperated list of wizards to show in this group, * is wildcard for all
wizardItems.[group].elements		array		Array of wizards in this group
wizardItems.[group].elements.[name]	array		Configuration of a single wizard
	icon				string		Path to the icon 	
	title				string		Title of the wizard
	description			string		Description of the wizard
	tt_content_defValues		array		Default values for tt_content




Examples
===========================================================================================================================
Render with tabs:
mod.wizards.newContentElement.renderMode = tabs


Hide bulletList:
mod.wizards.newContentElement.wizardItems.common.show := removeFromList(bullets)



Only show text and textpic in common:
mod.wizards.newContentElement.wizardItems.common.show = text,textpic



Add a new element (header):
mod.wizards.newContentElement.wizardItems.common.elements.header {
	icon = gfx/c_wiz/regular_text.gif
	title = Header
	description = Adds a header element only
	tt_content_defValues {
		CType = header
	}
}
mod.wizards.newContentElement.wizardItems.common.show := addToList(header)



Add a prefilled element to a new group:
mod.wizards.newContentElement.wizardItems.myGroup {
	header = My Company Special Items
	elements.customText {
		icon = gfx/c_wiz/regular_text.gif
		title = Introtext for national startpage
		description = use this element for all national startpages 
		tt_content_defValues {
			CType = text
			bodytext ( 
<h2>Section Header</h2>
<p class="bodytext">Lorem ipsum dolor sit amet, consectetur, sadipisci velit ...</p>
			)
			header = Section Header
			header_layout = 100
		}
	}
}
mod.wizards.newContentElement.wizardItems.myGroup.show = customText



Xavier Perseguers, 23.03.2009: 10432: Page TS option to disable avaiable languages [resolved to Steffen Kamper]

 Page TSconfig -> Page (mod.SHARED): Add new property

 property: disableLanguages
 data type: comma-separated list of language UID
 description:
 This allows a set of languages to be unavailable for a subtree

Steffen, 2009-04-19 10827: Hide "Save and View"-button when editing a content-element [resolved to Steffen Kamper] ->OPTIONS

property: saveDocView
saveDocView.[table] 
data type: boolean
description: If set, a button “Save and view” will appear in TCEFORMs.
Any value set for a single table will override the default value set to the object “saveDocView”.
default: 1

Steffen, 2009-04-19 10919: Hide View-icon in listview with doktypes 254 and 255 [resolved to Steffen Kamper] mod.web_list

property: mod.web_list.noViewWithDokTypes 
data type: comma-separated list of dokTypes
description: hide view icon for the defined dokTypes
default: 254,255

Steffen, 2009-04-19 10550: Listview: default limits are hardcoded [resolved to Steffen Kamper]

mod.web_list

property: itemsLimitSingleTable
data type: int
description: set the default max. number of items to show in single table view
default: 100

property: itemsLimitPerTable
data type: int
description: set the default max. number of items to show per table
default: 20

[edit] doc_indexed_search

Nothing for now.

[edit] doc_template

[Dmitry] Documentation template still has old TYPO3 logo -- must be replaced with new! Issue found by ben van 't ende (Netcreators).

[edit] css_styled_content

  • Michael Stucki, 2009-02-27: The document should be moved to CoreDocs.
  • On 2009-02-27, the default value of "separateRows" was changed to "1" (see Core List, subject "[TYPO3-core] Re: FYI24 - Follow-up to #10083")
  • Add info on the new fallbackRendering method 11107: Provide more flexible rendering for "text with image" [resolved to Ernesto Baschny]:
    • New property ".fallbackRendering", cObject.
      Can be used to overwrite the rendering method in specific "edge" situations (e.g. when rendering only one image, or when rendering a list of files without captions). This cObject will be called once the major "rendering" type is defined (dl, ul, div) and when the pre-processor already has gathered some information about how many images to render (register:imageCount) and if the current rendering will output a global caption for the whole image block or split captions are needed (register:renderGlobalCaption). Using this information the fallbackRendering can output some string, which will overwrite the default rendering method (e.g. dl, ul, div and newly introduced "simple", which renders least structure, intended for one image only).
      The default css_styled_content setup in TYPO3 v4.3 provides these fallbacks (when loading the v4.3 static template from css_styled_content):
      • with rendering=dl,ul,div, a single image fallbacks to rendering=simple
      • with rendering=dl, a list of images with no caption fallbacks to rendering=ul
      • with rendering=dl, a list of images with one "global" caption (no splitCaption configured) fallbacks to rendering=ul
  • For "render_uploads" userFunc, added properties 2421: Moving all HTML fromtx_cssstyledcontent_pi1 to TS [resolved to Ernesto Baschny]:
    • .itemRendering, cObject/+optionSplit. Provides the rendering information for every row in the file list. Each file will be rendered with this cObject, optionSplit will be applied to the whole itemRendering array so that different rendering needs can be applied to indidivual rows. Default rendering in css_styled_content is a COA for table based rendering with even/odd classes in the rows. Available registers at this point are:
      • linkedIcon: a linked icon representing the file (either extension-dependent or a thumbnail of the image)
      • linkedLabel: the linked text, usually the filename. The text can be overwritten using the labelStdWrap property.
      • filename: the filename being rendered (with extension, but without path)
      • path: the full path of the file
      • description: optional, if available
      • fileSize: the size of the file in bytes
      • fileExtension: the extension of the file (e.g. "pdf", "gif", etc)
    • Example:
	itemRendering = COA
	itemRendering {
		wrap = <tr class="tr-odd tr-first">|</tr> |*| <tr class="tr-even">|</tr> || <tr class="tr-odd">|</tr> |*|

		10 = TEXT
		10.data = register:linkedIcon
		10.wrap = <td class="csc-uploads-icon">|</td>
		10.if.isPositive.field = layout

		20 = COA
		20.wrap = <td class="csc-uploads-fileName">|</td>
		20.1 = TEXT
		20.1 {
			data = register:linkedLabel
			wrap = <p>|</p>
		}
		20.2 = TEXT
		20.2 {
			data = register:description
			wrap = <p class="csc-uploads-description">|</p>
			required = 1
		}

		30 = TEXT
		30.if.isTrue.field = filelink_size
		30.data = register:fileSize
		30.wrap = <td class="csc-uploads-fileSize">|</td>
		30.bytes = 1
		30.bytes.labels = {$styles.content.uploads.filesizeBytesLabels}
	}
    • .labelStdWrap, stdWrap. Provides a mean to override the default text that is linked in the "linkedLabel" registry for each itemRendering. Registry items filename, path, description, fileSize and fileExtension are available at this point.

Example:

tt_content.uploads.20.labelStdWrap.override.data = register:description

[edit] Changes committed to CoreDocs, please review and remove when ok

When a pending documentation change is committed to the Core Documentation, it is removed from this page and moved to the Documentation for Review.

[edit] Errata

Please don't report errors in the Core Documentation here. Use the bug tracker (http://bugs.typo3.org/) to report an issue. Choose the project "Documentation" and the category "OpenOffice (SXW)".

Personal tools