DEPRECATION WARNING
This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.
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¶
Extension Key: sp_directory
Copyright 2004, Carsten Horst, <carsten(AT)sprog.de>
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¶
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¶
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¶
The address records are extended with two new fields:¶
a
The address records are extended with two new fields:
You can assign categories and a frontend editor group to an address record.
b
Create new page content¶
a
Create new page content
b
You can store the address records in folders of your choice. The foder¶
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
The plugin provides several choices how to display the address records¶
a
The plugin provides several choices how to display the address records on the frontend (see the following pictures):
b
This Picture shows the result of the following properties:¶
a
This Picture shows the result of the following properties:
Grouped by category
Display foldername
b
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¶
See Configuration.
Configuration¶
The following variables should be self explaining.
Reference¶
templateFile¶
Property
templateFile
Data type
string
Description
Path to the template file
Default
EXT:sp_directory/pi1/directory.tmpl
itemsPerPage¶
Property
itemsPerPage
Data type
integer
Description
Number of address records to display on one page
Default
10
wrap1¶
Property
wrap1
Data type
string
Description
The marker ###W1B### ###W1E### in the template file will be replaced with the provided value.
Default
<table border=0><tr><td><img src=/t3lib/gfx/i/modulefolder.gif><strong> | </strong></td></tr></table>
wrap2¶
Property
wrap2
Data type
string
Description
The marker ###W2B### ###W2E### in the template file will be replaced with the provided value.
Default
<img src=/media/scripts/blank.gif><img src=/t3lib/gfx/i/modulefolder.gif><strong> | </strong>
wrap3¶
Property
wrap3
Data type
string
Description
The marker ###W2B### ###W2E### in the template file will be replaced with the provided value.
Default
<img src=/media/scripts/blank.gif><img src=/t3lib/gfx/i/modulefolder.gif><strong> | </strong>
default_fegroup¶
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¶
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
active¶
Property
active
Data type
string
Description
Color for active items
Default
#CC0000
inactive¶
Property
inactive
Data type
string
Description
Color for inactive items
Default
#999999
displayNameLink¶
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
[plugin.tx_spdirectory]
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¶
None yet.
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¶
- 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
EXT: Address Directory - 4