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: tm_topapps¶
Author: | Kasper Skårhøj |
---|---|
Created: | 2002-11-01T00:32:00 |
Changed by: | Tapio Markula |
Changed: | 2008-04-08T18:20:22 |
Author: | Tapio Markula |
Email: | tapio.markula@xetpoint.fi |
Info 3: | |
Info 4: |
EXT: tm_topapps¶
Extension Key: tm_topapps
Copyright 2000-2007,Tapio Markula, < tapio.markula@xetpoint.fi >
Stefan Galinski <stefan.galinski@frm2.tum.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¶
EXT: tm_topapps 1
Introduction 1
What does it do? 1
History 1
Configuration 2
TS Config for users/ user groups 2
Other configurations 2
Hooks 2
Known Problems 3
General 3
Unimplemented Features of the Original topapps 3
Open Issues 4
Changelog 4
Credits 5
Introduction¶
What does it do?¶
This is just a version of Kasper's and Lasse's 'topapps', which was in 'Typo3 4.1.0 beta' . That plugin added two function bars to the top of the backend, for example drag'drop modulemenu and clear cache functionalities.
Topapps was intended as an alternative for traditional backend for Typo3 4.1 and newer, but it was not implemented in Typo3 4.1 series. Typo3 4.2 has similar functionalities on the top of the view and the new backend replaced the topapps.
Tm_topapps has some unimplemented features regarding the original topapps, but implemented features are stable. Concerning Typo3 4.1 tm_toppapps adds most of the functionalities of topapps and some new functionalities.
The only part, which can be used with Typo3 4.2 is alternative module menu. The plugin 'tm_shared lib' adds an option in order to choose the module menu type. If extended personal user setup has been enabled, it is possible to change menu type also from 'User > Setup' module.
Tm_topapps adds also a new interface option, which can be added with the install too ( 'backend_topapps' )
History¶
This plugin was previously a part of 'tm_shared_lib' . For Typo3 4.2 the plugin has been changed so, that the module menu can be use as alternative of the left side menu.
Configuration¶
TS Config for users/ user groups¶
This plugin has following shared configuration for user TS configuration user/user group mod.SHARED :
Generic TS Config for users using setup.override:
allowChangeUser¶
Property
allowChangeUser
Datatype
boolean
Description
Allows using topapps non-administrators to change user from the user menu. If not enabled the whole module is disabled because personal user setup can do also from elsewhere, if the user setup is in generally allowed.
Only for Typo3 4.1.
Default
0
This plugin has following configuration for user TS configuration user/user group for new alternative of the plugin 'toppapps' using mod.topapps :
disableBasicShortcuts¶
Property
disableBasicShortcuts
Datatype
boolean
Description
Disables the default shortcut icon set of Kasper's topapps.
Default
0
companyImage¶
Property
companyImage
Datatype
string
Description
Possible to define web address for the logo image of some company.
Only for Typo3 4.1.
Default
companyAddress¶
Property
companyAddress
Datatype
string
Description
Possible to define web address link for the related company logo.
Only for Typo3 4.1.
Default
hideButtonToolbar¶
Property
hideButtonToolbar
Datatype
boolean
Description
Hides second row topapps (big shortcut icons, the tab set for submodules of the ' Web' main module.
Only for Typo3 4.1.
Default
0
Other configurations¶
With the install tool it is possible to add interface 'backend_toppapps', which temporary takes use the drag'n drop menu instead of leftside menu.
In the configuration of tm_shared_lib (first implementation in ver. '0.2.8' ) has been added for Typo3 4.2 option to use the main menu from tm_topapps ( 'backendmenutype' ).
Hooks¶
Added in the middle of module installation a hook to add new modules.
$TYPO3_CONF_VARS['EXTCONF'][TM_TOPAPPS_EXTkey]['addTopApps']
Note. The function 'addTopApps' must have a parameter. The value must be used to check, if the module will be added among other modules, for example (use the same folder name and module name):
function addTopApps ($moduleName) {
if($moduleName=='my1module')
t3lib_extMgm::addTopApp('xMOD_txtopapps_my1module',t3lib_extMgm::e xtPath($_EXTKEY).'my1module/');
if($moduleName=='my2module')
t3lib_extMgm::addTopApp('xMOD_txtopapps_my2module',t3lib_extMgm::e xtPath($_EXTKEY).'my2module/');
}
I made a hook for the logo menu on the top left corner in order to reset the entire menu.
$TYPO3_CONF_VARS['EXTCONF'][TM_TOPAPPS_EXTkey]['logoMenuItems']
Modules 'xMOD_txtopapps_dashboard' and 'xMOD_txtopapps_search' didn't work. I made possible to make hooks for them and create with them proper functionalities.
$TYPO3_CONF_VARS['EXTCONF'][TM_TOPAPPS_EXTkey]['addDasboardItems']
Just return with the function 'addDasboardItem ' a string.
$TYPO3_CONF_VARS['EXTCONF'][TM_TOPAPPS_EXTkey]['addSearchMenuItems ']
Just return with the function 'addSearchMenuItems ' a string.
$TYPO3_CONF_VARS['EXTCONF'][TM_TOPAPPS_EXTkey]['addSearchBox']
Just do needed database operations and echo needed string.
To the second row, where is some shortcut links added by the module 'xMOD_txtopapps_shortcuts', you can add any new link
$TYPO3_CONF_VARS['EXTCONF'][TM_TOPAPPS_EXTkey]['addShortcutItems']
Just return with the function 'addShortcutItems' string.
Note. All hooks work only with Typo3 4.1.
Known Problems¶
General¶
Works with all features only with Typo3 4.1.x.
Unimplemented Features of the Original topapps¶
- submenu for direct access to module functionalities
- dashboard module (possible to build using a hook)
- search module (possible to build using a hook)
Below comparison table between original topapps, tm_topapps and Typo3 4.2
((Unknown Property))¶
a
topapps
topapps
tm_topapps
tm_topapps
Typo 4.2
Typo 4.2
Clock¶
a
Clock
topapps
X
tm_topapps
X
Typo 4.2
Shortcut bar¶
a
Shortcut bar
topapps
X
tm_topapps
X
Typo 4.2
Submodules (Web modules)¶
a
Submodules (Web modules)
topapps
X *
tm_topapps
X
Typo 4.2
Old shortcuts and old search¶
a
Old shortcuts and old search
topapps
tm_topapps
X
Typo 4.2
Dashboard¶
a
Dashboard
topapps
X (not functional)
tm_topapps
(possible to build)**
Typo 4.2
Workspace selector¶
a
Workspace selector
topapps
tm_topapps
Typo 4.2
X
Link to workspace module¶
a
Link to workspace module
topapps
tm_topapps
Typo 4.2
X
Company logo¶
a
Company logo
topapps
X
tm_topapps
X
Typo 4.2
Search¶
a
Search
topapps
X (not functional)
tm_topapps
(possible to build)
Typo 4.2
X
User information¶
a
User information
topapps
tm_topapps
Typo 4.2
X
Logout link¶
a
Logout link
topapps
***
tm_topapps
X****
Typo 4.2
X
*Web submodules are in the same row as some shortcuts to certain modules.
** There is hook in the module in order to build the functionality
*** Logout link is Icon menu.
**** Logout link is an icon
Open Issues¶
There is however a problem, which relates with the replacement of the plugin 'topapps'. Some browsers have z-index problems. Frame documents inside the content might have SELECT-boxes, which goes over dropdown menus. Because the content is inside nested frameset and not in the same page, it is not possible to hide SELECT-boxes with some additional JavaScript code. If you want to avoid problem just use a browser, which doesn't have z-index problem, which relates with this issue. Concerning MS IE this problem has been fixed in IE 7.
Another problems relates with special characters in the UTF-8 backend interface. Add into locallang.php a line:
ini_set('default_charset', 'UTF-8');
Internet Explorer 6 has some small glitches, but nothing critical. Firefox 2.x, IE 7 and Opera 9.x works like expected. Konqueror has some problems with frames and the submenus. Its not possible to use the menu reasonable with that browser. Browser below the mentioned versions can work, but that wasnt tested.
Changelog¶
- Made Typo3 4.2 compatible.
- Added so-called JavaDoc descriptions before functions.
- Some code improvements and performance work; Added browser in the user module; Changed look of the old_shortcuts module to an icon at the right site; Bugfixes (Thanks to Stefan Galinski)
- Fixed a bug in contextual menus, if new menu styles has been used (the bug was actually in tm_shared lib and I changed only required version number).
- Moved all 'tm_topapps' related JavaScript and CSS into this plugin.
- Made topapps related extensions as as a new extension. Note that key names of hooks has been changed.
Related changes, when this plugin was a part of tm_shared_lib:
- Added new module 'logout' – stand alone log out link on the first row.
- Changed a little bit hook handling.
- Added multilingual language labels to the modified version of the plugin 'topapps'.
- Added integrated support for 'topapps' plugin (the plugin comes from Typo3 4.1 RC 1 ) with some these changes:
- Disabled possibility to change big shortcut icons.
- Disable as default the module 'user' from non-administrators.
- Made hook for shortcut links (allows to put changing of icons back).
- Disabled function menus from dropdown menus because they don't work.
- Normal shortcuts implemented as IFRAME inside a layer, which can be show and hide. Workspace selector has been take off because it is in top right.
- Disabled new search functionality, because it didn't work (search is available in the shortcut frame). Made hook for trying to recreate it.
- Disable example dashboard but make possible to create it using a hook.
- Possible to disable second toolbar row setting 'mod.topapps.hideButtonToolbar=1'.
- Some images are skin image instead of fixed image names.
- Dummy company logo disabled. Company logo needs 'mod.topapps.companyAddress=...' and 'mod.topapps.companyImage=...'.
Credits¶
Special thank's for Stefan Galinski < Stefan.Galinski@frm2.tum.de > helping finding and fixing bugs, creating a module for topapps and some improvements.
Ext: tm_topapps - 5