Editing Module:DecodeEncode/doc (section)

== Decode ({{mono|1=&amp;copy;}} &rarr; ©) <span class="anchor" id="Decode"></span>==
{{hatnote|See {{slink||Known issues}} for possible THIN SPACE, epsilon issues}}
:Decodes [[List of XML and HTML character entity references|Named Entities]] ''from'' entity name ''into'' a regular (unicode) character:
:<code>&amp;copy;</code> &rarr; <code>&copy;</code>
:<code>&amp;gt;</code> &rarr; <code>></code>

All welldefined named entities are decoded ([https://html.spec.whatwg.org/multipage/named-characters.html#named-character-references HTML Named character references], formally: as defined in the [https://www.php.net/get_html_translation_table PHP table]).

:A regular, rendered sentence:
::"At 100 °F, & with a "burning" sun above, we , we ⁄walked⁄."

:In code:
::"<code>At 100&amp;nbsp;&amp;deg;F, &amp; with a &amp;quot;burning&amp;quot; sun above, we &amp;frasl;walked&amp;frasl;.</code>" -- wikitext

:Processing:
:<code><nowiki>{{#invoke:decodeEncode|decode|s=At 100&nbsp;&deg;F, &amp; with a &quot;burning&quot; sun above, we &frasl;walked&frasl;.}}</nowiki></code> &rarr;
::<code>{{#invoke:decodeEncode|decode|s=At 100&nbsp;&deg;F, &amp; with a &quot;burning&quot; sun above, we &frasl;walked&frasl;.}}</code> -- In code: straight characters, no named entities.

:Renders, again:
::"At 100 °F, & with a "burning" sun above, we ⁄walked⁄."

===Decode a reduced set only===
By setting {{para|subset_only|true}}, only these five entity names are decoded: '&amp;lt;', '&amp;gt;', '&amp;amp;', '&amp;quot;', '&amp;nbsp;' (that is, into '&lt;', '&gt;', '&amp;', '&quot;', '&nbsp;').

:'''Note''': There is a difference with the relevant Lua parameter. (This only concerns your task if you also work directly with the Lua mw.text.decode function). Lua documentation defines parameter {{para|decodeNamedEntities}}, having this effect: when ''omitted or false'', only the reduced set of entities is recognized and decoded. This use of 'false' is ''inverted'' in using {{para|subset_only}}: {{para|decodeNamedEntities|false}} =  {{para|subset_only|true}}.

:Also, this module ignores the "omitted" logic: {{para|subset_only}} should be set explicitly to 'true' to be effective.