MediaWiki/archive/customizing/new Special page - Revision history

Woozle: Woozle moved page creating a custom Special page in MediaWiki to MediaWiki/archive/customizing/new Special page without leaving a redirect: probably quite obsolete

2017-12-14T23:46:26Z

Woozle moved page creating a custom Special page in MediaWiki to MediaWiki/archive/customizing/new Special page without leaving a redirect: probably quite obsolete

← Older revision	Revision as of 23:46, 14 December 2017
(No difference)

Woozle: the _gen function is particular to the allpages special page, and doesn't need to be kept

2006-11-12T23:40:00Z

the _gen function is particular to the allpages special page, and doesn't need to be kept

← Older revision		Revision as of 23:40, 12 November 2006
Line 5:		Line 5:

	# Copy an existing Special page to use as a template; they are in the '''includes/''' folder, and are named '''Special.php''' (first character of "" should be capitalized). Whatever you use as the "*" becomes the variable-name for the new page; I'll use "Tester" as an example.		# Copy an existing Special page to use as a template; they are in the '''includes/''' folder, and are named '''Special.php''' (first character of "" should be capitalized). Whatever you use as the "*" becomes the variable-name for the new page; I'll use "Tester" as an example.
	# The new Special page must define a function called "wfSpecial*()" ("wfSpecialTester()" in this example). It calls a function ending in _gen(), which must also be uniquely named among all the Special pages, so naming it "wfSpecialTester_gen()" is a good custom. Note that the calls to the _gen() function must also be changed to the new name (there are two of them in wfSpecialTester()).		# The new Special page must define a function called "wfSpecial*()" ("wfSpecialTester()" in this example).
	# Edit SpecialPage.php and add a line to the initialization of the $wgSpecialPages array:		# Edit SpecialPage.php and add a line to the initialization of the $wgSpecialPages array:
	'Tester' => new SpecialPage( 'Tester' ),		'Tester' => new SpecialPage( 'Tester' ),

Woozle: /* Instructions */ oh, yeah, and now you can actually customize the code.

2006-11-12T23:14:38Z

Instructions: oh, yeah, and now you can actually customize the code.

← Older revision		Revision as of 23:14, 12 November 2006
Line 9:		Line 9:
	'Tester' => new SpecialPage( 'Tester' ),		'Tester' => new SpecialPage( 'Tester' ),
	# Create a new page called '''Mediawiki:Tester'''; its contents become the title of the new page. This title will show up in [[Special:Specialpages]], too.		# Create a new page called '''Mediawiki:Tester'''; its contents become the title of the new page. This title will show up in [[Special:Specialpages]], too.
			# Now you can modify the code in SpecialTester.php to do whatever it was you wanted to do.

	''Note for MediaWiki developers: see how the insertion of a code-block in the above list breaks the numbering, even though there are no blank lines? We need some way to prevent that, or at least to hard-code the initial number in a sequence.''		''Note for MediaWiki developers: see how the insertion of a code-block in the above list breaks the numbering, even though there are no blank lines? We need some way to prevent that, or at least to hard-code the initial number in a sequence.''

Woozle: also need to change code in the new page

2006-11-12T23:13:47Z

also need to change code in the new page

← Older revision		Revision as of 23:13, 12 November 2006
Line 4:		Line 4:
	This procedure was determined by experimentation; there doesn't seem to be any official documentation yet.		This procedure was determined by experimentation; there doesn't seem to be any official documentation yet.

	# Copy an existing Special page to use as a template; they are in the '''includes/'' folder, and are named '''Special.php''' (first character of "" should be capitalized). Whatever you use as the "*" becomes the variable-name for the new page; I'll use "Tester" as an example.		# Copy an existing Special page to use as a template; they are in the '''includes/''' folder, and are named '''Special.php''' (first character of "" should be capitalized). Whatever you use as the "*" becomes the variable-name for the new page; I'll use "Tester" as an example.
			# The new Special page must define a function called "wfSpecial*()" ("wfSpecialTester()" in this example). It calls a function ending in _gen(), which must also be uniquely named among all the Special pages, so naming it "wfSpecialTester_gen()" is a good custom. Note that the calls to the _gen() function must also be changed to the new name (there are two of them in wfSpecialTester()).
	# Edit SpecialPage.php and add a line to the initialization of the $wgSpecialPages array:		# Edit SpecialPage.php and add a line to the initialization of the $wgSpecialPages array:
	'Tester' => new SpecialPage( 'Tester' ),		'Tester' => new SpecialPage( 'Tester' ),

Woozle at 23:07, 12 November 2006

2006-11-12T23:07:17Z

New page

=={{hide|Navigation}}==
[[computing]]: [[software]]: [[wiki]]: [[MediaWiki]]: [[creating a custom Special page in MediaWiki|creating a custom Special page]]
==Instructions==
This procedure was determined by experimentation; there doesn't seem to be any official documentation yet.

# Copy an existing Special page to use as a template; they are in the '''includes/'' folder, and are named '''Special*.php''' (first character of "*" should be capitalized). Whatever you use as the "*" becomes the variable-name for the new page; I'll use "Tester" as an example.
# Edit SpecialPage.php and add a line to the initialization of the $wgSpecialPages array:
'Tester' => new SpecialPage( 'Tester' ),
# Create a new page called '''Mediawiki:Tester'''; its contents become the title of the new page. This title will show up in [[Special:Specialpages]], too.

''Note for MediaWiki developers: see how the insertion of a code-block in the above list breaks the numbering, even though there are no blank lines? We need some way to prevent that, or at least to hard-code the initial number in a sequence.''