Changes between Version 11 and Version 12 of ServerSideRedirectPlugin


Ignore:
Timestamp:
Aug 6, 2015, 9:12:39 AM (6 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • ServerSideRedirectPlugin

    v11 v12  
    55== Description
    66
    7 This plug-in allows one to place a redirect macro at the start of any wiki page which will cause an server side redirect when the wiki page is viewed.
     7This plugin allows you to place a redirect macro at the start of any wiki page which will cause an server side redirect when the wiki page is viewed.
    88
    9 This plug-in is compatible (i.e. can be used) with the client side redirect macro TracRedirect but doesn't depend on it. Because the redirect is caused by the server (using a HTTP redirect request to the browser) it is much faster and less noticeable for the user. The back-link feature of TracRedirect can also be used for server side redirected pages because both generate the same URL attributes.
     9This plugin is compatible (i.e. can be used) with the client side redirect macro TracRedirect, but doesn't depend on it. Because the redirect is caused by the server (using a HTTP redirect request to the browser) it is much faster and less noticeable for the user. The back-link feature of TracRedirect can also be used for server side redirected pages because both generate the same URL attributes.
    1010
    11 A protection for 1st (A->A) and 2nd (A->B->A) order redirect loops is implemented, but higher order loops (A->B->C->A, etc.) must be handled by the browser or the user. Firefox 3 handles redirect loops well.
     11A protection for first order redirect loop (A -> A) and second order redirect loops (A -> B -> A) is implemented, but higher order redirect loops (A -> B -> C -> A, etc.) must be handled by the browser or the user. Firefox 3 handles redirect loops well.
    1212
    13 To edit a redirecting wiki page access its URL with `?action=edit` appended. To view the page either use `?action=view`, which will print the redirect target (if TracRedirect isn't active, which will redirect the wiki using client side code), or `?redirect=no` which disables redirection of both the ServerSideRedirectPlugin and TracRedirect plug-in.
     13To edit a redirecting wiki page access its URL with `?action=edit` appended. To view the page either use `?action=view`, which will print the redirect target (if TracRedirect isn't active, which will redirect the wiki using client side code), or `?redirect=no` which disables redirection of both the ServerSideRedirectPlugin and TracRedirect plugin.
    1414
    15 Direct after the redirect target is added (or modified) Trac will automatically reload it, as it does with all wiki pages. This plug-in will detect this and not redirect but display the wiki page with the redirect target URL printed to provide feedback about the successful change. However, further visits will trigger the redirect.
     15Direct after the redirect target is added (or modified) Trac will automatically reload it, as it does with all wiki pages. This plugin will detect this and not redirect but display the wiki page with the redirect target URL printed to provide feedback about the successful change. However, further visits will trigger the redirect.
    1616
    17 == Bugs/Feature Requests ==
     17== Bugs/Feature Requests
    1818
    1919Existing bugs and feature requests for ServerSideRedirectPlugin are
     
    2121
    2222If you have any issues, create a
    23 [/newticket?component=ServerSideRedirectPlugin&owner=martin_s new ticket].
     23[/newticket?component=ServerSideRedirectPlugin new ticket].
    2424
    2525[[TicketQuery(component=ServerSideRedirectPlugin&group=type,format=progress)]]
    2626
    27 == Download ==
     27== Download
    2828
    2929Download the zipped source from [download:serversideredirectplugin/0.11 here].
    3030
    31 == Source ==
     31== Source
    3232
    3333You can check out ServerSideRedirectPlugin from [/svn/serversideredirectplugin/0.11 here] using Subversion, or [source:serversideredirectplugin/0.11 browse the source] with Trac.
     
    3939Install the plugin as per the usual installation steps.
    4040
    41 Enable the plugin in `conf/trac.ini` as follows:
     41Enable the plugin in your `conf/trac.ini` file as follows:
    4242
    43 {{{
    44 #!ini
     43{{{#!ini
    4544[components]
    4645tracserversideredirect.* = enabled
     
    6362}}}
    6463
    65 The macro is normally not executed, but the plugin will scan every wiki page for it and
    66 execute the redirect before the wiki page is send to the user. However, a fall-back implementation of the macro
    67 is provided which displays the redirect target to the user. This message is also shown directly after the redirect
    68 macro was added to the wiki page to give the editing user a feedback over the successful change.
     64The macro is normally not executed, but the plugin will scan every wiki page for it and execute the redirect before the wiki page is send to the user. However, a fall-back implementation of the macro is provided which displays the redirect target to the user. This message is also shown directly after the redirect macro was added to the wiki page to give the editing user a feedback over the successful change.
    6965
    70 Please note that the lower-case version '`redirect`' is compatible with the TracRedirect macro, which is not
    71 redefined by this plugin if this macro is also enabled. The upper-case version '`Redirect`' is always provided by this
    72 plugin and will be ignored by TracRedirect.
     66Please note that the lower-case version '`redirect`' is compatible with the TracRedirect macro, which is not redefined by this plugin if this macro is also enabled. The upper-case version '`Redirect`' is always provided by this plugin and will be ignored by TracRedirect.
    7367
    7468
     
    7973[[redirect(http://www.example.com/)]]
    8074}}}
     75
    8176or
    8277{{{
     
    8681}}}
    8782
    88 == Recent Changes ==
     83== Recent Changes
    8984
    9085[[ChangeLog(serversideredirectplugin, 3)]]
    9186
    92 == Author/Contributors ==
     87== Author/Contributors
    9388
    9489'''Author:''' [wiki:martin_s] [[BR]]
    95 '''Maintainer:''' [wiki:martin_s] [[BR]]
     90'''Maintainer:''' [[Maintainer]] [[BR]]
    9691'''Contributors:'''