Template:Nihongo/doc

From Vigyanwiki
< Template:Nihongo
Revision as of 21:43, 7 December 2022 by Admin (talk | contribs) (1 revision imported)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

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

; {{Nihongo||虚無僧|komusō|extra2='Priest of nothingness'}}
: Mendicant priest of the Fuke sect of Zen Buddhism.

Gives
komusō (虚無僧) 'Priest of nothingness'
Mendicant priest of the Fuke sect of Zen Buddhism.
Without extra2
Code

; {{Nihongo||虚無僧|komusō}} 'Priest of nothingness'
: Mendicant priest of the Fuke sect of Zen Buddhism.

Gives
komusō (虚無僧) 'Priest of nothingness'
Mendicant priest of the Fuke sect of Zen Buddhism.

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 (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: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

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Nihongo

[[Category:TemplateData documentation{{#translation:}}]]

This template is used to display Japanese text, applying the correct code and formatting.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
English text1

The word as translated into English. Note this will sometimes be the actual Japanese word if it has been adopted into English.

Stringoptional
Kanji/kana text2

The word as written in Japanese (kanji, kana, Roman letters, and possibly other marks).

Stringrequired
Romanized (rōmaji) text3

Transliteration of the Japanese word, using Hepburn Romanization.

Stringoptional
Lead formattinglead

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.

Suggested values
yes
Stringoptional
Extra text inside parentheses4 extra

Adds extra text inside the parentheses.

Stringoptional
Extra text outside parentheses5 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 be bolded). Literal translations and linguistic glosses must use single quotation marks, not double.

Stringoptional