.. You may want to use the usual include line. Uncomment and adjust the path. .. include:: ../Includes.txt :Created: 2007-09-12T15:42:55 :Changed: 2012-10-12T09:15:34.400000000 :Info 1: :Info 2: :Info 3: :Info 4: .. _EXT-Glossary-extended: EXT: Glossary extended ====================== Extension Key: **sg\_glossary** Version >= 1.0.650 Copyright 2004-2012, Stefan Geith, e.g. typo3dev2012@geithware.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: Table of Contents ----------------- **EXT: Glossary extended 1** **Introduction 1** What does it do? 1 Screenshots 2 **Tutorial 3** Hints on Updates from previous Versions 3 Basic Installation 3 Displaying Entries in Popup-Windows 5 Usage of Custom-Tag 6 Enable FE-Editing 6 **Configuration 8** Reference 8 **To-Do list 9** **Changelog 9** .. _Introduction: Introduction ------------ .. _What-does-it-do: What does it do? ^^^^^^^^^^^^^^^^ sg\_glossary is a frontend plugin that implements a glossary with these features: \- each entry can contain a list of images with imagecaptions \- each entry can contain a list of related entries, which is displayed as a list of links. \- the description of an entry can be shown within the main-window or as a popup-window \- includes custom tags like searchentry that will open the description in a popup-window \- popup-windows will close automatically when they loose focus (not, if FE-user with edit-permissions is logged in) \- you can define FE-users, who will be able to edit, add, hide, unhide and delete new entries in the Frontend \- if a FE-user with any edit-permission is logged in, edit-buttons and extra edit-info is displayed \- the frontend-editor includes an image-browser for uploading, selecting and deleting of images .. _Screenshots: Screenshots ^^^^^^^^^^^ |img-1| |img-2| |img-3| .. _Tutorial: Tutorial -------- NOTE: This plugin is based on the library sg\_zfelib. Please be sure to have the latest Version ( **sg\_zfelib 1.1** or above) of the library-plugin ! If you are an experienced user, you can find many configuration- options for this plugin in the documentation of the library sg\_zfelib. This manual should also help you to install my other plugins, that are also based on sg\_zfelib. .. _Hints-on-Updates-from-previous-Versions: Hints on Updates from previous Versions ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. _If-you-update-from-Version-below-1-0-650: If you update from Version below 1.0.650: """"""""""""""""""""""""""""""""""""""""" If you use the feature to edit sg\_glossayrs-entries in the FE, you must now enable the Option :code:`enableCrFeuser` in the ExtensionMangers Setup page for sg\_glossary. .. _Basic-Installation: Basic Installation ^^^^^^^^^^^^^^^^^^ - |img-4| Import extensions from online repository and install them: **sg\_zfelib** and **sg\_glossary** - |img-5| Create a SystemFolder and name it *Glossary* - Add some entries of type *Glossary* to this folder: |img-6| e.g. these: |img-7| - Create a page in your Pagetree, where you want to display the glossary – in my example, I named it ' *Techniklexikon* ': |img-8| - |img-9| On this page, create a pagecontent of type ' *Insert plugin* ', select ' *Glossary extended* ', select as *Startingpoint* the systempage ' *Glossary* ' where you entered your glossary- entries;Select PluginMode 'search glossary' (that will display the Alphabetical Selector);For PageIDs always enter the ID of this page; uncheck 'Edit in Popup-Window':Create another pagecontent with same Settings but select PluginMode 'list+show glossary'. - View result: |img-10| .. _Displaying-Entries-in-Popup-Windows: Displaying Entries in Popup-Windows ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - First you have to create a folder, where you can create pages that open in a popup-window.For this, I create a ' *Not in Menu'* -Page and name it ' *Popup-Folder'* .Within this folder I create a ' *Not in Menu'* -Page and name it *'Glossary-Popup'* .On this page place the ' *Glossary extended* '-Plugin, enter ' *view/edit glossary* ' as Plugin-Mode, and select the systemfolder ' *Glossary* ' for the *Startingpoint* .: - Set a Template for the folder 'Popup-Folder', that is suitable for popup-windows.I have set a Template, that only shows the content – no menu etc.: |img-11| The template-file ' *popuptmpl.html'* could e.g. look like this: ::
###CONTENT###
- Now change the settings of your Glossary-Page and set 'Page-ID of EditPage' to this Popup-Page (e.g. 236) and check 'Edit in Popup- Window'; change PluginMode 'list+show glossary' to 'list glossary' - View the result: |img-1| .. _Usage-of-Custom-Tag-LEX: Usage of Custom-Tag ^^^^^^^^^^^^^^^^^^^^^^^^^ - On any page, you can use **** *keyword* **** and **** *alternative\_text* **** to include a link to a popup-window, that displays the entry *'keyword'* .plugin.tx\_sgglossary\_pi1.PIDitemDisplay must be set to the ID of the Page-ID, where the glossary-entry is displayed. - If you want this custom-tag to work in *tt\_news* also, add this to the setup-section of your root- template:plugin.tt\_news.general\_stdWrap.parseFunc < tt\_content.text.20.parseFunc - If you want to use the Tags with RTE, add the following TSconfig: :code:`# Glossar-Tags zulassen` :code:`RTE.default.proc.allowTags := addToList(LEX)RTE.default.proc.allowTagsOutside := addToList(LEX)RTE.default.proc.entryHTMLparser\_db.allowTags < RTE.default.proc.allowTags# Glossar-Tags einfuegenRTE.default {userElements {10 = Spezial Funktionen10 {1 = Glossar1.description = Verweis auf Glossar1.mode = wrap1.content = \|}}}` .. _Automatic-creation-of-Links-to-glossary: Automatic creation of Links to glossary ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ With the additional plugin "sg\_glossary\_parser" you can automatically add links on every word on your website, that has an entry in the glossary. See comments in in "EXT:sg\_glossary\_parser/static\_parser/setup.txt" for configuration options. .. _Enable-FE-Editing: Enable FE-Editing ^^^^^^^^^^^^^^^^^ Add the following to the setup-section of your root-template: :: plugin.tx_sgglossary_pi1 { edit = 1 allow { admin.user = glossadmin,17 admin.group = 0 addEntry.user = 0 addEntry.group = glosseditors,23 uploadImage.user = 0 uploadImage.group = glosseditors unhideAll.user = 0 unhideAll.group = 0 unhideOwn.user = 0 unhideOwn.group = glosseditors editAll.user = 0 editAll.group = 0 editOwn.user = 0 editOwn.group = glosseditors,23 deleteEntry.user = 0 deleteEntry.group = 0 deleteOwn.user = 0 deleteOwn.group = glosseditors deleteImage.user = 0 deleteImage.group = 0 } } - This means:- The user with name ' *glossadmin* ' and the user with the user-id *17* are administrators for glossary-entries;they may upload/delete images and add/edit/hide/unhide/delete any glossary- entries.- All users of the group ' *glosseditors* ' may add/edit/hide/unhide/delete only their **own** glossary-entries and mayupload images.- All users of the group with group-id *23* only may add and edit entries, but not hide/unhide/delete. - Clear all cache, login to your site as user ' *glossadmin* ' and view the glossary-page: |img-2| So this user may add (+) and edit (stencil) entries. - |img-12| A click on a glossary-entry shows this: - A click on the stencil shows this: |img-3| .. _Configuration: Configuration ------------- .. _generated: ((generated)) ^^^^^^^^^^^^^ .. _Templates: Templates """"""""" All template-files contain parts, that are only displayed, when a FE- user with edit-permissions is logged in.These parts a wrapped in , e.g. :: Click here to ###ADD_BUTTON### new item All template-files contain parts, that are only displayed, when a FE- Admin-user is logged in.These parts a wrapped in , e.g. :: Click here to ###ADD_BUTTON### new item .. _Reference: Reference ^^^^^^^^^ See Documentation of sg\_zfelib of configuration. .. _generated: ((generated)) """"""""""""" .. _Example: Example: ~~~~~~~~ :: plugin.tx_sgglossary_pi1 { allowCaching = 1 templateList = typo3conf/ext/sg_glossary/pi1/glossary_list.tmpl templateSingle = typo3conf/ext/sg_glossary/pi1/glossary_single.tmpl tx_sgglossary_entries.search { word.type = 1 abc.label = ABC abc { index = 0-9,A=aä,B,C,D,E,F,G,H,I,J,K,L,M,N,O=oö,P,Q,R,S,T,U=uü,V,W,XY,Z indexWrapFirst = | indexWrapOther =   | indexWrapHidden =     | indexWrapAllItem = |   indexHasAllItem = 1 getAllLabel = All getHiddenLabel = Hidden fieldAbc = word } submit.label = Suchen ! submit.imagemode = 1 reset.label = Reset reset.imagemode = 1 clear.label = Clear listmode.label = Listmode } edit = 0 allow { admin.user = 0 admin.group = 0 seeAllHidden.user = 0 seeAllHidden.group = 0 addEntry.user = 0 addEntry.group = 0 uploadImage.user = 0 uploadImage.group = 0 unhideAll.user = 0 unhideAll.group = 0 unhideOwn.user = 0 unhideOwn.group = 0 editAll.user = 0 editAll.group = 0 editOwn.user = 0 editOwn.group = 0 deleteEntry.user = 0 deleteEntry.group = 0 deleteOwn.user = 0 deleteOwn.group = 0 deleteImage.user = 0 deleteImage.group = 0 } } .. _To-Do-list: To-Do list ---------- Enhance manual .. _generated: ((generated)) ^^^^^^^^^^^^^ .. _generated: ((generated)) """"""""""""" .. _Please-send-me-an-eMail-if-you-find-bugs-in-the-plugin-or-the-manual: Please send me an eMail, if you find bugs in the plugin or the manual ! ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. _Changelog: Changelog --------- - 1.0.750 Compatible with TYPO3 4.7.x - 1.0.400 New Field abstract; can be enabled by ExtManager - 1.0.0 Stable release - 0.13.0 Some minor bugfixes - 0.12.8 Bugfix: now also installable as a global extension - 0.12.7 Experimental: RTE (BE only) for fields 'description' and 'imagecaption'. - 0.12.6 Little Speedup of ListMode - 0.12.5 Bugfix: urlencode for -Tags - 0.12.4 Bugfix in tx\_sgaddress\_LinkClass: now works with sg\_search; - 0.12.3 Fixed Bug: sg\_search didnt search sg\_glossary; - 0.12.2 All-In-One-Modes for Plugins implemented. - 0.12.1 Fixed Bug: Missing subpart ###NOLIST\_PART### 0.12.0 Changed class-names for tag-processing to match namespace. 0.11.0 Initial Beta-Version; documentation still has to be completed - 0.9.0. Completely rewritten with use of sg\_zfelib - 0.7.0. Changed mysql-field cruser\_id to crfeuser\_id **IF YOU UPDATE** from <=0.6.0 and have used FE-Editing to enter glossary- entires: **BEFORE UPDATING:** using phpMyAdmin change in table 'tx\_sgglossary\_entires' the name offield 'cruser\_id' to 'crfeuser\_id'. **AND UPDATE** sg\_zfeeditlib to version >= 0.7.0 .. _generated: ((generated)) ^^^^^^^^^^^^^ .. _More: More """" If you find this plugin useful and add it to your page, please send me a link to that page – just because I'm always proud to see my work spread over millions of typo3-sites ... |img-13| - 10 .. ######CUTTER_MARK_IMAGES###### .. |img-1| image:: img-1.png .. :align: left .. :border: 0 .. :height: 194 .. :id: Grafik11 .. :name: Grafik11 .. :width: 579 .. |img-2| image:: img-2.png .. :align: left .. :border: 0 .. :height: 121 .. :id: Grafik18 .. :name: Grafik18 .. :width: 528 .. |img-3| image:: img-3.png .. :align: left .. :border: 0 .. :height: 490 .. :id: Grafik19 .. :name: Grafik19 .. :width: 481 .. |img-4| image:: img-4.png .. :align: left .. :border: 0 .. :height: 62 .. :id: Grafik1 .. :name: Grafik1 .. :width: 284 .. |img-5| image:: img-5.png .. :align: left .. :border: 0 .. :height: 63 .. :id: Grafik2 .. :name: Grafik2 .. :width: 159 .. |img-6| image:: img-6.png .. :align: left .. :border: 0 .. :height: 44 .. :id: Grafik3 .. :name: Grafik3 .. :width: 159 .. |img-7| image:: img-7.png .. :align: left .. :border: 0 .. :height: 83 .. :id: Grafik4 .. :name: Grafik4 .. :width: 308 .. |img-8| image:: img-8.png .. :align: left .. :border: 0 .. :height: 98 .. :id: Grafik5 .. :name: Grafik5 .. :width: 518 .. |img-9| image:: img-9.png .. :align: left .. :border: 0 .. :height: 368 .. :id: Grafik6 .. :name: Grafik6 .. :width: 281 .. |img-10| image:: img-10.png .. :align: left .. :border: 0 .. :height: 189 .. :id: Grafik7 .. :name: Grafik7 .. :width: 664 .. |img-11| image:: img-11.png .. :align: left .. :border: 0 .. :height: 247 .. :id: Grafik9 .. :name: Grafik9 .. :width: 650 .. |img-12| image:: img-12.png .. :align: left .. :border: 0 .. :height: 162 .. :id: Grafik13 .. :name: Grafik13 .. :width: 416 .. |img-13| image:: img-13.png .. :align: left .. :border: 0 .. :height: 32 .. :id: Graphic1 .. :name: Graphic1 .. :width: 102