Nwuan a̱tyin ka a li Ta‌̱mpi‌̱let:Nihongo foot/doc

{{Documentation subpage}}
{{Lua|Module:Nihongo}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
{{TOCright}}

This template marks the <code>Kanji</code> segment as being in Japanese Kanji, which helps user agents (web browsers and so on) to display it correctly. It also applies the <code>t_nihongo_kanji</code> CSS class. The footnote generated is called using the <code><nowiki><references /></nowiki></code>.

== Usage ==
{{Details|topic=when to use this template|Wikipedia:Manual of Style (Japan-related articles)|Wikipedia:Manual of Style (footnotes)}}

=== Syntax ===
<pre>{{Nihongo foot|English|Kanji|Rōmaji|extra|extra2|post=,|group=group|ref_name=name}}

<references group="group" /></pre>

Outputs:

{{Nihongo foot|English|Kanji|Rōmaji|extra|extra2|post=,|group=group|ref_name=name}}

<references group="group" />

=== Parameters ===
* &lt;{{var|English}}>. Optional. The word as translated into English. Note that this will sometimes be the actual Japanese word due to it being adopted into English.
* &lt;{{var|kanji/kana}}>. Required when &lt;{{var|rōmaji}}> is empty or omitted. The word as written using Japanese script (kanji, kana).
* &lt;{{var|rōmaji}}>. Required when &lt;{{var|kanji/kana}}> is empty. Transliteration of the Japanese word, using Hepburn Romanization.
* &lt;{{var|extra}}>. Optional. Can be used to add a gloss (particularly if there is no English form). Can also be expressed as a named parameter, <code>extra=</code>
* &lt;{{var|extra2}}>. Optional. Can also be expressed as a named parameter, <code>extra2=</code>. It is only useful in ";" definitions (extra2 will be displayed without bold, whereas text following the template will get the bold).
* lead=yes. Optional. This should be used for the first instance of Japanese, usually in the lead. It gives the reader an idea what kind of non-English writing they are viewing.
* post=&lt;{{var|postscript}}>. Optional. Additional characters, such as commas, added after the visible English name but before the reference.
* group&lt;{{var|group name}}>. Optional. Can be used to define a custom references group. The group is then called by using <code><nowiki><references group=</nowiki>"''group''" /></code> instead of the normal <code><nowiki><references /></nowiki></code>.
* ref_name&lt;{{var|name}}>. Optional. Can be used to define a custom reference name. Use when the note is called multiple times with the same value on a page.
* ''lead=yes''. Optional. This should be used for the first instance, usually a footnote in the lead. It gives the reader an idea what kind of non-English writing they are viewing.

== Examples ==

=== Regular use ===
{| class="wikitable" border="0" width="%80"
|width="%50"|<pre>{{Nihongo foot|English|英語|eigo}}

<references /></pre>
|width="%50"|{{Nihongo foot|English|英語|eigo}}

<references />
|}

=== With group defined ===
{| class="wikitable" border="0" width="%80"
|width="%50"|<pre>{{Nihongo foot|English|英語|eigo|group=nb}}

<references group="nb" /></pre>
|width="%50"|{{Nihongo foot|English|英語|eigo|group=nb}}

<references group="nb" />
|}

== User style ==
[[Help:User style|User style]] can be set by adding code similar to

<syntaxhighlight lang="css">
@media screen, tv {
	*[lang="ja"] {
		color: green;
	}
}</syntaxhighlight>

or

<syntaxhighlight lang="css">
@media screen, tv {
	.t_nihongo_kanji {
		color: green;
	}
}
</syntaxhighlight>
to your [[Special:Mypage/common.css|common.css]].

==Error messaging==
This template emits one error message of its own:
:<span class="error" style="font-size:100%">error: <nowiki>{{nihongo foot}}</nowiki>: Japanese or romaji text required</span>
One of the positional parameters <code>&lt;{{var|kanji/kana}}></code> (<code><nowiki>{{{2}}}</nowiki></code>), the 'Japanese' referred to in the error message or <code>&lt;{{var|rōmaji}}></code> (<code><nowiki>{{{3}}}</nowiki></code>) is required for proper operation of this template.  Articles with these errors are collected in {{clc|Nihongo template errors}}.

This error often occurs because the template is malformed:
:<code><nowiki>{{Nihongo foot|東京タワー}}</nowiki></code> instead of <code><nowiki>{{Nihongo foot||東京タワー}}</nowiki></code>; {{lang|ja|東京タワー}} is in <code><nowiki>{{{1}}}</nowiki></code> (<code>&lt;{{var|English}}></code>) instead of <code><nowiki>{{{2}}}</nowiki></code> (<code>&lt;{{var|kanji/kana}}></code>).  To resolve this error, add the missing pipe (<code>|</code>).

Because this template uses {{tld|lang}} and {{tlx|transl}} which emit their own error messages, see the help text for those at:
:{{cl|Lang and lang-xx template errors}} – for error messages emitted by {{tld|lang}}
:{{cl|Transl template errors}} – for error messages emitted by {{tld|transl}}

== See also ==
* {{tl|Nihongo}}, original: generates everything that is in a footnote inside parenthesis
* {{tl|Nihongo3}}, essentially the same as {{tl|Nihongo}}, but gives romaji first and English inside the parentheses
* {{tl|Nihongo krt}}, essentially the same as {{tl|Nihongo}}, but gives kanji first with rōmaji and English inside the parentheses
* {{tl|Nihongo2}}, also displays the kanji properly, but without adding anything in parentheses, without romaji and without the extra parameters
* {{tl|Nihongo-s}}, a simplified version of {{tl|Nihongo}} without the extra spans or checks

<includeonly>{{basepage subpage|
<!-- CATEGORIES BELOW THIS LINE PLEASE -->
[[Category:Citation templates]]
[[Category:Inline templates]]
[[Category:Japonic multilingual support templates]]
[[Category:WikiProject Japan templates]]
}}</includeonly>
<templatedata>
{
	"params": {
		"1": {
			"label": "English text",
			"example": "English",
			"type": "string",
			"suggested": true
		},
		"2": {
			"label": "Kana/kanji text",
			"example": "英語",
			"type": "string",
			"required": true
		},
		"3": {
			"label": "Romanized (rōmaji) text",
			"example": "eigo",
			"type": "string",
			"suggested": true
		},
		"lead": {
			"label": "Label writing systems",
			"description": "If 'yes', shows \"Japanese: \", etc., as leads",
			"example": "yes",
			"type": "string"
		},
		"extra": {
			"aliases": [
				"4"
			],
			"label": "First extra text",
			"type": "string"
		},
		"extra2": {
			"aliases": [
				"5"
			],
			"label": "Second extra text",
			"type": "string"
		},
		"group": {
			"label": "Footnote reference group",
			"type": "string",
			"suggested": true
		}
	},
	"description": "Like {{Nihongo}}, allows kanji/kana and rōmaji text, but puts them in footnotes"
}
</templatedata>