 | Thismodule is rated asready for general use. It has reached a mature state, is considered relatively stable and bug-free, and may be used wherever appropriate. It can be mentioned onhelp pages and other Wikipedia resources as an option for new users. To minimise server load and avoid disruptive output, improvements should be developed throughsandbox testing rather than repeated trial-and-error editing. |
 | This module is currentlyprotected from editing. See theprotection policy andprotection log for more details. Please discuss any changes on thetalk page; you maysubmit an edit request to ask anadministrator to make an edit if it isuncontroversial or supported byconsensus. You may alsorequest that this page be unprotected. |
 | This Lua module is used onapproximately 143,000 pages. To avoid major disruption and server load, any changes should be tested in the module's/sandbox or/testcases subpages, or in your ownmodule sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on thetalk page before implementing them. |
Implements Lua functionsmw.text.decode,mw.text.encode in a module.
{{#invoke:decodeEncode|decode|s=Source text©}} →Source text©SeeList of XML and HTML character entity references.
© →©> →>All well-defined named entities are decoded (HTML Named character references, formally: as defined in thePHP table).
At 100 °F, & with a "burning" sun above, we ⁄walked⁄." -- wikitext{{#invoke:decodeEncode|decode|s=At 100 °F, & with a "burning" sun above, we ⁄walked⁄.}} →At 100 °F, & with a "burning" sun above, we ⁄walked⁄. -- In code: straight characters, no named entities.By setting|subset_only=true, only these five entity names are decoded: '<', '>', '&', '"', ' ' (that is, into '<', '>', '&', '"', ' ').
|decodeNamedEntities=, having this effect: whenomitted or false, only the reduced set of entities is recognized and decoded. This use of 'false' isinverted in using|subset_only=:|decodeNamedEntities=false =|subset_only=true.|subset_only= should be set explicitly to 'true' to be effective.encode encodes some entity-named characters into that name (for example:& →&).Regular sentence:
In code:
At >100 °F, & with a "burning" sun above, we walked. ©"Encode:
{{#invoke:decodeEncode|encode|s=At >100 °F, & with a "burning" sun above, we walked. ©|charset=&<>{{!}}°"'&©}}At >100 °F, & with a "burning" sun above, we walked. ©Per Lua documentation, only a small set of characters is processed. The characterset can be set (expanded) by using|charset=.
|charset=<>" \'& (the default),|charset=<>°"'&©{{!}}; characters not in the default will be replaced by their decimal entity:© →©(hexadecimal number, not decimal nor named ©)  works, but  doesn't.require('strict')localp={}localfunction_getBoolean(boolean_str)-- from: module:String; adapted-- requires an explicit truelocalboolean_valueiftype(boolean_str)=='string'thenboolean_str=boolean_str:lower()ifboolean_str=='true'orboolean_str=='yes'orboolean_str=='1'thenboolean_value=trueelseboolean_value=falseendelseiftype(boolean_str)=='boolean'thenboolean_value=boolean_strelseboolean_value=falseendreturnboolean_valueendfunctionp.decode(frame)locals=frame.args['s']or''localsubset_only=_getBoolean(frame.args['subset_only']orfalse)returnp._decode(s,subset_only)endfunctionp._decode(s,subset_only)-- U+2009 THIN SPACE: workaround for bug: HTML entity   is decoded incorrect. Entity   gets decoded properlys=mw.ustring.gsub(s,' ',' ')-- U+03B5 ε GREEK SMALL LETTER EPSILON: workaround for bug (phab:T328840): HTML entity ε is decoded incorrect for gsub(). Entity ε gets decoded properlys=mw.ustring.gsub(s,'ε','ε')localret=mw.text.decode(s,notsubset_only)returnretendfunctionp.encode(frame)locals=frame.args['s']or''localcharset=frame.args['charset']returnp._encode(s,charset)endfunctionp._encode(s,charset)-- example: charset = '_&©−°\\\"\'\=' -- do escape with backslash not %;localretifcharsetandcharset~=''thenret=mw.text.encode(s,charset)else-- use default: chartset = '<>&"\' ' (outer quotes = lua required; space = NBSP)ret=mw.text.encode(s)endreturnretendreturnp