Template:ja-kanjitab/documentation

This template shows a table of kanji in a term. It uses Module:kanjitab.

Usage
This can be used in two ways:
 * 1) The conventional kanji-only mode, which only links to the kanji in the term. This template knows what kanji are in the term by itself, so one need only enter   with no parameters.
 * 2) The newer readings mode, which links to kanji, shows their readings, and adds readings categories.

In either case, use the template at the top of the Etymology section. This creates a table floated at the right margin.

For example, the entry 外来語 would include the following:

===Etymology===

or

===Etymology===

Note: if there is no other etymology text, do not use the  header; (which would create an apparently blank section) the  template follows the   header.

How to use kanjitab with kanji readings
This expects the readings of the kanji separated by pipes. For example, would have  ; for, we have. A number can follow kana if the kana is intended for more than one kanji, e.g., for we have.

What about a word like ? The original readings of those kanji are and, so those go in between the pipes. They are the modern readings before sound changes such as rendaku or sokuon. (The actual readings can be specified in k1, k2, k3, etc.--see below.) That is, they are the readings of the individual kanji as they appear on the pages of the respective kanji, not as they are read in that particular word (if they differ.)

Historical readings, such as the former pronunciations and  for  that developed into the modern pronunciation  through onbin, are not meant to be included in the template.

Additional parameters:
 *  ,  ,  ,  ,  ,  ,   Optional
 * If there is a sound change in a kanji's reading, enter that altered reading in k1 for the first kanji, k2 for the second, etc. When k1, k2, etc. are defined, it uses those in place of the even unnamed parameters (the readings before sound changes) to create the sort key when sort is omitted.


 * For, k1=はっ and k2=ぴょう. The whole thing is.
 * For, k2=んちゅ. The whole thing is.


 *  ,  ,  ,  ,  ,  ,   Optional
 * o is for omitted okurigana. The readings used in "read as" categories are conservative and stick with the "core" readings that are as general as possible. Use these for cases like or.
 *  : Optional
 * This should only be used when there are kana that are not covered by kanji, for example in terms with leading honorific お, verbs, or terms with irregular readings. Enter the kana as-is. (No need for quotes on the end as for   in other templates.) This kana string can be any mix of hiragana or katakana. It is turned into the proper sort key automatically by Module:Jpan-sortkey.
 *  : Optional
 * Categorizes the term according to its reading type. Choose from the following values:


 * o or on: on'yomi
 * kanon: kanon
 * goon: go'on
 * soon: sōon
 * toon: tōon
 * kan, kanyo, or kanyoon: kan'yōon
 * k or kun: kun'yomi
 * juku, jukuji, jukujikun: jukujikun
 * n or nanori: nanori
 * ok or j: jūbakoyomi . Only applies to the whole term.
 * ko or y: yutōyomi . Only applies to the whole term.
 * irr, irreg, or irregular: irregular
 * It is also possible to specify values for individual kanji rather than the whole term, by separating them with commas. Each value should be followed by a number if it spans more than one kanji. For example, for we would have , and for  we would have.


 *  : Optional
 * Marks the kanji as . If equals, all kanji will be marked as ateji (e.g. ). Otherwise the format is one or more   (or  ) joined by  . For example,  would have  , and  would have.

For example, on we would have: ""

If the kana reading is the same as the sum of the readings parameters, the   parameter and k1, k2, etc. may be omitted, and the template will concatenate all of the even unnamed parameters and make a sort key from that. This covers most cases.

For example, on we would have: ""

If the term exhibits rendaku, the parameter r may be set to any value to add the term to Category: terms with rendaku.


 *  : Optional
 * Alternative kanji spellings of the word, separated by commas. Needed if you want to redirect with.
 * Labels can be added with the following syntax:
 * Such labels are identical to those used in label, and will be processed as such. It will also appear on the ja-see redirect. For example, see and  ("equestrianism"), or  and  ("Brazil, obsolete").
 * Such labels are identical to those used in label, and will be processed as such. It will also appear on the ja-see redirect. For example, see and  ("equestrianism"), or  and  ("Brazil, obsolete").


 *  : Optional
 * Prohibits multiple kanjitabs from occupying the same line.

Categorization
On the back end, this template adds categories that group entries by the readings of their kanji, of the form " terms spelled with (kanji) read as (reading)".

For example, has Category:Japanese terms spelled with 発 read as はつ and Category:Japanese terms spelled with 表 read as ひょう;  has Category:Okinawan terms spelled with 民 read as みん and Category:Okinawan terms spelled with 国 read as くく.

These categories in turn belong in two parent categories: one of the form " terms spelled with (kanji)", (the same category link generated by the kanji headword line template), and the other of the form " terms spelled with kanji read as (reading)". Use (with the appropriate reading types specified as numbered parameters) to generate the readings subcategories. See the documentation of for more information.