.. You may want to use the usual include line. Uncomment and adjust the path. .. include:: ../Includes.txt .. role:: underline ========================= EXT: General Data Display ========================= :Created: 2010-02-18T17:33:18 :Changed by: Roderick Braun :Changed: 2015-09-15T15:24:45 :Classification: general_data_display :Description: The keywords help with categorizing and tagging of the manuals. You can combine two or more keywords and add additional keywords yourself. Please use at least one keyword from both lists. If your manual is NOT in english, see next tab "language" ---- forEditors (use this for editors / german "Redakteure") forAdmins (use this for Administrators) forDevelopers (use this for Developers) forBeginners (manuals covering TYPO3 basics) forIntermediates (manuals going into more depth) forAdvanced (covering the most advanced TYPO3 topics) see more: http://wiki.typo3.org/doc_template#tags ---- :Keywords: data display, data categorization, searchable, data sheet :Author: Roderick Braun :Email: roderick.braun@ph-freiburg.de :Info 4: :Language: en, de |img-1| |img-2| EXT: General Data Display - general\_data\_display .. _EXT-General-Data-Display: EXT: General Data Display ========================= Extension Key: general\_data\_display Language: en, de Keywords: data display, data categorization, searchable, data sheet Copyright 2000-2010, Roderick Braun, 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.org .. _Table-of-Contents: Table of Contents ----------------- `EXT: General Data Display 1 <#__RefHeading__1189_255256260>`_ **`Introduction 3 <#__RefHeading__1191_255256260>`_** `What does it do? 3 <#__RefHeading__1193_255256260>`_ `Screenshots 3 <#__RefHeading__1195_255256260>`_ **`Users manual 5 <#__RefHeading__1197_255256260>`_** `Update from older versions 5 <#__RefHeading__1700_1801375055>`_ `Add the plugin to a page 5 <#__RefHeading__675_1566569376>`_ `Configure the plugin 5 <#__RefHeading__2291_1591933810>`_ **`Configuration 8 <#__RefHeading__1205_255256260>`_** `TypoScript Reference 8 <#__RefHeading__2301_1591933810>`_ `HTML Template 8 <#__RefHeading__2303_1591933810>`_ `Stylesheet 9 <#__RefHeading__2305_1591933810>`_ `Languages 9 <#__RefHeading__2307_1591933810>`_ **`Tutorial 10 <#__RefHeading__1211_255256260>`_** `Insert plugin to your page 10 <#__RefHeading__752_1566569376>`_ `Defining datafields 10 <#__RefHeading__754_1566569376>`_ `Defining categories 10 <#__RefHeading__756_1566569376>`_ `Enter your first dataset 11 <#__RefHeading__758_1566569376>`_ `Modifying data definitions 12 <#__RefHeading__760_1566569376>`_ `HTML Tag substitutions 12 <#__RefHeading__677_1566569376>`_ **`Known problems 13 <#__RefHeading__1213_255256260>`_** **`ChangeLog 14 <#__RefHeading__1217_255256260>`_** .. _Introduction: Introduction ------------ .. _What-does-it-do: What does it do? ^^^^^^^^^^^^^^^^ - With this plugin you can define datasets to build up a searchable database from any categorizable data. A dataset consists of a title a (sub)category and a set of datafields which are defineable according to your data. The plugin creates a searchable link list out of these titles and categories which points to detail views of your defined datasets. - Possibility to give frontend user restricted access to datasets .. _Screenshots: Screenshots ^^^^^^^^^^^ .. _Example-1-Searchable-linklist-generated-from-categorized-data: Example 1: Searchable linklist generated from categorized data """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" |img-3| .. _Example-2-Detail-view: Example 2: Detail view """""""""""""""""""""" |img-4| .. _Users-manual: Users manual ------------ .. _Update-from-older-versions: Update from older versions ^^^^^^^^^^^^^^^^^^^^^^^^^^ If you update from an older version of this plugin it is most likely that you have to convert your content due to table/content changes – otherwise (some of) your data is inaccessible afterwards. Please select UPDATE! from the pull down menu of your extension manager after upgrading this extension and your data will automatically be converted into the new format. Although this should work without problems it would be better to dump your data in order to prevent data loss. .. _Add-the-plugin-to-a-page: Add the plugin to a page ^^^^^^^^^^^^^^^^^^^^^^^^ Switch to your Typo3 Backend (BE) and point the page modul to the page where you want to add the the content element.Klick “new content” and choose “General Data Display” from the Plugins section. If you use a customized template and/or stylesheet it is likely that an update makes it necessary to modify these files. .. _Configure-the-plugin: Configure the plugin ^^^^^^^^^^^^^^^^^^^^ All of the configuration is done using the configuration tab of the plugin in the BE and / or via TS. .. _General-settings-tab: General settings tab """""""""""""""""""" The General settings tab holds the plugin display settings. |img-5| .. _Data-location: Data location ~~~~~~~~~~~~~ The page where the datasets are located .. _Searchform: Searchform ~~~~~~~~~~ The page where the searchview is located (default: searchview & detailview are presented on the same page) .. _Detailview: Detailview ~~~~~~~~~~ The page where the detailview is located .. _View: View ~~~~ Select if the searchform & linklist or the detailview is presented (empty: show both) .. _User-stylesheet: User stylesheet ~~~~~~~~~~~~~~~ You can load your customized stylesheet here – w/o standard stylesheet is used .. _User-template: User template ~~~~~~~~~~~~~ You can load your customized template here - w/o standard template is used .. _List-view-tab: List view tab """"""""""""" .. _img-6: |img-6| ~~~~~~~ .. _Initially-display-datasets: Initially display datasets ~~~~~~~~~~~~~~~~~~~~~~~~~~ Whether the list of datasets is presented initially or not .. _Entries-per-page: Entries per page ~~~~~~~~~~~~~~~~ How many datasets should be displayed before showing a pagebrowser .. _Max-pagelinks: Max pagelinks ~~~~~~~~~~~~~ The maximum of pagelinks displayed by the pagebrowser .. _Search-with-alphabetic-linklist: Search with alphabetic linklist ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Enable/disable an alphabetic dataset browser below the search field. .. _FE-user-administration-tab: FE user administration tab """""""""""""""""""""""""" In the administration tab you have the opportunity to give restricted frontend (FE) access to specific users or groups. Restricted means that these users can only add/delete/modify datasets and are not allowed to add/delete/modify categories or datafields. In contrast all authorized BE users have always full access to the FE administration menu of this plugin. |img-7| .. _FE-Admistration-users: FE Admistration users ~~~~~~~~~~~~~~~~~~~~~ The FE users that are allowed to add/change/delete datasets .. _Administration-group: Administration group ~~~~~~~~~~~~~~~~~~~~ The FE usergroup that are allowed to add/change/delete datasets .. _Strict-permissions: Strict permissions ~~~~~~~~~~~~~~~~~~ Yes: Only the creator is allowed to modify/delete own datasets (default)No: Every configured FE user can modify/delete all datasets If you are allowed to see the FE adminstration menu either because you are an allowed BE user or a configured FE user (section above) an administrator menu is presented below the search field in list view and edit/delete links below your datasets in detail view. .. _Configuration: Configuration ------------- .. _TypoScript-Reference: TypoScript Reference ^^^^^^^^^^^^^^^^^^^^ Properties of plugin.tx\_generaldatadisplay\_pi1 .. ### BEGIN~OF~TABLE ### .. _dataPID: dataPID """"""" .. container:: table-row Property dataPID Data type int Description Page id where the datasets reside Default $GLOBALS['TSFE']->id .. _listViewPID: listViewPID """"""""""" .. container:: table-row Property listViewPID Data type int Description Page id of the listview Default $GLOBALS['TSFE']->id .. _detailViewPID: detailViewPID """"""""""""" .. container:: table-row Property detailViewPID Data type int Description Page id of the detail view Default $GLOBALS['TSFE']->id .. _userTemplateFile: userTemplateFile """""""""""""""" .. container:: table-row Property userTemplateFile Data type string Description User defined template Default templates/template.html .. _userStyleSheet: userStyleSheet """""""""""""" .. container:: table-row Property userStyleSheet Data type string Description User defined CSS Default css/default.css .. _maxFileSize: maxFileSize """"""""""" .. container:: table-row Property maxFileSize Data type int Description Max. uploadable file size Default 500000 .. _viewMode: viewMode """""""" .. container:: table-row Property viewMode Data type int Description 1 = listview, 2=detail view Default 1 .. _initialNoResults: initialNoResults """""""""""""""" .. container:: table-row Property initialNoResults Data type bool Description Initially do not show datasets in listview Default 0 (show) .. _withoutBrowseList: withoutBrowseList """"""""""""""""" .. container:: table-row Property withoutBrowseList Data type bool Description Do not show alphabetical browselist Default 0 (show) .. _nrPageResults: nrPageResults """"""""""""" .. container:: table-row Property nrPageResults Data type int Description Number of results presented in listview Default 0 (show all) .. _nrMaxPages: nrMaxPages """""""""" .. container:: table-row Property nrMaxPages Data type int Description Number of max. pagelinks showed in pagebrowser Default 5 .. _feAdminUsers: feAdminUsers """""""""""" .. container:: table-row Property feAdminUsers Data type string Description List of FE-user ids with administrative access Default (empty) Example: 1,2,3... .. _feAdminGroups: feAdminGroups """"""""""""" .. container:: table-row Property feAdminGroups Data type string Description List of FE-group ids with administrative access Default (empty) Example: 1,2,3... .. _allowDataExport: allowDataExport """"""""""""""" .. container:: table-row Property allowDataExport Data type bool Description Allow CSV-export of data (experimental) Default 0 (disabled) .. _allowDataImport: allowDataImport """"""""""""""" .. container:: table-row Property allowDataImport Data type bool Description Allow import of CSV-data (experimental) Default 0 (disabled) .. _strictPerm: strictPerm """""""""" .. container:: table-row Property strictPerm Data type bool Description Only the creator can modify/delete the dataset (configured/authorized FE user only) Default 1 (enabled) .. ###### END~OF~TABLE ###### .. _HTML-Template: HTML Template ^^^^^^^^^^^^^ The default template is named template.html and can be found in the path of your extension directiory: Typically “typo3conf/ext/general\_data\_display/templates/”. .. _Markers: Markers """"""" Some of the markers in the which are substituted depending on the view as follows: .. ### BEGIN~OF~TABLE ### .. _ACTION-URL: ###ACTION\_URL### ~~~~~~~~~~~~~~~~~ .. container:: table-row Common Markers (required) ###ACTION\_URL### Substitute The URL of the plugin page .. _PI-BASE: ###PI\_BASE### ~~~~~~~~~~~~~~ .. container:: table-row Common Markers (required) ###PI\_BASE### Substitute The PI base of the plugin .. _PLUGINNAME: ###PLUGINNAME### ~~~~~~~~~~~~~~~~ .. container:: table-row Common Markers (required) ###PLUGINNAME### Substitute The name of the plugin .. _UID: ###UID### ~~~~~~~~~ .. container:: table-row Common Markers (required) ###UID### Substitute The UID of a specific dataset .. ###### END~OF~TABLE ###### .. ### BEGIN~OF~TABLE ### .. _ADMINSTUFF: ###ADMINSTUFF### ~~~~~~~~~~~~~~~~ .. container:: table-row Other Markers ###ADMINSTUFF### Substitute The edit/delete link (only in FE admin view) .. _FE-ADMINLINKS: ###FE-ADMINLINKS### ~~~~~~~~~~~~~~~~~~~ .. container:: table-row Other Markers ###FE-ADMINLINKS### Substitute The admin link menu (only in FE admin view) .. _CATEGORY-NAME: ###CATEGORY-NAME### ~~~~~~~~~~~~~~~~~~~ .. container:: table-row Other Markers ###CATEGORY-NAME### Substitute The name of the category .. _DATA-TITLE: ###DATA-TITLE### ~~~~~~~~~~~~~~~~ .. container:: table-row Other Markers ###DATA-TITLE### Substitute The title of the dataset .. _HEADING: ###HEADING\_...### ~~~~~~~~~~~~~~~~~~ .. container:: table-row Other Markers ###HEADING\_...### Substitute All headings (eg. HEADING\_TITLE →Title) .. _HITS: ###HITS### ~~~~~~~~~~ .. container:: table-row Other Markers ###HITS### Substitute No. of hits in the resultlist .. _OPTIONFIELD: ###OPTIONFIELD### ~~~~~~~~~~~~~~~~~ .. container:: table-row Other Markers ###OPTIONFIELD### Substitute The search menu .. _PAGELINKS: ###PAGELINKS### ~~~~~~~~~~~~~~~ .. container:: table-row Other Markers ###PAGELINKS### Substitute The pagebrowser .. _SEARCHPHRASE: ###SEARCHPHRASE### ~~~~~~~~~~~~~~~~~~ .. container:: table-row Other Markers ###SEARCHPHRASE### Substitute The entered searchphrase .. ###### END~OF~TABLE ###### .. _Stylesheet: Stylesheet ^^^^^^^^^^ The default stylesheet is located in typo3conf/ext/general\_data\_display/css/default.css. .. _Languages: Languages ^^^^^^^^^ Backend languages are English and German. To edit or add frontend languages to the plugin, edit the phpfiles: :: typo3conf/ext/general_data_display/pi1/locallang.php To add new language you have to copy the labels of the default language into your desired one and translate them. .. _Tutorial: Tutorial -------- .. _Insert-plugin-to-your-page: Insert plugin to your page ^^^^^^^^^^^^^^^^^^^^^^^^^^ Insert the plugin on your preferred page and configure it as described in the User Manual. Login to the Typo3 BE as allowed user or with your FE account if you configured FE user access. The plugin output should now look like this: |img-8| .. _Defining-datafields: Defining datafields ^^^^^^^^^^^^^^^^^^^ Start creating datafields - use the "Datafields"-link and press “+”. Choose a name for your first field and select the datafield type from the option menu. Define as many datafields as you need for your dataset to hold all the information you want. With the three checkboxes you can change the way the plugin is dealing with the values. |img-9| .. _Defining-categories: Defining categories ^^^^^^^^^^^^^^^^^^^ Now add your first category using the “Categories”-link. Without any assignable category all data will later be displayed under a ”No category assigned”-category. Add some more categories and try the subcategory option too. |img-10| .. _Enter-your-first-dataset: Enter your first dataset ^^^^^^^^^^^^^^^^^^^^^^^^ Now it's time to insert your first dataset – choose “New data” . Depending on your defined datafields the plugin is presenting a form where you can enter your datasets. The title will later be displayed in the linklist below the assigned category. Check this out and go on entering your data . |img-11| .. _Modifying-data-definitions: Modifying data definitions ^^^^^^^^^^^^^^^^^^^^^^^^^^ If you wish to modify or delete your categories or your defined datafields you can use the “Categories” respective “Datafields”- link. In addition you have the possibility to alter the sequence of datafields displayed in detail view. Use the up an down arrows in the datafield list for that task. |img-12| .. _HTML-Tag-substitutions: HTML Tag substitutions ^^^^^^^^^^^^^^^^^^^^^^ All HTML tags are removed from content before it is written to database but there are several HTML tag substitutions implemented you can use inside textfields to emphasize your data. .. ### BEGIN~OF~TABLE ### .. _bold: **bold** """""""" .. container:: table-row Text decoration **bold** HTML Tag bold Substitution \*\*bold\*\* .. _italic: *italic* """""""" .. container:: table-row Text decoration *italic* HTML Tag italic Substitution //italic// .. _underline-underline: :underline:`underline` """""""""""""""""""""" .. container:: table-row Text decoration :underline:`underline` HTML Tag underline Substitution \_\_underline\_\_ .. _: :: "" .. container:: table-row Text decoration :: teletyper HTML Tag teletyper Substitution %%teletyper%%'' .. _sup-superscript: :sup:`superscript` """""""""""""""""" .. container:: table-row Text decoration :sup:`superscript` HTML Tag superscript Substitution ^^superscript^^ .. _sub-subscript: :sub:`subscript` """""""""""""""" .. container:: table-row Text decoration :sub:`subscript` HTML Tag subscript Substitution ,,subscript,, .. _List-ordered: List (ordered) """""""""""""" .. container:: table-row Text decoration List (ordered) HTML Tag
  1. listitem
Substitution {{~ listitem1 ~ listitem2 … }} .. _List-unordered: List (unordered) """""""""""""""" .. container:: table-row Text decoration List (unordered) HTML Tag Substitution {{\* listitem1 \* listitem2 … }} .. _URL-named-test-link: URL named test (link) """"""""""""""""""""" .. container:: table-row Text decoration URL named test (link) HTML Tag test Substitution [[URL\|test]] .. _URL-named-URL-shortlink: URL named URL (shortlink) """"""""""""""""""""""""" .. container:: table-row Text decoration URL named URL (shortlink) HTML Tag URL Substitution [[URL]] .. ###### END~OF~TABLE ###### .. _Known-problems: Known problems -------------- - Currently administrative FE user access is only possible if the plugin and the data is stored on the same page (empty startingpoint). - Indentation of subcategories is done via stylesheet and defined up to level 5 – if you need higher levels you have to define appropriate css classes. - BE data access - although possible - is only poorly implemented and therefore not advisable. The project is maintained on http://forge.typo3.org/projects/show /extension-general\_display. If you stumble across a bug or you have feature requests feel free to submit an issue. .. _ChangeLog: ChangeLog --------- .. ### BEGIN~OF~TABLE ### .. _1-0-0: 1.0.0 ^^^^^ .. container:: table-row Version 1.0.0 Changes Initial release .. _1-0-2: 1.0.2 ^^^^^ .. container:: table-row Version 1.0.2 Changes New input datatypes & verifications added, required flag for input fields, fixed searchable flag .. _1-0-3: 1.0.3 ^^^^^ .. container:: table-row Version 1.0.3 Changes Security fix & minor changes .. _1-0-4: 1.0.4 ^^^^^ .. container:: table-row Version 1.0.4 Changes Bugfix - wrong function call produced log warnings .. _1-1-0: 1.1.0 ^^^^^ .. container:: table-row Version 1.1.0 Changes Subcategories are now implemented .. _1-1-1: 1.1.1 ^^^^^ .. container:: table-row Version 1.1.1 Changes Normal BE user access to the FE administration interface, minor fixes & documentation added .. _1-2-0: 1.2.0 ^^^^^ .. container:: table-row Version 1.2.0 Changes Content is now base64 encoded to prevent data corruption through charset change, replaced deprecated eregi-function .. _1-3-0: 1.3.0 ^^^^^ .. container:: table-row Version 1.3.0 Changes New image datatype added New table design makes base64 encoding obsolete – please read update instructions! A lot of bugfixes & code cleaning .. _1-4-0: 1.4.0 ^^^^^ .. container:: table-row Version 1.4.0 Changes Short HTML tag substitutions for textfields implemented Additional searchterms are treated as AND statements All content is cacheable now Some bugfixes .. _1-4-1: 1.4.1 ^^^^^ .. container:: table-row Version 1.4.1 Changes Bugfix release .. _1-4-2: 1.4.2 ^^^^^ .. container:: table-row Version 1.4.2 Changes Security fixes & better form checking .. _1-4-3: 1.4.3 ^^^^^ .. container:: table-row Version 1.4.3 Changes SQL injection fix .. _1-4-4: 1.4.4 ^^^^^ .. container:: table-row Version 1.4.4 Changes Maintenance release .. _1-5-0: 1.5.0 ^^^^^ .. container:: table-row Version 1.5.0 Changes Typo3 version 6 compatible Search field enhancement (required template change) Better visualization of subcategories New textfield formatting options (ordered/unordered list) Most options are now in flexform & TS Bugfixing & code cleaning .. _1-5-1: 1.5.1 ^^^^^ .. container:: table-row Version 1.5.1 Changes Experimental Import / Export (CSV) Template change Bugfixing .. _1-6-0: 1.6.0 ^^^^^ .. container:: table-row Version 1.6.0 Changes Permissions of configured FE user restricted (can only add datasets, no categories/datafields) Introduced standard values for datafields - please read update instructions! New datafield type added (currency) Template change .. _1-6-1: 1.6.1 ^^^^^ .. container:: table-row Version 1.6.1 Changes Maintanance release .. _1-6-2: 1.6.2 ^^^^^ .. container:: table-row Version 1.6.2 Changes Security fixes & new datatype (file) added .. _1-6-3: 1.6.3 ^^^^^ .. container:: table-row Version 1.6.3 Changes Security fixes for upload feature – please read update instructions! .. ###### END~OF~TABLE ###### |img-2| 14 .. ######CUTTER_MARK_IMAGES###### .. |img-1| image:: img-1.png .. :align: left .. |img-2| image:: img-2.png .. :border: 0 .. :height: 21 .. :hspace: 9 .. :id: Grafik2 .. :name: Grafik2 .. :width: 87 .. |img-3| image:: img-3.png .. :align: left .. :border: 0 .. :height: 527 .. :id: graphics1 .. :name: graphics1 .. :width: 637 .. |img-4| image:: img-4.png .. :align: left .. :border: 0 .. :height: 380 .. :id: graphics2 .. :name: graphics2 .. :width: 639 .. |img-5| image:: img-5.png .. :align: left .. :border: 0 .. :height: 498 .. :id: graphics3 .. :name: graphics3 .. :width: 461 .. |img-6| image:: img-6.png .. :align: left .. :border: 0 .. :height: 219 .. :id: graphics4 .. :name: graphics4 .. :width: 482 .. |img-7| image:: img-7.png .. :align: left .. :border: 0 .. :height: 534 .. :id: graphics5 .. :name: graphics5 .. :width: 659 .. |img-8| image:: img-8.png .. :align: left .. :border: 0 .. :height: 107 .. :id: graphics6 .. :name: graphics6 .. :width: 638 .. |img-9| image:: img-9.png .. :align: left .. :border: 0 .. :height: 171 .. :id: graphics10 .. :name: graphics10 .. :width: 346 .. |img-10| image:: img-10.png .. :align: left .. :border: 0 .. :height: 123 .. :id: graphics7 .. :name: graphics7 .. :width: 344 .. |img-11| image:: img-11.png .. :align: left .. :border: 0 .. :height: 498 .. :id: graphics8 .. :name: graphics8 .. :width: 500 .. |img-12| image:: img-12.png .. :align: left .. :border: 0 .. :height: 204 .. :id: graphics9 .. :name: graphics9 .. :width: 249