Tɛmplet:Nihongo/doc

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.

Further information on when to use this template: Wikipedia:Manual of Style (Japan-related articles)

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.

Note: literal translations and linguistic glosses go in single quotation marks, not double.

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:

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

For a tutorial, see Wikipedia:TemplateData/Tutorial.

For additional technical information, see mw:Help:TemplateData and mw:Extension:TemplateData.

---

• Main page
• Feedback at MediaWiki or local feedback
• Sandbox (no account required)

---

About

---

• Why are the developers building this?
  • User Test Data
• Documentation:
  • Introductory tutorial
  • User guide
  • Keyboard shortcuts
  • Frequently Asked Questions (or at MediaWiki)
• Development:
  • Roadmap
  • Updates
  • Weekly status reports

---

Help out

---

• Update the help pages
• Add template data (Tutorial)
• Translate and localize documentation

---

Research

---

• Main research page

---

Other

---

• Customization
• Known problems
• Requests for Comments (RfCs): Jul 2013 a, Jul 2013 b, Jul 2015, Sep 2015

What is template data?

Template data is the standardized description of a template, used by the default VisualEditor, the optional 2017 wikitext editor and other tools to improve the template-editing experience for the user. Both VisualEditor and the 2017 wikitext editor include a wizard to edit templates, but for the wizard to be most useful, it needs to present specific information to the user about each template, such as a short description of the template's purpose and its parameters. This information is codified formally (by any wiki editor) using template data.

Editing without template data

Without template data, each parameter needs to be added manually when inserting a new template.

No information is provided about what the value of the parameter should be.

Editing with template data

With template data, a list of supported parameters (and their description) is provided for the template.

Template data provides context for each parameter, and makes it much easier for users to modify templates.

Adding template data

Anyone can help by adding template data to templates (particularly high-profile ones, such as infoboxes) so that they are easier to edit in VisualEditor. The following is a minimal example, placed on a template's documentation page:

<templatedata>{
  "description": "insert description here",
  "params": {
    "first parameter": {
      "label": "x",
      "description": "x",
      "type": "string",
      "suggested": true,
      "autovalue": "derived automatic value",
      "default": "default value",
      "required": false
    }
  }
}</templatedata>

You can also add or edit template data using a GUI, by pressing the following button which appears at the top of the edit page: Edit template data

The template data tutorial explains in detail how to add template data information to a template.

Adding suggested values for parameters

The parameter property suggestedvalues lets you define a list of parameter values to be shown to VisualEditor users in a dropdown for easy selection. This can be done either directly in JSON or using the TemplateData editor with no coding required. Both methods are explained in detail below.

Once the values have been added to template data, the VisualEditor will display them in a combo box (a dropdown into which users can also enter a custom value). The user selects the desired value by clicking on it. If the list of values is long - for example, a list of a country’s states - the user can begin typing in the field, whereupon the list will be filtered to show only values containing the typed text. To change an entered value, the user must simply clear the field, and the full dropdown list will appear again. If the user needs a value not included in the list (for example, "message in a bottle") they can type it in manually.

For suggested values to be displayed in the VisualEditor, the parameter’s type must be set to one of the following options:

• content
• line
• string
• number
• unknown
• unbalanced wikitext.

Other types (file, page, template, user, date, boolean, URL) are not currently supported because they have special functionalities in the VisualEditor already (such as autocomplete) which would interfere with the dropdown menu for suggested values in the VisualEditor.

Adding suggested values for parameters in wikitext

To add suggested values to any parameter type, add the new property “suggestedvalues” to the parameter in JSON. The “suggestedvalues” attribute must be a list of strings.

An example might look like this:

"media_type": {
	"label": "Type of media",
	"example": "Newspaper",
	"type": "string",
	"description": "In what medium was the article published?",
	"suggestedvalues": [
    	"Journal",
    	"Book",
    	"Newspaper",
    	"Magazine"
	]
}

Adding suggested values for parameters with the template data editor

For the parameter types listed above, you can add suggested values using the template data editor.

Step 1. Click on "Manage TemplateData".
Step 2. Click on the name of the parameter you want to add suggested values to.
Step 3. If it’s not already, set the type of the parameter to one of the following: content, line, string, number, unknown or unbalanced wikitext. A new input field "Suggested values" will appear. If the parameter is already set to one of these types, the input field should already be visible.
Step 4. Type in the suggested value(s), including any spaces and special characters, and press enter to add it to the list.

Here you can see an example of how to add suggested values in the TemplateData editor.

Used templates

Main page: Wikipedia:TemplateData/Used templates

See also

• Wikipedia:VisualEditor/TemplateData/List A list of all pages with template data

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

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
English text	1	The word as translated into English. Note this will sometimes be the actual Japanese word if it has been adopted 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
Lead formatting	lead	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. Pahasi din niŋ talahi yes	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 be bolded). Literal translations and linguistic glosses must use single quotation marks, not double.	String	optional