.. You may want to use the usual include line. Uncomment and adjust the path. .. include:: ../Includes.txt ============== EXT: Quickpoll ============== :Author: Kasper Skårhøj :Created: 2002-11-01T00:32:00 :Changed: 2004-10-05T14:39:27 :Author: Vibeke Bertelsen :Email: typo3@vibber.dk :Info 3: :Info 4: .. _EXT-Quickpoll: EXT: Quickpoll ============== Extension Key: **Quickpoll** Copyright 2000-2004, Vibeke Bertelsen, 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: Quickpoll 1** **Introduction 1** What does it do? 1 **User manual 1** Adding the plugin to a page 1 Adding a new poll 1 Managing multiple polls 1 Changing the look of the plug-in 1 **Database Tables 1** tx\_quickpoll\_poll 1 **Known problems 2** **Todo-list 2** .. _Introduction: Introduction ------------ .. _img-1: |img-1| ^^^^^^^ |img-2| .. _What-does-it-do: What does it do? ^^^^^^^^^^^^^^^^ Quickpoll is a simple poll module that lets website visitors vote for one of a set of statements. When the user has voted she'll see a bar chart with the current results. In typo3 a poll consisting of a question and a set of answers can be set up. Polls can be placed anywhere on the page and can be controlled like other typo3 elements via start and end date. Users are only allowed to vote for one option and are only allowed to vote once every 30 days. .. _Requierements: Requierements ^^^^^^^^^^^^^ Cookies must be activated on the user's browser. .. _A-note-on-security: A note on security ^^^^^^^^^^^^^^^^^^ Users are blocked from voting more than once with the use of cookies. Note that it very easy for a savvy user to cheat and vote multiple times by removing the cookie. LANGUAGES AVAILABLE: English, Danish .. _User-manual: User manual ----------- .. _Adding-a-poll: Adding a poll ^^^^^^^^^^^^^ This consists of two actions. First you insert a poll record which is where the question and the votes are stored and next you insert the quickpoll plug-in on the page where you want to display the poll. Choose the list module |img-3| Choose the page where you want to store the poll record (can be another page than where the poll is displayed) Click Create New Record |img-4| Choose 'poll' |img-5| Fill in the the Title, question and answer fields. Put each answer option on a seperate line |img-6| Save and close the poll record Inserting the plug-in for display Choose the page module in the menu Insert a plug-in on the page where the poll should be displayed Choose Quickpoll in the list of options If your poll record is placed on a separate page, insert that page in the startingpoint field |img-7| Save and close The poll is now ready for use .. _Managing-polls: Managing polls ^^^^^^^^^^^^^^ You can put multiple poll records on one page. Only the topmost active poll will be displayed by the plug-in. You can use this if you want to set up different polls to be displayed over a period of time. Add a number of poll records and set their start and end time accordingly – insert a plug-in that points to the page with the poll records and so the polls will be displayed one by one. Note that an error message will be displayed if no active poll can be found. .. _Viewing-or-resetting-the-results: Viewing or resetting the results ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ You can view the results in the poll record. The number of votes are added as a number next to each answer option. You can also easily reset the number of votes by simply inserting 0 instead of the number of votes. |img-8| .. _Changing-the-look-of-the-plug-in: Changing the look of the plug-in ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The look of Quickpoll is controlled by a set of css styles. These can be changed by editing the file called ext\_typoscript\_setup.txt .. _Database-Tables: Database Tables --------------- .. _tx-quickpoll-poll: tx\_quickpoll\_poll ^^^^^^^^^^^^^^^^^^^ The plug-in uses this one table. The fields are like this: .. ### BEGIN~OF~TABLE ### .. _uid: uid """ .. container:: table-row a uid b Unique record identifier ie. poll ID .. _pid: pid """ .. container:: table-row a pid b Identifier of parent page ie. the page where the poll record is placed .. _tstamp: tstamp """""" .. container:: table-row a tstamp b Timestamp in unix time of when the poll was changed .. _crdate: crdate """""" .. container:: table-row a crdate b The creation date of the poll in Unix time .. _cruser-id: cruser\_id """""""""" .. container:: table-row a cruser\_id b ID of user that ceated the poll .. _sorting: sorting """"""" .. container:: table-row a sorting b Internal number for controlling the order of the poll on the page .. _deleted: deleted """"""" .. container:: table-row a deleted b 1 if poll was deleted .. _hidden: hidden """""" .. container:: table-row a hidden b 1 if poll was hidden (deactivated) .. _starttime: starttime """"""""" .. container:: table-row a starttime b Time of when to put the poll online .. _endtime: endtime """"""" .. container:: table-row a endtime b Time of when to set the pol offline .. _title: title """"" .. container:: table-row a title b Title of the poll .. _question: question """""""" .. container:: table-row a question b Question of the poll .. _answers: answers """"""" .. container:: table-row a answers b Answers and number of votes. Answers are delimited by a line break. Number of votes are added in front of answer delimited by a \| character .. _fe-group: fe\_group """"""""" .. container:: table-row a fe\_group b If set only registered users will be able to vote .. ###### END~OF~TABLE ###### .. _Known-problems: Known problems -------------- None known. Please give feedback if you experience any. .. _Todo-list: Todo-list --------- This is meant to be a simple module. No enhancements are planned at the moment |img-9| EXT: Quickpoll - 3 .. ######CUTTER_MARK_IMAGES###### .. |img-1| image:: img-1.png .. :align: left .. :border: 1 .. :height: 98 .. :id: Graphic5 .. :name: Graphic5 .. :width: 250 .. |img-2| image:: img-2.png .. :align: left .. :border: 1 .. :height: 94 .. :id: Graphic6 .. :name: Graphic6 .. :width: 249 .. |img-3| image:: img-3.png .. :align: left .. :border: 0 .. :height: 35 .. :id: Graphic2 .. :name: Graphic2 .. :width: 109 .. |img-4| image:: img-4.png .. :align: left .. :border: 0 .. :height: 24 .. :id: Graphic3 .. :name: Graphic3 .. :width: 143 .. |img-5| image:: img-5.png .. :align: left .. :border: 0 .. :height: 31 .. :id: Graphic4 .. :name: Graphic4 .. :width: 84 .. |img-6| image:: img-6.png .. :align: left .. :border: 0 .. :height: 208 .. :id: Graphic7 .. :name: Graphic7 .. :width: 300 .. |img-7| image:: img-7.png .. :align: left .. :border: 0 .. :height: 79 .. :id: Graphic8 .. :name: Graphic8 .. :width: 120 .. |img-8| image:: img-8.png .. :align: left .. :border: 0 .. :height: 66 .. :id: Graphic9 .. :name: Graphic9 .. :width: 89 .. |img-9| image:: img-9.png .. :align: left .. :border: 0 .. :height: 32 .. :id: Graphic1 .. :name: Graphic1 .. :width: 102