Module:Convert/tester/doc - Revision history

BrandonXLF: Remove confusing sort key for Category:Modules for test tools

2024-09-01T22:28:26Z

Remove confusing sort key for Category:Modules for test tools

← Previous revision		Revision as of 22:28, 1 September 2024
Line 169:		Line 169:

	<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox\|\|		<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox\|\|
	[[Category:Modules for test tools~~\|Test tools, {{PAGENAME}}~~]]		[[Category:Modules for test tools]]
	[[Category:Modules that check for strip markers‎]]		[[Category:Modules that check for strip markers‎]]
	}}</includeonly><noinclude>		}}</includeonly><noinclude>

Warudo: Added the page to :Category:Module documentation pages

2024-08-29T20:54:38Z

Added the page to Category:Module documentation pages

← Previous revision		Revision as of 20:54, 29 August 2024
Line 171:		Line 171:
	[[Category:Modules for test tools\|Test tools, {{PAGENAME}}]]		[[Category:Modules for test tools\|Test tools, {{PAGENAME}}]]
	[[Category:Modules that check for strip markers‎]]		[[Category:Modules that check for strip markers‎]]
	}}</includeonly>		}}</includeonly><noinclude>
			[[Category:Module documentation pages]]
			</noinclude>

IznoRepeat: /* Comparing a module with its sandbox */phab:T337149#8953569, replaced: [// → [https:// (3)

2023-07-25T22:46:56Z

Comparing a module with its sandbox: phab:T337149#8953569, replaced: [// → [https:// (3)

← Previous revision		Revision as of 22:46, 25 July 2023
Line 158:		Line 158:

	The following text is a sample showing output that may result from the above.		The following text is a sample showing output that may result from the above.
	*[[Module:Convert]] • [[Module:Convert/sandbox]] • <span style="color:darkred;">different</span> (<span class="plainlinks">[//en.wikipedia.org/w/index.php?title=Special%3AComparePages&page1=Module%3AConvert&page2=Module%3AConvert%2Fsandbox diff]</span>)		*[[Module:Convert]] • [[Module:Convert/sandbox]] • <span style="color:darkred;">different</span> (<span class="plainlinks">[https://en.wikipedia.org/w/index.php?title=Special%3AComparePages&page1=Module%3AConvert&page2=Module%3AConvert%2Fsandbox diff]</span>)
	*[[Module:Convert/data]] • [[Module:Convert/data/sandbox]] • <span style="color:green;">same content</span>		*[[Module:Convert/data]] • [[Module:Convert/data/sandbox]] • <span style="color:green;">same content</span>
	*[[Module:Convert/text]] • [[Module:Convert/text/sandbox]] • <span style="color:darkred;">different</span> (<span class="plainlinks">[//en.wikipedia.org/w/index.php?title=Special%3AComparePages&page1=Module%3AConvert%2Ftext&page2=Module%3AConvert%2Ftext%2Fsandbox diff]</span>)		*[[Module:Convert/text]] • [[Module:Convert/text/sandbox]] • <span style="color:darkred;">different</span> (<span class="plainlinks">[https://en.wikipedia.org/w/index.php?title=Special%3AComparePages&page1=Module%3AConvert%2Ftext&page2=Module%3AConvert%2Ftext%2Fsandbox diff]</span>)
	*[[Module:Convert/extra]] • [[Module:Convert/extra/sandbox]] • <span style="color:darkred;">different</span> (<span class="plainlinks">[//en.wikipedia.org/w/index.php?title=Special%3AComparePages&page1=Module%3AConvert%2Fextra&page2=Module%3AConvert%2Fextra%2Fsandbox diff]</span>)		*[[Module:Convert/extra]] • [[Module:Convert/extra/sandbox]] • <span style="color:darkred;">different</span> (<span class="plainlinks">[https://en.wikipedia.org/w/index.php?title=Special%3AComparePages&page1=Module%3AConvert%2Fextra&page2=Module%3AConvert%2Fextra%2Fsandbox diff]</span>)

	By default, each output line is prefixed with '<code>*</code>' to give a bulleted list. An alternative prefix can be specified with the <code>prefix</code> parameter. For example, the following gives an indented bulleted list.		By default, each output line is prefixed with '<code>*</code>' to give a bulleted list. An alternative prefix can be specified with the <code>prefix</code> parameter. For example, the following gives an indented bulleted list.

Uzume: syntaxhighlight lua code

2023-02-09T02:13:16Z

syntaxhighlight lua code

← Previous revision		Revision as of 02:13, 9 February 2023
Line 15:		Line 15:

	The testcases module page (for example, [[Module:Convert/sandbox/testcases]]) may contain:		The testcases module page (for example, [[Module:Convert/sandbox/testcases]]) may contain:
			<syntaxhighlight lang=lua>
	<pre>
	local tests = [==[		local tests = [==[

Line 29:		Line 29:
	p.tests = tests		p.tests = tests
	return p		return p
			</syntaxhighlight>
	</pre>

	If wanted, the tests can be run using a template different from the one specified in the tests. For example, the following would run the tests from [[Module:Convert/sandbox/testcases]], but would change the name of each template found on that page to "<code>convert/sandbox2</code>".		If wanted, the tests can be run using a template different from the one specified in the tests. For example, the following would run the tests from [[Module:Convert/sandbox/testcases]], but would change the name of each template found on that page to "<code>convert/sandbox2</code>".
Line 42:		Line 42:

	The templates do not have to be the same, for example, the following tests would work:		The templates do not have to be the same, for example, the following tests would work:
			<syntaxhighlight lang=lua>
	<pre>
	local tests = [==[		local tests = [==[

Line 51:		Line 51:

	]==]		]==]
			</syntaxhighlight>
	</pre>

	In the results, the status column shows "Pass" if the output from the template exactly matches the expected text. If there is no expected text, the template output is shown in the Actual column with a blank status. If the given expected text differs from the template output, the template output is shown in the Actual column with status "Fail", and the number of fails is shown at the top of the page. Searching the page for "Fail" will find each problem. Any "Fail" result is followed by a row showing the nowiki actual and expected wikitext.		In the results, the status column shows "Pass" if the output from the template exactly matches the expected text. If there is no expected text, the template output is shown in the Actual column with a blank status. If the given expected text differs from the template output, the template output is shown in the Actual column with status "Fail", and the number of fails is shown at the top of the page. Searching the page for "Fail" will find each problem. Any "Fail" result is followed by a row showing the nowiki actual and expected wikitext.
Line 75:		Line 75:

	Instead of specifying the tests with a multiline string, it is possible to assign a table to <code>p.tests</code> as shown in the following testcases module.		Instead of specifying the tests with a multiline string, it is possible to assign a table to <code>p.tests</code> as shown in the following testcases module.
			<syntaxhighlight lang=lua>
	<pre>
	local tests = {		local tests = {
	-- Each test item is of form { template, expected }.		-- Each test item is of form { template, expected }.
Line 88:		Line 88:
	p.tests = tests		p.tests = tests
	return p		return p
			</syntaxhighlight>
	</pre>

	This example provides the same results as the multiline string at "Mixed tests" above.		This example provides the same results as the multiline string at "Mixed tests" above.

Izno: add cat

2021-12-25T23:54:25Z

add cat

← Previous revision		Revision as of 23:54, 25 December 2021
Line 170:		Line 170:
	<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox\|\|		<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox\|\|
	[[Category:Modules for test tools\|Test tools, {{PAGENAME}}]]		[[Category:Modules for test tools\|Test tools, {{PAGENAME}}]]
			[[Category:Modules that check for strip markers‎]]
	}}</includeonly>		}}</includeonly>

Johnuniq: update

2021-10-27T06:46:23Z

update

← Previous revision		Revision as of 06:46, 27 October 2021
Line 152:		Line 152:
	It is also possible for a module to define pairs of page titles in <code>p.pairs</code> (a table), and to use the tester module to generate a table for each pair of titles.		It is also possible for a module to define pairs of page titles in <code>p.pairs</code> (a table), and to use the tester module to generate a table for each pair of titles.

		⚫	As a convenience, certain keywords are defined. If a keyword is recognized, the list of pairs comes from the module rather than the parameters. For example, the following uses the "convert" keyword to get the list of pairs of pages related to Module:Convert.
	The result will be a bulleted list, with each lines starting by '*' and ending by a newline for each pair of compared pages.

	The input lists of pairs may also include items that are a string (instead of a table specifying the pair of pages to compare). That string, which can contain any wikitext, will be output as is as a separate line in the result. You can use it to split a long list into sections with some headings. You can also use it to insert one or more comment lines after the results of comparing a pair (just use a static string starting by '*:' to not break the list, and to indent that comment below). For example it is expected that a sandbox should be different from the non-sandbox version of a template if they are only used to call a module and the only difference should be the name of the sandbox module instead of the normal version of that module.

⚫	As a convenience, certain keywords are defined in ~~this~~ ~~module: if one of them~~ is recognized, ~~then~~ the ~~actual~~ list of ~~pair~~ comes from the module ~~itself~~ ~~and~~ ~~you~~ ~~don't need to specify a list of pairs~~. For example, the following uses the "convert" keyword to get the list of pairs of pages related to ~~the~~ Module:Convert.
	<pre>		<pre>
	{{#invoke:convert/tester\|compare\|convert}}		{{#invoke:convert/tester\|compare\|convert}}
Line 167:		Line 163:
	*[[Module:Convert/extra]] • [[Module:Convert/extra/sandbox]] • <span style="color:darkred;">different</span> (<span class="plainlinks">[//en.wikipedia.org/w/index.php?title=Special%3AComparePages&page1=Module%3AConvert%2Fextra&page2=Module%3AConvert%2Fextra%2Fsandbox diff]</span>)		*[[Module:Convert/extra]] • [[Module:Convert/extra/sandbox]] • <span style="color:darkred;">different</span> (<span class="plainlinks">[//en.wikipedia.org/w/index.php?title=Special%3AComparePages&page1=Module%3AConvert%2Fextra&page2=Module%3AConvert%2Fextra%2Fsandbox diff]</span>)

			By default, each output line is prefixed with '<code>*</code>' to give a bulleted list. An alternative prefix can be specified with the <code>prefix</code> parameter. For example, the following gives an indented bulleted list.
			<pre>
			{{#invoke:convert/tester\|compare\|convert\|prefix=:*}}
			</pre>

	<!-- Category -->
	<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox\|\|		<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox\|\|

	[[Category:Modules for test tools\|Test tools, {{PAGENAME}}]]		[[Category:Modules for test tools\|Test tools, {{PAGENAME}}]]

	}}</includeonly>		}}</includeonly>

Verdy p: /* Comparing a module with its sandbox */

2018-10-30T19:26:28Z

Comparing a module with its sandbox

← Previous revision		Revision as of 19:26, 30 October 2018
Line 156:		Line 156:
	The input lists of pairs may also include items that are a string (instead of a table specifying the pair of pages to compare). That string, which can contain any wikitext, will be output as is as a separate line in the result. You can use it to split a long list into sections with some headings. You can also use it to insert one or more comment lines after the results of comparing a pair (just use a static string starting by '*:' to not break the list, and to indent that comment below). For example it is expected that a sandbox should be different from the non-sandbox version of a template if they are only used to call a module and the only difference should be the name of the sandbox module instead of the normal version of that module.		The input lists of pairs may also include items that are a string (instead of a table specifying the pair of pages to compare). That string, which can contain any wikitext, will be output as is as a separate line in the result. You can use it to split a long list into sections with some headings. You can also use it to insert one or more comment lines after the results of comparing a pair (just use a static string starting by '*:' to not break the list, and to indent that comment below). For example it is expected that a sandbox should be different from the non-sandbox version of a template if they are only used to call a module and the only difference should be the name of the sandbox module instead of the normal version of that module.

	As a convenience, certain keywords are defined. For example, the following uses the "convert" keyword.		As a convenience, certain keywords are defined in this module: if one of them is recognized, then the actual list of pair comes from the module itself and you don't need to specify a list of pairs. For example, the following uses the "convert" keyword to get the list of pairs of pages related to the Module:Convert.
	<pre>		<pre>
	{{#invoke:convert/tester\|compare\|convert}}		{{#invoke:convert/tester\|compare\|convert}}

Verdy p: /* Comparing a module with its sandbox */

2018-10-30T19:23:18Z

Comparing a module with its sandbox

← Previous revision		Revision as of 19:23, 30 October 2018
Line 154:		Line 154:
	The result will be a bulleted list, with each lines starting by '*' and ending by a newline for each pair of compared pages.		The result will be a bulleted list, with each lines starting by '*' and ending by a newline for each pair of compared pages.

	The input lists of pairs may also include items that are a string (instead of a table specifying the pair of pages to compare). That string, which can contain any wikitext, will be output as is as a separate line in the result. You can use it to split a long list into sections with some headings. You can also use it to insert one or more comment lines after the results of comparing a pair (just use a static string starting by '*:' to not break the list, and to indent that comment below).		The input lists of pairs may also include items that are a string (instead of a table specifying the pair of pages to compare). That string, which can contain any wikitext, will be output as is as a separate line in the result. You can use it to split a long list into sections with some headings. You can also use it to insert one or more comment lines after the results of comparing a pair (just use a static string starting by '*:' to not break the list, and to indent that comment below). For example it is expected that a sandbox should be different from the non-sandbox version of a template if they are only used to call a module and the only difference should be the name of the sandbox module instead of the normal version of that module.

	As a convenience, certain keywords are defined. For example, the following uses the "convert" keyword.		As a convenience, certain keywords are defined. For example, the following uses the "convert" keyword.

Verdy p: /* Comparing a module with its sandbox */

2018-10-30T19:20:11Z

Comparing a module with its sandbox

← Previous revision		Revision as of 19:20, 30 October 2018
Line 151:		Line 151:

	It is also possible for a module to define pairs of page titles in <code>p.pairs</code> (a table), and to use the tester module to generate a table for each pair of titles.		It is also possible for a module to define pairs of page titles in <code>p.pairs</code> (a table), and to use the tester module to generate a table for each pair of titles.

			The result will be a bulleted list, with each lines starting by '*' and ending by a newline for each pair of compared pages.

			The input lists of pairs may also include items that are a string (instead of a table specifying the pair of pages to compare). That string, which can contain any wikitext, will be output as is as a separate line in the result. You can use it to split a long list into sections with some headings. You can also use it to insert one or more comment lines after the results of comparing a pair (just use a static string starting by '*:' to not break the list, and to indent that comment below).

	As a convenience, certain keywords are defined. For example, the following uses the "convert" keyword.		As a convenience, certain keywords are defined. For example, the following uses the "convert" keyword.

～ (Nyoro) at 07:03, 3 May 2016

2016-05-03T07:03:37Z

← Previous revision		Revision as of 07:03, 3 May 2016
Line 162:		Line 162:
	*[[Module:Convert/text]] • [[Module:Convert/text/sandbox]] • <span style="color:darkred;">different</span> (<span class="plainlinks">[//en.wikipedia.org/w/index.php?title=Special%3AComparePages&page1=Module%3AConvert%2Ftext&page2=Module%3AConvert%2Ftext%2Fsandbox diff]</span>)		*[[Module:Convert/text]] • [[Module:Convert/text/sandbox]] • <span style="color:darkred;">different</span> (<span class="plainlinks">[//en.wikipedia.org/w/index.php?title=Special%3AComparePages&page1=Module%3AConvert%2Ftext&page2=Module%3AConvert%2Ftext%2Fsandbox diff]</span>)
	*[[Module:Convert/extra]] • [[Module:Convert/extra/sandbox]] • <span style="color:darkred;">different</span> (<span class="plainlinks">[//en.wikipedia.org/w/index.php?title=Special%3AComparePages&page1=Module%3AConvert%2Fextra&page2=Module%3AConvert%2Fextra%2Fsandbox diff]</span>)		*[[Module:Convert/extra]] • [[Module:Convert/extra/sandbox]] • <span style="color:darkred;">different</span> (<span class="plainlinks">[//en.wikipedia.org/w/index.php?title=Special%3AComparePages&page1=Module%3AConvert%2Fextra&page2=Module%3AConvert%2Fextra%2Fsandbox diff]</span>)


			<!-- Category -->
			<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox\|\|

			[[Category:Modules for test tools\|Test tools, {{PAGENAME}}]]

			}}</includeonly>