Module:TrainingPages/doc - Revision history

Pppery: Bump rating

2023-11-19T02:05:02Z

Bump rating

← Previous revision		Revision as of 02:05, 19 November 2023
Line 1:		Line 1:
	{{Module rating\|~~alpha~~}}		{{Module rating\|protected}}
	This module is intended to accept the name of a page (defaulting to the page currently being displayed), look it up in an index of pages, step forward or backward by some number of pages (usually 1), and give back the name of the page at that position.		This module is intended to accept the name of a page (defaulting to the page currently being displayed), look it up in an index of pages, step forward or backward by some number of pages (usually 1), and give back the name of the page at that position.

Line 14:		Line 14:

	*next_page: the next page on the index list		*next_page: the next page on the index list

	*last_page: the preceding page on the index list		*last_page: the preceding page on the index list

	*page_number: the number the page indicated is in the list		*page_number: the number the page indicated is in the list

	*total_pages: the total number of pages in the index		*total_pages: the total number of pages in the index

	*main: allows you to flip forward or backward an arbitrary number of pages		*main: allows you to flip forward or backward an arbitrary number of pages

Line 27:		Line 23:

	* ''page'' is the page you are starting from (the one you're looking up in the index)		* ''page'' is the page you are starting from (the one you're looking up in the index)
		⚫	** if ''page'' is blank or omitted, the mw.title.getCurrentTitle() function is used to locate the current page. (So far as I know, this is always the page that matters, the one everything ultimately gets transcluded to, not the template or module)

		⚫	** if ''page'' is a number and doesn't contain any text, the page that number of positions down in the index will be the base page used. With "main" and no displacement set, this returns the name of page#N. Otherwise you can have it return some number of pages off from that number, or the default page, as it would if the name of the page in that position had been entered as text.
⚫	:* if ''page'' is blank or omitted, the mw.title.getCurrentTitle() function is used to locate the current page. (So far as I know, this is always the page that matters, the one everything ultimately gets transcluded to, not the template or module)
⚫	:* if ''page'' is a number and doesn't contain any text, the page that number of positions down in the index will be the base page used. With "main" and no displacement set, this returns the name of page#N. Otherwise you can have it return some number of pages off from that number, or the default page, as it would if the name of the page in that position had been entered as text.

	* ''defaultpage'' is the page to be returned if there ''is'' no next page, previous page, or page displaced by n in the index. Can be blank, in which case the module output will be blank if this happens.		* ''defaultpage'' is the page to be returned if there ''is'' no next page, previous page, or page displaced by n in the index. Can be blank, in which case the module output will be blank if this happens.

	* ''index'' is the name of the index module with the list of all the pages. The pages should be in a list from beginning to end. There are three ways to format this:		* ''index'' is the name of the index module with the list of all the pages. The pages should be in a list from beginning to end. There are three ways to format this:
		⚫	** Index can be in ''module'' space (e.g. [[Module:TrainingPages/default index]]) in which case they must consist of ''return {'Name of first page','Name of second page','Name of third page''' ... etc.''}''.

		⚫	** Index can be in some other space, not in module format, in which case it need merely contain a list of Wikilinks in double square brackets. Everything outside the brackets is ignored, and every link in double square brackets is counted. The only limitation is that in this version anything in double square brackets is taken as a link, even if nowiki applies or it is in other brackets or has a newline in it or something that prevents it from appearing as a proper link. You can put a pair of nowiki or noninclude tags between the two opening square brackets as a kludge to avoid having this happen, if need be.
⚫	:* Index can be in ''module'' space (e.g. [[Module:TrainingPages/default index]]) in which case they must consist of ''return {'Name of first page','Name of second page','Name of third page''' ... etc.''}''.
		⚫	** (If omitted, the index still defaults to [[Module:TrainingPages/default index]], so common tasks might be added to it. However, no provision has been made to prevent from paging from one set into another, so unless this only sees use in one consistent overall set of trainingpages that is a bad idea unless upgraded.)
⚫	:* Index can be in some other space, not in module format, in which case it need merely contain a list of Wikilinks in double square brackets. Everything outside the brackets is ignored, and every link in double square brackets is counted. The only limitation is that in this version anything in double square brackets is taken as a link, even if nowiki applies or it is in other brackets or has a newline in it or something that prevents it from appearing as a proper link. You can put a pair of nowiki or noninclude tags between the two opening square brackets as a kludge to avoid having this happen, if need be.
⚫	:* (If omitted, the index still defaults to [[Module:TrainingPages/default index]], so common tasks might be added to it. However, no provision has been made to prevent from paging from one set into another, so unless this only sees use in one consistent overall set of trainingpages that is a bad idea unless upgraded.)

	* ''displacement'' specifies how many pages to go forward or back in the ''main'' module.		* ''displacement'' specifies how many pages to go forward or back in the ''main'' module.

	* ''noerr'' suppresses error messages if the index file can't be found; an empty string is returned.		* ''noerr'' suppresses error messages if the index file can't be found; an empty string is returned.
		⚫	* ''anonymize'' - any nonblank value causes project specific pages (Wikipedia:) to be returned as Project:
	<includeonly>		<includeonly>
	[[Category:Wikipedia training templates]]</includeonly>		[[Category:Wikipedia training templates]]</includeonly>

⚫	* ''anonymize'' - any nonblank value causes project specific pages (Wikipedia:) to be returned as Project:

Wnt at 01:09, 8 June 2013

2013-06-08T01:09:03Z

← Previous revision		Revision as of 01:09, 8 June 2013
Line 44:		Line 44:
	<includeonly>		<includeonly>
	[[Category:Wikipedia training templates]]</includeonly>		[[Category:Wikipedia training templates]]</includeonly>

			* ''anonymize'' - any nonblank value causes project specific pages (Wikipedia:) to be returned as Project:

Sage Ross (WMF): cat

2013-05-01T16:18:29Z

cat

← Previous revision		Revision as of 16:18, 1 May 2013
Line 42:		Line 42:

	* ''noerr'' suppresses error messages if the index file can't be found; an empty string is returned.		* ''noerr'' suppresses error messages if the index file can't be found; an empty string is returned.
			<includeonly>
			[[Category:Wikipedia training templates]]</includeonly>

Wnt: /* Parameters */

2013-04-25T04:18:50Z

Parameters

← Previous revision		Revision as of 04:18, 25 April 2013
Line 41:		Line 41:
	* ''displacement'' specifies how many pages to go forward or back in the ''main'' module.		* ''displacement'' specifies how many pages to go forward or back in the ''main'' module.

	* ''noerr'' suppresses error messages if the index file can't be found; an empty string is returned. ~~[[User:Wnt\|Wnt]] ([[User talk:Wnt\|talk]]) 04:18, 25 April 2013 (UTC)~~		* ''noerr'' suppresses error messages if the index file can't be found; an empty string is returned.

Wnt: /* Parameters */

2013-04-25T04:18:33Z

Parameters

← Previous revision		Revision as of 04:18, 25 April 2013
Line 40:		Line 40:

	* ''displacement'' specifies how many pages to go forward or back in the ''main'' module.		* ''displacement'' specifies how many pages to go forward or back in the ''main'' module.

			* ''noerr'' suppresses error messages if the index file can't be found; an empty string is returned. [[User:Wnt\|Wnt]] ([[User talk:Wnt\|talk]]) 04:18, 25 April 2013 (UTC)

Wnt: /* Parameters */

2013-04-25T04:17:39Z

Parameters

← Previous revision		Revision as of 04:17, 25 April 2013
Line 29:		Line 29:

	:* if ''page'' is blank or omitted, the mw.title.getCurrentTitle() function is used to locate the current page. (So far as I know, this is always the page that matters, the one everything ultimately gets transcluded to, not the template or module)		:* if ''page'' is blank or omitted, the mw.title.getCurrentTitle() function is used to locate the current page. (So far as I know, this is always the page that matters, the one everything ultimately gets transcluded to, not the template or module)
			:* if ''page'' is a number and doesn't contain any text, the page that number of positions down in the index will be the base page used. With "main" and no displacement set, this returns the name of page#N. Otherwise you can have it return some number of pages off from that number, or the default page, as it would if the name of the page in that position had been entered as text.

	* ''defaultpage'' is the page to be returned if there ''is'' no next page, previous page, or page displaced by n in the index. Can be blank, in which case the module output will be blank if this happens.		* ''defaultpage'' is the page to be returned if there ''is'' no next page, previous page, or page displaced by n in the index. Can be blank, in which case the module output will be blank if this happens.

Wnt at 14:32, 17 April 2013

2013-04-17T14:32:50Z

← Previous revision		Revision as of 14:32, 17 April 2013
Line 1:		Line 1:
			{{Module rating\|alpha}}
	This module is intended to accept the name of a page (defaulting to the page currently being displayed), look it up in an index of pages, step forward or backward by some number of pages (usually 1), and give back the name of the page at that position.		This module is intended to accept the name of a page (defaulting to the page currently being displayed), look it up in an index of pages, step forward or backward by some number of pages (usually 1), and give back the name of the page at that position.

Line 38:		Line 39:

	* ''displacement'' specifies how many pages to go forward or back in the ''main'' module.		* ''displacement'' specifies how many pages to go forward or back in the ''main'' module.
	[[Category:Modules in alpha]]

Wnt: Rating alpha

2013-04-16T23:05:10Z

Rating alpha

← Previous revision		Revision as of 23:05, 16 April 2013
Line 38:		Line 38:

	* ''displacement'' specifies how many pages to go forward or back in the ''main'' module.		* ''displacement'' specifies how many pages to go forward or back in the ''main'' module.
			[[Category:Modules in alpha]]

Wnt: Example. And ... Mlx is broken, somehow.

2013-03-27T05:48:21Z

Example. And ... Mlx is broken, somehow.

← Previous revision		Revision as of 05:48, 27 March 2013
Line 1:		Line 1:
	This module is intended to accept the name of a page (defaulting to the page currently being displayed), look it up in an index of pages, step forward or backward by some number of pages (usually 1), and give back the name of the page at that position.		This module is intended to accept the name of a page (defaulting to the page currently being displayed), look it up in an index of pages, step forward or backward by some number of pages (usually 1), and give back the name of the page at that position.

	Use {{Mlx\|TrainingPages\|''function''\|''parameters''}} to invoke		Use {{Mlx\|TrainingPages\|''function''\|''parameters''}} to invoke. For example:

			<code><nowiki>{{#invoke:TrainingPages\|last_page\|index=Wikipedia:Training/For students/Editing module index\|page=Wikipedia:Training/For students/Where to get help\|defaultpage=Wikipedia:Training/header}}</nowiki></code> yields:


			{{#invoke:TrainingPages\|last_page\|index=Wikipedia:Training/For students/Editing module index\|page=Wikipedia:Training/For students/Where to get help\|defaultpage=Wikipedia:Training/header}}

	== Functions==		== Functions==

Wnt: oops, those were the internal variable names

2013-03-27T05:45:35Z

oops, those were the internal variable names

← Previous revision		Revision as of 05:45, 27 March 2013
Line 20:		Line 20:
	(All parameters are available to every function, except ''displacement'' which only matters for main)		(All parameters are available to every function, except ''displacement'' which only matters for main)

	* ''~~currentpage~~'' is the page you are starting from (the one you're looking up in the index)		* ''page'' is the page you are starting from (the one you're looking up in the index)

	:* if ~~currentpage~~ is blank or omitted, the mw.title.getCurrentTitle() function is used to locate the current page. (So far as I know, this is always the page that matters, the one everything ultimately gets transcluded to, not the template or module)		:* if ''page'' is blank or omitted, the mw.title.getCurrentTitle() function is used to locate the current page. (So far as I know, this is always the page that matters, the one everything ultimately gets transcluded to, not the template or module)

	* ''defaultpage'' is the page to be returned if there ''is'' no next page, previous page, or page displaced by n in the index. Can be blank, in which case the module output will be blank if this happens.		* ''defaultpage'' is the page to be returned if there ''is'' no next page, previous page, or page displaced by n in the index. Can be blank, in which case the module output will be blank if this happens.

	* ''~~indexmodule~~'' is the name of the index module with the list of all the pages. The pages should be in a list from beginning to end. There are three ways to format this:		* ''index'' is the name of the index module with the list of all the pages. The pages should be in a list from beginning to end. There are three ways to format this:

	:* ~~Indexmodule~~ can be in ''module'' space (e.g. [[Module:TrainingPages/default index]]) in which case they must consist of ''return {'Name of first page','Name of second page','Name of third page''' ... etc.''}''.		:* Index can be in ''module'' space (e.g. [[Module:TrainingPages/default index]]) in which case they must consist of ''return {'Name of first page','Name of second page','Name of third page''' ... etc.''}''.
	:* ~~Indexmodule~~ can be in some other space, not in module format, in which case it need merely contain a list of Wikilinks in double square brackets. Everything outside the brackets is ignored, and every link in double square brackets is counted. The only limitation is that in this version anything in double square brackets is taken as a link, even if nowiki applies or it is in other brackets or has a newline in it or something that prevents it from appearing as a proper link. You can put a pair of nowiki or noninclude tags between the two opening square brackets as a kludge to avoid having this happen, if need be.		:* Index can be in some other space, not in module format, in which case it need merely contain a list of Wikilinks in double square brackets. Everything outside the brackets is ignored, and every link in double square brackets is counted. The only limitation is that in this version anything in double square brackets is taken as a link, even if nowiki applies or it is in other brackets or has a newline in it or something that prevents it from appearing as a proper link. You can put a pair of nowiki or noninclude tags between the two opening square brackets as a kludge to avoid having this happen, if need be.
	:* (If omitted, the ~~indexmodule~~ still defaults to [[Module:TrainingPages/default index]], so common tasks might be added to it. However, no provision has been made to prevent from paging from one set into another, so unless this only sees use in one consistent overall set of trainingpages that is a bad idea unless upgraded.)		:* (If omitted, the index still defaults to [[Module:TrainingPages/default index]], so common tasks might be added to it. However, no provision has been made to prevent from paging from one set into another, so unless this only sees use in one consistent overall set of trainingpages that is a bad idea unless upgraded.)

	* ''displacement'' specifies how many pages to go forward or back in the ''main'' module.		* ''displacement'' specifies how many pages to go forward or back in the ''main'' module.