.. You may want to use the usual include line. Uncomment and adjust the path. .. include:: ../Includes.txt ====================== EXT: Address Directory ====================== :Author: Kasper Skårhøj :Created: 2002-11-01T00:32:00 :Changed: 2004-01-17T13:41:48 :Author: Carsten Horst :Email: carsten(AT)sprog.de :Info 3: :Info 4: .. _EXT-Address-Directory: EXT: Address Directory ====================== Extension Key: **sp\_directory** Copyright 2004, Carsten Horst, 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: Address Directory 1** **Introduction 1** What does it do? 1 Screenshots 1 **Users manual 4** **Adminstration 4** **Configuration 4** Reference 4 **Tutorial 4** **Known problems 5** **To-Do list 5** **Changelog 5** .. _Introduction: Introduction ------------ .. _What-does-it-do: What does it do? ^^^^^^^^^^^^^^^^ This extension is based on *nicosdirectory* from Nico Ueckermann, but has gone through a very intensive customization by my side. So I decided to make a new extension out of it. This extension displays *tt\_address* records in a directory like way. It is possible to display the address records categorized and/or grouped by the folder in which they reside in the backend. It is also possible to let them be edited on the frontend or to display certain fields of an address record only to logged in users of a special group. .. _Screenshots: Screenshots ^^^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _The-address-records-are-extended-with-two-new-fields: The address records are extended with two new fields: """"""""""""""""""""""""""""""""""""""""""""""""""""" .. container:: table-row a The address records are extended with two new fields: You can assign categories and a frontend editor group to an address record. b |img-1| .. _Create-new-page-content: Create new page content """"""""""""""""""""""" .. container:: table-row a Create new page content b |img-2| .. _You-can-store-the-address-records-in-folders-of-your-choice-The-foder: You can store the address records in folders of your choice. The foder """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. container:: table-row a You can store the address records in folders of your choice. The foder names could later be used to have another level of categorization. b |img-3| .. _The-plugin-provides-several-choices-how-to-display-the-address-records: The plugin provides several choices how to display the address records """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. container:: table-row a The plugin provides several choices how to display the address records on the frontend (see the following pictures): b |img-4| |img-5| .. _This-Picture-shows-the-result-of-the-following-properties: This Picture shows the result of the following properties: """""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. container:: table-row a This Picture shows the result of the following properties: Grouped by category Display foldername b |img-6| .. ###### END~OF~TABLE ###### .. _Users-manual: Users manual ------------ - Install the extension through the extension manager - Create address category records, if you want to have your address categorized - Create address records, assign categories and if you want someone to be able to edit the address record through the frontend, assign a frontend editor group. - Create a new 'Directory' page content element (see Screenshots). Select the display mode Now you should see something like on pictures in the Screenshots section. .. _Adminstration: Adminstration ------------- See Configuration. .. _Configuration: Configuration ------------- The following variables should be self explaining. .. _Reference: Reference ^^^^^^^^^ .. ### BEGIN~OF~TABLE ### .. _templateFile: templateFile """""""""""" .. container:: table-row Property templateFile Data type string Description Path to the template file Default :: EXT:sp_directory/pi1/directory.tmpl .. _itemsPerPage: itemsPerPage """""""""""" .. container:: table-row Property itemsPerPage Data type integer Description Number of address records to display on one page Default :: 10 .. _wrap1: wrap1 """"" .. container:: table-row Property wrap1 Data type string Description :: The marker ###W1B### ###W1E### in the template file will be replaced with the provided value. Default ::
|
.. _wrap2: wrap2 """"" .. container:: table-row Property wrap2 Data type string Description :: The marker ###W2B### ###W2E### in the template file will be replaced with the provided value. Default :: | .. _wrap3: wrap3 """"" .. container:: table-row Property wrap3 Data type string Description :: The marker ###W2B### ###W2E### in the template file will be replaced with the provided value. Default :: | .. _default-fegroup: default\_fegroup """""""""""""""" .. container:: table-row Property default\_fegroup Data type integer Description The default frontend group which is allowed to create new address records through the frontend. This group is then also assigne as the frontend editor group. Default .. _required-fields: required\_fields """""""""""""""" .. container:: table-row Property required\_fields Data type string list (separated by comma) Description These fields are required if an address record is edited through the frontend. Possible values: :: name, street, zip, city, email, www, description, image, category Default :: name,email,category .. _hidden-fields-fegroup: hidden\_fields\_fegroup """"""""""""""""""""""" .. container:: table-row Property hidden\_fields\_fegroup Data type integer Description Logged in members of this group will also see the fields provided by the 'hidden\_fields' variable. Default .. _hidden-fields: hidden\_fields """""""""""""" .. container:: table-row Property hidden\_fields Data type string list (separated by comma) Description These fields are hidden until a member of 'hidden\_fields\_group' is logged on. Possible values: :: street, zip, city, description, phone, mobile, fax, www, email, image Default .. _active: active """""" .. container:: table-row Property active Data type string Description Color for active items Default :: #CC0000 .. _inactive: inactive """""""" .. container:: table-row Property inactive Data type string Description Color for inactive items Default :: #999999 .. _displayNameLink: displayNameLink """"""""""""""" .. container:: table-row Property displayNameLink Data type integer Description 1 or 0. Select if you want the Name in the list be a link to the detail page Default :: 1 .. ###### END~OF~TABLE ###### [plugin.tx\_spdirectory] .. _Tutorial: Tutorial -------- If you simply want to display some address records see Screenshots and Configuration. If you want fronotend users to be able to create and/or edit address records, you have to keep some things in mind: - How to allow frontend users to create new address records?You need to assign the constant variable >default\_fegroup< a value. This value is the id (Integer !!) of the wanted group.Members of this group are now allowed to create new address records.If you did not enable >Display foldername< in the plugin (see screenshots), these address records are created on the page where the plugin resides.If you enable >Display foldername<, the frontend user can decide, in which folder he wants to store the record. - How to allow frontend users to edit address records?Every logged in frontend user, who is member of the >Frontend Editor group< or the >Assigned Frontend user< of an address record can edit the selected record. .. _Known-problems: Known problems -------------- None yet. .. _To-Do-list: To-Do list ---------- Feel free to make suggestions! If you think something is missing in the documention, feel free to contact me as well. .. _Changelog: Changelog --------- - 0.2.3 Fixed some display bugs and added the assigned frontend user to the tt\_address record. - 0.2.2 Added finnish translation - 0.2.0 Initial public release |img-7| EXT: Address Directory - 4 .. ######CUTTER_MARK_IMAGES###### .. |img-1| image:: img-1.png .. :align: left .. :border: 0 .. :height: 137 .. :id: Grafik1 .. :name: Grafik1 .. :width: 237 .. |img-2| image:: img-2.jpeg .. :align: left .. :border: 0 .. :height: 39 .. :id: Grafik2 .. :name: Grafik2 .. :width: 225 .. |img-3| image:: img-3.jpeg .. :align: left .. :border: 0 .. :height: 49 .. :id: Grafik3 .. :name: Grafik3 .. :width: 120 .. |img-4| image:: img-4.jpeg .. :align: left .. :border: 0 .. :height: 85 .. :id: Grafik4 .. :name: Grafik4 .. :width: 159 .. |img-5| image:: img-5.jpeg .. :align: left .. :border: 0 .. :height: 242 .. :id: Grafik5 .. :name: Grafik5 .. :width: 242 .. |img-6| image:: img-6.png .. :align: left .. :border: 0 .. :height: 328 .. :id: Grafik7 .. :name: Grafik7 .. :width: 420 .. |img-7| image:: img-7.png .. :align: left .. :border: 0 .. :height: 32 .. :id: Graphic1 .. :name: Graphic1 .. :width: 102