Template:Nihongo/doc: Difference between revisions
m (1 revision imported: Templates) |
m (1 revision imported from wikipedia:Template:Nihongo/doc: nihongo update) |
||
(One intermediate revision by one other user not shown) | |||
Line 1: | Line 1: | ||
{{Documentation subpage}} |
{{Documentation subpage}} |
||
<!-- Categories go where indicated at the bottom of this page, please; interwikis go to Wikidata (see also: [[Wikipedia:Wikidata]]). --> |
|||
{{High-use}} |
|||
{{COinS safe|n}} |
{{COinS safe|n}} |
||
{{Lua|Module:Nihongo}} |
|||
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> |
|||
{{TOCright}} |
{{TOCright}} |
||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
{|class=wikitable |
{|class=wikitable |
||
|Without lead=yes |
|Without lead=yes |
||
|With lead=yes |
|With lead=yes |
||
|- |
|- |
||
|<code><nowiki>{{Nihongo|</nowiki><{{var|english}}>|<{{var|kanji/kana}}>|<{{var|rōmaji}}>|<{{var|extra}}>|<{{var|extra2}}>}}</code> |
|||
|{{Nihongo| |
|<code><nowiki>{{Nihongo|</nowiki><{{var|english}}>|<{{var|kanji/kana}}>|<{{var|rōmaji}}>|lead=yes|extra=<{{var|extra}}>|extra2=<{{var|extra2}}>}}</code> |
||
|{{Nihongo|English|kanji/kana|rōmaji|lead=yes|extra|extra2}} |
|||
|} |
|} |
||
'''Parameters:''' |
|||
* |
* <{{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. |
||
* |
* <{{var|kanji/kana}}>. Required when <{{var|rōmaji}}> is empty or omitted. The word as written using Japanese script (kanji, kana). |
||
* |
* <{{var|rōmaji}}>. Required when <{{var|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. |
||
* |
* <{{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> |
||
* |
* <{{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). |
||
=== Examples === |
=== Examples === |
||
;Regular use: |
;Regular use: |
||
{| CLASS="wikitable" |
{| CLASS="wikitable" |
||
|'''Code''' ||< |
|'''Code''' ||<code><nowiki>{{Nihongo|Tokyo Tower|東京タワー|Tōkyō tawā}}</nowiki></code> |
||
|- |
|- |
||
|'''Gives'''|| {{Nihongo|Tokyo Tower|東京タワー|Tōkyō tawā}} |
|'''Gives'''|| {{Nihongo|Tokyo Tower|東京タワー|Tōkyō tawā}} |
||
|} |
|} |
||
;Use in lead: |
;Use in lead: |
||
{| CLASS="wikitable" |
{| CLASS="wikitable" |
||
|'''Code''' ||< |
|'''Code''' ||<code><nowiki>{{Nihongo|Tokyo Tower|東京タワー|Tōkyō tawā|lead=yes}}</nowiki></code> |
||
|- |
|- |
||
|'''Gives'''|| {{Nihongo|Tokyo Tower|東京タワー|Tōkyō tawā|lead=yes}} |
|'''Gives'''|| {{Nihongo|Tokyo Tower|東京タワー|Tōkyō tawā|lead=yes}} |
||
Line 44: | Line 44: | ||
;Without <code>English</code>: |
;Without <code>English</code>: |
||
{| CLASS="wikitable" |
{| CLASS="wikitable" |
||
|'''Code''' ||< |
|'''Code''' ||<code><nowiki>{{Nihongo||東京タワー|Tōkyō tawā}}</nowiki></code> |
||
|- |
|- |
||
|'''Gives'''|| {{Nihongo||東京タワー|Tōkyō tawā}} |
|'''Gives'''|| {{Nihongo||東京タワー|Tōkyō tawā}} |
||
Line 51: | Line 51: | ||
;Without <code>English</code>, use in lead: |
;Without <code>English</code>, use in lead: |
||
{| CLASS="wikitable" |
{| CLASS="wikitable" |
||
|'''Code''' ||< |
|'''Code''' ||<code><nowiki>{{Nihongo||東京タワー|Tōkyō tawā|lead=yes}}</nowiki></code> |
||
|- |
|- |
||
|'''Gives'''|| {{Nihongo||東京タワー|Tōkyō tawā|lead=yes}} |
|'''Gives'''|| {{Nihongo||東京タワー|Tōkyō tawā|lead=yes}} |
||
|} |
|} |
||
;With < |
;With <code>extra</code> to add a literal translation: |
||
{| CLASS="wikitable" |
|||
|'''Code''' ||<code><nowiki>{{Nihongo|''Sokoban''|倉庫番|Sōko-ban|{{lit|warehouse keeper}}}}</nowiki></code> |
|||
|- |
|||
|'''Gives'''|| {{Nihongo|''Sokoban''|倉庫番|Sōko-ban|{{lit|warehouse keeper}}}} |
|||
⚫ | |||
;With <code>extra2</code>: |
|||
{| CLASS="wikitable" |
{| CLASS="wikitable" |
||
|'''Code''' || |
|'''Code''' || |
||
< |
<code><nowiki>; {{Nihongo||虚無僧|komusō|extra2='Priest of nothingness'}}</nowiki></code><BR /> |
||
< |
<code><nowiki>: Mendicant priest of the Fuke sect of Zen Buddhism.</nowiki></code> |
||
|- |
|- |
||
|'''Gives'''|| |
|'''Gives'''|| |
||
; {{Nihongo||虚無僧|komusō|extra2= |
; {{Nihongo||虚無僧|komusō|extra2='Priest of nothingness'}} |
||
: Mendicant priest of the Fuke sect of Zen Buddhism. |
: Mendicant priest of the Fuke sect of Zen Buddhism. |
||
|} |
|} |
||
{{hatnote|Note: literal translations and linguistic glosses go in [[MOS:SINGLE|single quotation marks]], not double.}} |
|||
;Without < |
;Without <code>extra2</code>: |
||
{| CLASS="wikitable" |
{| CLASS="wikitable" |
||
|'''Code''' || |
|'''Code''' || |
||
< |
<code><nowiki>; {{Nihongo||虚無僧|komusō}} 'Priest of nothingness'</nowiki></code><BR /> |
||
< |
<code><nowiki>: Mendicant priest of the Fuke sect of Zen Buddhism.</nowiki></code> |
||
|- |
|- |
||
|'''Gives'''|| |
|'''Gives'''|| |
||
<!-- -->; {{Nihongo||虚無僧|komusō}} |
<!-- -->; {{Nihongo||虚無僧|komusō}} 'Priest of nothingness' |
||
<!-- -->: Mendicant priest of the Fuke sect of Zen Buddhism. |
<!-- -->: Mendicant priest of the Fuke sect of Zen Buddhism. |
||
|} |
|} |
||
Line 81: | Line 89: | ||
[[Help:User style|User style]] can be set by adding code similar to |
[[Help:User style|User style]] can be set by adding code similar to |
||
< |
<syntaxhighlight lang="css"> |
||
@media screen, tv { |
@media screen, tv { |
||
*[lang="ja"] { |
*[lang="ja"] { |
||
color: green; |
color: green; |
||
} |
} |
||
}</ |
}</syntaxhighlight> |
||
⚫ | |||
or |
|||
==Error messaging== |
|||
<source lang="css"> |
|||
This template emits one error message of its own: |
|||
@media screen, tv { |
|||
:<span class="error" style="font-size:100%">error: <nowiki>{{nihongo}}</nowiki>: Japanese or romaji text required</span> |
|||
.t_nihongo_kanji { |
|||
One of the positional parameters <code><{{var|kanji/kana}}></code> (<code><nowiki>{{{2}}}</nowiki></code>), the 'Japanese' referred to in the error message or <code><{{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}}. |
|||
color: green; |
|||
⚫ | |||
This error often occurs because the template is malformed: |
|||
} |
|||
:<code><nowiki>{{Nihongo|東京タワー}}</nowiki></code> instead of <code><nowiki>{{Nihongo||東京タワー}}</nowiki></code>; {{lang|ja|東京タワー}} is in <code><nowiki>{{{1}}}</nowiki></code> (<code><{{var|english}}></code>) instead of <code><nowiki>{{{2}}}</nowiki></code> (<code><{{var|kanji/kana}}></code>). To resolve this error, add the missing pipe (<code>|</code>) or consider using {{tlx|lang}} or {{tlx|transl}} |
|||
</source> |
|||
⚫ | |||
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}} |
|||
==Limitations== |
|||
This cannot be used within a Wikilink in an article or in any template or other page that is [[WP:Transclusion|transcluded]] into an article. |
|||
== See also == |
|||
* {{tlp|Lang-ja|...}},{{tlp|lang|ja|...}}, similar templates in the [[:Category:Lang-x templates|Lang-x template]] for marking up Japanese text |
|||
⚫ | |||
* {{tl|Nihongo krt}}, essentially the same as this template, but gives kanji first with rōmaji and English inside the parentheses |
|||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
== Template data == |
|||
{{TemplateDataHeader}} |
{{TemplateDataHeader}} |
||
<templatedata> |
<templatedata> |
||
Line 108: | Line 131: | ||
"label": "English text", |
"label": "English text", |
||
"type": "string", |
"type": "string", |
||
"description": "The word as translated into English." |
"description": "The word as translated into English. Note this will sometimes be the actual Japanese word if it has been adopted into English." |
||
}, |
}, |
||
"2": { |
"2": { |
||
Line 125: | Line 148: | ||
"type": "string", |
"type": "string", |
||
"description": "Adds extra text inside the parentheses. ", |
"description": "Adds extra text inside the parentheses. ", |
||
"aliases":[ |
"aliases": [ |
||
"extra" |
|||
] |
|||
}, |
}, |
||
"5": { |
"5": { |
||
"label": "Extra text outside parentheses", |
"label": "Extra text outside parentheses", |
||
"type": "string", |
"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 |
"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":[ |
"aliases": [ |
||
"extra2" |
|||
] |
|||
}, |
}, |
||
"lead": { |
"lead": { |
||
"label": " |
"label": "Lead formatting", |
||
"type": "string", |
"type": "string", |
||
"description": " |
"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> |
</templatedata> |
||
⚫ | |||
=== See also === |
|||
<!-- Categories go below this line, please; interwikis go to Wikidata, thank you! --> |
|||
* {{tl|Nihongo4}}, the same as this template, but does not link to [[Help:Installing Japanese character sets]] |
|||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
* {{tl|zh}}, for use with Chinese text |
|||
⚫ | |||
<!-- CATEGORIES AND INTERWIKIS BELOW THIS LINE PLEASE --> |
|||
[[Category:Japonic multilingual support templates|{{PAGENAME}}]] |
[[Category:Japonic multilingual support templates|{{PAGENAME}}]] |
||
[[Category:WikiProject Japan templates|Nihongo]] |
[[Category:WikiProject Japan templates|Nihongo]] |
||
</includeonly> |
}}</includeonly> |
Latest revision as of 16:22, 20 April 2023
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. |
[[Category:Template documentation pages{{#translation:}}]]
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. |
This template should not be used in citation templates such as Citation Style 1 and Citation Style 2, 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
extra
to 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
@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 (11).
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:Transl 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>