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: RealURL management¶
Author: | Rupert Germann |
---|---|
Created: | 2004-07-31T12:12:38 |
Changed by: | Juraj Sulek |
Changed: | 2007-11-11T13:34:02 |
Email: | juraj@sulek.sk |
Info 2: | |
Info 3: | |
Info 4: |
EXT: RealURL management¶
Extension Key: realurlmanagement
Copyright 2005-2006, juraj@sulek.sk, <juraj@sulek.sk>
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: RealURL management 1
Introduction 1
What does it do? 1
Users manual 1
Control environment 1
Pages 2
Aliases 4
Errors 4
Redirect 5
RealURL-Table Clean 6
PageBrowser 6
Attention 6
Configuration 6
TSconfig configuration 7
To-Do list 7
Changelog 8
Introduction¶
What does it do?¶
Allows you to delete and change the URL's created by RealUrl extension.
It is useful:
- after site renaming
- if RealURL create a URL that you don't like
- if you are done with testing and you want to insert real data
Users manual¶
Control environment¶
Control environment consists of this modules:
- Pages
- Aliases
- Errors
- Redirects
- RealURL-Table Clean
- About
Access to this modules can be allowed or disallowed in TSconfig for user or group.
Admin user has the access to any module always granted.
Pages¶
In this module it is possible to view and delete URL's generated by RealUrl for pages and to change the already generated Speaking URL path segment for every page. The user has default the access to this module denied but it is possible to allow it with this (user or group)TSconfig:
realUrlManagement.pages.show=1
In this frame the page(branch) can be chosen with which we will work.
Select the depth of view and processing from page(branch) selected in (1).
Delete record.(The user has default no access to this action but it is possible to grand access with this (user or group) TSconfig: realUrlManagement.pages.delete=1 )
Delete all shown RealUrl records.(The user has default no access to this action but it is possible to grand access with this (user or group) TSconfig: realUrlManagement.pages.deleteShown=1 )
Edit the Speaking URL path segment generated for this page.(see the “Speaking URL path segment editing” section.)(The user has default no access to this action but it is possible to grand access with this (user or group) TSconfig: realUrlManagement.pages.edit=1 )
Edit the expiration date. (see the “Expiration date editing” section.)(The user has default no access to this action but it is possible to grand access with this (user or group) TSconfig: realUrlManagement.pages.changeExpire =1 )
Create a new record. If you use this action, current record will be expired and new record will be create and open for editing. So can you make more record to one page. It is useful if you want create new record but you will let the old record remain valid while it is indexed e.g. by Google.(The user has default no access to this action but it is possible to grand access with this (user or group) TSconfig: realUrlManagement.pages.create =1 )
Expire all shown RealUrl records.(The user has default no access to this action but it is possible to grand access with this (user or group) TSconfig: realUrlManagement.pages.expireShown=1 )
Every RealUrl record for page consist of this parts:
Language¶
Part
Language
Description
Language with flag.
Path¶
Part
Path
Description
URL generated by RealUrl extension.
Expire¶
Part
Expire
Description
The expiration date or none if not given.
Root Page ID¶
Part
Root Page ID
Description
mpvar¶
Part
mpvar
Description
Speaking URL path segment editing¶
You can edit either the whole URL or only the the Speaking URL path segment for selected page. (It is the string after last '/' character). Entered string will be cleared from all illegals characters, all no ASCII characters will be converted to ASCII characters and all special characters will be rawurlencoded.
After the click on the pencil image and confirmation will you become this screen:
If you want to edit the whole URL you must check the “Edit the whole URL” checkbox. The user has default the access to this checkbox denied but it is possible to allow it with this (user or group)TSconfig:
realUrlManagement.pages.editWholeURL =1
Then you will such screen:
If You enter an path segment that exist or an empty path segment, you wiIl become an error warning.
Expiration date editing¶
Expiration date editing use the standard typo3 date-time editing feature. This extension can work with extensions “KJ:Backend Calendar(kj_becalendar)” or “Date2Calender(erotea_date2cal)” for more simply editing of the expiration date.
Aliases¶
In this module it is possible to view, edit and delete aliases for tables shown on frontend (e.g. tt_news or tt_adress tables).The user has default the access to this module denied but it is possible to allow it with this (user or group)TSconfig:
realUrlManagement.aliases.show =1
Table for which the alias was created
Delete record.(The user has default no access to this action but it is possible to grand access with this (user or group) TSconfig: realUrlManagement.aliases.delete =1 )
Edit the alias.(The editing process for aliases module is similar to editing process for pages module. See “Speaking URL path segment editing”, but here the full alias is edited and not only a part(path segment).)(The user has default no access to this action but it is possible to grand access with this (user or group) TSconfig: realUrlManagement.aliases.edit=1 ).
Sort aliases. By clicking on this element the aliases will be sorted(ascending or descending) by field right to this element.
Currently selected sorting field. By clicking on this element you switch between ascending and descending sorting.
Edit the expiration date. (see the “Expiration date editing” section.)(The user has default no access to this action but it is possible to grand access with this (user or group) TSconfig: realUrlManagement.aliases.changeExpire =1 )
Create a new alias. If you use this action, current alias will be expired and new alias will be create and open for editing. So can you make more aliases to one id. It is useful if you want create new alias but you will let the old alias remain valid while it is indexed e.g. by Google.(The user has default no access to this action but it is possible to grand access with this (user or group) TSconfig: realUrlManagement.aliases.create =1 )
Errors¶
In this module it is possible to view and delete error logs from RealUrl extension and to clear the counter variable for error logs. The user has default the access to this module denied but it is possible to allow it with this (user or group)TSconfig:
realUrlManagement.errors.show =1
Delete record.(The user has default no access to this action but it is possible to grand access with this (user or group) TSconfig: realUrlManagement.errors.delete =1 )
Clear the Counter. Here you can set the Counter to 0. This is useful after error correcting to discovery if this error occurs again.(The user has default no access to this action but it is possible to grand access with this (user or group) TSconfig: realUrlManagement.errors.clearCounter =1 )
Sort errors. By clicking on this element the errors will be sorted(ascending or decending) by field right to this element.
Currently selected sorting field. By clicking on this element you switch between ascending and descending sorting.
Redirect¶
In this module it is possible to view, edit and delete records from tx_realurl_redirects table in which the RealUrl store informations about redirects.
The user has default the access to this module denied but it is possible to allow it with this (user or group)TSconfig:
realUrlManagement.redirects.show =1
Create a new redirect. (The user has default no access to this action but it is possible to grand access with this (user or group) TSconfig: realUrlManagement.redirects.create =1 )
Delete redirect. (The user has default no access to this action but it is possible to grand access with this (user or group) TSconfig: realUrlManagement.redirects.delete =1 )
Clear the Counter. Here you can set the Counter to 0. (The user has default no access to this action but it is possible to grand access with this (user or group) TSconfig: realUrlManagement.redirects.clearCounter =1 )
Edit. You can edit Url, Destination and Moved permanently values. (The user has default no access to this action but it is possible to grand access with this (user or group) TSconfig: realUrlManagement.redirects.edit =1 )
Sort redirects. By clicking on this element the errors will be sorted(ascending or decending) by field right to this element.
Currently selected sorting field. By clicking on this element you switch between ascending and descending sorting.
RealURL-Table Clean¶
With this module you can clear every table used by RealUrl extension to store the URL records. Cleaning of this tables will not affect content or page record. But use this module carefully while by cleaning this tables the RealUrl extension muss create all record newly, and if you have changed name of a page the new generated record for this page will not be the same as the old record and if this page was indexed by e.g. Google the link from Google will not work. But this function is useful if you have finished with development and testing and you want insert real data. Then it can be profitable to clear all old data with this function before you start with inserting of real data.
The user has default the access to this module denied but it is possible to allow it with this (user or group)TSconfig:
realUrlManagement.tableClean.show =1
PageBrowser¶
Pagebrowser is available by modules “Aliases”, ”Errors” and “Redirect”.
You can set this values for pagebrowser:
::¶
value
recordsOnPage
description
With this value can you set how many records should be shown on one page.
::¶
value
maxPages
description
With this value can you set how many pages should be shown in pagebrowser. If the count of all pages exceed this number the pagebrowser will slide.
The syntax is:
realUrlManagement.pageBrowser.{$value}={$number}
or
realUrlManagement.pageBrowser.{$module}.{$value}={$number}
E.g.
realUrlManagement.pageBrowser.maxPages=20
realUrlManagement.pageBrowser.aliases.maxPages=20
With first setting(without {$module}) can you set default values and this default values can be overwritten by the second setting for each module separately. If you don't set anything the default value 20 will be used.
How to add your own Modules¶
Default this extension contain this modules: Pages, Aliases, Errors, Redirects, RealURL-Table Clean and About. But it is possible to add your own modules. The only thing you must do is to produce an extension with this ext_localconf.php file:
<?php
if (!defined ("TYPO3_MODE")) die ("Access denied.");
require_once(t3lib_extMgm::extPath('realurlmanagement').'class.tx_realurlmanagement.php');
$myModule['extkey']=$_EXTKEY;
$myModule['script']='pi/class.tx_realurlmanmoduleexample.php';
$myModule['class']='tx_realurlmanmoduleexample';
$myModule['text']='LLL:EXT:'.$_EXTKEY.'/pi/locallang.php:label.example';
tx_realurlmanagement::registerModule($myModule);
?>
The function registerModule take as parameter a array with this values:
extkey¶
value
extkey
description
extension key
script¶
value
script
description
Path to php file which contains the module.
class¶
value
class
description
Class from object which contains the module. This class must contain function showModule() because this function will be executed if this module is selected.
text¶
value
text
description
This text will appear at the selectbox.
If you want to disable this module to some user or group you must add this code to user or group tsconfig:
realUrlManagement.modules.{extension key}.hide=1
You can download extension “realurlmanmoduleexample” to see how this work.
Attention¶
Be careful by changing of RealUrl records. This records can by indexed by some search machine e.g.(Google) and if you change a record from side indexed in such machine the links from this machine can be broken. So i recommend to change the records directly after creating or if you are sure that this are not indexed(the site haven't yet been online).
Configuration¶
TSconfig configuration¶
This is all available (user or group) TSconfig configuration for this extension
::¶
Configuration
realUrlManagement.pages.show = 1
Description
Allow the pages modul.
::¶
Configuration
realUrlManagement.pages.delete = 1
Description
Allow the “delete URL” action in pages modul.
::¶
Configuration
realUrlManagement.pages.deleteShown = 1
Description
Allow the “delete shown pages” action in pages modul.
::¶
Configuration
realUrlManagement.pages.edit = 1
Description
Allow the “edit” action in pages modul.
::¶
Configuration
realUrlManagement.pages.editWholeURL = 1
Description
Allow the “edit whole URL” action in pages modul.
::¶
Configuration
realUrlManagement.pages.changeExpire = 1
Description
Allow the “expire” action in pages modul.
::¶
Configuration
realUrlManagement.pages.expireShown = 1
Description
Allow the “expire shown pages” action in pages modul.
::¶
Configuration
realUrlManagement.pages.create = 1
Description
Allow the “create” action in pages modul.
::¶
Configuration
realUrlManagement.aliases.show = 1
Description
Allow the aliases modul.
::¶
Configuration
realUrlManagement.aliases.delete = 1
Description
Allow the “delete” action in aliases modul.
::¶
Configuration
realUrlManagement.aliases.edit = 1
Description
Allow the “edit” action in aliases modul.
::¶
Configuration
realUrlManagement.aliases.changeExpire = 1
Description
Allow the “expire” action in aliases modul.
::¶
Configuration
realUrlManagement.aliases.create = 1
Description
Allow the “create” action in aliases modul.
::¶
Configuration
realUrlManagement.errors.show = 1
Description
Allow the errors module.
::¶
Configuration
realUrlManagement.errors.delete = 1
Description
Allow the “delete” action for errors module.
::¶
Configuration
realUrlManagement.errors.clearCounter = 1
Description
Allow the “clear counter” action for errors module.
::¶
Configuration
realUrlManagement.redirects.show = 1
Description
Allow the “redirects” module.
::¶
Configuration
realUrlManagement.redirects.edit = 1
Description
Allow the “edit” action in redirect module.
::¶
Configuration
realUrlManagement.redirects.clearCounter = 1
Description
Allow the “clear counter” action in redirect module.
::¶
Configuration
realUrlManagement.redirects.create = 1
Description
Allow the “create” action in redirect module.
::¶
Configuration
realUrlManagement.redirects.delete = 1
Description
Allow the “delete” action in redirect module.
::¶
Configuration
realUrlManagement.tableClean.show = 1
Description
Allow the “RealURL-Table Clean” module.
::¶
Configuration
realUrlManagement.about.hide = 1
Description
Disallow the about module.
::¶
Configuration
realUrlManagement.pageBrowser.recordsOnPage = 20
Description
Define how much records should be maximal on one page. Default value for all pagebrowsers.
::¶
Configuration
realUrlManagement.pageBrowser.maxPages = 20
Description
Define how much pages should be shown in the pagebrowser. Default value for all pagebrowsers.
::¶
Configuration
realUrlManagement.pageBrowser.aliases.recordsOnPage = 20
Description
Define how much records should be maximal on one page by “aliases” module. This value is not necessary – if it is not entered the default will be taken.
::¶
Configuration
realUrlManagement.pageBrowser.aliases.maxPages = 20
Description
Define how much pages should be shown in the pagebrowser by “aliases” module. This value is not necessary – if it is not entered the default will be taken.
::¶
Configuration
realUrlManagement.pageBrowser.errors.recordsOnPage = 20
Description
Define how much records should be maximal on one page by “errors” module. This value is not necessary – if it is not entered the default will be taken.
::¶
Configuration
realUrlManagement.pageBrowser.errors.maxPages = 20
Description
Define how much pages should be shown in the pagebrowser by “errors” module. This value is not necessary – if it is not entered the default will be taken.
::¶
Configuration
realUrlManagement.pageBrowser.redirects.recordsOnPage = 20
Description
Define how much records should be maximal on one page by “redirects” module. This value is not necessary – if it is not entered the default will be taken.
::¶
Configuration
realUrlManagement.pageBrowser.redirects.maxPages = 20
Description
Define how much pages should be shown in the pagebrowser by “redirects” module. This value is not necessary – if it is not entered the default will be taken.
::¶
Configuration
realUrlManagement.modules.{extension key}.hide=1
Description
Hide module with extension key={extension key}.
To-Do list¶
- Finish this manual.
- Make a module to more easily configuration of RealUrl extension ($TYPO3_CONF_VARS['EXTCONF']['realurl'])..
- function for renaming pagetrees
- wizard for url and description editing by redirect module
- Finish the about module.
Changelog¶
realurlmanagement 0.3.3
Improving of the English label. (thx. to Lucas Thurston)
realurlmanagement 0.3.2
- Bug repaired. Now it is possible to have the same URL path for different languages.
- Prepared for logging. Logging works now for URL changes and delete in the page module. The rest will come soon.
realurlmanagement 0.3.0
Now you can easy add your own modules.
realurlmanagement 0.2.3
- pagebrowser added
- manual updated
realurlmanagement 0.2.2
- bug repaired by expire function
- “Expire all Shown” function added
- “Delete all shown” function changed
- “Edit whole URL” function added
realurlmanagement 0.2.1
bug repaired thx. to Alex Widschwendter
realurlmanagement 0.2.0
- expire edit function added for pages and aliases
- integration of “Date2Calendar(erotea_date2cal)” and “KJ Backend Calendar(kj_becalendar)” to expiration edit
- create function added for pages and aliases
- manual changes
- PHP changes(all modules are now make as objects)
- redirect module added
realurlmanagement 0.1.0
first release
EXT: RealURL management - 9