DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:goto:supplement

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
plugin:goto:supplement [2019-03-21 09:31]
turnermm [Configuration]
plugin:goto:supplement [2019-03-22 21:14] (current)
turnermm [External Links]
Line 1: Line 1:
 +[[:​plugin:​goto|<​= goto]]
 ===== Temporary download ===== ===== Temporary download =====
  
-Redirects to user page and namespace: \\ +https://​github.com/​turnermm/​goto/​archive/​user.zip  ​
-https://​github.com/​turnermm/​goto/​archive/​user.zip \\ +
- +
-Redirects to both user and group targets: \\ +
-https://​github.com/​turnermm/​goto/​archive/​group.zip  ​\\ +
-This version will very likely be the default distribution. ​+
  
 See the [[#​configuration|configuration options]] for how to configure the page to which the user is redirected. See the [[#​configuration|configuration options]] for how to configure the page to which the user is redirected.
Line 20: Line 16:
 ==== 2. Configured Background Process ==== ==== 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. 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_optons''​ 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 ==== ==== Configuration ====
 ^Option^Description^Default^ ^Option^Description^Default^
Line 26: Line 24:
 |auto_login|On login, automatically go to predefined page, as set in ''​auto_options''​ |false | |auto_login|On login, automatically go to predefined page, as set in ''​auto_options''​ |false |
 |auto_options|Target for the auto_login page(See [[#​auto_options]])|:​user_page | |auto_options|Target for the auto_login page(See [[#​auto_options]])|:​user_page |
-|common_ns((i.e. ''​common namespace'',​ so named because it is common to all users.))|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 all users will have a namespace in the common namespace directory. | |+|common_ns((i.e. ''​common namespace'',​ so named because it is common to all users.))|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. | |
 |group|Comma 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|Comma 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_options|The user can be redirected either to the group start page or to the user's own page in the group namespace|start_page| +|group_options|The 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''​ dnd ''​user_page''​|start_page| 
-|group_only|Redirect ​only to group namespaces, i.e. not to user namespaces and pages|false| +|only_option|The 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 eitherwith group having precedence.|default| 
-|user_only|Redirect ​to user namespaces and pages onlyi.e. not to group namespaces.|false|+
 ==== Auto_Options ==== ==== 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:+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, whwere "​foo"​ is the userid:
   - :user_page \\ :​foo  ​   - :user_page \\ :​foo  ​
   - :​user_ns:​user_page \\ :foo:foo   - :​user_ns:​user_page \\ :foo:foo
Line 39: Line 37:
  
 ==== Group Options ==== ==== 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: 
 +  - start_page \\ group-name:​start
 +  - user_page ​ \\  group-name:​userid
  
-|Options|start_page| user_page ​ | 
-| Redirects to: |:​group_namespace:​start| ​ group_namespace:​user| 
  
  
  
 ==== External Links ==== ==== External Links ====
-External links now supported ​in the [[https://github.com/turnermm/goto/archive/master.zip|extern]] branch, which also includes the auto-login features.  ​+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.%%**  
 + 
 +  
plugin/goto/supplement.1553157086.txt.gz · Last modified: 2019-03-21 09:31 by turnermm