rb

About Ruby

Han characters: Chinese, Japanese, and Korean texts have some characters that they share in common. In Japanese these are called Kanji (literally “Han characters”). There are several thousand of these characters to learn. For new readers or readers new to the Biblical texts it may be very difficult for them to recognize what Chinese or Japanese word corresponds to the Han character(s) they are seeing.

Ruby glosses: In order to help these readers, some Bibles are printed with glosses using small phonetic characters (e.g. Japanese uses the hiragana alphabet) placed above the more symbolic Han characters to tell the reader how to pronounce the character. These phonetic characters are generically called “ruby glosses” or “rubies”. In Japanese this technique is called Furigana.

Summary

Description

Ruby gloss. Used to annotate the base text with ruby characters.

Syntax help
  • USFM: \rb content|@gloss\rb*

  • USX: <char style="rb" @gloss>content</char>

    gloss

    Ruby gloss characters (default attribute)

    • If the base text being glossed (B) is a phrase of multiple Han characters, then the ruby gloss text (gg) may contain multiple elements, one for glossing each of the base text characters making up the phrase. Use a colon : to separate multiple glossing characters. Parts of a phrase gloss may be left empty. Example: \rb BB|"gg:gg"\rb* or \rb BBBB|gg1::gg3:\rb*.

Style Type

Character

Valid In

[BookTitles], [BookIntroduction], [BookIntroductionEndTitles], [Section], [Para] (Body Paragraphs, Poetry), [List], [Table]

Added

3.0

Examples

  • USFM

  • USX

  • USJ

Example 1. One Han character with a single ruby gloss
\p \rb 哀|あい\rb*
Example 2. One Han character with a single ruby gloss
<para style="p><char style="rb" gloss="あい">哀</char></para>
Example 3. One Han character with a single ruby gloss
{
  "type": "para",
  "marker": "p",
  "content": [
    {
      "type": "char",
      "marker": "rb",
      "gloss": "あい",
      "content": [
        "哀"
      ]
    }
  ]
}
  • USFM

  • USX

  • USJ

Example 4. Two Han characters with a single ruby phrase gloss
\p \rb 話賄|はなはなし\rb*
Example 5. Two Han characters with a single ruby phrase gloss
<para style="p"><char style="rb" gloss="はなはなし">話賄</char></para>
Example 6. Two Han characters with a single ruby phrase gloss
{
  "type": "para",
  "marker": "p",
  "content": [
    {
      "type": "char",
      "marker": "rb",
      "gloss": "はなはなし",
      "content": ["話賄"]
    }
  ]
}
  • USFM

  • USX

  • USJ

Example 7. Phrase gloss with portions of ruby characters separated by a colon
\p \rb 話賄|はな:はなし\rb*
Example 8. Phrase gloss with portions of ruby characters separated by a colon
<para style="p"><char style="rb" gloss="はな:はなし">話賄</char></para>
Example 9. Phrase gloss with portions of ruby characters separated by a colon
{
  "type": "para",
  "marker": "p",
  "content": [
    {
      "type": "char",
      "marker": "rb",
      "gloss": "はな:はなし",
      "content": ["話賄"]
    }
  ]
}
  • USFM

  • USX

  • USJ

Example 10. Character sequence which includes a non-Han character which is NOT glossed
\p \rb 定ま|さだ:\rb*
Example 11. Character sequence which includes a non-Han character which is NOT glossed
<para style="p"><char style="rb" gloss="さだ:">定ま</char></para>
Example 12. Character sequence which includes a non-Han character which is NOT glossed
{
  "type": "para",
  "marker": "p",
  "content": [
    {
      "type": "char",
      "marker": "rb",
      "gloss": "さだ:",
      "content": ["定ま"]
    }
  ]
}
  • USFM

  • USX

  • USJ

Example 13. Un-glossed character occurring between glossed characters in a phrase
\p \rb 神の子|かみ::こ\rb*
Example 14. Un-glossed character occurring between glossed characters in a phrase
<para style="p"><char style="rb" gloss="かみ::こ">神の子</char></para>
Example 15. Un-glossed character occurring between glossed characters in a phrase
{
  "type": "para",
  "marker": "p",
  "content": [
    {
      "type": "char",
      "marker": "rb",
      "gloss": "かみ::こ",
      "content": ["神の子"]
    }
  ]
}
  • USFM

  • USX

  • USJ

Example 16. Genesis 1.1-2 (Japanese Contemporary Bible - Biblica)
\id GEN
\c 1
\p
\v 1 まだ\rb 何|なに\rb*もなかった\rb 時|とき\rb*、\rb 神|かみ\rb*は\rb 天|てん\rb*と
\rb 地|ち\rb*を\rb 造|つく\rb*りました。
\v 2 \rb 地|ち\rb*は\rb 形|かたち\rb*も\rb 定|さだ\rb*まらず、\rb 闇|やみ\rb*に
\rb 包|つつ\rb*まれた\rb 水|みず\rb*の\rb 上|うえ\rb*を、さらに\rb 神|かみ\rb*の
\rb 霊|れい\rb*が\rb 覆|おお\rb*っていました。
Example 17. Genesis 1.1-2 (Japanese Contemporary Bible - Biblica)
<usx version="3.1">
  <book code="MAT" style="id"/>
  <chapter number="5" style="c" sid="MAT 5"/>
  <para style="p">
    <verse number="1" style="v" sid="GEN 1:1"/>まだ
    <char style="rb" gloss="なに">何</char>もなかった
    <char style="rb" gloss="とき">時</char>、
    <char style="rb" gloss="かみ">神</char>は
    <char style="rb" gloss="てん">天</char>と
    <char style="rb" gloss="ち">地</char>を
    <char style="rb" gloss="つく">造</char>りました。
    <verse eid="GEN 1:1"/>
    <verse number="2" style="v" sid="GEN 1:2"/>
    <char style="rb" gloss="ち">地</char>は
    <char style="rb" gloss="かたち">形</char>も
    <char style="rb" gloss="さだ">定</char>まらず、
    <char style="rb" gloss="やみ">闇</char>に
    <char style="rb" gloss="つつ">包</char>まれた
    <char style="rb" gloss="みず">水</char>の
    <char style="rb" gloss="うえ">上</char>を、さらに
    <char style="rb" gloss="かみ">神</char>の
    <char style="rb" gloss="れい">霊</char>が
    <char style="rb" gloss="おお">覆</char>っていました。
    <verse eid="GEN 1:2"/></para>
</usx>
Example 18. Genesis 1.1-2 (Japanese Contemporary Bible - Biblica)
{
  "type": "USJ",
  "version": "3.1",
  "content": [
    {
      "type": "book",
      "marker": "id",
      "code": "MAT",
      "content": []
    },
    {
      "type": "chapter",
      "marker": "c",
      "number": "5",
      "sid": "MAT 5"
    },
    {
      "type": "para",
      "marker": "p",
      "content": [
        {
          "type": "verse",
          "marker": "v",
          "number": "1",
          "sid": "GEN 1:1"
        },
        "まだ ",
        {
          "type": "char",
          "marker": "rb",
          "gloss": "なに",
          "content": ["何"]
        },
        " もなかった ",
        {
          "type": "char",
          "marker": "rb",
          "gloss": "とき",
          "content": ["時"]
        },
        "、 ",
        {
          "type": "char",
          "marker": "rb",
          "gloss": "かみ",
          "content": [" 神"]
        },
        "は ",
        {
          "type": "char",
          "marker": "rb",
          "gloss": "てん",
          "content": ["天"]
        },
        "と ",
        {
          "type": "char",
          "marker": "rb",
          "gloss": "ち",
          "content": ["地"]
        },
        " を ",
        {
          "type": "char",
          "marker": "rb",
          "gloss": "つく",
          "content": ["造"]
        },
        "りました。 ",
        {
          "type": "verse",
          "marker": "v",
          "number": "2",
          "sid": "GEN 1:2"
        },
        {
          "type": "char",
          "marker": "rb",
          "gloss": "ち",
          "content": ["地"]
        },
        "は ",
        {
          "type": "char",
          "marker": "rb",
          "gloss": "かたち",
          "content": ["形"]
        },
        "も ",
        {
          "type": "char",
          "marker": "rb",
          "gloss": "さだ",
          "content": ["定"]
        },
        "まらず、 ",
        {
          "type": "char",
          "marker": "rb",
          "gloss": "やみ",
          "content": ["闇"]
        },
        "に ",
        {
          "type": "char",
          "marker": "rb",
          "gloss": "つつ",
          "content": ["包"]
        },
        "まれた ",
        {
          "type": "char",
          "marker": "rb",
          "gloss": "みず",
          "content": ["水"]
        },
        "の ",
        {
          "type": "char",
          "marker": "rb",
          "gloss": "うえ",
          "content": ["上"]
        },
        "を、さらに ",
        {
          "type": "char",
          "marker": "rb",
          "gloss": "かみ",
          "content": ["神"]
        },
        "の ",
        {
          "type": "char",
          "marker": "rb",
          "gloss": "れい",
          "content": ["霊"]
        },
        "が ",
        {
          "type": "char",
          "marker": "rb",
          "gloss": "おお",
          "content": ["覆"]
        },
        "っていました。 "
      ]
    }
  ]
}
Genesis 1.1-2 (Japanese Contemporary Bible - Biblica)

Properties

TextType

VerseText

TextProperties

publishable, vernacular

Publication Issues