Module:Korean transliteration notice/doc
Appearance
This module is for generating various Korean transliteration notice templates.
Automatically generates "variant" from the title template that invokes it (e.g., invoking from "Template Romanization" gives "Revised Romanization" as the variant).
All templates using this support a RR, MR, and Yale parameter for different Korean transliteration systems.
Usage
- small, form, and including – unnecessary to use in templates as grabbed when passed in from talk pages.
- id – the HTML id used in edit notices; "editnotice" is automatically appended.
- image – name of the file to be used as an icon, without the File: prefix.
- variant – defaults to the template name; the variant of Korean transliteration, which should be a Wikipedia article.
- transliteration examples – gives transliteration examples in parentheses.
- compare – comparison variants of Korean transliteration.
- text – custom text, set only if required to be different from the default.
- doc – if set to no, will not load the automatic documentation at Template:Korean transliteration notice/documentation.
- editnotice_cat – if set to yes, categorizes in the edit notice category.
- nocat – disables documentation if set to true.
- size – set the size of the image (example: size=60px).
Example
As of March 2024, Template Romanization uses the following parameters:
{{#invoke:Korean transliteration notice|main | id = rr | image = File:Flag of South Korea.svg | transliteration_examples = ''Gim'', ''Seoul'', ''Han River'' | compare = [[McCune-Reischauer|MR]], [[Yale Romanization|Yale]] }}
which produces:
File:File:Flag of South Korea.svg | This module uses the rean transliteration notice/doc, which has its own transliteration conventions (e.g., Gim, Seoul, Han River) and some terms that are used in it may be different or absent from MR, Yale or other romanizations of Korean. According to the relevant Korean style guide, this should not be changed without broad consensus. Per WP:COMMONNAME, use words commonly established in English over any transliteration if they exist. |