.. You may want to use the usual include line. Uncomment and adjust the path. .. include:: ../Includes.txt ======================= EXT: Smoelenboek plugin ======================= :Author: Kasper Skårhøj :Created: 2002-11-01T00:32:00 :Changed: 2010-01-21T17:17:53 :Author: Frans van der Veen :Email: extensions@netcreators.com :Info 3: :Info 4: .. _EXT-Smoelenboek-plugin: EXT: Smoelenboek plugin ======================= Extension Key: **nc\_gov\_smoelenboek** Copyright 2000-2002, Frans van der Veen, 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: TU/e banner plugin 1** **Introduction 1** What doet het? 1 **Gebruik van de plugin 2** back-end 2 **Configuratie 6** Installatie 6 Setup en typoscript configuratie 6 Een adresveld banner instellen middels TS 7 Configuratie stylesheets 8 **TODO 9** **Changelog 9** **Bronvermelding 9** .. _Copyright: Copyright ========= .. _Credits: Credits ------- .. _Sponsors: Sponsors -------- \- Gemeente heemskerk. .. _Introduction: Introduction ------------ .. _What-does-it-do: What does it do? ^^^^^^^^^^^^^^^^ With this plugin you can create a userlisting and show detailed information about the user (optionally with a picture of the user). You can list the users alphabetically, view which users celebrate their birthday the next period and this plugin also provides a search possibility allowing easy access to your users. .. _Screenshots: Screenshots """"""""""" *Picture 1: Examples* |img-1| .. _Users-manual: Users manual ------------ .. _The-views: The views ^^^^^^^^^ This plugin has several views. All explained below. .. _Listview: Listview """""""" This is the default view of the plugin. It simply shows a list of users. |img-2| |img-3| |img-4| |img-5| |img-6| *Picture 2: The listing* |img-1| Search fields. You can enter a search query in the search box and the plugin will search in the (for the by TS defined columns) records in the database. It is also possible to narrow your search by searching by department and by bureau. By index On the entry page the plugin shows all the records. It is also possible to view users by name, by clicking on a letter in the index list. Status The status field displays special info, whether the user is still working here, or possibly ill. This can all be configured by TS. Info fields By default the plugin shows the name, phone, mobile and status fields. Gallery view This enables the gallery view where a list of thumbnails is displayed. .. _Detail-view: Detail view ----------- *Picture 3: detail view* |img-7| The detailed view will display business information (and if supplied a picture). The plugin can also be configured so it will show private info. This way the plugin can be used as a source for contact information in case an calamity. The plugin can also be configured so that it gives the user the freedom to edit their own personal page. A user can upload several images, do some RTE text editting and supply a link to his or her own website. *Picture 4: User's personal page* |img-8| .. _Configuration: Configuration ------------- .. _Installation: Installation ^^^^^^^^^^^^ The installation of the plugin is quite simple. Install using the extension manager. Make a storage folder where you will put the user records. Add a content-element to the page where you want to display the plugin. Select type 'insert plugin' and select the 'Smoelenboek' as plugin. *Picture 5: Configuration* |img-9| |img-10| |img-11| |img-12| |img-13| |img-14| |img-15| When the page has reloaded you will be able to see the configuration options of the plugin. What the plugin will display. Possible options are: list view, birthday view or search. The starting point of the plugin. Here is where the plugin will get it's records from. Select the folder you created at 2) If you created more storage folders in the storage folder you created at 2) you can choose here how deep the plugin should seek into the folder hierarchy. Show extended information (calamity). This option enables the plugin so that detailed information is displayed (eg personal information) so someone can look this up in case of a calamity). The number of results per page. Page for searchresults: here you can set the page where the plugin should redirect to when a user searches. Add the nc\_gov\_smoelenboek extension as a static template (from extension). You can now add 'user' (“Gebruikers”) records to the storage folder you specified at 2). If you want to enable the user to edit his own page, then you will have to create a FE user and select this user in the (smoelenboek) user record, otherwise the user will not be allowed to edit his record. .. _TS-configuration: TS configuration ^^^^^^^^^^^^^^^^ This plugin has several TS configuration options. .. ### BEGIN~OF~TABLE ### .. _pidList: pidList """"""" .. container:: table-row Property pidList Data type string Description Default value for the 'From' or sender email address of direct mails. (Required) Note: This email address appears as the originating address or sender address in the direct mails received by the recipients. .. _recursive: recursive """"""""" .. container:: table-row Property recursive Data type string Description The depth the plugin will search in the page hierarchy. .. _templateFile: templateFile """""""""""" .. container:: table-row Property templateFile Data type string Description Template file for the plugin. .. _results-at-a-time: results\_at\_a\_time """""""""""""""""""" .. container:: table-row Property results\_at\_a\_time Data type integer Description The number of results that will be displayed on one page. .. _extendedView: extendedView """""""""""" .. container:: table-row Property extendedView Data type boolean Description Set to 1 for the extended view. Extended view enables the plugin to show personal info (so it can be used for calamity e.g.) .. _searchPage: searchPage """""""""" .. container:: table-row Property searchPage Data type integer Description The pid for the page where the search is located. .. _defaultMode: defaultMode """"""""""" .. container:: table-row Property defaultMode Data type string Description Can be birthday, search or list. Will set the plugin into according view. .. _showFields: showFields """""""""" .. container:: table-row Property showFields Data type string Description The fields which will be displayed. Comma separated. .. _searchFields: searchFields """""""""""" .. container:: table-row Property searchFields Data type string Description The fields which will be searched. Comma separated. .. _mode-list: mode\_list """""""""" .. container:: table-row Property mode\_list Data type wrap Description Wrapper for the listing mode link. .. _mode-gallery: mode\_gallery """"""""""""" .. container:: table-row Property mode\_gallery Data type wrap Description wrapper for the gallery mode link. .. _birthdayOffset: birthdayOffset """""""""""""" .. container:: table-row Property birthdayOffset Data type integer Description This value determines from now until now + offset (in seconds) which users are shown in the birthday list mode. .. _CSS-DEFAULT-STYLE: \_CSS\_DEFAULT\_STYLE """"""""""""""""""""" .. container:: table-row Property \_CSS\_DEFAULT\_STYLE Data type Description Some default CSS styles. .. _maxUserImages: maxUserImages """"""""""""" .. container:: table-row Property maxUserImages Data type integer Description Specifies how many images a user can supply on his own personal info page. .. _personalInfoDisabled: personalInfoDisabled """""""""""""""""""" .. container:: table-row Property personalInfoDisabled Data type boolean Description Disables the personal user information page. 0 default. .. _personalInfoEditDisabled: personalInfoEditDisabled """""""""""""""""""""""" .. container:: table-row Property personalInfoEditDisabled Data type boolean Description Disables editting personal user information page. 0 default. .. _additionalWhereStatementAnd: additionalWhereStatementAnd """"""""""""""""""""""""""" .. container:: table-row Property additionalWhereStatementAnd Data type String Description You can add additional selection criteria here for the list view (expert only) Example: additionalWhereStatementAnd = woonwoonplaatsnm = 'Heemskerk' .. ###### END~OF~TABLE ###### .. _pageBrowser-section: pageBrowser section """"""""""""""""""" .. ### BEGIN~OF~TABLE ### .. _showFirstLast: showFirstLast ~~~~~~~~~~~~~ .. container:: table-row Property showFirstLast Data type boolean Description Use this switch if the two links named "<< First" and "LAST >>" will be shown and point to the first or last page. .. _pagefloat: pagefloat ~~~~~~~~~ .. container:: table-row Property pagefloat Data type integer/string Description This defines were the current page is shown in the list of pages in the Pagebrowser. If this var is an integer it will be interpreted as position in the list of pages. If its value is the keyword "center" the current page will be shown in the middle of the pagelist. .. _showRange: showRange ~~~~~~~~~ .. container:: table-row Property showRange Data type string Description This var switches the display of the pagelinks from pagenumbers to ranges f.e.: 1-5 6-10 11-15... instead of 1 2 3... .. _dontLinkActivePage: dontLinkActivePage ~~~~~~~~~~~~~~~~~~ .. container:: table-row Property dontLinkActivePage Data type boolean Description Use this as a switch if the active (current) page should be displayed as pure text or as a link to itself. .. _disabledLinkWrap: disabledLinkWrap ~~~~~~~~~~~~~~~~ .. container:: table-row Property disabledLinkWrap Data type stdWrap Description stdWrap for disabled links. .. _inactiveLinkWrap: inactiveLinkWrap ~~~~~~~~~~~~~~~~ .. container:: table-row Property inactiveLinkWrap Data type stdWrap Description stdWrap for inactive links. .. _activeLinkWrap: activeLinkWrap ~~~~~~~~~~~~~~ .. container:: table-row Property activeLinkWrap Data type stdWrap Description stdWrap for active links. .. _showResultsWrap: showResultsWrap ~~~~~~~~~~~~~~~ .. container:: table-row Property showResultsWrap Data type stdWrap Description stdWrap for the results page. .. _showResultsNumbersWrap: showResultsNumbersWrap ~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property showResultsNumbersWrap Data type stdWrap Description stdWrap for the result numbers. .. _browseBoxWrap: browseBoxWrap ~~~~~~~~~~~~~ .. container:: table-row Property browseBoxWrap Data type stdWrap Description stdWrap for the browsebox. .. _browseLinksWrap: browseLinksWrap ~~~~~~~~~~~~~~~ .. container:: table-row Property browseLinksWrap Data type stdWrap Description stdWrap for the browselinks. .. ###### END~OF~TABLE ###### .. _displaySingle-section: displaySingle section """"""""""""""""""""" .. ### BEGIN~OF~TABLE ### .. _fields: fields ~~~~~~ .. container:: table-row Property fields Data type stdWrap Description wraps for the fields specified by showFields. .. ###### END~OF~TABLE ###### .. _displayList-section: displayList section """"""""""""""""""" See displaySingle section. .. _displayGallery-section: displayGallery section """""""""""""""""""""" See displaySingle section. .. _displayBirthday-section: displayBirthday section """"""""""""""""""""""" See displaySingle section. .. _displayPersonalInfo-section: displayPersonalInfo section """"""""""""""""""""""""""" .. ### BEGIN~OF~TABLE ### .. _fields: fields ~~~~~~ .. container:: table-row Property fields Data type stdWrap Description Wraps for personal\_info, personal\_info\_link, personal\_info\_images fields. .. ###### END~OF~TABLE ###### .. _Troubleshooting: Troubleshooting --------------- .. _The-plugin-shows-warnings-errors: The plugin shows warnings / errors. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Make sure you included the static template (from extension). .. _Known-problems: Known problems -------------- None so far. .. _TODO: TODO ---- - Update plugin so that user has the freedom to edit more fields (like name, private info, business info). - Update database fieldnames to english. .. _Changelog: Changelog --------- .. ### BEGIN~OF~TABLE ### .. _0-1-0-BETA: 0.1.0 (BETA) ^^^^^^^^^^^^ .. container:: table-row Version 0.1.0 (BETA) Changes Initial release Date 20-12-2007 .. _0-2-0-BETA: 0.2.0 (BETA) ^^^^^^^^^^^^ .. container:: table-row Version 0.2.0 (BETA) Changes Updated so a user can supply his own personal information. Date 28-12-2007 .. ###### END~OF~TABLE ###### .. _Sources: Sources ------- |img-16| EXT: Smoelenboek plugin - 9 .. ######CUTTER_MARK_IMAGES###### .. |img-1| image:: img-1.png .. :align: left .. :border: 0 .. :height: 123 .. :id: graphics1 .. :name: graphics1 .. :width: 345 .. |img-2| image:: img-2.png .. :align: left .. |img-3| image:: img-3.png .. :align: left .. |img-4| image:: img-4.png .. :align: left .. |img-5| image:: img-5.png .. :align: left .. |img-6| image:: img-6.png .. :align: left .. |img-7| image:: img-7.png .. :align: left .. :border: 0 .. :height: 381 .. :id: graphics3 .. :name: graphics3 .. :width: 331 .. |img-8| image:: img-8.png .. :align: left .. :border: 0 .. :height: 279 .. :id: graphics5 .. :name: graphics5 .. :width: 393 .. |img-9| image:: img-9.png .. :align: left .. :border: 0 .. :height: 178 .. :id: graphics4 .. :name: graphics4 .. :width: 537 .. |img-10| image:: img-10.png .. :align: left .. |img-11| image:: img-11.png .. :align: left .. |img-12| image:: img-12.png .. :align: left .. |img-13| image:: img-13.png .. :align: left .. |img-14| image:: img-14.png .. :align: left .. |img-15| image:: img-15.png .. :align: left .. |img-16| image:: img-16.png .. :align: left .. :border: 0 .. :height: 32 .. :id: Graphic1 .. :name: Graphic1 .. :width: 102