.. You may want to use the usual include line. Uncomment and adjust the path. .. include:: ../Includes.txt ============================= EXT: ECV Subscription Manager ============================= :Author: Kasper Skårhøj :Created: 2002-11-01T00:32:00 :Changed by: Christian Voigt :Changed: 2007-10-17T01:24:51 :Author: Christian Voigt :Email: chris@evolutioncv :Info 3: :Info 4: .. _EXT-ECV-Subscription-Manager: EXT: ECV Subscription Manager ============================= Extension Key: **my\_extension\_key** Copyright 2000-2002, Christian Voigt, 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: My Extension 1** **Introduction 1** What does it do? 1 Screenshots 1 **Users manual 1** FAQ 1 **Adminstration 1** FAQ 2 **Configuration 2** FAQ 2 Reference 2 **Tutorial 2** **Known problems 2** **To-Do list 2** **Changelog 2** .. _Introduction: Introduction ------------ .. _What-does-it-do: What does it do? ^^^^^^^^^^^^^^^^ - Allows you to create simple event-records (titel, time, date, price, location, description, teaser, target-group) and display them in a list or as a detail-page for an specific event. You can also create forms with as many form-fields as you like to subscribe to the events via email. (email function not mplemented as of now.) - Event-records can be stored in any available page. - for now you can summarize this extension as follows :-You can create data-records of events, there is a fixed number of fields for this, so it is not very flexible.-You can display your records in a list-view and in a details-page. there is no search function, or filter or anything. all records from the specified page are listet at once.-You can define your form in a template file, all markers are automagicly created, so you can have as many fields as you like- as of now, that is all. there is no function implemented to handle the form data other than displaying it on a relsuts-page. (Which ou could now send via email.)- there is NO error handling, nor is there any kind of field- validation.- .. _Screenshots: Screenshots ^^^^^^^^^^^ .. _img-1-This-is-the-Listview: |img-1| This is the Listview. """"""""""""""""""""""""""""" Only a few field are shown, also a link to the details-page and a link to subscribe now! .. _img-2-Details-Page: |img-2| Details-Page """""""""""""""""""" All currently available fields are displayed. There is a link back to the listview and a link to subscribe now! .. _img-3-Form: |img-3| Form """""""""""" Some fields are shown, to get a summary. Formfields are defined in the template file. there is a link back to the details-page and a submit- button to send the form (not implemented yet) |img-4| .. _Backend: Backend """"""" Just delete and list functions. No search/filter whatsoever .. _Users-manual: Users manual ------------ -Install the extension and update your database -create a page or pages where you want to diplay you events and insert the ecv-subscription-manager plugin -copy the subscriptions.html and email.html files from EXT:/pi1/ to your fileadmin folder, or anywhere else within your fileadmin folder. -insert some typoscript to configure the extension, for now it is just the directory of the template.and the folder where to look for records. (if this is not set, the current page where the plugin is included will be used) :: plugin.tx_ecvsubscrmgr_pi1 { mainConfig.pageID = 71 mainConfig.Template = fileadmin/templates/ecv_subscrmgr/subscriptions.html mainConfig.emailTemplate = fileadmin/templates/ecv_subscrmgr/email.html } \- create some records by switching to listview and to the page you specified with typoscript or the page where the plugin is included and add a new record. fill out the fields and save. repeat as often as required. \- you can now view your page. \- you may want to alter the two template files according to your wishes. \- formfields are identified by their name attribute, the plugin will create a marker for each form-field, this is devised from the name attribute. All markers are all upper-case (if you form field has the name-attribute “name” a marker named ###NAME### will be created for use in your email.html template) \- all subscriptions are stored in the database, they are accesible with the backend module Web/ECV-Subscriptions) .. _FAQ: FAQ ^^^ - No records are displayed : you may have set a wrong pageID. If you stored your records on the same page as the plugin then simply leave this one out. It will find them automaticly if parameter pageID is not set - Nothing gets displayed, although I am sure I have the right path (see uestion above): you may want to check your access rights for your template files in fileadmin (or wherever you have put them). For testing purposes you can set them to read/write (Win) or 777 (Unix/Linux) .. _Adminstration: Adminstration ------------- .. _FAQ: FAQ ^^^ .. _Configuration: Configuration ------------- .. _FAQ: FAQ ^^^ .. _Reference: Reference ^^^^^^^^^ \- Possible subsections: Reference (TypoScript) .. ### BEGIN~OF~TABLE ### .. _pageID: pageID """""" .. container:: table-row Property pageID Data type int Description Sets the page the plugin looks for records. If this is not set the page where the plugin is included will be used. Default .. _Template: Template """""""" .. container:: table-row Property Template Data type string Description path to the template file. Should be somewhere in your fileadmin folder. Default .. _emailTemplate: emailTemplate """"""""""""" .. container:: table-row Property emailTemplate Data type string Description path to the email-template file. Should be somewhere in your fileadmin folder. This could be used to create confirmation emails Default .. ###### END~OF~TABLE ###### .. _Tutorial: Tutorial -------- see User Manual for now... .. _Known-problems: Known problems -------------- - there are no implemented email functions for now. This extension in its actual state is pretty useless for non-programmers. - No form-validation is implemented. In fact, there is virtually no Error-Handling at all! - .. _To-Do-list: To-Do list ---------- - email-function - some nice form handling Way better backend module .. _Changelog: Changelog --------- - 0.0.1 – 10.Okt.2007+ (Initial release) - 0.0.2 – 11.Okt.2007+ Implemented email-template. The created output can be used to send by mail or to store it elsewhere.+ Implemented auto-markers. Whatever form fields you specify in your template, markers will be cretat for use in your email-template+ updated template-files, there is a much better representation of what is possible and how its doneo Manual updated - 0.0.3 – 16.Okt.2007+ Introduced Backend-Module+ some new Markers for template+ Supscriptions are now stored in the database for future reference and editingo manual updated - 0.0.4 – 17.Okt.2007+ rewrite of template handling+ lgenerated links are now typo3-coding-guidlines+ added backend module functions : list of subscriptions, delete function, info-function |img-5| EXT: ECV Subscription Manager - 5 .. ######CUTTER_MARK_IMAGES###### .. |img-1| image:: img-1.png .. :align: left .. :border: 1 .. :height: 344 .. :hspace: 9 .. :id: Grafik1 .. :name: Grafik1 .. :width: 447 .. |img-2| image:: img-2.png .. :align: left .. :border: 1 .. :height: 280 .. :hspace: 9 .. :id: Grafik2 .. :name: Grafik2 .. :width: 447 .. |img-3| image:: img-3.png .. :align: left .. :border: 1 .. :height: 245 .. :hspace: 9 .. :id: Grafik3 .. :name: Grafik3 .. :width: 447 .. |img-4| image:: img-4.png .. :align: left .. :border: 1 .. :height: 314 .. :hspace: 9 .. :id: Grafik4 .. :name: Grafik4 .. :width: 450 .. |img-5| image:: img-5.png .. :align: left .. :border: 0 .. :height: 32 .. :id: Graphic1 .. :name: Graphic1 .. :width: 102