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: Partner Frontend-Plugin¶
Author: | Kasper Skårhøj |
---|---|
Created: | 2002-11-01T00:32:00 |
Changed by: | David Brühlmeier |
Changed: | 2008-01-06T08:14:27 |
Author: | David Bruehlmeier |
Email: | typo3@bruehlmeier.com |
Info 3: | |
Info 4: |
EXT: Partner Frontend-Plugin¶
Extension Key: partner_fe
Copyright 2004-2006, David Bruehlmeier, <typo3@bruehlmeier.com>
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: Partner Frontend-Plugin 1
Introduction 1
What does it do? 1
Screenshots 1
Users manual 1
Adminstration 1
Configuration 1
Installation 1
Mandatory Configuration 1
Reference 2
Tutorial 3
FAQ 3
Known problems 3
To-Do list 3
Changelog 3
Introduction¶
Important notice: This extension was created as a “proof-of- concept” for frontend-display of partner records. The development stopped at this stage and the extension is currently not supported any more. Some of the features may or may not work. If anybody is interested in taking over this extension, please contact me: typo3@bruehlmeier.com .
I currently do not recommend using this extension.
What does it do?¶
This extension is able to display and change partner-records from the extension 'partner' in the frontend. For instance, you might want to display a list of partners on your webpage with a certain occupation (e.g. all team-leaders of a soccer club). You can define the occupation in the frontend-plugin and the extension will automatically select all relevant partners and display them in a customizable way (HTML-template).
Screenshots¶
Users manual¶
Administration¶
Configuration¶
Installation¶
Like any other extension: Download from TER, click install.
Mandatory Configuration¶
The extension comes with some preset TypoScript to facilitate the configuration. However, you need to make at least the following configurations in order to get a working installation:
Include the default static template
The extension comes with a set of default constants and TypoScript configurations. In order to use this set, you need to include the static template 'Partner Default (partner)' in your template:
Set the General Records Sorage Page
In the folder where you want to store your partner records, you need to set a General Record Storage page. This is the sys-folder where the extension will look for the partner-records to display.
Reference¶
Please note that the default values are only set if the static template 'Partner Default (partner)' is included in your template (see chapter 'Mandatory Configuration').
templateFile¶
Property
templateFile
Data type
string
Description
This is the template file for displaying partners. Can be set in the Constant Editor.
Default
EXT:partner_fe/pi1/partner_display.tmpl
partnerDisplayFields¶
Property
partnerDisplayFields
Data type
string
Description
Comma-separated list of partner-fields which can be displayed. Normally, you should list all fields which you included as markers in your HTML-template. The fields must be configured in $TCA (table tx_partner_main). The field names must exactly correspond to the $TCA-fieldnames! Can be set in the Constant Editor.
NOTE: Strictly speaking, this is an optional setting. However, if you restrict this to only the fields you will actually display, you can gain a lot of performance!
Default
first_name,last_name,org_name,street,postal_code,locality,country
contactInfoDisplayFields¶
Property
contactInfoDisplayFields
Data type
string
Description
Comma-separated list of contact information-fields which should be displayed. The fields must be configured in $TCA (table tx_partner_contact_info). The field names must exactly correspond to the $TCA-fieldnames!
NOTE: Strictly speaking, this is an optional setting. However, if you restrict this to only the fields you will actually display, you can gain a lot of performance!
Default
type,area_code,number,email,url
orderBy¶
Property
orderBy
Data type
string
Description
Comma-separated list of partner-fields by which to order the resulting list.
Default
last_name,first_name,org_name,postal_code
restrictToPostalCode¶
Property
restrictToPostalCode
Data type
string
Description
If this is set, the resulting list is restricted to this postal code. The comparison is done in SQL using “LIKE”, so a wildcard (%) is appended to this value. This enables you for instance to show only partners from postal codes starting with “9” on a page.
Default
selectors.postal_code.wrapItems¶
Property
selectors.postal_code.wrapItems
Data type
stdWrap
Description
Wrap one item of the selector for the postal code. The default separates each item with “|” symbol.
selectors.postal_code.wrapItems {
wrap = |
wrap.splitChar = ,
}
Default
see description
contactInfoDisplay¶
Property
contactInfoDisplay
Data type
Description
These settings determine the marker ###DISPLAY### for contact- information. This marker can be used to concatinate several fields (e.g. the area code and the number of a phone number) for displaying. The standard setup looks like this:
# Phone
contactInfoDisplay.0 {
stdWrap.wrap = Phone:
10 = area_code
10.stdWrap.wrap = (|)
20 = number
}
# Mobile Phone
contactInfoDisplay.1 {
stdWrap.wrap = Mobile Phone:
10 = area_code
10.stdWrap.wrap = (|)
20 = number
}
# Fax
contactInfoDisplay.2 {
stdWrap.wrap = Fax:
10 = area_code
10.stdWrap.wrap = (|)
20 = number
}
# E-Mail
contactInfoDisplay.3 {
stdWrap.wrap = E-Mail:
10 = email
}
# URL
contactInfoDisplay.4 {
stdWrap.wrap = URL:
10 = url
}
Default
see description
contactInfoDisplay.0.stdWrap¶
Property
contactInfoDisplay.0.stdWrap
Data type
stdWrap
Description
Wraps contact-infos of the type 0 (Phone)
Default
contactInfoDisplay.1.stdWrap¶
Property
contactInfoDisplay.1.stdWrap
Data type
stdWrap
Description
Wraps contact-infos of the type 1 (Mobile Phone)
Default
contactInfoDisplay.2.stdWrap¶
Property
contactInfoDisplay.2.stdWrap
Data type
stdWrap
Description
Wraps contact-infos of the type 2 (Fax)
Default
contactInfoDisplay.3.stdWrap¶
Property
contactInfoDisplay.3.stdWrap
Data type
stdWrap
Description
Wraps contact-infos of the type 3 (E-Mail)
Default
contactInfoDisplay.4.stdWrap¶
Property
contactInfoDisplay.4.stdWrap
Data type
stdWrap
Description
Wraps contact-infos of the type 4 (URL)
Default
[tsref:plugin.tx_partnerfe_pi1]
Please note that – just like with any other Frontend-Extension – you can override labels you don't like. For instance, if you would like to change the label of the postal code selector, you could use a TypoScript setup like this:
plugin.tx_partnerfe_pi1._LOCAL_LANG.default.selector_postal_code_label = Postal Code %2
Tutorial¶
FAQ¶
Known problems¶
To-Do list¶
Changelog¶
EXT: Partner Frontend-Plugin - 5