Module:Wikitext Parsing/doc - Revision history

64.114 etc at 02:28, 19 October 2024

2024-10-19T02:28:20Z

← Previous revision		Revision as of 02:28, 19 October 2024
Line 1:		Line 1:
	{{High risk}}		{{High risk}}
			{{cascade-protected template\|page=module}}

	This module provides some functions to help with the potential complex situation involved in modules like [[Module:Template parameter value]], which intend to process the raw wikitext of a page and want to respect nowiki tags or similar reliably. This module is designed only to be called by other modules.		This module provides some functions to help with the potential complex situation involved in modules like [[Module:Template parameter value]], which intend to process the raw wikitext of a page and want to respect nowiki tags or similar reliably. This module is designed only to be called by other modules.

MSGJ: /* ParseTemplates */ don't think chronological is the right word here

2024-07-02T09:00:28Z

ParseTemplates: don't think chronological is the right word here

← Previous revision		Revision as of 09:00, 2 July 2024
Line 13:		Line 13:
	== ParseTemplates ==		== ParseTemplates ==
	{{Module rating\|beta}}		{{Module rating\|beta}}
	<code>ParseTemplates(InputText, dontEscape)</code> will attempt to parse all <code><nowiki>{{Templates}}</nowiki></code> on a page, handling multiple factors such as <code><nowiki>[[Wikilinks]]</nowiki></code> and <code><nowiki>{{{Variables}}}</nowiki></code> among other complex syntax. Due to the complexity of the function, it is considerably slow, and should be used carefully. The function returns a list of template objects in ~~chronological~~ order, which have the following properties:		<code>ParseTemplates(InputText, dontEscape)</code> will attempt to parse all <code><nowiki>{{Templates}}</nowiki></code> on a page, handling multiple factors such as <code><nowiki>[[Wikilinks]]</nowiki></code> and <code><nowiki>{{{Variables}}}</nowiki></code> among other complex syntax. Due to the complexity of the function, it is considerably slow, and should be used carefully. The function returns a list of template objects in order of appearance, which have the following properties:
	* '''Args''': A key-value set of arguments, not in ~~chronological~~ order		* '''Args''': A key-value set of arguments, not in order
	* '''ArgOrder''': A list of keys in the ~~chronological~~ order they appear in the template		* '''ArgOrder''': A list of keys in the order they appear in the template
	* '''Children''': A list of template objects ~~in chronological order~~ that are contained within the existing template. Only immediate children are listed		* '''Children''': A list of template objects that are contained within the existing template, in order of appearance. Only immediate children are listed
	* '''Name''': The name of the template		* '''Name''': The name of the template
	* '''Text''': The raw text of the template		* '''Text''': The raw text of the template

Aidan9382: try to rewrite first bit

2024-02-07T22:54:32Z

try to rewrite first bit

← Previous revision		Revision as of 22:54, 7 February 2024
Line 1:		Line 1:
	{{High risk}}		{{High risk}}

	This module provides some functions to help with the ~~rare~~ ~~processing~~ ~~mistake~~ involved in modules like [[Module:Template parameter value]], which intend to ~~parse~~ the raw wikitext of a page. ~~This~~ ~~module is not~~ to be ~~used~~ in ~~#invoke:~~ ~~calls,~~ as ~~there's~~ no ~~use~~ in ~~doing~~ ~~so. All text will~~ be ~~handled~~ by ~~MediaWiki~~ ~~before reaching the module anyways, and there will likely be no meaningful output~~.		This module provides some functions to help with the potential complex situation involved in modules like [[Module:Template parameter value]], which intend to process the raw wikitext of a page and want to respect nowiki tags or similar reliably. This module is designed only to be called by other modules.

	== PrepareText ==		== PrepareText ==

MSGJ: /* PrepareText */ ce

2024-01-25T09:41:26Z

PrepareText: ce

← Previous revision		Revision as of 09:41, 25 January 2024
Line 7:		Line 7:
	<code>PrepareText(text, keepComments)</code> will run any content within certain tags that disable processing ({{tag\|nowiki\|o}}, {{tag\|pre\|o}}, {{tag\|syntaxhighlight\|o}}, {{tag\|source\|o}}, {{tag\|math\|o}}) through mw.text.nowiki and remove HTML comments to avoid irrelevant text being processed by modules, allowing tricky syntax to be parsed through more basic means such as <code>%b{}</code>.		<code>PrepareText(text, keepComments)</code> will run any content within certain tags that disable processing ({{tag\|nowiki\|o}}, {{tag\|pre\|o}}, {{tag\|syntaxhighlight\|o}}, {{tag\|source\|o}}, {{tag\|math\|o}}) through mw.text.nowiki and remove HTML comments to avoid irrelevant text being processed by modules, allowing tricky syntax to be parsed through more basic means such as <code>%b{}</code>.

	If the second parameter, <code>keepComments</code>, is set to true, the content of HTML comments will be passed through mw.text.nowiki instead of being ~~removing~~ entirely.		If the second parameter, <code>keepComments</code>, is set to true, the content of HTML comments will be passed through mw.text.nowiki instead of being removed entirely.

	Any code using this function directly should consider using mw.text.decode to correct the output at the end if part of the processed text is returned, though this will also decode any input that was encoded but not inside a no-processing tag, which likely isn't a significant issue but still something worth considering.		Any code using this function directly should consider using mw.text.decode to correct the output at the end if part of the processed text is returned, though this will also decode any input that was encoded but not inside a no-processing tag, which likely isn't a significant issue but still something worth considering.

Aidan9382: clarify

2023-11-29T08:12:13Z

clarify

← Previous revision		Revision as of 08:12, 29 November 2023
Line 9:		Line 9:
	If the second parameter, <code>keepComments</code>, is set to true, the content of HTML comments will be passed through mw.text.nowiki instead of being removing entirely.		If the second parameter, <code>keepComments</code>, is set to true, the content of HTML comments will be passed through mw.text.nowiki instead of being removing entirely.

	Any code using this function directly should consider using mw.text.decode to correct ~~their~~ output at the end, though this will also decode any input that was encoded but not inside a no-processing tag, which likely isn't a significant issue but still something worth considering.		Any code using this function directly should consider using mw.text.decode to correct the output at the end if part of the processed text is returned, though this will also decode any input that was encoded but not inside a no-processing tag, which likely isn't a significant issue but still something worth considering.

	== ParseTemplates ==		== ParseTemplates ==

Aidan9382: like or

2023-11-29T08:10:17Z

like or

← Previous revision		Revision as of 08:10, 29 November 2023
Line 1:		Line 1:
	{{High risk}}		{{High risk}}

	This module provides some functions to help with the rare processing mistake involved in modules like or [[Module:Template parameter value]], which intend to parse the raw wikitext of a page. This module is not to be used in #invoke: calls, as there's no use in doing so. All text will be handled by MediaWiki before reaching the module anyways, and there will likely be no meaningful output.		This module provides some functions to help with the rare processing mistake involved in modules like [[Module:Template parameter value]], which intend to parse the raw wikitext of a page. This module is not to be used in #invoke: calls, as there's no use in doing so. All text will be handled by MediaWiki before reaching the module anyways, and there will likely be no meaningful output.

	== PrepareText ==		== PrepareText ==

Aidan9382: wording changes

2023-11-29T07:33:05Z

wording changes

← Previous revision		Revision as of 07:33, 29 November 2023
Line 1:		Line 1:
	{{High risk}}		{{High risk}}

	This module provides some functions to help with the rare processing ~~error~~ involved in modules like ~~[[Module:Transcluder]]'s <code>getParameters()</code>~~ or [[Module:Template parameter value]], which intend to parse the raw wikitext of a page. This module is not to be used in #invoke: calls, as there's no use in doing so. All text will be handled by MediaWiki before reaching the module anyways, and there will likely be no meaningful output.		This module provides some functions to help with the rare processing mistake involved in modules like or [[Module:Template parameter value]], which intend to parse the raw wikitext of a page. This module is not to be used in #invoke: calls, as there's no use in doing so. All text will be handled by MediaWiki before reaching the module anyways, and there will likely be no meaningful output.

	== PrepareText ==		== PrepareText ==

Aidan9382: /* ParseTemplates */ double s

2023-07-05T10:26:42Z

ParseTemplates: double s

← Previous revision		Revision as of 10:26, 5 July 2023
Line 16:		Line 16:
	* '''Args''': A key-value set of arguments, not in chronological order		* '''Args''': A key-value set of arguments, not in chronological order
	* '''ArgOrder''': A list of keys in the chronological order they appear in the template		* '''ArgOrder''': A list of keys in the chronological order they appear in the template
	* '''Children''': A list of template ~~objectss~~ in chronological order that are contained within the existing template. Only immediate children are listed		* '''Children''': A list of template objects in chronological order that are contained within the existing template. Only immediate children are listed
	* '''Name''': The name of the template		* '''Name''': The name of the template
	* '''Text''': The raw text of the template		* '''Text''': The raw text of the template

Aidan9382: release not ready

2023-06-24T20:44:24Z

release not ready

← Previous revision		Revision as of 20:44, 24 June 2023
Line 4:		Line 4:

	== PrepareText ==		== PrepareText ==
	{{Module rating\|~~ready~~}}		{{Module rating\|release}}
	<code>PrepareText(text, keepComments)</code> will run any content within certain tags that disable processing ({{tag\|nowiki\|o}}, {{tag\|pre\|o}}, {{tag\|syntaxhighlight\|o}}, {{tag\|source\|o}}, {{tag\|math\|o}}) through mw.text.nowiki and remove HTML comments to avoid irrelevant text being processed by modules, allowing tricky syntax to be parsed through more basic means such as <code>%b{}</code>.		<code>PrepareText(text, keepComments)</code> will run any content within certain tags that disable processing ({{tag\|nowiki\|o}}, {{tag\|pre\|o}}, {{tag\|syntaxhighlight\|o}}, {{tag\|source\|o}}, {{tag\|math\|o}}) through mw.text.nowiki and remove HTML comments to avoid irrelevant text being processed by modules, allowing tricky syntax to be parsed through more basic means such as <code>%b{}</code>.

Aidan9382: better idea

2023-06-24T20:43:57Z

better idea

← Previous revision		Revision as of 20:43, 24 June 2023
Line 1:		Line 1:
	{{High risk}}		{{High risk}}
⚫	{{Module rating\|beta}}

	This module provides some functions to help with the rare processing error involved in modules like [[Module:Transcluder]]'s <code>getParameters()</code> or [[Module:Template parameter value]], which intend to parse the raw wikitext of a page. This module is not to be used in #invoke: calls, as there's no use in doing so. All text will be handled by MediaWiki before reaching the module anyways, and there will likely be no meaningful output.		This module provides some functions to help with the rare processing error involved in modules like [[Module:Transcluder]]'s <code>getParameters()</code> or [[Module:Template parameter value]], which intend to parse the raw wikitext of a page. This module is not to be used in #invoke: calls, as there's no use in doing so. All text will be handled by MediaWiki before reaching the module anyways, and there will likely be no meaningful output.

	== PrepareText ==		== PrepareText ==
			{{Module rating\|ready}}
	<code>PrepareText(text, keepComments)</code> will run any content within certain tags that disable processing ({{tag\|nowiki\|o}}, {{tag\|pre\|o}}, {{tag\|syntaxhighlight\|o}}, {{tag\|source\|o}}, {{tag\|math\|o}}) through mw.text.nowiki and remove HTML comments to avoid irrelevant text being processed by modules, allowing tricky syntax to be parsed through more basic means such as <code>%b{}</code>.		<code>PrepareText(text, keepComments)</code> will run any content within certain tags that disable processing ({{tag\|nowiki\|o}}, {{tag\|pre\|o}}, {{tag\|syntaxhighlight\|o}}, {{tag\|source\|o}}, {{tag\|math\|o}}) through mw.text.nowiki and remove HTML comments to avoid irrelevant text being processed by modules, allowing tricky syntax to be parsed through more basic means such as <code>%b{}</code>.

Line 12:		Line 12:

	== ParseTemplates ==		== ParseTemplates ==
		⚫	{{Module rating\|beta}}
	<code>ParseTemplates(InputText, dontEscape)</code> will attempt to parse all <code><nowiki>{{Templates}}</nowiki></code> on a page, handling multiple factors such as <code><nowiki>[[Wikilinks]]</nowiki></code> and <code><nowiki>{{{Variables}}}</nowiki></code> among other complex syntax. Due to the complexity of the function, it is considerably slow, and should be used carefully. The function returns a list of template objects in chronological order, which have the following properties:		<code>ParseTemplates(InputText, dontEscape)</code> will attempt to parse all <code><nowiki>{{Templates}}</nowiki></code> on a page, handling multiple factors such as <code><nowiki>[[Wikilinks]]</nowiki></code> and <code><nowiki>{{{Variables}}}</nowiki></code> among other complex syntax. Due to the complexity of the function, it is considerably slow, and should be used carefully. The function returns a list of template objects in chronological order, which have the following properties:
	* '''Args''': A key-value set of arguments, not in chronological order		* '''Args''': A key-value set of arguments, not in chronological order