View source for Module:Korean transliteration notice/doc

{{Module rating|beta}}
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
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:Revised Romanization" gives "Revised Romanization" as variant).

All templates using this support the following parameters:

* '''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 file to be used as an icon, without the File: prefix.
* '''variant''' – defaults to the template name; the variant of transliteration, which should be a Wikipedia article.
* '''transliteration examples''' – gives transliteration examples in parentheses
* '''compare''' – comparison with other transliterations of Korean
* '''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 edit notice category
* '''nocat''' disables documentation if set to true
* '''size''' set the size of the image (example: <code>{{para|size|60px}}</code>) 

=== Examples ===
As of July 2024, [[Template:Revised Romanization]] uses the following parameters:

<pre><nowiki>{{#invoke:Korean transliteration notice|main
| id     = rr
| image  = Hunmin jeong-eum.jpg
| transliteration_examples = ''Joseon'', ''Tteokbokki'', ''Pansori''
| compare = [[McCune-Reischauer|MR]], [[Yale romanization of Korean|Yale]]
}}
</nowiki></pre>

which produces:
{{#invoke:Korean transliteration notice|main
| id     = rr
| image  = Hunmin jeong-eum.jpg
| transliteration_examples = ''Joseon'', ''Tteokbokki'', ''Pansori''
| compare = [[McCune-Reischauer|MR]], [[Yale romanization of Korean|Yale]]
| variant = Revised Romanization of Korean
}}

Other Examples:
*[[Template:McCune-Reischauer]] 
*[[Template:Yale romanization of Korean]]  

<includeonly>{{Sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->

}}</includeonly>
<noinclude>[[Category:Module documentation pages]]</noinclude>