Template:Nihongo krt/sandbox

This is the template sandbox page for Template:Nihongo krt (diff).
See also the companion subpage for test cases.

Template documentation[view] [edit] [history] [purge]

This template uses Lua:

Module:Nihongo (sandbox)

Usage

This template is basically the same as {{Nihongo2}}, except that it appends rōmaji and an English translation inside parenthesis.

This template is useful when one is addressing a Japanese term directly for the purpose of explaining the language patterns (which is otherwise awkward when using rōmaji, since rōmaji is unable to discriminate kana). The optional English translation is included as a bonus for certain use cases but isn't the main purpose of using this template (since the semantic meanings of Japanese words are irrelevant to the explanation of the Japanese language patterns themselves).

Syntax:

`{{Nihongo krt\|<english>\|<kanji/kana>\|<rōmaji>\|<extra>\|<extra2>}}`

Parameters:

<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.
<kanji/kana>. Required/Optional. The word as written using Japanese script (kanji, kana).
<rōmaji>. Required/Optional. Transliteration of the Japanese word, using Hepburn Romanization.
<extra>. Optional. Can be used to add a gloss (particularly if there is no English form). Can also be expressed as a named parameter, extra=
<extra2>. Optional. Can also be expressed as a named parameter, extra2=. It is only useful in ";" definitions (extra2 will be displayed without bold, whereas text following the template will get the bold).

This template marks the Kanji segment as being in Japanese Kanji, which helps web browsers display it correctly. It also applies the t_nihongo_kanji CSS style class to it.

Parameters 1 and 2 are required, since without Japanese writing this template is futile, and without romaji the target audience on English Wikipedia can't be expected to read Japanese.

Using the template without the Rōmaji and Kanji version is essentially pointless, and will result in a useless or worse-than-useless display. Parameters 4 and 5 can also be directly invoked with |extra= and |extra2=. Parameter |extra2= is useful only in ";" definitions (|extra2='s content will be displayed without bold, whereas text following the template will get the bold); see below for a concrete example.

Please note:

The Rōmaji parameter (the second one) does automatically put its content into italics, which in most cases other than proper names should be done (manually).
The English parameter (the third one) does not automatically put quotation marks around its content. This may or may not be desired, depending upon the context and content (and as in example below, something else may be done, such as prefacing the English translation with something. Literal translations and linguistic glosses go in single quotation marks, not double.
The order of parameters is fixed so that this template can be made compatible with the {{Nihongo}} and {{Nihongo3}} templates.

See examples below for usage hints.

Examples

Without an English translation:

Code	`{{Nihongo krt\|\|食べる\|taberu}}`
Gives	食べる (taberu)

Including an English translation:

Code	`{{Nihongo krt\|"let's go"\|行こう\|ikō}}`
Gives	行こう (ikō, "let's go")

User style

User style can be set by adding code similar to

*[lang=ja] { color: green; font-family: Arial; }

or

.t_nihongo_kanji { color: green; font-family: Arial; }

to common.css.

Error messaging

This template emits one error message of its own:

error: {{nihongokrt}}: Japanese or romaji text required

One of the positional parameters <kanji/kana> ({{{2}}}), the 'Japanese' referred to in the error message or <rōmaji> ({{{3}}}) is required for proper operation of this template.

This error often occurs because the template is malformed:

{{Nihongo krt|東京タワー}} instead of {{Nihongo krt||東京タワー}}; 東京タワー is in {{{1}}} (<english>) instead of {{{2}}} (<kanji/kana>). To resolve this error, add the missing pipe (|) or consider using {{lang}} or {{transl}}

Because this template uses {{lang}} and {{transl}} which emit their own error messages, see the help text for those at:

Category:Lang and lang-xx template errors – for error messages emitted by {{lang}}

Category:Transliteration template errors – for error messages emitted by {{transl}}

{{Nihongo}}, essentially same as this template, but gives English first with kanji and rōmaji inside the parentheses
{{Nihongo2}}, only displays the kanji properly, without any further information (i.e. no rōmaji or English translation)
{{Nihongo3}}, essentially same as this template, but gives Rōmaji first with kanji and English inside the parentheses
{{Nihongo-s}}, a simplified version of {{Nihongo}} without the extra spans or checks
{{Nihongo foot}}, same as {{Nihongo}}, but puts everything but the English into a footnote.

Like {{Nihongo2}} with '''kanji''' first, but with '''rōmaji''' and an English translation in parenthesis

Template parameters[Edit template data]
Parameter		Description	Type	Status
English translation	`1`	Example let's go	String	optional
Kanji/kana	`2`	If there's no rōmaji, then kanji/kana is required. Example 行こう	String	required
Rōmaji	`3`	If there's no kanji/kana, then rōmaji is required. Example ikō	String	required
extra text inside parentheses	`extra` `4`	Example	String	optional
extra text after parentheses	`extra2` `5`	Example	String	optional

The above documentation is transcluded from Template:Nihongo krt/doc.
Editors can experiment in this template's sandbox and testcases pages.
Add categories to the /doc subpage. Subpages of this template.