.. You may want to use the usual include line. Uncomment and adjust the path. .. include:: ../Includes.txt ============ Flash banner ============ :Created: 2010-02-18T17:33:18 :Changed: 2010-11-02T09:30:48 :Classification: z7_flashbanner :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: forAdmins, forBeginners :Author: zeroseven design studios :Email: team@zeroseven.de :Info 4: :Language: en |img-1| |img-2| Flash banner - z7\_flashbanner .. _Flash-banner: Flash banner ============ Extension Key: z7\_flashbanner Language: en Keywords: forAdmins, forBeginners Copyright 2000-2010, zeroseven design studios, 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 ----------------- `Flash banner 1 <#1.Flash%20banner|outline>`_ **`Introduction 3 <#1.1.Introduction|outline>`_** `What does it do? 3 <#1.1.1.What%20does%20it%20do_|outline>`_ `Screenshots 3 <#1.1.2.Screenshots|outline>`_ **`Users manual 4 <#1.2.Users%20manual|outline>`_** **`Administration 5 <#1.3.Administration|outline>`_** **`Configuration 6 <#1.4.Configuration|outline>`_** `Reference 6 <#1.4.1.Reference|outline>`_ .. _Introduction: Introduction ------------ .. _What-does-it-do: What does it do? ^^^^^^^^^^^^^^^^ The extension “Flash banner” helps you to integrate any number of graphics and links through the backend. These will be represented with a SWF in the front-end and replaced with an administrator-selectable effect. The following settings can be set up by the administrator: - Dimensions of the SWF and the contained graphics - Transition effect - The time that each vision is shown. - Depth of automatic search for banners in the rootline .. _Screenshots: Screenshots ^^^^^^^^^^^ This is a view of the Constant Editor to configure the settings. |img-3| .. _Users-manual: Users manual ------------ The extension includes a plugin that can be embedded as a normal front-end plugin anywhere. .. _Administration: Administration -------------- All necessary adjustments and configurations can be carried out conveniently through the Constant Editor. The following options are available for this: .. _generated: ((generated)) ^^^^^^^^^^^^^ .. _Width-Height: Width / Height """""""""""""" The SWF is automatically displayed in this size and in case ImageMagick is available, all images are also scaled to this size by TYPO3. .. _Duration: Duration """""""" Time shows how long each individual banner graphic is visible. Allegation in milliseconds. .. _Transition: Transition """""""""" .. _disguise: disguise ~~~~~~~~ Desaturate the original image.Showing the new image of a round mask, animated from left to right. .. _fade: fade ~~~~ Transition of the new image over the existing one. .. _glaze: glaze ~~~~~ Blur the original image and zoom in.Fade into the blurry and also zoomed new image.Zoom out and remove the fuzziness. .. _locomotion: locomotion ~~~~~~~~~~ Slide in the new image from left to right.Simultaneous sliding out of the original image to the right. .. _upright: upright ~~~~~~~ Slide in the new image from top to bottom over the original image. .. _vanish: vanish ~~~~~~ Desaturate the original image and fade to to base color.Fade in the new desaturated image and restore saturation. .. _Base-color: Base color """""""""" This value is used as bgcolor parameter for flash embedding. And it's used for some of the transitions. Flash can only handle hex values. When you set an HTML color name, it's translated internally to its hex string. .. _Walk-up-rootline: Walk up rootline """""""""""""""" In case there are no banners lodged on the current page, the plugin can automatically search for banners on the parent pages. With this option you can specify how far the plugin should wander up and search in the rootline. .. _Load-swfobject: Load swfobject """""""""""""" The SWF is embedded on the web page with swfobject. The default extension embeds the swfobject.js on from the extension directory. If however, already another swfobject javascript-file is embedded on the website, this can lead to conflict. The automatic embedding can be disabled with this option. .. _Image-type-number-Link-type-number: Image type number / Link type number """""""""""""""""""""""""""""""""""" These settings usually haven't got to be adjusted. You should change these values only if you know about the typeNum of the PAGE object, or if there are conflicts with other extensions that use the same typeNum. .. _Configuration: Configuration ------------- .. _Reference: Reference ^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _swfWidth: swfWidth """""""" .. container:: table-row Property swfWidth Data type integer Description Width of the SWF in pixels. Default 100 .. _swfHeight: swfHeight """"""""" .. container:: table-row Property swfHeight Data type integer Description Height of the SWF in pixels. Default 100 .. _imgWidth: imgWidth """""""" .. container:: table-row Property imgWidth Data type boolean Description Width of the banner graphics in pixels. imgWidth / imgHeight is optional. If only one is given the image is scaled proportionally. If an 'm' exists in the imgWidth or imgHeight and if both are present the imgWidth and imgHeight is regarded as the Maximum width/height and the proportions will be kept. Default 100 .. _imgHeight: imgHeight """"""""" .. container:: table-row Property imgHeight Data type string Description Height of the banner graphic in pixels. See imgWidth. Default 100 .. _duration: duration """""""" .. container:: table-row Property duration Data type integer Description Timing of a single banner in milliseconds. Default 6000 .. _transition: transition """""""""" .. container:: table-row Property transition Data type string Description Type of transition. The following keywords are allowed: \- disguise- fade- glaze- locomotion- upright- vanish Default fade .. _bgcolor: bgcolor """"""" .. container:: table-row Property bgcolor Data type string Description The base color for some of the transitions. Non-hex values are converted internally. Default #000000 .. _walkRootline: walkRootline """""""""""" .. container:: table-row Property walkRootline Data type integer Description Maximum steps to walk up the rootline until there is found a banner. Default 99 .. _swfobject: swfobject """"""""" .. container:: table-row Property swfobject Data type boolean Description Load extension's swfobject javascript file. Default 1 .. _imageTypeNum: imageTypeNum """""""""""" .. container:: table-row Property imageTypeNum Data type integer Description typeNum for the link to the image-managing process. Do not forget to adjust the typeNum value even at the Page instance “banner images”. Default 7281 .. _linkTypeNum: linkTypeNum """"""""""" .. container:: table-row Property linkTypeNum Data type integer Description typeNum for the link to the link-managing process.Do not forget to adapt the typeNum value even at the Page instance “banner next to”. Default 7282 .. ###### END~OF~TABLE ###### [tsref:plugin.tx\_z7flashbanner\_pi1] .. _generated: ((generated)) """"""""""""" .. _Example: Example ~~~~~~~ :: plugin.tx_z7flashbanner_pi1 { imgWidth = 100c } .. _Parameters-for-SWF-embedding: Parameters for SWF embedding ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ There are a lot of parameters to define SWF behaviour. This is not a complete list. I'm sure you will find what you want anywhere in the internet. .. ### BEGIN~OF~TABLE ### .. _wmode: wmode """"" .. container:: table-row Property wmode Data type string Description wmode Default .. _bgcolor: bgcolor """"""" .. container:: table-row Property bgcolor Data type string Description Background color Default #000000 .. ###### END~OF~TABLE ###### [tsref:plugin.tx\_z7flashbanner\_pi1.params] .. _generated: ((generated)) """"""""""""" .. _Example: Example ~~~~~~~ :: plugin.tx_z7flashbanner_pi1 { params.wmode = transparent params.bgcolor = #ff0000 } |img-2| 6 .. ######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: 479 .. :id: Grafik1 .. :name: Grafik1 .. :width: 669