Template:Nihongo/doc

Disclaimer

This is a technical documentation, so proper design or information organization is not needed, as long as it able to explain the code used in the template. If you feel any difficulties on understanding the codes, feel free to ask any technical editors around.

Description

This template is used for adding Japanese text to articles.

Functions

This template is used to provide the term/name in the original language in the case that the English translation is questioned, as well as to provide the pronunciation of the term/name in the Japanese language.

Syntax

Default Syntax

Type these syntax wherever you want to add Japanese text next to a term/name.

{{Nihongo|<Name>|<Kanji>|<Explanation>}}

Notes:

• <Name> is for the English name (or what it was called)
• <Kanji> is how their Kanji name is written
• <Explanation> used with three alternatives:
  1. If the <Name> section is an English name, then it'll be used for typing the Romanization of the Kanji.
  2. If the <Name> section is the Romanization of the Kanji, then it'll be used for typing the English naming.
  3. If both the English naming and Romanization are the same, then this part will also include the Romanization name.

Example

{{Nihongo|Shimakaze|島風|Shimakaze}}

will be displayed as:
Shimakaze (島風, Shimakaze^?)

Extended Syntax

With Furigana

Additionally, there is also a named "Furigana" parameter, for adding any Furigana given for a set of kanji, in the original text:

{{Nihongo|<Name>|<Kanji>|Furigana=<Text>|<Explanation>}}

Notes:

• For all notes, please see last section's note
• Text without <...> is the format and must be typed as is.

Example

{{Nihongo|Shimakaze|島風|Furigana=しまかぜ|Shimakaze}}

will be displayed as:
Shimakaze (島風(しまかぜ), Shimakaze^?)

Additional Notes

• The minimum requirement is two pipes (|) for the template to work. So if you just have one or two detail(s), type as following:
  • One detail: {{Nihongo|<detail>||}}
    
    Example:
    Typing {{Nihongo|Shimakaze||}}
    will gives you result:
    Shimakaze (, Shimakaze^?)
    space
  • Two details: {{Nihongo|<detail 1>|<detail 2>|}}
    
    Example:
    Typing {{Nihongo|Shimakaze|島風|}}
    will gives you result:
    Shimakaze (島風, Shimakaze^?)
    space
• The pipes can be extended one more time, to add a "literature meaning". For example:
  • Typing {{Nihongo|Shimakaze|島風|Furigana=しまかぜ|Shimakaze|lit. Island Breeze}}
    will gives you result:
    Shimakaze (島風(しまかぜ), Shimakaze^?, lit. Island Breeze)