EXT: Glossary extended¶

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 <LEX>searchentry</LEX> 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¶

Hints on Updates from previous Versions¶

Basic Installation¶

• Import extensions from online repository and install them: sg_zfelib and sg_glossary

• Create a SystemFolder and name it Glossary

• Add some entries of type Glossary to this folder:

  e.g. these:

  

• Create a page in your Pagetree, where you want to display the glossary – in my example, I named it ' Techniklexikon ':

  

• 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:

  

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.:

The template-file ' popuptmpl.html' could e.g. look like this:

<!-- ###DOCUMENT### -->
         <div align="center">
                 <table width="100%" border="0" cellspacing="0" cellpadding="20">
                         <tr>
                                 <td>
                                         <!--TYPO3SEARCH_begin-->
                                         ###CONTENT###
                                         <!--TYPO3SEARCH_end-->
                                 </td>
                         </tr>
                 </table>
         </div>
 <!-- ###DOCUMENT### -->

• 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:

Usage of Custom-Tag <LEX>¶

• On any page, you can use <LEX> keyword </LEX> and <LEX word= *keyword* > alternative_text </LEX> 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 <LEX> Tags with RTE, add the following TSconfig: # Glossar-Tags zulassen 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 = <LEX>\|</LEX>}}}

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¶

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:

  So this user may add (+) and edit (stencil) entries.

• A click on a glossary-entry shows this:

• A click on the stencil shows this:

((generated))¶

<!-- ###EDITORONLY### --> Click here to ###ADD_BUTTON### new item <!-- ###EDITMODEONLY### -->

<!-- ###ADMINONLY### --> Click here to ###ADD_BUTTON### new item <!-- ###ADMINONLY### -->

Reference¶

See Documentation of sg_zfelib of configuration.

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
        }
}

((generated))¶

((generated))¶