DEPRECATION WARNING
This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.
EXT: Readable name of your extension¶
| Author: | Kasper Skårhøj |
|---|---|
| Created: | 2002-11-01T00:32:00 |
| Changed: | 2008-08-20T11:40:23 |
| Classification: | extensionkey |
| Description: | The keywords help with categorizing and tagging of the manuals. You can combine two or more keywords and add additional keywords yourself. Please use at least one keyword from both lists. If your manual is NOT in english, see next tab "language" ---- forEditors (use this for editors / german "Redakteure") forAdmins (use this for Administrators) forDevelopers (use this for Developers) forBeginners (manuals covering TYPO3 basics) forIntermediates (manuals going into more depth) forAdvanced (covering the most advanced TYPO3 topics) see more: http://wiki.typo3.org/doc_template#tags ---- |
| Keywords: | keywords comma-separated |
| Author: | Author name |
| Email: | you@email.com |
| empty: | |
| language (EN, DE, FR, NL, DK, ES, DK, ... ): | |
| EN | |
EXT: Readable name of your extension - extensionkey
EXT: Accordion Ext JS¶
extensionkey: pf_accordion
keywords: accordion, Ext JS, javascript, slider
language: EN
Copyright 2000-2008, Peter Foerger, <pfoerger@gmail.com>
This document is published under the Open Content License
available from http://www.opencontent.org/opl.shtml
The content of this document is related to TYPO3
- a GNU/GPL CMS/Framework available from www.typo3.org
Table of Contents¶
EXT: Accordion Ext JS 1
1 Introduction 3
1.1. What does it do? 3
1.2. Screenshots 3
2 Users manual 4
2.1. FAQ 4
3 Configuration 5
3.1. Reference 5
4 Known problems 6
5 To-Do list 7
6 ChangeLog 8
Introduction¶
What does it do?¶
Displays content elements as a accordion, based on the Ext JS javascript framework. The extension is intended for developers who like to use Ext JS as their main javascript framework and don't want to get upset running different frameworks in parallel.
Users manual¶
Install as usual. Include the static template to your main TypoScript template. While creating/editing content elements you will find a new checkbox labeled 'Accordion Ext JS' in the 'Type-Section' of all content elements.If you set this flag and have a proper configuration as descried in next section your content element will ready for sliding in/out.
FAQ¶
Do I need to include ext-adapter and resources by myself?In order to make use of the accordion feature only you can easily relay on the customized build that comes with the extension (res/ext.js). To enable all features of Ext JS (and that's what you want, won't you?) include the appropriate adapter and ext-all.js or build your own.
Configuration¶
TypoScript setup to use the resources supplied by the extension:
Include CSS file
page.includeCSS.file1 = EXT:pf_accordion/res/pfaccordion.css
Include javascript resources:
page.includeJS.file51 = EXT:pf_accordion/res/ext.js page.includeJS.file52 = EXT:pf_accordion/res/pfaccordion.js
Set the plugin as the render object:
page.10.subparts.YOUR_SUBPART.renderObj < plugin.tx_pfaccordion
or in case you are using TemplaVoila modify your data-structure. Most likely this will be the node that holds your main content. Scroll to the TypoScript section of that node add at least the plugin as the render object (conf.tt_content < plugin.tx_pfaccordion). The TypoScript node should look similar to this:
<TypoScript>
<![CDATA[
10= RECORDS
10.source.current=1
10.tables = tt_content
10.wrap = <!--TYPO3SEARCH_begin--> | <!--TYPO3SEARCH_end-->
10.conf.tt_content < plugin.tx_pfaccordion
]]>
</TypoScript>
Reference¶
Reference (TypoScript)
The extension comes with a static TypoScript template which is in charge of wrapping the content element with the css-styles required. It is basically an 'outerWrap' prepended by the 'header' of the corresponding content object. The content is also wrappped by a couple of classes responsible for the nice box with round edges. These are optional and can be safely removed.
stdWrap.outerWrap¶
Property
stdWrap.outerWrap
Data type
wrap
Description
Wraps the content element with the css classes used to display the element as an accordion
Default
@see static/setup.txt
stdWrap.prepend¶
Property
stdWrap.prepend
Data type
string
Description
Used to prepend a cObject that holds the header field by default
Default
@see static/setup.txt
fieldRequired¶
Property
fieldRequired
Data type
string
Description
Field required to render the ts-code
Default
tx_pfaccordion_accordion
lib.header¶
Property
lib.header
Data type
string
Description
Renders default header. As we have already included the header we remove it.
Default
false
Known problems¶
If you encounter any problems using the extension feel free to contact me via mail or on skype (nick: bauschan)
To-Do list¶
In case you have any suggestions or ideas let me know.