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:Simple logout button or link¶
Created: | 2009-05-02T17:25:33 |
---|---|
Changed: | 2009-05-02T23:56:58.930000000 |
Classification: | dvs_simplelogout |
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) see more: http://wiki.typo3.org/doc_template#tags ---- |
Keywords: | frontend, felogin, login, logout, feuser, button, link, forAdmins, forBeginners |
Author: | Uwe Schmelzer |
Email: | us@dv-schmelzer.de |
Info 4: | |
Language: | en |
EXT:Simple logout button or link - dvs_simplelogout
EXT:Simple logout button or link¶
Extension Key: dvs_simplelogout
Language: en
Keywords: frontend, felogin, login, logout, feuser, button, link, forAdmins, forBeginners
Copyright 2000-2008, Uwe Schmelzer, <us@dv-schmelzer.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.org
Table of Contents¶
EXT:Simple logout button or link 1
`Introduction 3 <#1.1.Introduction|outline>`_
`Users manual 4 <#1.2.Users%20manual|outline>`_
`Administration 5 <#1.3.Administration|outline>`_
`Configuration 7 <#1.4.Configuration|outline>`_
`Tutorial 8 <#1.5.Tutorial|outline>`_
`Known problems 9 <#1.6.Known%20problems|outline>`_
`To-Do list 10 <#1.7.To-Do%20list|outline>`_
`ChangeLog 11 <#1.8.ChangeLog|outline>`_
Introduction¶
What does it do?¶
Provides a logout button or link. Context: logged in fe users.
What problem is solved?¶
The default typo3 logout form, as provided by the system extension “felogin”, doesn't work on protected pages.This one does.
Screenshots¶
Users manual¶
Nothing to configure for users.
Administration¶
FAQ¶
Q: Why another logout form? Isn't the on provided by felogin good enough?
A: The default typo3 logout form, as provided by the system extension “felogin”, doesn't work on protected pages.This one does.
Q: Please describe in detail what's wrong with the default typo3 logout form.
A: If you put the default logout form on a protected page and hit the logout button, you'll end up with a page access error screen. The reason for this: Typo3 logs the fe user out first. Then it tries to redirect from the protected page to the login form. This is what produces the error. The protected page cannot be used as redirection base, as the FE User was logged out already. Thus, we end up with a page access error.
Installation¶
Install the extension with the extension manager¶
Go to Admin tools > Ext. Manager
- Select “Import extensions” in the select box on top of the page
- Enter “dvs_simplelogout” in the search field and press the “Look up” button.
Follow the instructions on the screen.
This extension has no options which are configurable during the installation process.
Insert the plugin into a page¶
- Go to the page, where you want to insert the logout button.
- Click the Icon.
- In section “Plugins”, choose the “Simple logout button/link” plugin.See screenshot below:
Configure the plugin¶
Configure the plugin. See screenshot below:
Prerequisites:
- You should have a working fe user login form.
- This page will be selected in step 3. “Select the login page”.
- Hint: The login page is **not* the page, where you are inserting this extension.*
- If you dont have a working fe user login form, see manual for EXT:felogin on how to do this.
Test it¶
Prerequisites:
- You should have a working fe user login form.
- This page will be selected in step 3. “Select the login page”.
- Hint: The login page is **not* the page, where you are inserting this extension.*
- If you dont have a working fe user login form, see manual for EXT:felogin on how to do this.
Start the test
- Go to the FE User Login-Page
2. Navigate to the page where you have inserted the “dvs_simplelogout” plugin.
- You should see some output like in the screenshot below:
- Click the “Log out”-Button (or the link)
- You should be redirected to the page in step 1
- You should be logged out (as FE User)
Configuration¶
Typoscript Reference¶
templateFile¶
Property
templateFile
Data type
resource
Description
The HTML-template for the logout button and the logout link Example:
plugin.tx_dvssimplelogout_pi1 {
templateFile = fileadmin/template.tpl
}
Default
pidLoginPage¶
Property
pidLoginPage
Data type
int+
Description
PageId of the fe login page
Example: plugin.tx_dvssimplelogout_pi1 {
pidLoginPage = 123
}
Default
whatToDisplay¶
Property
whatToDisplay
Data type
string
Description
Display a logout button or a logout link
Example:
plugin.tx_dvssimplelogout_pi1 {
whatToDisplay = button
}
Allowed values:
button
link
Default
Typoscript Example:
Put this in the SETUP part of the root template. Or in the SETUP part of an extension template.
plugin.tx_dvssimplelogout_pi1 {
templateFile = fileadmin/template.tpl
pidLoginPage = 123
whatToDisplay = button
}
Hint: Flexform values override TS values¶
Please be aware, that flexform values (from the plugin configuration in the backend) override any TS values.
HTML-Template Reference¶
The HTML output of this extension is configurable via template and markers.
Default template¶
You'll find the default HTML-Template in the extension folder:EXT:dvs_simplelogout/pi1/template.tpl
Available markers¶
You'll find documentation about the available markers inside the default HTML-Template.
Tutorial¶
Please see section “Administration” above.
Known problems¶
None for now.
To-Do list¶
Add more translations to locallang.xml
Hopefully, this extension will become obsolete with newer versions of typo3.
Current typo3 Version is 4.2.6