.. You may want to use the usual include line. Uncomment and adjust the path. 
.. include:: ../Includes.txt


====================================
EXT: Readable name of your extension
====================================

:Author:
      Kasper Skårhøj

:Created:
      2002-11-01T00:32:00

:Changed:
      2008-08-20T17:12:28

: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


|img-1| |img-2| EXT: Readable name of your extension - extensionkey

.. _EXT-Kwick:

EXT: Kwick
==========

**extensionkey: pf\_kwick**

keywords: kwick, 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:

Table of Contents
-----------------

EXT: Kwick 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:

Introduction
------------

.. _What-does-it-do:

What does it do?
^^^^^^^^^^^^^^^^

The extension adapts the popular \*kwick\* effect known from
'mootools' to work based on the Ext JS framework.

.. _Screenshots:

Screenshots
^^^^^^^^^^^

|img-3|

|img-4|

.. _Users-manual:

Users manual
------------

Meet the requirements, the extension requires PHP 5. Install as usual.
Include the static template to your main TypoScript template. CSS and
JS libaries have to get included, See the configuration section for an
example on how to do that.

.. _FAQ:

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:

Configuration
-------------

- TypoScript setup to use the resources supplied by the extension:

- Include CSS file

::

   page.includeCSS.file1 = EXT:pf_kwick/res/pfkwick.css

of course you can reference your own custom css-styles here as well.

-

- Include javascript resources:

::

   page.includeJS.file51 = EXT:pf_kwick/res/ext.js
   page.includeJS.file52 = EXT:pf_kwick/res/pfkwick.js

-

- Add the plugin wherever you want it to appear e.g. :

::

   lib.kwick < plugin.tx_pfkwick_pi1 

or

::

   page.10.marks.kwick < plugin.tx_pfkwick_pi1

In the Constant editor you'll find some basic settings to play with.
For an explanation see the next section.

You can easily expand the number of elements to display like (this
goes to TS setup, but you know that):

::

   plugin.tx_pfkwick_pi1.elementX = my string here, can be html or plain text

where X is a unique number for the element. Elements 1 to 7 are set up
by default.

.. _Reference:

Reference
^^^^^^^^^

Reference (TypoScript)

[[plugin.tx\_pfkwick\_pi1]

.. ### BEGIN~OF~TABLE ###


.. _elementNum:

elementNum
""""""""""

.. container:: table-row

   Property
         elementNum
   
   Data type
         integer
   
   Description
         Number of elements to display
   
   Default
         7



.. _element1:

element1
""""""""

.. container:: table-row

   Property
         element1
         
         element2
         
         ...
   
   Data type
         string
   
   Description
         String to be displayed. Can be html or plain text.
   
   Default



.. _wrap:

wrap
""""

.. container:: table-row

   Property
         wrap
   
   Data type
         wrap
   
   Description
         The kwick elements are rendered as an unordered list. This string
         wraps the list elements generated by the plugin.
   
   Default
         <div id="kwicks\_container"><ul id="kwicks"> \| </ul><span
         class="clr"><!-- spanner --></span></div>


.. ###### END~OF~TABLE ######

.. _Known-problems:

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:

To-Do list
----------

In case you have any suggestions or ideas let me know.

.. _ChangeLog:

ChangeLog
---------

Initial upload.

8


.. ######CUTTER_MARK_IMAGES######

.. |img-1| image:: img-1.png
.. :align: left

.. |img-2| image:: img-2.png
.. :border: 0
.. :height: 21
.. :hspace: 9
.. :id: Grafik2
.. :name: Grafik2
.. :width: 87

.. |img-3| image:: img-3.png
.. :align: left
.. :border: 0
.. :height: 81
.. :id: graphics1
.. :name: graphics1
.. :width: 669

.. |img-4| image:: img-4.png
.. :align: left
.. :border: 0
.. :height: 81
.. :id: graphics2
.. :name: graphics2
.. :width: 669