This page is still a beta!

1.2. Users manual

Control environment

Control environment consists of this modules:

  1. Pages

  2. Aliases

  3. Errors

  4. Redirects

  5. RealURL-Table Clean

  6. 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

  1. In this frame the page(branch) can be chosen with which we will work.

  2. Select the depth of view and processing from page(branch) selected in (1).

  3. 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)

  4. 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)

  5. 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)

  6. 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)

  7. 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)

  8. 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:

Part

Description

Language

Language with flag.

Path

URL generated by RealUrl extension.

Expire

The expiration date or none if not given.

Root Page ID

mpvar

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

  1. Table for which the alias was created

  2. 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)

  3. 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).

  4. Sort aliases. By clicking on this element the aliases will be sorted(ascending or descending) by field right to this element.

  5. Currently selected sorting field. By clicking on this element you switch between ascending and descending sorting.

  6. 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)

  7. 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

  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)

  2. 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)

  3. Sort errors. By clicking on this element the errors will be sorted(ascending or decending) by field right to this element.

  4. 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

  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)

  2. 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)

  3. 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)

  4. 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)

  5. Sort redirects. By clicking on this element the errors will be sorted(ascending or decending) by field right to this element.

  6. 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

description

recordsOnPage

With this value can you set how many records should be shown on one page.

maxPages

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:

value

description

extkey

extension key

script

Path to php file which contains the module.

class

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

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.