Mediawiki Extension RightFunctions - Revision history

DochyJP: Text replacement - "[{{fullurl:{{FULLPAGENAMEE}}|action=mpdf}} Download this page as PDF]" to ""

2021-04-14T12:47:59Z

Text replacement - "[{{fullurl:{{FULLPAGENAMEE}}|action=mpdf}} Download this page as PDF]" to ""

DochyJP: Text replacement - " " to " [{{fullurl:{{FULLPAGENAMEE}}|action=mpdf}} Download this page as PDF]"

2021-04-14T12:43:34Z

Text replacement - " " to " [{{fullurl:{{FULLPAGENAMEE}}|action=mpdf}} Download this page as PDF]"

DochyJP: Added template version in infobox for future updates

2021-04-13T07:06:33Z

Added template version in infobox for future updates

DochyJP: Changed Infobox

2021-02-26T13:24:46Z

Changed Infobox

DochyJP: Text replacement - "Template-uk:Class-Infobox-Software" to "Template:Class-Infobox-Software"

2021-02-25T12:38:34Z

Text replacement - "Template-uk:Class-Infobox-Software" to "Template:Class-Infobox-Software"

DochyJP: Added infobox and semantic variables

2021-02-15T12:46:13Z

Added infobox and semantic variables

DochyJP: Page creation

2021-01-04T16:29:12Z

Page creation

New page

'''[[PageName::{{PAGENAME}}|]]'''

{{Template-uk:Class-Infobox-Software
|image = 
|Source = [[Source::DataSource]] 
|Version = [[Version::MW-1.35-LTS]]
|Language = [[Language::English]]
|Subject = [[Subject::Mediawiki]] 
|DocumentType = [[DocumentType::Extension]] 
|LastEditBy = [[LastEditBy::{{REVISIONUSER}}]]
|LastEdit = [[LastEdit::{{REVISIONYEAR}}-{{REVISIONMONTH}}-{{REVISIONDAY2}}]]
|DocumentStatus = [[DocumentStatus::Active]] 
}}


== Description ==
The RightFunctions extension tests various page or user permissions and displays text based off of them. 

Please note that these parser functions may be used to superficially hide information from those with certain rights. Also note that all functions disable the cache on the page they are used in unless you set $wgRightFunctionsAllowCaching to true.

== Installation ==
=== Download ===
Download and place the file(s) in a directory called RightFunctions in your extensions/ folder. 

[https://extdist.wmflabs.org/dist/extensions/RightFunctions-REL1_35-d812527.tar.gz Version 1.35 LTS]

=== Activation ===
Add the following code at the bottom of your LocalSettings.php:
<pre>
require_once "$IP/extensions/RightFunctions/RightFunctions.php";
</pre>
=== Configuration ===
These variables control how the various parser functions work. There are currently 4 variables.
:*$wgRightFunctionsUserGroups : Default value: array( '*', 'user', 'autoconfirmed', 'sysop', 'bureaucrat' ). An array of groups to test for in #Usergroup. They are arranged in order of least to greatest for group testing.
:*$wgRightFunctionsAllowCaching : Default value: false. If set to true, the functions do not disable the parser cache and they do not trigger the recache when getting a user's groups. It is recommended that you leave this as false.
:*$wgRightFunctionsAllowExpensiveQueries : Default value: true. If set to true, using ifpageright and ifpageallowed will check the rights more thoroughly (like through cascading protection), so it will produce more accurate results, but it will me more server-intensive to perform. It is recommended that you leave this as true.
:*$wgRightFunctionsDisableFunctions : Default value: array(); Functions in this array will not get evaluated and will simply return nothing.

== Usage==
=== Ifright ===
Tests whether the current user has the given right, then displays the appropriate text. If the right doesn't exist, it simply returns else. If no right is specified, it returns then. This function ignores per-page restrictions on a user's rights, so use #Ifpageright if you need that functionality. 
Usage: <nowiki>{{#ifright:right|then|else}}</nowiki>
=== Ifallowed ===
Tests whether the given user has the given right, then displays the appropriate text. This function will return nothing unless a user is defined. This function ignores per-page restrictions on a user's rights, so use #Ifpageallowed if you need that functionality. 
Usage: <nowiki>{{#ifallowed:user|right|then|else}}</nowiki>
=== Switchright ===
A switch statement that tests whether the current user has the rights. This operates much like the ParserFunctions #switch statement. 

Usage: <nowiki>{{#switchright:right1=result1|right2|right3=result2 and 3|right4=result4|default (or #default=default if the default text contains =)}}</nowiki>

=== Userrights ===
Lists all rights in an unordered list either of the current user or of the given user. If a user isn't defined, it triggers on the current user instead. 

Usage: <nowiki>{{#userrights:}} (for current user) or {{#userrights:user}} (for other users)<//nowiki>

=== Usergroup ===
Returns the highest user group the user belongs to. The groups are defined in lowest-to-highest ranking in the array $wgRightFunctionsUserGroups. If a user isn't defined, it triggers on the current user instead. 

Usage: <nowiki>{{#usergroup:}} (for current user) or {{#usergroup:user}} (for other users)</nowiki>

=== Ifgroup ===
Tests if the given user is in the specified group. If no user is specified, it tests the current user. If no group is specified, it returns else. 

Usage: <nowiki>{{#ifgroup:group|then|else}} (for current user) or {{#ifgroup:group|then|else|user}} (for other users)</nowiki>

=== Switchgroup ===
A switch statement that tests whether the current user is in a group. This operates much like the ParserFunctions #switch statement. 

Usage: <nowiki>{{#switchgroup:group1=result1|group2|group3=result2 and 3|group4=result4|default (or #default=default if the default text contains =)}}</nowiki>

=== Ifpageright ===

Tests whether the current user has the given right on the given page, then displays the appropriate text. If the right doesn't exist, it simply returns else. If no right is specified, it returns then. This function does not ignore per-page restrictions on a user's rights. 

Usage: <nowiki>{{#ifpageright:right|then|else|page}} for testing other pages or {{#ifpageright:right|then|else}}</nowiki> for testing the current page.

=== Ifpageallowed ===
Tests whether the given user has the given right on the given page, then displays the appropriate text. If no user is specified, it returns nothing. If no page is specified, it checks the current page. If the right doesn't exist, it returns else and if no right is specified, it returns then. This function does not ignore per-page restrictions on a user's rights. 

Usage: <nowiki>{{#ifpageallowed:user|right|then|else|page}} for testing other pages or {{#ifpageallowed:user|right|then|else}}</nowiki> for testing the current page.

=== Ifprotected ===
Tests whether the given page is protected, then displays the appropriate text. If no page is given, it tests the current page. It will return then if the page is either fully-protected, semi-protected, protected because it is included in a cascading-protected page, or if it is namespace-protected. You may control which of these are tested by adding the letters "f", "s", "c", and/or "n" (standing for fully-protected, semi-protected, cascading-protected, and namespace-protected, respectively) to the fourth parameter of the page (by default all 4 are tested). 

Usage: <nowiki>{{#ifprotected:then|else|page}} for testing other pages, or {{#ifprotected:then|else}}</nowiki> for testing the current page or (for example) <nowiki>{{#ifprotected:then|else|page|fns}} </nowiki>for testing only certain types of protection.

=== Getrestrictions ===
Grabs what right is required to carry out the action on the given page. If no page is given, it checks the current page instead. If no right is given, it checks the 'edit' right. If there are no restrictions on that page for the particular right, it returns the empty string (""). If the page has cascading restrictions as well, it returns the highest restriction level for the page (from all cascading sources and the local page itself). If you would like all the restrictions to be listed instead, set the third parameter to "true". If you do, the output format changes to be more detailed, depending on what restrictions exist for the current page, cascading-protected sources, and namespace protection. 

Usage: <nowiki>{{#getrestrictions:right|page}} for testing other pages, or {{#getrestrictions:right}} for testing the current page or {{#getrestrictions:right|page|true}}</nowiki> for listing all restrictions instead of just the highest one.

 [[#top|Back to top of page]] - [[English|Back to Welcome Page]] 

[[Category:Mediawiki]]

@@ Line 1: / Line 1: @@
 '''<span style="color:white; background:white">[[PageName::{{PAGENAME}}|]]</span>'''
 <!-- Template Infobox Software -->
-{{Template-uk:Class-Infobox-Software
+{{Template:Class-Infobox-Software
 	|image = <!-- If an logo is required, enter the link here -->
 	|Section = [[Section::{{PAGENAME}}]]

@@ Line 15: / Line 15: @@
 }}
 <!-- End of Template Infobox Generic-->
-[{{fullurl:{{FULLPAGENAMEE}}|action=mpdf}} Download this page as PDF]
 == Description ==
 The RightFunctions extension tests various page or user permissions and displays text based off of them.<br>

@@ Line 11: / Line 11: @@
 	|LastEdit = [[LastEdit::{{REVISIONYEAR}}-{{REVISIONMONTH}}-{{REVISIONDAY2}}]]
 	|Status = [[Status::Active]] <!--[[Status::Active]]  [[Status::Development]] [[Status::Obsolete]] [[Status::Archived]] [[Status::To Delete]]-->
 }}
 <!-- End of Template Infobox Generic-->

@@ Line 1: / Line 1: @@
-'''<span style="color:white; background:white">[[PageName::{{PAGENAME}}|]]</span>'''
+<!-- Template Infobox Generic-->
-<!-- Template Infobox Software -->
+{{Template:Class-Infobox-Generic<!-- ALL MUST BE FILLED IN -->
 	|image = <!-- If an logo is required, enter the link here -->
 	|Section = [[Section::{{PAGENAME}}]]
-	|Source = [[Source::DataSource]] <!-- DataSource, Semantic Query, Template, ... -->
+	|Source = [[Source::DataSource]]  <!-- [[Source::DataSource]], [[Source::Query]] ... -->
-	|Version = [[Version::MW-1.35-LTS]]
+	|Language = [[Language::English]] <!-- [[Language::English]], [[Language::Français]], [[Language::Nederlands]] -->
-	|Language = [[Language::English]]
+	|Topic =  [[Topic::Mediawiki]] <!-- [[Topic::Mediawiki]], [[Subject::Microsoft]], ... -->
-	|Subject = [[Subject::Mediawiki]] <!-- KMS, ... -->
+	|SubTopic = [[SubTopic::Mediawiki Extension]] <!-- [[SubTopic::Mediawiki Extension]], [[SubTopic::Office 365]] , ... -->
-         |DocumentType = [[DocumentType::Extension]] <!-- Extension -->
+         |DocumentType =  [[DocumentType::Documentation]] <!-- [[DocumentType::User Guide]], [[DocumentType::Procedure]], [[DocumentType::Script]], [[DocumentType::Gallery]], ...-->
 	|LastEditBy = [[LastEditBy::{{REVISIONUSER}}]]
 	|LastEdit = [[LastEdit::{{REVISIONYEAR}}-{{REVISIONMONTH}}-{{REVISIONDAY2}}]]
-|DocumentStatus = [[DocumentStatus::Active]] <!--[[DocumentStatus::Active]]  [[DocumentStatus::Development]] [[DocumentStatus::Obsolete]] -->
+	|Status = [[Status::Active]] <!--[[Status::Active]]  [[Status::Development]] [[Status::Obsolete]] [[Status::Archived]] [[Status::To Delete]]-->
 }}
-<!-- End of Template Infobox Software -->
+<!-- End of Template Infobox Generic-->
 == Description ==