Module:DecodeEncode/doc: Difference between revisions
From Wikipedia, the free encyclopedia
Line 14:
Line 14:
:A regular, rendered sentence:
:A regular, rendered sentence:
::"At 100(削除) ° (削除ここまで)F, &(削除) amp; (削除ここまで) with a (削除) " (削除ここまで)burning(削除) " (削除ここまで) sun above, we (削除) walked (削除ここまで)"
::"At 100(追記) ° (追記ここまで)F, & with a (追記) " (追記ここまで)burning(追記) " (追記ここまで) sun above, we (追記) , we ⁄walked⁄. (追記ここまで)"
:In code:
:In code:
::"<code>At 100&nbsp;&deg;F, &(削除) amp; (削除ここまで)amp; with a &quot;burning&quot; sun above, we walked</code>"-- (削除) in code (削除ここまで)
::"<code>At 100&nbsp;&deg;F, & with a &quot;burning&quot; sun above, we (追記) &frasl; (追記ここまで)walked(追記) &frasl;. (追記ここまで)</code>"(追記) (追記ここまで)-- (追記) wikitext (追記ここまで)
:Processing:
:Processing:
:<code><nowiki>{{#invoke:decodeEncode|decode|s=At 100 °F, & with a "burning" sun above, we walked}}</nowiki></code> →
:<code><nowiki>{{#invoke:decodeEncode|decode|s=At 100 °F, & with a "burning" sun above, we (追記) , we ⁄ (追記ここまで)walked(追記) ⁄. (追記ここまで)}}</nowiki></code> →
::<code>{{#invoke:decodeEncode|decode|s=At 100 °F, & with a "burning" sun above, we walked}}</code> -- In code: no named entities
::<code>{{#invoke:decodeEncode|decode|s=At 100 °F, & with a "burning" sun above, we (追記) , we ⁄ (追記ここまで)walked(追記) ⁄. (追記ここまで)}}</code> -- In code: no named entities
===Decode a reduced set only===
===Decode a reduced set only===
Revision as of 01:44, 26 December 2020
This module is rated as pre-alpha. It is incomplete and may or may not be in active development. Do not use it in article namespace pages. A module remains in pre-alpha until its developer, or another editor who adopts it if it is abandoned for some time, considers the basic structure complete.
Implements Lua functions mw.text.decode, mw.text.encode in a module.
{{#invoke:decode|s=Source text}}→Source text
See List of XML and HTML character entity references.
Decode (© → ©)
- Decodes Named Entities from entity name into a regular (unicode) character:
©→©>→>
All welldefined 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 , we ⁄walked⁄.}}→At 100 °F, & with a "burning" sun above, we , we ⁄walked⁄.-- In code: no named entities
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 ©)
Template
As of Dec 2020[update] , there are no tempates implementing this module.