View source for Module:Wikitext Parsing/doc

{{High risk}}

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 ==
{{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>.

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.

== 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:
* '''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
* '''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
* '''Text''': The raw text of the template

If the second parameter, <code>dontEscape</code>, is set to true, the inputted text won't be ran through the <code>PrepareText</code> function.

<includeonly>{{Sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->

}}</includeonly>