Template:ja-r/documentation

Definition from Wiktionary, the free dictionary
Jump to: navigation, search
Edit-copy green.svg Documentation for Template:ja-r. [edit]
This page contains usage information, categories, interwiki links and other content describing the template.

This is a wrapper for {{l}} that does two things:

  1. automatic romanization (which is italicized here and put in l's tr parameter)
  2. placing of furigana aka ruby over the linked term (the term with furigana is put in l's third unnamed parameter)

The "r" stands for "ruby". This template generates content using the modules Module:ja-link and Module:ja.

Parameters[edit]

|1=
The term itself that we want to link to (which is put directly into l's second unnamed parameter)
|2= (if the first term contains non-kana characters)
The term written entirely in kana with regular ASCII spaces between words (so that there will be spaces in the romanization, not relevant to the placing of furigana)
|3= or |gloss= (optional)
Same as the gloss field of l.
|pos=
Part of speech.
|linkto= (optional)
Make the link point to this. Useful for -na adjectives or suru verbs where you want the link to point to the lemma but be displayed as the form plus suru or -na, e.g.  (にゅう) (しゅ)する (nyūshu suru) which displays 入手する with ruby but points to 入手.
|caps= (optional)
set to any value to capitalize the first letters of each word (for proper nouns)
|rom=
Override the romaji.

For example, {{ja-r|猿も木から落ちる|さる も き から おちる}} produces  (さる) ()から ()ちる (saru mo ki kara ochiru).

Known bug[edit]

The automatic placement of ruby fails in rare cases, for instance when the same kana occurs in both the parameter containing kanji and the parameter containing kana, and the parameter containing kana has two instances of this kana. (Below, the kana in question is .)

It's possible to force the ruby to align correctly by placing percent signs between words in the term (in addition to the kana version.) The percent signs won't be displayed in the link. For example:

Transliteration[edit]

Use a period (full stop) between two kana to force a two consecutive vowels to be transliterated separately rather than as a long vowel. For example:

{{ja-r|羨ましい|うらやまし.い}}

produces

 (うらや)ましい (urayamashii)

rather than

 (うらや)ましい (urayamashī)

Dividing kana between kanji[edit]

Currently, kana sequences that correspond to multiple kanji are divided one per kana if possible. Otherwise, they are parsed into syllables. If the number of syllables is equal to the number of kanji, then one syllable is placed above each kanji. Otherwise, the sequence of kana is grouped with the whole sequence of kanji.

Cases where automatic grouping works:

In certain cases, the parsing function will not generate the correct grouping. This includes cases in which a single kanji is pronounced with two or more consonant-initial syllables, or with a sequence of two vowels (not forming a long vowel), or in which a sequence that is sometimes read as a long vowel is divided between kanji.

In such cases, use a percent sign (%) in both the kanji and kana parameters to determine which kana go above which kanji:

Spaces can also be used, if the corresponding kana contains a space:

  • {{ja-usex|私の学校は花園があります。|わたし の がっこう は はなぞの が あります。|My school has a flower garden.}}

     (わたし) (がっ) (こう)花園 (はなぞの)あります
    Watashi no gakkō wa hanazono ga arimasu.
    My school has a flower garden.
  • {{ja-usex|私の学校 は 花園があります。|わたし の がっこう は はなぞの が あります。|My school has a flower garden.}}

     (わたし) (がっ) (こう)花園 (はなぞの)あります
    Watashi no gakkō wa hanazono ga arimasu.
    My school has a flower garden.