.. You may want to use the usual include line. Uncomment and adjust the path. .. include:: ../Includes.txt ======================= 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: EXT: RealURL management ======================= Extension Key: **realurlmanagement** Copyright 2005-2006, 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: 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: Introduction ------------ .. _What-does-it-do: 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: Users manual ------------ .. _Control-environment: 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. |img-1| Admin user has the access to any module always granted. .. _Pages: 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** |img-2| 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: .. ### BEGIN~OF~TABLE ### .. _Language: Language """""""" .. container:: table-row Part Language Description Language with flag. .. _Path: Path """" .. container:: table-row Part Path Description URL generated by RealUrl extension. .. _Expire: Expire """""" .. container:: table-row Part Expire Description The expiration date or none if not given. .. _Root-Page-ID: Root Page ID """""""""""" .. container:: table-row Part Root Page ID Description .. _mpvar: mpvar """"" .. container:: table-row Part mpvar Description .. ###### END~OF~TABLE ###### .. _Speaking-URL-path-segment-editing: 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. |img-3| After the click on the pencil image and confirmation will you become this screen: |img-4| 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: |img-5| If You enter an path segment that exist or an empty path segment, you wiIl become an error warning. |img-6| .. _Expiration-date-editing: 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. |img-7| .. _Aliases: 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** |img-8| 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: 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** |img-9| 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: 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** |img-10| 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: 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 ^^^^^^^^^^^ Pagebrowser is available by modules “Aliases”, ”Errors” and “Redirect”. |img-11| You can set this values for pagebrowser: .. ### BEGIN~OF~TABLE ### .. _: :: "" .. container:: table-row value :: recordsOnPage description With this value can you set how many records should be shown on one page. .. _: :: "" .. container:: table-row 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. .. ###### END~OF~TABLE ###### 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: How to add your own Modules ^^^^^^^^^^^^^^^^^^^^^^^^^^^ |img-12| 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: :: The function registerModule take as parameter a array with this values: .. ### BEGIN~OF~TABLE ### .. _extkey: extkey """""" .. container:: table-row value extkey description extension key .. _script: script """""" .. container:: table-row value script description Path to php file which contains the module. .. _class: class """"" .. container:: table-row 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: text """" .. container:: table-row value text description This text will appear at the selectbox. .. ###### END~OF~TABLE ###### 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: 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: Configuration ------------- .. _TSconfig-configuration: TSconfig configuration ^^^^^^^^^^^^^^^^^^^^^^ This is all available (user or group) TSconfig configuration for this extension .. ### BEGIN~OF~TABLE ### .. _: :: "" .. container:: table-row Configuration :: realUrlManagement.pages.show = 1 Description Allow the pages modul. .. _: :: "" .. container:: table-row Configuration :: realUrlManagement.pages.delete = 1 Description Allow the “delete URL” action in pages modul. .. _: :: "" .. container:: table-row Configuration :: realUrlManagement.pages.deleteShown = 1 Description Allow the “delete shown pages” action in pages modul. .. _: :: "" .. container:: table-row Configuration :: realUrlManagement.pages.edit = 1 Description Allow the “edit” action in pages modul. .. _: :: "" .. container:: table-row Configuration :: realUrlManagement.pages.editWholeURL = 1 Description Allow the “edit whole URL” action in pages modul. .. _: :: "" .. container:: table-row Configuration :: realUrlManagement.pages.changeExpire = 1 Description Allow the “expire” action in pages modul. .. _: :: "" .. container:: table-row Configuration :: realUrlManagement.pages.expireShown = 1 Description Allow the “expire shown pages” action in pages modul. .. _: :: "" .. container:: table-row Configuration :: realUrlManagement.pages.create = 1 Description Allow the “create” action in pages modul. .. _: :: "" .. container:: table-row Configuration :: realUrlManagement.aliases.show = 1 Description Allow the aliases modul. .. _: :: "" .. container:: table-row Configuration :: realUrlManagement.aliases.delete = 1 Description Allow the “delete” action in aliases modul. .. _: :: "" .. container:: table-row Configuration :: realUrlManagement.aliases.edit = 1 Description Allow the “edit” action in aliases modul. .. _: :: "" .. container:: table-row Configuration :: realUrlManagement.aliases.changeExpire = 1 Description Allow the “expire” action in aliases modul. .. _: :: "" .. container:: table-row Configuration :: realUrlManagement.aliases.create = 1 Description Allow the “create” action in aliases modul. .. _: :: "" .. container:: table-row Configuration :: realUrlManagement.errors.show = 1 Description Allow the errors module. .. _: :: "" .. container:: table-row Configuration :: realUrlManagement.errors.delete = 1 Description Allow the “delete” action for errors module. .. _: :: "" .. container:: table-row Configuration :: realUrlManagement.errors.clearCounter = 1 Description Allow the “clear counter” action for errors module. .. _: :: "" .. container:: table-row Configuration :: realUrlManagement.redirects.show = 1 Description Allow the “redirects” module. .. _: :: "" .. container:: table-row Configuration :: realUrlManagement.redirects.edit = 1 Description Allow the “edit” action in redirect module. .. _: :: "" .. container:: table-row Configuration :: realUrlManagement.redirects.clearCounter = 1 Description Allow the “clear counter” action in redirect module. .. _: :: "" .. container:: table-row Configuration :: realUrlManagement.redirects.create = 1 Description Allow the “create” action in redirect module. .. _: :: "" .. container:: table-row Configuration :: realUrlManagement.redirects.delete = 1 Description Allow the “delete” action in redirect module. .. _: :: "" .. container:: table-row Configuration :: realUrlManagement.tableClean.show = 1 Description Allow the “RealURL-Table Clean” module. .. _: :: "" .. container:: table-row Configuration :: realUrlManagement.about.hide = 1 Description Disallow the about module. .. _: :: "" .. container:: table-row Configuration :: realUrlManagement.pageBrowser.recordsOnPage = 20 Description Define how much records should be maximal on one page. Default value for all pagebrowsers. .. _: :: "" .. container:: table-row Configuration :: realUrlManagement.pageBrowser.maxPages = 20 Description Define how much pages should be shown in the pagebrowser. Default value for all pagebrowsers. .. _: :: "" .. container:: table-row 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. .. _: :: "" .. container:: table-row 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. .. _: :: "" .. container:: table-row 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. .. _: :: "" .. container:: table-row 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. .. _: :: "" .. container:: table-row 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. .. _: :: "" .. container:: table-row 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. .. _: :: "" .. container:: table-row Configuration :: realUrlManagement.modules.{extension key}.hide=1 Description Hide module with extension key={extension key}. .. ###### END~OF~TABLE ###### .. _To-Do-list: 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: 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 |img-13| EXT: RealURL management - 9 .. ######CUTTER_MARK_IMAGES###### .. |img-1| image:: img-1.png .. :align: left .. :border: 0 .. :height: 100 .. :name: obrázky1 .. :width: 447 .. |img-2| image:: img-2.png .. :align: left .. :border: 0 .. :height: 415 .. :name: obrázky2 .. :width: 669 .. |img-3| image:: img-3.png .. :align: left .. :border: 0 .. :height: 54 .. :name: obrázky3 .. :width: 448 .. |img-4| image:: img-4.png .. :align: left .. :border: 0 .. :height: 73 .. :name: obrázky4 .. :width: 468 .. |img-5| image:: img-5.png .. :align: left .. :border: 0 .. :height: 73 .. :name: obrázky10 .. :width: 468 .. |img-6| image:: img-6.png .. :align: left .. :border: 0 .. :height: 73 .. :name: obrázky5 .. :width: 468 .. |img-7| image:: img-7.png .. :align: left .. :border: 0 .. :height: 191 .. :name: obrázky8 .. :width: 631 .. |img-8| image:: img-8.png .. :align: left .. :border: 0 .. :height: 287 .. :name: obrázky6 .. :width: 508 .. |img-9| image:: img-9.png .. :align: left .. :border: 0 .. :height: 284 .. :name: obrázky7 .. :width: 502 .. |img-10| image:: img-10.png .. :align: left .. :border: 0 .. :height: 287 .. :name: obrázky9 .. :width: 500 .. |img-11| image:: img-11.png .. :align: left .. :border: 0 .. :height: 62 .. :name: obrázky11 .. :width: 473 .. |img-12| image:: img-12.png .. :align: left .. :border: 0 .. :height: 116 .. :name: obrázky12 .. :width: 475 .. |img-13| image:: img-13.png .. :align: left .. :border: 0 .. :height: 32 .. :id: Graphic1 .. :name: Graphic1 .. :width: 102