Template:Nihongo/doc
This is a documentation subpage for Template:Nihongo It contains usage information, categories and other content that is not part of the original template page. |
This template is used on approximately 101,000 pages. To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
Usage
editThis 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
edit- 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
extra2
Code |
|
Gives |
|
Note: literal translations and linguistic glosses go in single quotation marks, not double.
- Without
extra2
Code |
|
Gives |
|
User style
editUser style can be set by adding code similar to
@media screen, tv {
*[lang="ja"] {
color: green;
}
}
to common.css.
Error messaging
editThis 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.
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}}
Limitations
editThis cannot be used within a Wikilink in an article or in any template or other page that is transcluded into an article.
Template data
editThis is the TemplateData documentation for the template used by the new VisualEditor.
Nihongo
This template is used to display Japanese text, applying the correct code and formatting.
Parameter | Description | Type | Status | |
---|---|---|---|---|
English text | 1 | The word as translated into English. | String | optional |
Kanji/kana text | 2 | The word as written in Japanese (kanji, kana, Roman letters, and possibly other marks). | String | required |
Romanized (rōmaji) text | 3 | Transliteration of the Japanese word, using Hepburn Romanization. | String | optional |
Extra text inside parentheses | 4 extra | Adds extra text inside the parentheses. | String | optional |
Extra text outside parentheses | 5 extra2 | Adds extra text outside the parentheses. It is only useful in ";" definitions (it will be displayed without bold, whereas text following the template will get the bold). | String | optional |
Formatting | lead | Changes formatting style. If set to yes, uses lead formatting. Otherwise uses default formatting. | String | optional |