Template:Dialog/safe/doc
 |
This is a documentation subpage for Template:Dialog/safe (see that page for the template itself). It contains usage information, categories and other content that is not part of the original template page. |
 |
This is a dialog formatting template. It is meant for use on interactive dialog pages, and may involve interactions between wiki markup, html, and javascript. Please carefully test any edits before making them. |
|
|
This template is used on over 1300 pages. Changes to this template may cause some server load, and mistakes will be visible on many pages. Please carefully test any edits before making them, and avoid making unnecessary edits. |
This template converts certain wiki formatting characters in its parameter to numeric html entity references.
Usage
editApply this template to strings output by the template expansion process, that will be converted to html but are meant to remain relatively unaffected by the conversion. The conversion still alters the string somewhat. To bypass the conversion altogether, use {{dialog/init}}.
- {{dialog/safe|string}} returns a "safe" version of string, by substituting html entity references for certain characters that have format meaning in wiki markup. As of this writing, the characters are
- < > = [ ] * # : '
- Note, this list does not include characters that affect parsing of wiki markup, but don't affect the subsequent conversion to html:
- { } |
- These parsing characters (and some of the others) are significant when a dialog parameter is being injected into the template expansion process, and are dealt with there by replacing them with template calls — to templates {{(*}}, {{*)}}, {{!}}, etc., so that the expansion process returns those characters to their original forms.
Internals
editThe characters substituted for are designated by a Scribunto ustring pattern.
See also
edit