EXT: Footer Menu. This document is published under the Open Content License available from

Transcription

1 EXT: Footer Menu Extension Key: ms_footermenu Language: en Version: x.y.z Keywords: foreditors, forbeginners, footer, menu, sitemap, navigation Copyright , Manfred Müller-Späth This document is published under the Open Content License available from The content of this document is related to TYPO3 - a GNU/GPL CMS/Framework available from

2 EXT: Footer Menu Table of Contents EXT: Footer Menu...1 Introduction...3 What does it do?...3 Screenshots...3 Users manual...4 Administration...5 Installation...5 Configuration...5 Configuration...6 Reference...6 Tutorial...8 Known problems...9 To-Do list...10 ChangeLog

3 Introduction Introduction What does it do? This extension provides a customizable footer menu as front end plugin. This is a special version of a clickable sitemap, which is located under the content of a web page. Normally you may solve this with TypoScript settings in the TS template setup, but several customization brought me there to write this extension. It's much easier to use than setup the appropriate TypoScript code. Screenshots A footer menu with standard CSS: 3

4 Users manual Users manual Just use the menu as it appears in the browser! ;-) One note on the behaviour of the extension: as this is not a normal menu as know build by TypoScripts menu objects, this extension tries to flatten the menu. So it uses the first level as headline and places the second level as column just under the header. That's because a footer menu has normally no tree structure. So if you want to display pages on other levels, you may combine the parameters accordingly. With the latest features of static columns you may even define every page in the footer menu manually. 4

5 Administration Administration Installation Install the extension with the extension manager. Nothing to configure at this place. When done, you might put the plugin on a page in the back end or you may get the rendered content from the plugin and place it in the template via TypoScript like this (example): Configuration lib.footer.200 < plugin.tx_msfootermenu_pi1 Only the starting point for the menu is configurable in the back end, all other parameters are configured via constants or TypoScript setup in the template (see reference). The easiest way will be the configuration via the constant editor in the TYPO3 backend. 5

6 Configuration Configuration Reference All HTML and CSS code is stored in the appropriate default HTML template and default CSS file. plugin.tx_msfootermenu_pi1 Property: Data type: Description: Default: css_file string The CSS file describing the design of the HTML elements. EXT:ms_footermenu/res/d efault.css templatefile string HTML template for the menu design. EXT:ms_footermenu/res/d efault.html dontrender list Blacklist of page ids which will be ignored in any case. - alwaysrender list White list of page ids which will be rendered in any case. - filterpre list Pre-filtering of Doktypes (positive list) 1,2,4 filterpost list Post-filtering of Doktypes (positive list) 1,2 classlink string The class name of the links in the footer menu. footerlink classparent string The class name of the parent elements in the footer menu. footerparent classgroup string The class name of the groups in the footer menu. footergroup classcontent string The class name of the whole footer menu container. footercontent staticbefore string A comma separated list of page uids, which will be rendered directly (static) without traversing the page tree. This is helpful for pages normally not shown in the menu, or you might re-group some pages in another way for the footer only. This list(s) will be rendered before the default tree, so the columns will apear at the left side of the footer menu. Filters, white- and blacklist are regarded as well. The lists are comma separated, multiple lists are possible, these are separated by the pipe sign. If a pid in the list has a negative value, the page will not be linked, but the title will be rendered as headline e.g. in a DIV tag (depending on the HTML template you use). So this comes handy when regrouping a menu. staticafter string Same as staticbefore above, but after the default rendering, so it will be displayed at the right side of the menu columns. footertarget string Target of the generated links. _top (none) Example = 2,4,67,99-56,21,33 The result will be two menu columns, the second one has a negative pid as first entry, so this pid will only be rendered as headline and not be linked! start_pid int Starting point of the rendered menu. Useful, if the menu is used only via TS and not in the BE. - (the starting point defined in the BE flexform or the root of the current page tree/branch will be used) [tsref:plugin.tx_msfootermenu_pi1] 6

7 Configuration Example This is an example of configured constants, the setting is easy and could be done completely via the constant editor in the TYPO3 back end. plugin.tx_msfootermenu { css_file = fileadmin/css/footermenu.css dontrender = 166 alwaysrender = 90,230,150,246,239,243,258 start_pid = 22 staticbefore = 2,4,67,99-56,21,33 } 7

8 Tutorial Tutorial Hopefully, the extensions use is self explanatory ;-) 8

9 Known problems Known problems there had been some issues mentioned regarding the rendering of page titles with special chars, e.g. umlauts. This was not reproduceable in all cases. In an all UTF-8 system, the problem won't occur. Some minor changes where added though: some hard coded UTF-8 conversions had been eliminated, so the issue should be fixed. 9

10 To-Do list To-Do list describe the internal functionality of the plugin more precisely. Re-enineering and coding of a Fluid/Extbase version... 10

11 ChangeLog ChangeLog Version: Changes: ( ) fixed TYPO3 6.2 compatibility ( ) added the functionality of static columns, so a free defined menu structure might be displayed improved the configuration: could be done now completely with constant editor ( ) small bugfixes, documentation update ( ) TER driven cleanup small bugfixes, compatibiity to TYPO3 v. 6.x state changed to stable ( ) small bugfix in the default.css file fix of hard coded UTF-8 conversions added configuration of starting PID ( ) small bugfix in the default.css file: some lines had been deactivated through commentary characters reformatting of the documentation ( ) small bugfix concerning multilingual sites (Thx to Philip Almeida) documentation format fixed after three month of usage: RC status reached! ( ) minor changes in CSS code [add] documentation ( ) initial release 11