Module:DecodeEncode
.svg/60px-Test_Template_Info-Icon_-_Version_(2).svg.png){kind=icon}
 | This module is rated as ready for general use. It has reached a mature form and is thought to be relatively bug-free and ready for use wherever appropriate. It is ready to mention on help pages and other Wikipedia resources as an option for new users to learn. To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing. |
 | This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing. |
 | This Lua module is used on approximately 133,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 own module sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
Implements Lua functions mw.text.decode, mw.text.encode in a module.
{{#invoke:decodeEncode|decode|s=Source text©}}→Source text©
See List of XML and HTML character entity references.
Decode (© → ©)
- Decodes Named Entitiesfrom entity name into a regular (unicode) character:
©→©>→>
All well-defined named entities are decoded (HTML Named character references, formally: as defined in the PHP table).
- A regular, rendered sentence:
- "At 100 °F, & with a "burning" sun above, we , we ⁄walked⁄."
- In code:
- "
At 100 °F, & with a "burning" sun above, we ⁄walked⁄." -- wikitext
- "
- Processing:
{{#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.
- Renders, again:
- "At 100 °F, & with a "burning" sun above, we ⁄walked⁄."
Decode a reduced set only
By setting |subset_only=true, only these five entity names are decoded: '<', '>', '&', '"', ' ' (that is, into '<', '>', '&', '"', ' ').
- 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
|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|subset_only=:|decodeNamedEntities=false=|subset_only=true.
- Also, this module ignores the "omitted" logic:
|subset_only=should be set explicitly to 'true' to be effective.
Encode (© → ©)
- Function
encodeencodes some entity-named characters into that name (for example:&→&).
Regular sentence:
- "At >100 °F, & with a "burning" sun above, we walked. ©"
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. ©
- Renders as:
- "At >100 °F, & with a "burning" sun above, we walked. ©"
character set to encode
Per Lua documentation, only a small set of characters is processed. The characterset can be set (expanded) by using |charset=.
- Example:
|charset=<>" \'&(the default),|charset=<>°"'&©{{!}}; characters not in the default will be replaced by their decimal entity:©→©(hexadecimal number, not decimal nor named ©)
Known issues
- 13 Sep 2021: NOTE: The encode function with user-supplied charset is now used productively in {{R/superscript}} and {{R/ref}}. Before implementing breaking changes here, these templates need to be adjusted accordingly!
- 26 Sep 2021: U+2009 THIN SPACE ( ,  )
- Note: Possible bug: Decoding
 works, but doesn't. - Resolved in code.
- 4 Feb 2023: U+03B5 εGREEK SMALL LETTER EPSILON (ε, ε)
- See Module talk:DecodeEncode § Bug report: bad decoding of U+03B5 ε (epsilon)
- Resolved in code.
See also
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