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: Contacts List¶
Author: | Kasper Skårhøj |
---|---|
Created: | 2002-11-01T00:32:00 |
Changed: | 2008-12-16T11:55:22 |
Author: | Oliver Klee |
Email: | typo3-coding@oliverklee.de |
Info 3: | |
Info 4: |
EXT: Contacts List¶
Extension Key: contactslist
Copyright 2005-2008, Oliver Klee, <typo3-coding@oliverklee.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: Contacts List 1
Introduction 1
What does it do? 1
Screenshots 2
Users manual 2
FAQ 2
Installation and configuration 3
Upgrading from version 0.3.0 3
Reference 3
Introduction¶
If you like this extension, please submit a rating for it in the TER.
Development of this extension has been sponsored by MH- Computersysteme oHG .
If you find any bugs in this extension, please report them in the bug tracker under the product C ontactslist .
If you want to help out by fixing bugs, adding features or providing additional localization, please contact the author.
Translations wanted: If you would like to provide a translation of the extension (or fixes to the bad French localization), please contact the author.
What does it do?¶
This extension displays a list of contacts, e.g. of sales offices. The list is searchable by ZIP code and by country.
When a country is selected, the list for that country is displayed at once, so that the user doesn't need to type his or her ZIP code if the list is short.
Screenshots¶
Abbildung 1: Screenshot of the front-end plug-in: A search form with one search result.
As you can see, only the entries (in this case one entry) for the selected country are displayed. Fields that have no content (e.g.the street and the homepage) are not displayed so that there are no empty lines. Abbildung 2: Screenshot of the data entry form in the back end.
Users manual¶
FAQ¶
Where can I find the ISO alpha3 code for a country?¶
At the Unicode online data site .
Which fields are displayed in the front end?¶
The fields that are not empty and that are not hidden via TS setup.
How does the ZIP prefix list work?¶
It's a list of numbers (separated by commas or spaces) that should match the beginning of a ZIP code which is entered on the front end.
For example, if an office servers people from ZIP areas starting with 50, 531, 532, 54, and 56, the following should be in the ZIP prefixes field:
50,531,532,54,55,56
The order of the prefixes doesn't matter.
How can I configure the search for contacts in one country only?¶
Hide the ZIP code field using the TS setup.
How can I get the whole list (for all countries) to display?¶
This is not possible.
Why are the contacts from Germany displayed as default?¶
If you want to start with a blank list and no country selected, you can set:plugin.tx_contactslist_pi1.defaultCountry =in your TS setup.
Why is the drop-down-list of countries so short?¶
It lists only the countries that have a contact in them.
Installation and configuration¶
Make sure that you’re using at least TYPO3 4.0.0 and PHP 5.1.0.
Make sure that you have installed the extension static_info_tables .
Make sure that you have installed the extension oelib .
Install the extension and its dependencies.
In you main TS template, include this extension’s static setup under Include static (from extensions) .
The extension provides its own basic set of CSS styles (which work best if you're already using a CSS-based design). These stylesheets usually get included automatically. However, if your have set disableAllHeaderCode = 1 and want to use the provided stylesheet , you need to include the stylesheet typo3conf/ext/contactslist/pi1/contactslist_pi1.css manually into your page header.
Create a system folder (page) that will hold all the contacts data. (Usually, you need only one page, but there are scenarios where you might want to use more than one page, e.g.to have more than one user group tending to the data.)
Give the user group that will enter the data write access to that folder.
Select or create one or more pages that will have the plug-in.
Add a plug-in to the page(s).
As the plug-in type, select “Contacts List”.
As a starting point (starting page), add the system folder you created.
The default setup should work out of the box. If you want to change something, configure the plug-in to your liking using the template TS setup.
To configure the plug-in language, you need to set two values in your TS setup: config.language and page.config.language.
Enter the data in the back end using Web -> List.
Upgrading from version 0.3.0¶
Make sure that you’re using at least TYPO3 4.0.0 and PHP 5.1.0.
Make sure that you have installed the extension static_info_tables in the latest version.
Make sure that you have installed the extension oelib in the latest version.
The CSS file now is set via constants. If you are using a custom CSS file, please set it in the constants editor.
Upgrade this extension.
In you main TS template, include this extension’s static setup under Include static (from extensions) .
Uninstall the extension sr_static_info unless it’s still needed by another extension.
Reference¶
You can configure the plug-in using flexforms of the front end plug-in your TS template setup for plugin.tx_contactslist_pi1. property = value.
templateFile¶
Property
templateFile
Data type
String
Description
location of the template file
Default
EXT:contactslist/pi1/contactslist_pi1.html
class_h3¶
Property
class_h3
Data type
String
Description
CSS class for the item headings (will be automatically prefixed with tx-contactslist-pi1- )
Default
class_table¶
Property
class_table
Data type
String
Description
CSS class for the item table (will be automatically prefixed with tx-contactslist-pi1- )
Default
class_td1¶
Property
class_td1
Data type
String
Description
CSS class for the table row headings cell (will be automatically prefixed with tx-contactslist-pi1- )
Default
rowHeading
class_td2¶
Property
class_td2
Data type
String
Description
CSS class for the table row data cell (will be automatically prefixed with tx-contactslist-pi1- )
Default
class_inputcountry¶
Property
class_inputcountry
Data type
String
Description
CSS class for the country selector (will be automatically prefixed with tx-contactslist-pi1- )
Default
class_inputzipcode¶
Property
class_inputzipcode
Data type
String
Description
CSS class for the ZIP code text input (will be automatically prefixed with tx-contactslist-pi1- )
Default
class_submitbutton¶
Property
class_submitbutton
Data type
String
Description
CSS class for the submit button (will be automatically prefixed with tx-contactslist-pi1- )
Default
defaultCountry¶
Property
defaultCountry
Data type
String
Description
ISO alpha3 code for the country that is selected by default(leave empty to have nothing selected)
Default
DEU
onchangeCountryselect¶
Property
onchangeCountryselect
Data type
String
Description
onchange attribute for the country select(usually doesn't need to be changed)
Default
onchange="javascript:this.form.submit();"
hideFields¶
Property
hideFields
Data type
String
Description
comma-separated list of fields that should not be shown on the front endallowed values: intro, inputcountry, inputzipcode, submitbutton,contactperson, address1, address2, zipcode, city, country, zipprefixes, phone, fax, mobile, homepage, email,resultbrowser
Default
country,zipprefixes,resultbrowser
[tsref:plugin.tx_contactslist_pi1]
Setup for the list view¶
For the list view, there are some additional configuration option that can only be set using the TS setup (not with flexforms) in the form plugin.tx_contactslist_pi1.listView. property = value.
results_at_a_time¶
Property
results_at_a_time
Data type
integer
Description
the number of contacts that will be displayed per page (currently not used)
Default
10
maxPages¶
Property
maxPages
Data type
integer
Description
how many pages should be displayed in the list view page navigation
Default
5
orderBy¶
Property
orderBy
Data type
string
Description
which DB field is used for the default sorting in the list view
Default
company
descFlag¶
Property
descFlag
Data type
boolean
Description
the default sort order in the list view: 0 = ascending, 1 = descending
Default
0
[tsref:plugin.tx_realty_pi1.listView]
Constants for the Contacts List front-end plug-in in plugin.tx_contactslist_pi1¶
You can configure the plug-in using your TS template constant in the form plugin.tx_contactslist_pi1. property = value.
cssFile¶
Property
cssFile
Data type
string
Description
location of the CSS file (set as empty to not include the file)
Default
EXT:contactslist/pi1/contactslist_pi1.css
EXT: Contacts List - 4