plugin:goto
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
plugin:goto [2011-08-30 23:36] – [syntax.php] 98.189.177.103 | plugin:goto [2019-03-16 00:47] – [Updated Version] turnermm | ||
---|---|---|---|
Line 2: | Line 2: | ||
---- plugin ---- | ---- plugin ---- | ||
- | description: | + | description: |
- | author | + | author |
- | email : 2006-07-19 | + | email : aormond@gmail.com, |
type : syntax | type : syntax | ||
- | lastupdate : 2006-07-19 | + | lastupdate : 2017-02-16 |
- | compatible : 2006-11-06 | + | compatible : Weatherwax, Binky, Ponder Stibbons, Hrun, Detritus, Elenor of Tsort, Frusterick Manners, Greebo |
depends | depends | ||
conflicts | conflicts | ||
- | similar | + | similar |
tags : redirect | tags : redirect | ||
- | downloadurl: | + | downloadurl: |
+ | bugtracker : https:// | ||
+ | sourcerepo : https:// | ||
---- | ---- | ||
+ | This plugin redirects the current page to another page after a stipulated number of seconds. It requires the user to have JavaScript enabled in order to work to its fullest. However, a redirect link will still be displayed even without JavaScript. | ||
+ | ===== Installation ===== | ||
- | This [[plugins|plugin]] | + | Search and install the plugin using the [[plugin: |
+ | |||
+ | The default pause time, | ||
===== Syntax ===== | ===== Syntax ===== | ||
+ | |||
You can put the GOTO string anywhere in the document, but it probably makes the most sense to put it at the top. | You can put the GOTO string anywhere in the document, but it probably makes the most sense to put it at the top. | ||
+ | |||
~~GOTO> | ~~GOTO> | ||
- | The above will force the document to redirect to the [[:syntax]] page after the default amount of seconds. You can change the default number of seconds by editing the plugin (by default, this is 10 seconds). | ||
- | You can change the number of seconds | + | The above will force the document to redirect to the [[: |
+ | |||
+ | It is possible to link to a subheading of the page: | ||
+ | ~~GOTO> | ||
+ | === Pause before redirect === | ||
+ | |||
+ | You can change the number of seconds | ||
~~GOTO> | ~~GOTO> | ||
+ | |||
This will redirect the page after a 15 second pause. | This will redirect the page after a 15 second pause. | ||
- | By default, users can't set the pause length to be faster than three seconds, but this can be changed by editing | + | By default, users can't set the pause length to be faster than two seconds, but this can be changed |
===== Issues ===== | ===== Issues ===== | ||
- | *When editing a page with the '' | ||
- | *The viewer' | ||
- | *Currently, the plugin only works correctly for internal links. | ||
- | ===== Installation ===== | + | * The viewer' |
+ | * Currently, the plugin only works correctly for internal links. | ||
- | Download a zip [[http:// | ||
- | If you want to modify the default pause length and the minimum pause length, edit the following lines in '' | + | ===== Revision History ===== |
- | $seconds | + | |
- | $minSeconds | + | |
- | You can change the redirect message that is displayed by editing the following line in syntax.php: | + | * 2006-06-30 --- Released. |
- | $message = "< | + | |
- | '' | + | |
- | '' | + | |
- | + | ||
- | ===== syntax.php ===== | + | |
- | <code php syntax.php> | + | |
- | <?php | + | |
- | /** | + | |
- | * GOTO Plugin: Easily redirect to other pages in your wiki. | + | |
- | * | + | |
- | * @license | + | |
- | * @author | + | |
- | */ | + | |
- | + | ||
- | if(!defined(' | + | |
- | if(!defined(' | + | |
- | require_once(DOKU_PLUGIN.' | + | |
- | + | ||
- | class syntax_plugin_goto extends DokuWiki_Syntax_Plugin { | + | |
- | + | ||
- | function getInfo(){ | + | |
- | return array( | + | |
- | ' | + | |
- | ' | + | |
- | ' | + | |
- | ' | + | |
- | ' | + | |
- | ' | + | |
- | ); | + | |
- | } | + | |
- | + | ||
- | function getType(){ | + | |
- | return(' | + | |
- | } | + | |
- | + | ||
- | function connectTo($mode) { | + | |
- | $this-> | + | |
- | } | + | |
- | + | ||
- | function getSort() { | + | |
- | return 249; | + | |
- | } | + | |
- | + | ||
- | function handle($match, | + | |
- | + | ||
- | $seconds = 10; //Default number of seconds to wait before redirect. | + | |
- | $minSeconds = 3; //Minimum number of seconds allowed before redirect. | + | |
- | + | ||
- | /* $message is the redirection message that is displayed. %d will be replaced with a link | + | |
- | * to the destination. %s will be replaced with the number of seconds before redirect. */ | + | |
- | $message = "< | + | |
- | + | ||
- | global $ID; | + | |
- | $matches = explode("?", | + | |
- | if (is_numeric($matches[1])){ $seconds = $matches[1]; | + | |
- | if ($seconds < $minSeconds){ $seconds = $minSeconds; | + | |
- | resolve_pageid(getNS($ID), | + | |
- | $message = str_replace(" | + | |
- | $message = str_replace(" | + | |
- | return array($matches[0], | + | |
- | } | + | |
- | + | ||
- | function render($format, | + | |
- | $message = str_replace(" | + | |
- | $message = str_replace(" | + | |
- | $renderer-> | + | |
- | $renderer-> | + | |
- | } | + | |
- | + | ||
- | } | + | |
- | //Setup VIM: ex: et ts=4 enc=utf-8 : | + | |
- | </ | + | |
- | + | ||
- | ===== Revision History ===== | + | |
- | | + | |
* 2006-07-19 --- Made it easier to customize the displayed redirect message. | * 2006-07-19 --- Made it easier to customize the displayed redirect message. | ||
+ | * 2016-10-02 --- Moved to GitHub, added compability for PHP 7, added redirection to headlines, integration of language files, integration of configuration manager for settings, avoid redirection while editing | ||
+ | ===== Updated Version ===== | ||
+ | There is an updated version of '' | ||
+ | For documentation and download, see the '' | ||
- | |||
- | |||
- | |||
- | |||
- | |||
- | ===== Discussion ===== | ||
- | Right now this plugin can only redirect to internal wiki pages. I'd like it to be able to redirect to external pages, but I'm a little hazy on how DokuWiki processes URLs. Any help is appreciated. | ||
- | |||
- | I don't see the point of a page with a ~~GOTO~~ and then some additional content. I'd suggest that if a page contains only an internal link, make an HTTP-header (HTTP 301 response code) redirection and then show a " | ||
- | >I agree, that does sound nice. However, there are a couple reasons I didn't use an http header redirection. As far as I know, it's impossible to make a simple syntax plugin to do it (or at least it's beyond my abilities). Also, if the page redirects without being seen, it would become difficult for a user to remove the redirect. Of course, I'd love to see a more elegant solution, but this is working for me for now. ^_^ --- // | ||
- | >>How about a parameter that disables the redirect, e.g. redirect=no? | ||
- | >>> | ||
- | |||
- | Sorry, but this Plugin is a Crap. Why did you not use the all Wiki Standardcode like : | ||
- | |||
- | #redirect [[Articlename]] | ||
- | |||
- | ?? | ||
- | |||
- | The code you use is to complex and nobody can remember this. | ||
- | |||
- | |||
- | > You're welcome to do better. | ||
- | |||
- | > If there actually existed something like an "all Wiki Standardcode", | ||
- | >> Ever head of [[http:// | ||
- | |||
- | >>You have to now "# | ||
- | >>Use " | ||
- | >>The only thing is, that such a basic function should by part of the basecode. | ||
- | |||
- | ---- | ||
- | $seconds and $minSeconds could by inserted in to the admin-configuration. | ||
- | |||
- | ---- | ||
- | |||
- | ==== Why not allow to redirect to external sites? ==== | ||
- | |||
- | Specifying an URL like '' | ||
- | Is it a bug or a feature? | ||
- | --- [[user> | ||
- | |||
- | ==== Why not using HTTP redirects? ==== | ||
- | |||
- | If you add | ||
- | |||
- | ob_start(); | ||
- | ob_implicit_flush(FALSE); | ||
- | |||
- | to '' | ||
- | |||
- | - No need to enable JavaScript | ||
- | - No extra clicks for visitors, if they disabled JavaScript | ||
- | |||
- | The issue " | ||
- | |||
- | === User stupidity === | ||
- | |||
- | Simple - You can't rely on the fact that all users will be able to know how to use the address bar correctly. If you can't access it through visual scanning and mouse clicks, assume 80% of the population will be unable to utilize the feature. | ||
- | ==== Languages ==== | ||
- | |||
- | < | ||
- | Change | ||
- | |||
- | $message = "< | ||
- | |||
- | to | ||
- | |||
- | $message = "< | ||
- | </ | ||
- | |||
- | |||
- | and | ||
- | |||
- | Input this in the Path " | ||
- | |||
- | |||
- | == en == | ||
- | <code php> | ||
- | <?php | ||
- | /* | ||
- | English language file | ||
- | |||
- | %d will be replaced with a link to the destination. | ||
- | %s will be replaced with the number of seconds before redirect. | ||
- | */ | ||
- | $lang[' | ||
- | //Setup VIM: ex: et ts=2 enc=utf-8 : | ||
- | ?> | ||
- | </ | ||
- | |||
- | |||
- | == de == | ||
- | <code php> | ||
- | <?php | ||
- | /* | ||
- | German language file | ||
- | |||
- | %d will be replaced with a link to the destination. | ||
- | %s will be replaced with the number of seconds before redirect. | ||
- | */ | ||
- | $lang[' | ||
- | //Setup VIM: ex: et ts=2 enc=utf-8 : | ||
- | ?> | ||
- | </ | ||
- | |||
- | == fr == | ||
- | <code php> | ||
- | <?php | ||
- | /* | ||
- | french language file | ||
- | |||
- | %d will be replaced with a link to the destination. | ||
- | %s will be replaced with the number of seconds before redirect. | ||
- | */ | ||
- | $lang[' | ||
- | //Setup VIM: ex: et ts=2 enc=utf-8 : | ||
- | ?> | ||
- | </ | ||
- | |||
- | == es == | ||
- | <code php> | ||
- | <?php | ||
- | /* | ||
- | Spanish language file | ||
- | |||
- | %d will be replaced with a link to the destination. | ||
- | %s will be replaced with the number of seconds before redirect. | ||
- | */ | ||
- | $lang[' | ||
- | //Setup VIM: ex: et ts=2 enc=utf-8 : | ||
- | ?> | ||
- | </ | ||
- | |||
- | ==== Great ==== | ||
- | Great, this plugin made my day. Only issue is that I cannot remember the syntax, #REDIRECT would have been better. | ||
- | |||
- | ==== Support for Anchors ==== | ||
- | The # character is replaced by %23 in the URL, so I've made the following modification to the render function. | ||
- | |||
- | function render($format, | ||
- | $message = str_replace(" | ||
- | $message = str_replace(" | ||
- | $renderer-> | ||
- | $urlArr = split('#', | ||
- | $url = wl($urlArr[0]); | ||
- | if (count($urlArr) > 1) { | ||
- | $url .= '#' | ||
- | } | ||
- | $renderer-> | ||
- | } | ||
- | |||
- | ==== Support for external pages ==== | ||
- | |||
- | Minor modifications which allow: | ||
- | - external pages to be referenced. | ||
- | - doesn' | ||
- | |||
- | < | ||
- | --- ./ | ||
- | +++ ./ | ||
- | @@ -48,18 +48,29 @@ | ||
- | $matches = explode("?", | ||
- | if (is_numeric($matches[1])){ $seconds = $matches[1]; | ||
- | if ($seconds < $minSeconds){ $seconds = $minSeconds; | ||
- | - | ||
- | + if (substr($matches[0], | ||
- | + | ||
- | $message = str_replace(" | ||
- | $message = str_replace(" | ||
- | return array($matches[0], | ||
- | } | ||
- | |||
- | function render($format, | ||
- | - | ||
- | - | ||
- | - | ||
- | - | ||
- | + global $ACT; | ||
- | + if (substr($data[0], | ||
- | + | ||
- | + | ||
- | + | ||
- | + if ($ACT != ' | ||
- | + | ||
- | + } else { | ||
- | + | ||
- | + | ||
- | + | ||
- | + if ($ACT != ' | ||
- | + | ||
- | + } | ||
- | } | ||
- | |||
- | } | ||
- | </ |
plugin/goto.txt · Last modified: 2023-10-30 23:58 by Klap-in