User:Austin J. Che/Extensions/Recentchangesfilter

From OpenWetWare

< User:Austin J. Che | Extensions(Difference between revisions)
Jump to: navigation, search
(Examples)
Current revision (11:38, 17 November 2007) (view source)
 
(17 intermediate revisions not shown.)
Line 1: Line 1:
-
The standard [[Special:Recentchanges]] list can be overwhelming with the number of changes. An extension to MediaWiki to allow limiting the changes list to certain pages has been written at [[Special:Recentchangeslimit]].  
+
==Special:Recentchanges Filtering==
 +
The standard [[Special:Recentchanges|recent changes]] list can be overwhelming on a large site with the number of changes. This extension allows users to track a subset of changes that they are interested in and allows users to set preferences for the default filters to use when displaying the recent changes list.  
-
For a quick start and demo, see [[Reshma Shetty/Recent changes]] for an example of using this page.
+
===General Usage===
 +
The key to using this extension is to create desired filters. A filter is used in several possible ways. The filter can be passed as parameters at the end of the URL as extra path info, e.g. '''/wiki/Special:Recentchanges/parameters'''. They can also be passed with the real script path as in  '''/index.php?title=Special:Recentchanges&filter=parameters'''. A URL created in this manner can be either bookmarked in a browser, linked from a wiki page, or directly included within another wiki page (see below).  
-
==Usage==
+
Logged in users also have the ability to set their preferences (with help from the [[../PreferencesExtension/]]). When that extension is also installed, several additional options are added under the recent changs tab of a user's preferences. The enable filtering option turns on or off default filtering. With this option off, when the recent changes page is accessed without a filter in the URL, a normal recent changes page is returned (all results). If this option is enabled, then the other options determine the behavior of the [[Special:Recentchanges]] page when accessed without a filter. The filter list is of the form <tt>[name1]filter1...;[name2]filter2...;[name3]filter3</tt> for as many filters as one would like to define. The [name] part is optional but if not specified, the default name will be the filter number. The last preference allows specifying the default filter (by number, with the first filter numbered 0). When a user access the recent changes page, the default filter will be used if no other filter is given. In addition, the page will contain easy links to switch between all the filters listed on their filter list. An empty filter will always match everything and it is probably a good idea to always include this somewhere in one's list.
-
Currently, there is no interface to this special page other than creating a valid URL by hand. The select criteria is passed in one of two ways. The short/easy way is to pass parameters at the end of the URL as extra path info as in <nowiki>http://openwetware.org/wiki/Special:Recentchangeslimit/parameters</nowiki>. The second method is: <nowiki>http://openwetware.org/index.php?title=Special:Recentchangeslimit&select=parameters</nowiki>. Without any selection parameters, the page should appear almost identical to the normal changes list.
+
===Filter Specification===
-
Once a URL is created, the appropriate page can be either bookmarked or included within another wiki page.
+
The filter is specified as a boolean statement in disjunctive normal form (groups of expressions ANDed together that are then all ORed together).  
-
 
+
-
===Selection Specification===
+
-
 
+
-
The selection criteria is specified as a boolean statement in disjunctive normal form (groups of expressions ANDed together that are then all ORed together).  
+
====Expression====
====Expression====
-
The general form for one expression is '''type=match'''.
 
-
Types are either 1 or 2 letter codes. Known types and their meaning:
+
The general form for an expression is <nowiki><match type>=<match pattern></nowiki>.
-
* b: titles that begin with match
+
Match types are 1 or 2 letter codes and specify how the match pattern should be used in selecting items to display in the recent changes list. The basic types and their meaning:
-
* e: titles that end with match
+
-
* c: titles that contain match
+
-
* m: titles that match where the match expression can contain '%' character to represent a wildcard character. This is a more general version of the b, e, and c types.
+
-
* n: pages that are in the given namespace. Note that namespaces are given by numbers. Go to the normal recent changes limit, select the desired namespace, and look at the URL to determine the namespace to number mapping.
+
-
All of the above types have another type with an extra n in front, i.e. nb, ne, nc, nm, nn. These types represent the negation of the version without the n.
+
* '''b''': titles that begin with the pattern
 +
* '''e''': titles that end with the pattern
 +
* '''c''': titles that contain the pattern
 +
* '''m''': titles that match where the match expression can contain any number of the '%' character to represent a wildcard character that matches any number of charaters. This is a more general version of the b, e, and c types. Note that for URLs, you may need to encode the percent using '%25' in the URL.
 +
* '''p''': matches the page of the given name (will always match at most one page). The page name should be given fully qualified with the namespace prefix as appropriate (e.g. as p=User:Austin). The criteria n=User^p=Austin will never match any pages because p=Austin is interpreted as being in the main namespace and no page can be in both the User and main namespaces.
 +
* '''n''': The match pattern should be either a number corresponding to a namespace or the name of a namespace. This matches all pages that are in the given namespace. The main namespace has number 0 and doesn't have a name so you have to use the number. For other namespaces, you can use the name (e.g. 'User talk') or you can find the number by selecting the namespace in the dropdown list of the recent changes page, click go, and look at the URL to determine the namespace to number mapping. There's also a namespace called 'Special' with number -1 that includes pages like the upload log.
 +
* '''u''': match changes that were done by the given user
 +
* '''w''': match changes for pages on your (or whoever's currently logged in) watchlist. The match pattern is ignored so it can just be set to 1 or left off completely.
-
The default if no type is specified (that is only '''match''') is type 'b'.
+
All of the above types have a negated version with an extra n in front, i.e. '''nb''', '''ne''', '''nc''', etc. For example, nb=foo will match all pages that ''don't'' begin with foo.
-
Note that for the purpose of page title matching, it is necessary to be clear whether a page is in a different namespace. For example, User:Austin is not a page titled User:Austin but rather a page titled Austin in the namespace User. Thus, b=User won't match this page but b=Austin would and ns=2 would also. Pages prefixed like Knight:Contact are not really in a different namespace but in the main namespace so this page title would actually be Knight:Contact.
+
If no match type is specified (there is no equals sign), then the matching will be done with the default type of '''b'''.
 +
 
 +
''Note that for the purpose of selecting pages by title patterns, it is necessary to be clear which namespace a page is in.'' For example, the page User:Austin is not a page titled User:Austin but rather a page titled Austin in the namespace User. Thus, b=User won't match this page but either b=Austin or n=User would. Pages like Knight:Contact are in the main namespace so b=Contact wouldn't match this whereas b=Knight would.
====Joining Expressions====
====Joining Expressions====
-
'^' is used to represent AND and ',' (comma) is used to represent OR. Remember that expressions are assumed to be in disjunctive normal form so there's an intrinsic parenthesis order.
+
'^' is used to represent AND and ',' (comma) is used to represent OR. Expressions are assumed to be in disjunctive normal form so there's an intrinsic parenthesis order (and no way to change this order). This means that all the ANDs have higher precedence than the ORs.
===Examples===
===Examples===
-
* Select pages that begin with the Calendar: [[Special:Recentchangeslimit/b=Calendar]] or more simply [[Special:Recentchangeslimit/Calendar]]
+
* Select pages that begin with Calendar: [[Special:Recentchanges/b=Calendar]] or more simply [[Special:Recentchanges/Calendar]]
-
* Filter out all pages with a colon in them and pages in non-primary namespaces: [[Special:Recentchangeslimit/n=0^nc=:]]
+
* Ignore all changes made by User:Austin: [[Special:Recentchanges/nu=Austin]]
-
* Select last 10 pages that begin with either Endy or Knight: [[Special:Recentchangeslimit/Endy,Knight&limit=10]]
+
* Show changes for pages on your watchlist (in a nicer format than you can with the default watchlist): [[Special:Recentchanges/w=1]]
-
* Select pages that have changed in User namespace except for people's user names that end with the letter n or pages that contain the letters a, b, c in that order  (demonstrating that you can do useless things to waste time with this extension): [[Special:Recentchangeslimit/n=2^ne=n,m=%a%b%c%]]
+
* Filter out all pages with a colon in them and pages not in the main namespace: [[Special:Recentchanges/n=0^nc=:]]
 +
* Select pages that begin with either Endy or Knight and limit to the last 10 changes: [[Special:Recentchanges/Endy,Knight&limit=10]]
 +
* Select pages that have changed in User namespace except for people's user names that end with the letter n or pages that contain the letters a, b, c in that order or that are on your watchlist (demonstrating that you can do useless things to waste time with this extension): [[Special:Recentchanges/n=User^ne=n,m=%a%b%c%,w=1]]
 +
 
 +
===Including within another page===
 +
The special page can be included using the standard <nowiki>{{Special:Recentchanges/parameters)}}</nowiki> syntax. This allows including a select list of changes on a page. For example, here's a live demo showing the last 5 changes of articles in the main namespace that do not have a ':' in their name (uncategorized/general pages):{{Special:Recentchanges/n=0^nc=:&limit=5}}
 +
 
 +
==Installation/MediaWiki compatibility==
-
===Including===
+
More than most extensions, this one depends heavily on the internals of MediaWiki. Much of the code from wfSpecialRecentchanges is directly copied into this extension and updates to MediaWiki will require the corresponding update to this code. The current version of the code has been updated to work with the version of  MediaWiki running on this wiki (version {{CURRENTVERSION}}). Older versions are also available in the source directory.
-
The special page can be included using the standard <nowiki>{{Special:Recentchangeslimit/parameters)}}</nowiki> syntax. This allows including a select list of changes on a page.
+
 +
----
 +
Send bugs and comments to [[Austin Che]]. Other extensions including  sources can be found at [[../]].
-
==Source Download==
+
__NOTOC__
-
The extension was written by [[Austin Che]] and is available for download from:
+
-
* file to put in [http://austinche.name/mediawiki/SpecialRecentchangeslimit.php.txt extensions directory]
+
-
* file to put in [http://austinche.name/mediawiki/includes/SpecialRecentchangeslimit.php.txt includes directory]
+
-
Feel free to send comments or improvements.
+
[[category:Extensions]]

Current revision

Special:Recentchanges Filtering

The standard recent changes list can be overwhelming on a large site with the number of changes. This extension allows users to track a subset of changes that they are interested in and allows users to set preferences for the default filters to use when displaying the recent changes list.

General Usage

The key to using this extension is to create desired filters. A filter is used in several possible ways. The filter can be passed as parameters at the end of the URL as extra path info, e.g. /wiki/Special:Recentchanges/parameters. They can also be passed with the real script path as in /index.php?title=Special:Recentchanges&filter=parameters. A URL created in this manner can be either bookmarked in a browser, linked from a wiki page, or directly included within another wiki page (see below).

Logged in users also have the ability to set their preferences (with help from the PreferencesExtension). When that extension is also installed, several additional options are added under the recent changs tab of a user's preferences. The enable filtering option turns on or off default filtering. With this option off, when the recent changes page is accessed without a filter in the URL, a normal recent changes page is returned (all results). If this option is enabled, then the other options determine the behavior of the Special:Recentchanges page when accessed without a filter. The filter list is of the form [name1]filter1...;[name2]filter2...;[name3]filter3 for as many filters as one would like to define. The [name] part is optional but if not specified, the default name will be the filter number. The last preference allows specifying the default filter (by number, with the first filter numbered 0). When a user access the recent changes page, the default filter will be used if no other filter is given. In addition, the page will contain easy links to switch between all the filters listed on their filter list. An empty filter will always match everything and it is probably a good idea to always include this somewhere in one's list.

Filter Specification

The filter is specified as a boolean statement in disjunctive normal form (groups of expressions ANDed together that are then all ORed together).

Expression

The general form for an expression is <match type>=<match pattern>.

Match types are 1 or 2 letter codes and specify how the match pattern should be used in selecting items to display in the recent changes list. The basic types and their meaning:

  • b: titles that begin with the pattern
  • e: titles that end with the pattern
  • c: titles that contain the pattern
  • m: titles that match where the match expression can contain any number of the '%' character to represent a wildcard character that matches any number of charaters. This is a more general version of the b, e, and c types. Note that for URLs, you may need to encode the percent using '%25' in the URL.
  • p: matches the page of the given name (will always match at most one page). The page name should be given fully qualified with the namespace prefix as appropriate (e.g. as p=User:Austin). The criteria n=User^p=Austin will never match any pages because p=Austin is interpreted as being in the main namespace and no page can be in both the User and main namespaces.
  • n: The match pattern should be either a number corresponding to a namespace or the name of a namespace. This matches all pages that are in the given namespace. The main namespace has number 0 and doesn't have a name so you have to use the number. For other namespaces, you can use the name (e.g. 'User talk') or you can find the number by selecting the namespace in the dropdown list of the recent changes page, click go, and look at the URL to determine the namespace to number mapping. There's also a namespace called 'Special' with number -1 that includes pages like the upload log.
  • u: match changes that were done by the given user
  • w: match changes for pages on your (or whoever's currently logged in) watchlist. The match pattern is ignored so it can just be set to 1 or left off completely.

All of the above types have a negated version with an extra n in front, i.e. nb, ne, nc, etc. For example, nb=foo will match all pages that don't begin with foo.

If no match type is specified (there is no equals sign), then the matching will be done with the default type of b.

Note that for the purpose of selecting pages by title patterns, it is necessary to be clear which namespace a page is in. For example, the page User:Austin is not a page titled User:Austin but rather a page titled Austin in the namespace User. Thus, b=User won't match this page but either b=Austin or n=User would. Pages like Knight:Contact are in the main namespace so b=Contact wouldn't match this whereas b=Knight would.

Joining Expressions

'^' is used to represent AND and ',' (comma) is used to represent OR. Expressions are assumed to be in disjunctive normal form so there's an intrinsic parenthesis order (and no way to change this order). This means that all the ANDs have higher precedence than the ORs.

Examples

Including within another page

The special page can be included using the standard {{Special:Recentchanges/parameters)}} syntax. This allows including a select list of changes on a page. For example, here's a live demo showing the last 5 changes of articles in the main namespace that do not have a ':' in their name (uncategorized/general pages):

3 September 2014

       01:04 Dr.HeidiM.Mansour (diff; hist) . .  (+291) . . Dr. Heidi M. Mansour (Talk | contribs) (Journal Publications: )

2 September 2014

       23:16 Biomod/2014/Kyutech/Experiment (diff; hist) . .  (+18) . . Sato Daiki (Talk | contribs)
       23:16 Biomod/2014/Kyutech/Design (diff; hist) . .  (+18) . . Sato Daiki (Talk | contribs)
       23:16 Biomod/2014/Kyutech/Introduction (diff; hist) . .  (+18) . . Sato Daiki (Talk | contribs)
       23:15 Biomod/2014/Kyutech (diff; hist) . .  (+18) . . Sato Daiki (Talk | contribs)

Installation/MediaWiki compatibility

More than most extensions, this one depends heavily on the internals of MediaWiki. Much of the code from wfSpecialRecentchanges is directly copied into this extension and updates to MediaWiki will require the corresponding update to this code. The current version of the code has been updated to work with the version of MediaWiki running on this wiki (version 1.13.2). Older versions are also available in the source directory.


Send bugs and comments to Austin Che. Other extensions including sources can be found at User:Austin J. Che/Extensions.

Personal tools