User:Austin J. Che/Extensions/Recentchangesfilter - Revision history

Bill Flanagan at 15:38, 17 November 2007

Bill Flanagan — Sat, 17 Nov 2007 15:38:21 GMT

←Older revision		Revision as of 15:38, 17 November 2007
Line 55:		Line 55:

	__NOTOC__		__NOTOC__
		+
		+	[[category:Extensions]]

Austin: User:Austin/Extensions/Recentchangesfilter moved to User:Austin J. Che/Extensions/Recentchangesfilter: Automatically moved page while renaming the user "Austin" to "Austin J. Che"

Austin — Mon, 14 May 2007 22:49:28 GMT

User:Austin/Extensions/Recentchangesfilter moved to User:Austin J. Che/Extensions/Recentchangesfilter: Automatically moved page while renaming the user "Austin" to "Austin J. Che"

←Older revision

Revision as of 22:49, 14 May 2007

Austin J. Che: /* Installation/MediaWiki compatibility */

Austin J. Che — Tue, 30 Jan 2007 23:42:13 GMT

Installation/MediaWiki compatibility

←Older revision		Revision as of 23:42, 30 January 2007
Line 49:		Line 49:
	==Installation/MediaWiki compatibility==		==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 ~~MediaWiki 1.6. An older~~ version ~~that works with~~ MediaWiki version 1.~~5 is~~ also available in the source directory.	+	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.

	----		----

Austin J. Che: /* Expression */

Austin J. Che — Sat, 23 Sep 2006 18:08:53 GMT

Expression

←Older revision		Revision as of 18:08, 23 September 2006
Line 21:		Line 21:
	* '''c''': titles that contain 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.		* '''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.		* '''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		* '''u''': match changes that were done by the given user
Line 29:		Line 30:
	If no match type is specified (there is no equals sign), then the matching will be done with the default type of '''b'''.		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 ~~all~~ the ~~match types that select~~ by page ~~titles~~, ~~the behavior of~~ the page ~~title~~ is ~~as follows. If the title can be interepreted as~~ a ~~namespace~~:~~title where~~ the namespace ~~is something other than the main namespace, then n=namespace will automatically be added~~. ~~For example~~, ~~the pattern~~ b=User:Austin ~~is equivalent to~~ n=User^b=~~Austin~~ whereas b=~~Foo:Bar (Foo is not a valid namespace) matches any pages in ANY namespace beginning with Foo:Bar (such as User:Foo:Bar or User talk:Foo:Bar)~~.	+	''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====

Austin J. Che: /* Expression */

Austin J. Che — Sun, 17 Sep 2006 21:22:55 GMT

Expression

←Older revision		Revision as of 21:22, 17 September 2006
Line 20:		Line 20:
	* '''e''': titles that end with the pattern		* '''e''': titles that end with the pattern
	* '''c''': titles that contain 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.	+	* '''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.
	* '''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.		* '''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		* '''u''': match changes that were done by the given user
Line 29:		Line 29:
	If no match type is specified (there is no equals sign), then the matching will be done with the default type of '''b'''.		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 titles, ~~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~~.	+	Note that for all the match types that select by page titles, the behavior of the page title is as follows. If the title can be interepreted as a namespace:title where the namespace is something other than the main namespace, then n=namespace will automatically be added. For example, the pattern b=User:Austin is equivalent to n=User^b=Austin whereas b=Foo:Bar (Foo is not a valid namespace) matches any pages in ANY namespace beginning with Foo:Bar (such as User:Foo:Bar or User talk:Foo:Bar).

	====Joining Expressions====		====Joining Expressions====

Austin J. Che at 00:26, 19 April 2006

Austin J. Che — Wed, 19 Apr 2006 00:26:09 GMT

←Older revision		Revision as of 00:26, 19 April 2006
Line 45:		Line 45:
	===Including within another page===		===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}}		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==
		+
		+	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 MediaWiki 1.6. An older version that works with MediaWiki version 1.5 is also available in the source directory.

	----		----

Austin J. Che at 23:44, 8 April 2006

Austin J. Che — Sat, 08 Apr 2006 23:44:28 GMT

←Older revision		Revision as of 23:44, 8 April 2006
Line 5:		Line 5:
	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).		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~~\|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.	+	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.

	===Filter Specification===		===Filter Specification===

Austin J. Che: /* Expression */

Austin J. Che — Mon, 13 Mar 2006 04:40:42 GMT

Expression

←Older revision		Revision as of 04:40, 13 March 2006
Line 29:		Line 29:
	If no match type is specified (there is no equals sign), then the matching will be done with the default type of '''b'''.		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 titles, 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.	+	''Note that for the purpose of selecting pages by titles, 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====

Austin J. Che: /* Including within another page */

Austin J. Che — Mon, 13 Mar 2006 04:38:56 GMT

Including within another page

←Older revision		Revision as of 04:38, 13 March 2006
Line 44:		Line 44:

	===Including within another page===		===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):	+	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}}
-	{{Special:Recentchanges/n=0^nc=:&limit=5}}	+

	----		----

Austin J. Che at 20:33, 11 March 2006

Austin J. Che — Sat, 11 Mar 2006 20:33:36 GMT

←Older revision		Revision as of 20:33, 11 March 2006
Line 1:		Line 1:
-	The standard [[Special:Recentchanges\|recent changes]] list can be overwhelming with the number of changes. An extension to ~~MediaWiki~~ to ~~allow filtering~~ the changes list ~~using complex patterns is running on OpenWetWare~~.	+	==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\|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, the only interface for using this extension is to create a URL by hand. The filtering 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:Recentchanges/parameters</nowiki>. The second method is: <nowiki>http://openwetware.org/index.php?title=~~Special:Recentchanges&filter~~=~~parameters</nowiki>. Without any filter parameters, the page is identical to the normal changes list.~~	+	===Filter Specification===

-	Once a URL is created, the appropriate page can be either bookmarked in your browser, linked from a wiki page, or directly included within another wiki page. When a filter is provided, an extra link is provided at the top that allows toggling between filtering and not filtering the changes list.	+	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====
Line 46:		Line 44:

	===Including within another page===		===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.	+	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}}
-	==~~Source Download~~==	+
-	~~The extension was written by [[Austin Che]] and is available for download:~~	+
-	~~[http://austinche.name/mediawiki/SpecialRecentchangesfilter.php.txt SpecialRecentchangesfilter.php]~~	+

		+	----
		+	Send bugs and comments to [[Austin Che]]. Other extensions including sources can be found at [[../]].

-	~~Feel free to send comments or improvements.~~	+	__NOTOC__