Template:Nihongo/doc
 | This is a documentation subpage for Template:Nihongo. It may contain usage information, categories and other content that is not part of the original template page. |
 | This template is used on many pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
 | This template should not be used in citation templates such as Citation Style 1 because it includes markup that will pollute the COinS metadata they produce; see Wikipedia:COinS. |
 | This template uses Lua: |
Usage
This template marks the kanji segment as being in Japanese kanji and/or kana, which helps user agents (web browsers and so on) to display it correctly.
Syntax:
| Without lead=yes | With lead=yes |
{{Nihongo|<english>|<kanji/kana>|<rōmaji>|<extra>|<extra2>}}
|
{{Nihongo|<english>|<kanji/kana>|<rōmaji>|lead=yes|extra=<extra>|extra2=<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 when <rōmaji> is empty or omitted. The word as written using Japanese script (kanji, kana).
- <rōmaji>. Required when <kanji/kana> is empty. Transliteration of the Japanese word, using Hepburn Romanization.
- 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.
- <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).
Examples
- Regular use
| Code | {{Nihongo|Tokyo Tower|東京タワー|Tōkyō tawā}}
|
| Gives | Tokyo Tower (東京タワー, Tōkyō tawā) |
- Use in lead
| Code | {{Nihongo|Tokyo Tower|東京タワー|Tōkyō tawā|lead=yes}}
|
| Gives | Tokyo Tower (Japanese: 東京タワー, Hepburn: Tōkyō tawā) |
- Without
English
| Code | {{Nihongo||東京タワー|Tōkyō tawā}}
|
| Gives | Tōkyō tawā (東京タワー) |
- Without
English, use in lead
| Code | {{Nihongo||東京タワー|Tōkyō tawā|lead=yes}}
|
| Gives | Tōkyō tawā (Japanese: 東京タワー) |
- With
extrato add a literal translation
| Code | {{Nihongo|''Sokoban''|倉庫番|Sōko-ban|{{lit|warehouse keeper}}}}
|
| Gives | Sokoban (倉庫番, Sōko-ban, lit. 'warehouse keeper') |
- With
extra2
| Code |
|
| Gives |
|
- Without
extra2
| Code |
|
| Gives |
|
User style
User style can be set by adding code similar to
<syntaxhighlight lang="css"> @media screen, tv { *[lang="ja"] { color: green; }
}
to common.css.
Error messaging
This template emits one error message of its own:
- error: {{nihongo}}: 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. Articles with these errors are collected in Category:Nihongo template errors (0).
This error often occurs because the template is malformed:
{{Nihongo|東京タワー}}instead of{{Nihongo||東京タワー}}; 東京タワー 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}}
Limitations
This cannot be used within a Wikilink in an article or in any template or other page that is transcluded into an article.
See also
- {{Lang-ja|...}},{{lang|ja|...}}, similar templates in the Lang-x template for marking up Japanese text
- {{Nihongo3}}, essentially the same as this template, but gives rōmaji first and English inside the parentheses
- {{Nihongo krt}}, essentially the same as this template, but gives kanji first with rōmaji and English inside the parentheses
- {{Nihongo foot}}, same as this version, but puts everything but the English into a footnote
- {{Nihongo2}}, also displays the kanji properly, but without adding anything in parentheses, without rōmaji and without the extra parameters
- {{in lang|ja}}, to label sources written in Japanese
- {{Japanese}}, to request expert assistance with Japanese script
Template data
TemplateData for Nihongo
<templatedata> { "description": "This template is used to display Japanese text, applying the correct code and formatting.", "params": { "1": { "label": "English text", "type": "string", "description": "The word as translated into English. Note this will sometimes be the actual Japanese word if it has been adopted into English." }, "2": { "label": "Kanji/kana text", "type": "string", "required": true, "description": "The word as written in Japanese (kanji, kana, Roman letters, and possibly other marks)." }, "3": { "label": "Romanized (rōmaji) text", "type": "string", "description": "Transliteration of the Japanese word, using Hepburn Romanization." }, "4": { "label": "Extra text inside parentheses", "type": "string", "description": "Adds extra text inside the parentheses. ", "aliases": [ "extra" ] }, "5": { "label": "Extra text outside parentheses", "type": "string", "description": "Adds extra text outside the parentheses. It is only useful in \";\" definitions (it will be displayed without bold, whereas text following the template, will be bolded). Literal translations and linguistic glosses must use single quotation marks, not double.", "aliases": [ "extra2" ] }, "lead": { "label": "Lead formatting", "type": "string", "description": "If set to yes, changes formatting style 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.", "suggestedvalues": [ "yes" ] } }, "paramOrder": [ "1", "2", "3", "lead", "4", "5" ], "format": "inline" } </templatedata>