DEPRECATION WARNING
This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.
EXT: Footer Menu¶
Author: | Christopher |
---|---|
Created: | 2010-12-18T19:57:23 |
Changed: | 2014-12-29T18:11:47.801266000 |
Classification: | ms_footermenu |
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) ---- |
Keywords: | forEditors, forBeginners, footer, menu, sitemap, navigation |
Author: | Manfred Müller-Späth |
Email: | fms1961@gmail.com |
Language: | en |
EXT: Footer Menu¶
Extension Key: ms_footermenu
Language: en
Version: x.y.z
Keywords: forEditors, forBeginners, footer, menu, sitemap, navigation
Copyright 2006-2014, Manfred Müller-Späth <fms1961@gmail.com>
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¶
`EXT: Footer Menu 1 <#__RefHeading__5708_1738894311>`_
`Introduction 3 <#__RefHeading__5710_1738894311>`_
`Users manual 4 <#__RefHeading__467_413120346>`_
`Administration 5 <#__RefHeading__31511_818911409>`_
`Configuration 6 <#__RefHeading__31515_818911409>`_
`Tutorial 8 <#__RefHeading__31523_818911409>`_
`Known problems 9 <#__RefHeading__31525_818911409>`_
`To-Do list 10 <#__RefHeading__477_413120346>`_
`ChangeLog 11 <#__RefHeading__31623_818911409>`_
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:
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.
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):
lib.footer.200 < plugin.tx_msfootermenu_pi1
Configuration¶
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.
Configuration¶
Reference¶
All HTML and CSS code is stored in the appropriate default HTML template and default CSS file.
((generated))¶
plugin.tx_msfootermenu_pi1¶
Property
css_file
Data type
string
Description
The CSS file describing the design of the HTML elements.
Default
EXT:ms_footermenu/res/default.css
Property
templateFile
Data type
string
Description
HTML template for the menu design.
Default
EXT:ms_footermenu/res/default.html
Property
dontrender
Data type
list
Description
Blacklist of page ids which will be ignored in any case.
Default
Property
alwaysrender
Data type
list
Description
White list of page ids which will be rendered in any case.
Default
Property
filterPre
Data type
list
Description
Pre-filtering of Doktypes (positive list)
Default
1,2,4
Property
filterPost
Data type
list
Description
Post-filtering of Doktypes (positive list)
Default
1,2
Property
classLink
Data type
string
Description
The class name of the links in the footer menu.
Default
footerlink
Property
classParent
Data type
string
Description
The class name of the parent elements in the footer menu.
Default
footerparent
Property
classGroup
Data type
string
Description
The class name of the groups in the footer menu.
Default
footergroup
Property
classContent
Data type
string
Description
The class name of the whole footer menu container.
Default
footercontent
Property
staticBefore
Data type
string
Description
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.
Default
(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!
Property
staticAfter
Data type
string
Description
Same as “staticBefore” above, but after the default rendering, so it will be displayed at the right side of the menu columns.
Default
Property
footertarget
Data type
string
Description
Target of the generated links.
Default
_top
Property
start_pid
Data type
int
Description
Starting point of the rendered menu. Useful, if the menu is used only via TS and not in the BE.
Default
- (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]
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
}
Tutorial¶
Hopefully, the extensions use is self explanatory … ;-)
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.
To-Do list¶
- describe the internal functionality of the plugin more precisely.
- Re-enineering and coding of a Fluid/Extbase version ...
ChangeLog¶
0.3.3¶
Version
0.3.3
Changes
- (14-12-30)
- fixed TYPO3 6.2 compatibility
0.3.2¶
Version
0.3.2
Changes
- (13-07-16)
- 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
0.3.1¶
Version
0.3.1
Changes
- (13-03-11)
- small bugfixes, documentation update
0.3.0¶
Version
0.3.0
Changes
- (13-03-11)
- TER driven “cleanup”
- small bugfixes, compatibiity to TYPO3 v. 6.x
- state changed to “stable”
0.1.2¶
Version
0.1.2
Changes
- (09-11-16)
- small bugfix in the default.css file
- fix of hard coded UTF-8 conversions
- added configuration of starting PID
0.1.1¶
Version
0.1.1
Changes
- (08-11-14)
- small bugfix in the default.css file: some lines had been deactivated through commentary characters
- reformatting of the documentation
0.1.0¶
Version
0.1.0
Changes
- (08-09-30)
- small bugfix concerning multilingual sites (Thx to Philip Almeida)
- documentation format fixed
- after three month of usage: RC status reached!
0.0.2¶
Version
0.0.2
Changes
- (08-06-24)
- minor changes in CSS code
- [add] documentation
0.0.1¶
Version
0.0.1
Changes
- (08-05-29)
- initial release