.. You may want to use the usual include line. Uncomment and adjust the path. .. include:: ../Includes.txt ============================= EXT: Abile Tickets Management ============================= :Author: Kasper Skårhøj :Created: 2002-11-01T00:32:00 :Changed: 2005-05-05T11:42:38 :Author: David Worms :Email: open@abile.net :Info 3: :Info 4: .. _EXT-Abile-Tickets-Management: EXT: Abile Tickets Management ============================= Extension Key: **abile\_tickets** Copyright 2000-2002, David Worms, 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: Abile Tickets Management 1** **Introduction 1** What does it do? 1 Screenshots 1 **Users manual 2** FAQ 3 **Adminstration 3** FAQ 3 **Configuration 3** FAQ 3 Reference 3 **Tutorial 4** **Known problems 5** **To-Do list 5** **Changelog 5** .. _Introduction: Introduction ------------ .. _What-does-it-do: What does it do? ^^^^^^^^^^^^^^^^ - Abile Tickets extension allows frontend users to send messages to each others based on their usergroups . This extension is targeted toward intranet applications. At this point it is meant to be a relatively simple messaging solution. - In the frontend, the frontend users can either sent ticket or administer tickets based on their usergroups. - In the backend, the backend users can create categories which associate the “regular” frontend users with the “administrative” frontend users. - Emails are sent on ticket creation and ticket reply. - This extension was donated by `A `_ `daltas, French design firm specialised in website creation and content management `_ . .. _Screenshots: Screenshots ^^^^^^^^^^^ Frontend “Regular” Plugin |img-1| |img-2| Frontend “Administrative” Plugin |img-3| |img-4| .. _Users-manual: Users manual ------------ - This extension is meant to be used in an intranet environment. Your visitors must be authenticated before accessing this extension as it references a frontend user entity. - The default style sheet display the extension as a box (400 pixels width). You are encouraged to extends the style sheet to feet your needs. - There are two frontend plugin. The first one is targeted toward “regular” frontend users, the second one is targeted toward “administrative” frontend users. - “Regular” frontend plugin: frontend users may manage and create new tickets. When creating a new ticket, the available categories depends on the usergroups. The frontend user can personalized the display from the preference screen. - “Administrative” frontend plugin: frontend users receive and respond to tickets. The tickets they can manage are based on their respective categories. Only the tickets from the categories matching the frontend usergroups are displayed. .. _FAQ: FAQ ^^^ Please post your questions and we'll put them in the FAQ one after the others. .. _Adminstration: Adminstration ------------- - The administration of tickets is done from the frontend. The users owning a ticket may delete it as well as the administrators with matching permissions. - The administration of tickets categories is done from the backend. The backend administrator is responsible for creating new categories and assign the “regular” and “administrative” frontend usergroups. .. _FAQ: FAQ ^^^ Please post your questions and we'll put them in the FAQ one after the others. .. _Configuration: Configuration ------------- Installing the Abile Tickets extension should be an easy task. From the extension manager, go to “Import extensions from online repository” and enter the key “abile\_tickets”. The extension will be registered as a frontend plugin. To insert the plugins inside a page, create a new content in the page and select the ticket plugin from the plugin section. Next is to define the page in which the tickets' categories will be stored. Set the “Startingpoint” to this page. - You may control the display of the extension. This is achieved by overwriting the default TSconfig properties, overwriting the stylesheet or unseting the current one, and providing your own templates. Exemples of how you can overwrite the Tsconfig are presented in the Reference page. - Templates The extension makes use of the Smarty template engine. This is a geat way to seprate the logic from the display. Furthermore, it aims at helping you to develop your very own templates. In order to so so, you must configure the location of the directory were you will prepare the templates. Thisis achieve through the “templatesDir” property. In this directory, you must create to new directories called “templates” and “templates\_c”. In the new “templates” directory, you must insert the three templates “editScreen.tpl”, “listScreen.tpl” and “viewScreen.tpl”. The “templates\_c” directory is used by Smarty as a cache folder and must be writable. You'll find the default templates directory at the root of the Abile Tickets extension. .. _FAQ: FAQ ^^^ Please post your questions and we'll put them in the FAQ one after the others. .. _Reference: Reference ^^^^^^^^^ \- TypoScript .. ### BEGIN~OF~TABLE ### .. _templatesDir: templatesDir """""""""""" .. container:: table-row Property templatesDir Data type string Description Base directory where lies your Smarty templates and templates\_c directories. Default .. _listView-results-at-a-time: listView.results\_at\_a\_time """"""""""""""""""""""""""""" .. container:: table-row Property listView.results\_at\_a\_time Data type integer Description Number of results to display. Default 10 .. _listView-maxPages: listView.maxPages """"""""""""""""" .. container:: table-row Property listView.maxPages Data type integer Description Number of pages to browse from. An odd value will be better displayed. Default 5 .. _email-sendEmailOnCreation: email.sendEmailOnCreation """"""""""""""""""""""""" .. container:: table-row Property email.sendEmailOnCreation Data type boolean Description Should we send an summary email to the user after he created a ticket Default 1 .. _email-HTMLMail: email.HTMLMail """""""""""""" .. container:: table-row Property email.HTMLMail Data type boolean Description Wether or not we should send HTML based templates Default 1 .. _email-from: email.from """""""""" .. container:: table-row Property email.from Data type string Description The address of the email sender Default .. _email-fromName: email.fromName """""""""""""" .. container:: table-row Property email.fromName Data type string Description The name of the email sender Default .. _email-organization: email.organization """""""""""""""""" .. container:: table-row Property email.organization Data type string Description The name of your company Default .. ###### END~OF~TABLE ###### [tsref:tx\_abiletickets\_pi1] .. ### BEGIN~OF~TABLE ### .. _templatesDir: templatesDir """""""""""" .. container:: table-row Property templatesDir Data type string Description Base directory where lies your Smarty templates and templates\_c directories. Default .. _listView-results-at-a-time: listView.results\_at\_a\_time """"""""""""""""""""""""""""" .. container:: table-row Property listView.results\_at\_a\_time Data type integer Description Number of results to display. Default 10 .. _listView-maxPages: listView.maxPages """"""""""""""""" .. container:: table-row Property listView.maxPages Data type integer Description Number of pages to browse from. An odd value will be better displayed. Default 5 .. _email-sendEmailOnReply: email.sendEmailOnReply """""""""""""""""""""" .. container:: table-row Property email.sendEmailOnReply Data type boolean Description Should we send an email to notify the user that he recieved a ticket Default 1 .. _email-HTMLMail: email.HTMLMail """""""""""""" .. container:: table-row Property email.HTMLMail Data type boolean Description Wether or not we should send HTML based templates Default 1 .. _email-from: email.from """""""""" .. container:: table-row Property email.from Data type string Description The address of the email sender Default .. _email-fromName: email.fromName """""""""""""" .. container:: table-row Property email.fromName Data type string Description The name of the email sender Default .. _email-organization: email.organization """""""""""""""""" .. container:: table-row Property email.organization Data type string Description The name of your company Default .. ###### END~OF~TABLE ###### [tsref:tx\_abiletickets\_pi2] .. _generated: ((generated)) """"""""""""" .. _Minimum-example: Minimum example ~~~~~~~~~~~~~~~ :: plugin.tx_abiletickets_pi1{ #address of the email sender email.from #name of the email sender email.fromName #organization of the email sender email.organization } plugin.tx_abiletickets_pi2{ #address of the email sender email.from #name of the email sender email.fromName #organization of the email sender email.organization } .. _Full-exemple: Full exemple ~~~~~~~~~~~~ :: plugin.tx_abiletickets_pi1{ #location of the template and template_c Smarty templates templatesDir = #number of results to display listView.results_at_a_time = 10 #number of pages to browse from listView.maxPages = 5 #Should we send an email to notify the user that he recieved a ticket email.sendEmailOnCreation = 1 #Should we send an summary email to the user after he created a ticket email.HTMLMail = 1 #address of the email sender email.from #name of the email sender email.fromName #organization of the email sender email.organization } plugin.tx_abiletickets_pi2{ #location of the template and template_c Smarty templates templatesDir = #number of results to display listView.results_at_a_time = 10 #number of pages to browse from listView.maxPages = 5 #Should we send an email to notify the user that he recieved a ticket email.sendEmailOnReply = 1 #Wether or not we should send HTML based templates email.HTMLMail = 1 #address of the email sender email.from #name of the email sender email.fromName #organization of the email sender email.organization } *Notes, those properties are editable from the constant editor.* .. _Tutorial: Tutorial -------- Create a ticket category and assign the usergroups. A “Sender Group” is a usergroup with access to the “Regular” frontend plugin. A “Reciever Group” is a usergroup with access to the “Administrative” frontend plugin. |img-5| |img-6| Create a page called “Ticket” and insert the “Regular” frontend plugin. Then, create a page “Ticket management” and insert the “Administrative” frontend plugin. |img-7| .. _Known-problems: Known problems -------------- Please give us a maximum of feedback (good and bad). Also, we encourage you to provide us new translations. .. _To-Do-list: To-Do list ---------- - Correct the spelling and the grammar. - Translations .. _Changelog: Changelog --------- November 11 2004: orgininal posting. |img-8| EXT: Abile Tickets Management - 5 .. ######CUTTER_MARK_IMAGES###### .. |img-1| image:: img-1.png .. :align: left .. :border: 0 .. :height: 306 .. :id: Graphic4 .. :name: Graphic4 .. :width: 334 .. |img-2| image:: img-2.png .. :align: left .. :border: 0 .. :height: 213 .. :id: Graphic5 .. :name: Graphic5 .. :width: 406 .. |img-3| image:: img-3.png .. :align: left .. :border: 0 .. :height: 232 .. :id: Graphic11 .. :name: Graphic11 .. :width: 406 .. |img-4| image:: img-4.png .. :align: left .. :border: 0 .. :height: 359 .. :id: Graphic12 .. :name: Graphic12 .. :width: 406 .. |img-5| image:: img-5.png .. :align: left .. :border: 0 .. :height: 365 .. :id: Graphic8 .. :name: Graphic8 .. :width: 525 .. |img-6| image:: img-6.png .. :align: left .. :border: 0 .. :height: 108 .. :id: Graphic9 .. :name: Graphic9 .. :width: 447 .. |img-7| image:: img-7.png .. :align: left .. :border: 0 .. :height: 162 .. :id: Graphic10 .. :name: Graphic10 .. :width: 487 .. |img-8| image:: img-8.png .. :align: left .. :border: 0 .. :height: 32 .. :id: Graphic1 .. :name: Graphic1 .. :width: 102