.. You may want to use the usual include line. Uncomment and adjust the path. .. include:: ../Includes.txt =============== EXT: Newsticker =============== :Author: Kasper Skårhøj :Created: 2002-11-01T00:32:00 :Changed: 2003-10-10T13:34:29 :Description: Documentation to ilis_newsticker extension :Author: Irina Grimpe-Lishchenko :Email: ilis@omnisolutions.de, ilis@lishchenko.de :Info 3: :Info 4: .. _EXT-Newsticker: EXT: Newsticker =============== Extension Key: **ilis\_newsticker** Copyright 2000-2002, Irina Grimpe-Lishchenko, , 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.com .. _Table-of-Contents: Table of Contents ----------------- **EXT: Newsticker 1** **Introduction 1** What does it do? 1 Screenshots 1 **Users manual 3** FAQ 3 **Adminstration 3** **Configuration 4** Reference 4 **Known problems 5** **To-Do list 5** **Changelog 5** .. _Introduction: Introduction ------------ .. _What-does-it-do: What does it do? ^^^^^^^^^^^^^^^^ This extension is a simple frontend newsticker. Default it shows data from table tt\_news field short. But the source can be changed: both table and field, where it has sence of course. Currently there are 3 versions of newstickers, which are realised in client JavaScript and have different effects. This version does not support configuration of JavaScript parameters, JavaScript functions are hardcoded in extension class file. All of them are realised through input or textarea field of HTML forms, also their design can be adjusted to certain needs with CSS styles, that can be defined in template with certain TypoScript directives (See screenshot 1). It can be easily inserted as a content element to any page: simply choose apropriate content type from Type select list. After the entire form will be updated you will see the form which is similar to Screenshot 2. .. _Screenshots: Screenshots ^^^^^^^^^^^ |img-1| Template window: \- Content element Newsticker form: |img-2| .. _Users-manual: Users manual ------------ After installing the extension you will get one extra content elemnt type: newsticker. During the installation it will be added one extra field into tt\_content table: field with name tx\_ilisnewsticker\_ticker\_mode. The content of this field you can define choosing any of 3 accessable items in select list with a title „Choose newsticker layout“. The difference between them is only in different visualisation effects of your newsticker content element. The first type is also possible to get as a textarea form element. That has to be additionally configured with TypoScript directives. Default it is an input field. Source data for newsticker will be taken by default from „short“ field of table tt\_news. If you choose no Starttingpoint pages it will look tt\_news records with the same PID as current newsticker content element has. If you wish to get record from another storage you have to choose an apropriate Starttingpoint or several of them. .. _FAQ: FAQ ^^^ This you will have to ask me. I have none of them;) .. _Adminstration: Adminstration ------------- - The extension is not difficult to configure. What has to be noticed by administrators: the field tx\_ilisnewsticker\_ticker\_mode added to tt\_content table is an Exclude-field, that means that user or group has to get some permissions to edit it. - There is no Page/User TSconfig which are necessary for this extension. - Most likely you will have to configure the visualisation of your newsticker, I mean that part of it which makes a frame for your newsticker: correspondent styles of input field or textarea form elements as border style, border color, background color, text color, font properties etc. All possible TypoScript directives are shown on Screenshot 1. The also will be described in Reference chapter. .. _Configuration: Configuration ------------- .. _Reference: Reference ^^^^^^^^^ \- Reference (TypoScript) .. ### BEGIN~OF~TABLE ### .. _table: table """"" .. container:: table-row Property table Data type String Description The source table Default tt\_news .. _field: field """"" .. container:: table-row Property field Data type String Description The source column of source table Default short .. _style: style """"" .. container:: table-row Property style Data type String Description This is a definition of style or class attribute which will be added to input field, which is a kind of container for newsticker **Example:** :: style = STYLE=“font: normal 11px Arail,sans-serif; width: 90%; background-color: transparent; border: #A0BA9D solid 1px;“ or :: style = CLASS=“theNameOdClass“ Default .. _textarea: textarea """""""" .. container:: table-row Property textarea Data type Boolean Description 0 or 1. If 1 then container will be a textarea form element. Actual only for first of three possible newsticker modes. Default 0 .. _textarea-cols: textarea.cols """"""""""""" .. container:: table-row Property textarea.cols Data type Integer Description The number of columns for textarea. Actual only if textarea=1 Default 60 .. _textarea-rows: textarea.rows """"""""""""" .. container:: table-row Property textarea.rows Data type Integer Description The number of columns for textarea. Actual only if textarea=1 Default 3 .. _textrea-style: textrea.style """"""""""""" .. container:: table-row Property textrea.style Data type String Description **Example:** :: style = STYLE=“font: normal 11px Arail,sans-serif; background-color: transparent; border: #A0BA9D solid 1px;“ or :: style = CLASS=“theNameOdClass“ Default .. _cat: cat """ .. container:: table-row Property cat Data type Integer Description It is not obligatory. Default there is no category set, it means that selected items don't depend on their category. But if you set category to be equel to some number, then only items with that category will be selected. This assumes that the field containing the number of category must have the name „category“ Default - .. ###### END~OF~TABLE ###### .. _generated: ((generated)) """"""""""""" .. _Example: Example ~~~~~~~ Here you would show an example of the stuff from the reference or so: **CONSTANTS field of template:** :: newsticker { NewsCategorie = 6 InputFieldStyle = STYLE="font: normal 11px Arial,sans-serif; width:90%; background-color: transparent; border-style: none" TextareaStyle = STYLE="font: normal 11px Arial,sans-serif; background-color: #F0FCF0; border: #A0BA9D solid 1px;" } **SETUP field of template:** :: plugin.tx_ilisnewsticker_pi1 { table = tt_news field = short style = {$newsticker.InputFieldStyle} textarea = 1 textarea.style = {$newsticker.TextareaStyle} textarea.cols = 60 textarea.rows = 3 cat = {$newsticker.NewsCategorie} } .. _Known-problems: Known problems -------------- Among common problems can be named - No opportunity to configure JavaScript parameters of newsticker. - may be limited number of possible newstickers, which don't answer your needs If you find some bugs please inform me in order I could correct them. Actually I am not responsible for JavaScript functions, I did not write them. They are simply found on the Internet in free libraries with JavaScript stuff. .. _To-Do-list: To-Do list ---------- - Translation of labels to other languages. I can provide German and Russian. If some of you can help with translation to other languages they are welcome. - Adding the opportunity to configure in easy way JavaScript parameters for newsticker. .. _Changelog: Changelog --------- |img-3| EXT: Newsticker - 5 .. ######CUTTER_MARK_IMAGES###### .. |img-1| image:: img-1.png .. :align: left .. :border: 0 .. :height: 652 .. :id: Graphic4 .. :name: Graphic4 .. :width: 545 .. |img-2| image:: img-2.png .. :align: left .. :border: 0 .. :height: 650 .. :id: Graphic5 .. :name: Graphic5 .. :width: 682 .. |img-3| image:: img-3.png .. :align: left .. :border: 0 .. :height: 32 .. :id: Graphic1 .. :name: Graphic1 .. :width: 102