.. You may want to use the usual include line. Uncomment and adjust the path. .. include:: ../Includes.txt =================================== LumoNet ImmobilienScout24.de Expose =================================== :Author: Kasper Skårhøj :Created: 2002-11-01T00:32:00 :Changed by: Thomas Off :Changed: 2006-12-15T13:57:10 :Author: Thomas Off, LumoNet oHG :E-Mail: t.off@lumonet.de :Info 3: :Info 4: .. _LumoNet-ImmobilienScout24-de-Expose: LumoNet ImmobilienScout24.de Expose =================================== Extension Key: **lumophpinclude** Copyright 2006, Thomas Off, LumoNet oHG, 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 .. _Content: Content ------- **Introduction 1** **What does it do? 1** **Screenshots 2** **Usage 3** **Requirements 3** **Installation 3** **Configuration 3** **Known Bugs 5** **ToDo 6** **Changelog 7** .. _Introduction: Introduction ------------ .. _What-does-it-do: What does it do? ^^^^^^^^^^^^^^^^ The extension shows data from a realty exposé from the known portal ImmobilienScout24.de which is obtained by their XML-based API. This way, agents are able to present information about their realties on their website without having to edit data twice: the data they enter at ImmobilienScout24.de can improve the realty descriptions on thei homepage with little effort. .. _Screenshots: Screenshots ----------- **Backend view of the plugin:** |img-1| .. _Usage: Usage ----- .. _Requirements: Requirements ^^^^^^^^^^^^ typo3 >= 4.0 (could work on older versions of TYPO3 but this was not tested) To actually use the extension you need two things: An API key for developers which can be obtained at no fee from http://api.immobilienscout24.de/de/api\_center/ A valid vendor ID from ImmobilienScout24.de; to get one you'll have to sign a professional product from them (for which a monthly fee is charged) .. _Installation: Installation ^^^^^^^^^^^^ Get your API key and the vendor ID (the last one typically from your customer, the agent) Install the plugin via Extension Manager. Use the Constant Editor to set the API key and vendor ID. Create a new page. Add a new content element „ImmobilienScout24.de Exposé“ to this page. Enter the so called „Scout-ID“ of some realty (must not be one of the vendor whose ID is used) View your page in the frontend of the website. Adjust the templates to fit your needs. .. _Configuration: Configuration ^^^^^^^^^^^^^ The only configuration that can be done is setting the API key and the vendor ID, which is always necessary to use the plugin, and adjusting the templates. The following configuration options are available at the moment: .. ### BEGIN~OF~TABLE ### .. _api-key: api\_key """""""" .. container:: table-row Property api\_key Data type string Description The API key for developersGet one for free at http://api.immobilienscout24.de/de/api\_center/. **Example:** :: plugin.tx_lumoscoutexpose_pi1.api_key = API_KEY Default .. _vendor-id: vendor\_id """""""""" .. container:: table-row Property vendor\_id Data type string Description Path to a template file for map, sidebar and info window; an example can be found in the sub-directory templates of the plugin. **Example:** :: plugin.tx_lumoscoutexpose_pi1.vendor_id = VENDOR_ID Default .. _allappartmentbuy: allappartmentbuy """""""""""""""" .. container:: table-row Property allappartmentbuy appartmentrent gastronomy housebuy houserent housetype industry investment misc office site store waz Data type string Description Template file to be used for the different types of realties; the extension chooses the template based on the API response dynamically. Each of the templates features a set of common markers (from the exposés base types RealEstate and GISRealEstate) and markers specific to the type of realty (e.g. the type of heating is not used for sites). The template\_all file can be used to include all templates in one big file (not recommended because of the readability of the resulting HTML code) **Example:** :: plugin.tx_lumoscoutexpose_pi1.template.site = fileadmin/templates/template_site.html Default See template analyzer for default values .. ###### END~OF~TABLE ###### .. _Templating: Templating ^^^^^^^^^^ Included with the extension are sample templates for all types of exposés. A description of all available properties is provided within the document „Technische Dokumentation ImmobilienScout24-API“ which can be obtained from the developer website (http://api.immobilienscout24.de/de/api\_center/). The document is also provided within the extension's 'doc' directory. The following paragraphs list the markers available to all types of exposés from their base types RealEstate and GISRealEstate. .. _RealEstate: RealEstate """""""""" :code:`###uuid###` :code:`###CreationDate###` :code:`###DeactivationDate###` :code:`###LastModificationDate###` :code:`###Heading###` :code:`###vendor###` :code:`###foreignKey###` :code:`###groupNumber###` :code:`###ContactAddress\_company1###` :code:`###ContactAddress\_company2###` :code:`###ContactAddress\_title###` :code:`###ContactAddress\_salutation###` :code:`###ContactAddress\_firstName###` :code:`###ContactAddress\_lastName###` :code:`###ContactAddress\_phone###` :code:`###ContactAddress\_mobile###` :code:`###ContactAddress\_fax###` :code:`###ContactAddress\_eMail###` :code:`###ContactAddress\_homepage###` :code:`###ContactAddress\_businessPhone###` :code:`###ContactAddress\_businessFax###` :code:`###ContactAddress\_callBeforeFax###` .. _GISRealEstate: GISRealEstate """"""""""""" :code:`###Address\_street###` :code:`###Address\_houseNo###` :code:`###Address\_zip###` :code:`###Address\_city###` :code:`###showAddress###` :code:`###Continent###` :code:`###Country###` :code:`###Region###` :code:`###City###` :code:`###Quarter###` :code:`###geoX###` :code:`###geoY###` .. _Known-Bugs: Known Bugs ---------- No bugs known so far. Please report any other bugs (or suggestions for improvement) to the author of the extension. .. _ToDo: ToDo ---- - Implement different types of pictures to get (currently the 'Expose' type is used). - Add (better) error messages (as the API sometimes fails without reason) - Implement session management to use resources more efficiently (currently a new session is opened for every request) - .. _Changelog: Changelog --------- 2006-12-13 Thomas Off, LumoNet oHG Implemented missing handling of base type GISRealEstate 2006-12-12 Thomas Off, LumoNet oHG Initial release |img-2| LumoNet ImmobilienScout24.de Expose - 8 .. ######CUTTER_MARK_IMAGES###### .. |img-1| image:: img-1.jpeg .. :align: left .. :border: 1 .. :height: 298 .. :id: Grafik1 .. :name: Grafik1 .. :width: 563 .. |img-2| image:: img-2.png .. :align: left .. :border: 0 .. :height: 32 .. :id: Graphic1 .. :name: Graphic1 .. :width: 102