DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:goto

GOTO Plugin

Compatible with DokuWiki

  • 2018-04-22 "Greebo" yes
  • 2017-02-19 "Frusterick Manners" yes
  • 2016-06-26 "Elenor Of Tsort" yes
  • 2015-08-10 "Detritus" yes

plugin Easily have a page redirect to another page in the wiki

Last updated on
2019-03-12
Provides
Syntax
Repository
Source

Similar to 404manager, pageredirect

Tagged with redirect

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

Search and install the plugin using the Extension Manager. Refer to Plugins on how to install plugins manually.

The default pause time, before the redirect, and the minimum allowable pause time can be set in the configuration manager. See below for further details.

Syntax

You can put the GOTO string anywhere in the document, but it probably makes the most sense to put it at the top.

~~GOTO>wiki:syntax~~

The above will force the document to redirect to the syntax page after the default number of seconds. It comes set at three seconds. You can change the default number of seconds in the Configuration Manager.

It is possible to link to a subheading of the page:

~~GOTO>wiki:syntax#subheading~~

Pause before redirect

You can change the number of seconds before the redirect like so:

~~GOTO>wiki:syntax?15~~

This will redirect the page after a 15 second pause.

By default, users can't set the pause length to be faster than two seconds, but this can be changed in the Configuration Manager by setting a new value for the minSeconds option. The reason for the minimum pause length is that if it's too fast, it becomes difficult to hit the 'Edit Page' button before the redirect happens. If you can't edit the page, then it becomes tricky to remove the redirect.

Updated Version

Myron TurnerMyron Turner
turnermm

2019-04-05 22:48

Auto Login

Auto login enables registered users, on logging into the wiki, to be automatically redirected to their own user page. There are two ways to implement the auto login feature.

1. Embedded GOTO Syntax

The first uses the GOTO syntax with the user wildcard in place of the page id:

  ~~GOTO:user~~ 

This must be placed on the wiki's main page, so that when the user logs in, the page displayed in the browser is the page with this markup. No message is printed to the screen. and the user is redirected to the user page in the root namespace. If the userid is “foo”, the user page will be “:foo”. This does not take a time setting: ?tm. The redirection occurs after 1 second delay on login.

2. Configured Background Process

Unlike 1 this method requires no additional plugin markup. On login, the auto login feature redirects the user to the user's page or start page. This page and its namespace are based on the settings in either the auto_options setting or the group_options setting. For this to work, the auto_login option must be set to true. The redirection occurs immediately, without a delay.

The redirects are governed by the auto_options and group_options settings. The auto_options redirect to pages and namespaces based on the userid. The group_options redirect to pages located in namespaces based on group membership.

Configuration

OptionDescriptionDefault
secondsTime till redirection (seconds) 3
minSecondsMinimum time allowed till redirection (seconds) 2
auto_loginOn login, automatically go to predefined page, as set in auto_options or group_optionsfalse
auto_optionsTarget for the auto_login page based on userid (See auto_options):user_page
common_ns1)Used with auto_options. Arbitrarily defined namespace of any depth where the auto login pages will reside. This can include the wildcard user_ns, in which case the user will have a namespace in the common namespace directory.
groupComma separated list of group namespaces to which users can be redirected. Different users can be in different groups. If a user belongs to two groups on this list, the user will be redirected to the first.
group_optionsThe user can be redirected either to the group start page or to the user's own page in the group namespace. The options are start_page and user_pagestart_page
only_optionThe options are group and user. group restricts redirects only to group namespaces and their pages; user only to user namespaces and pages; and default to either, with group having precedence.default

Auto_Options

There a four options available for defining the user page and namespace to which the auto login will be directed. In each case user stands for the userid and ns for namespace. If the userid is “foo”, then the first option would give you “:foo” in the root namespace, the second option “:foo:foo”. The start page is one of DokuWiki's basic configurations and defaults to start. The fourth option requires that the GOTO common namespace (common_ns) option be set. These are the four possibilities for defining the auto login page, where “foo” is the userid:

  1. :user_page
    :foo
  2. :user_ns:user_page
    :foo:foo
  3. :user_ns:start_page
    foo:start
  4. :common_ns:user_page
    <common_ns>:foo 2)

Group Options

Therre are two possibilities for defining the auto login page based on group membership. In each case the group name is the name of the namespace so that both options locate the redirect page in a namespace which is the same as the group name:

  1. start_page
    group-name:start
  2. user_page
    group-name:userid

External links now supported. The following:

 ~~GOTO>https://mturner.org/devel/doku.php?id=wiki:welcome~~

will redirect to wiki:welcome at mturner.org. The on-page notification will read:
You will be redirected to https://mturner.org/devel/doku.php?id=wiki:welcome in approximately 3 seconds.

Revision History

Old Discussion

To review old issues and discussion: old_discussion

1)
i.e. common namespace, so named because it is common to all users.
plugin/goto.txt · Last modified: 2019-04-05 23:24 by turnermm