ref
Summary
- Description
-
Scripture reference. For marking scripture references, with an optional machine-readable target location.
- Syntax
-
-
USFM:
\refcontent|@loc\ref* -
USX:
<ref@loc @gen>content</char>- loc
-
Use for explicitely identifying the target scripture reference. (default attribute)
-
Follows the pattern:
[A-Z1-4]{3}(-[A-Z1-4]{3})? ?[a-z0-9\-:]*. -
Example:
MAT 3:1-4, where:-
Book names is a standard 3-character scripture book identifier.
-
The chapter + verse separator is a colon
:. -
Verse ranges are indicated using a hyphen.
-
-
- gen
-
Set the value to
trueto indicate that a<ref>tag was auto-generated. Auto-generated tags can be stripped from USFM texts converted from USX.
-
- Valid In
-
[BookTitles],[BookIntroduction],[BookIntroductionEndTitles],[Section],[Para](Body Paragraphs, Poetry),[List],[Table],[Footnote],[CrossReference] - Added
-
3.1
Examples
-
USFM
-
USX
-
USJ
Example 1. Target references in \xt without \ref - Matthew 5.13 (GNT)
\id MAT
\c 13
\s1 Salt and Light
\r (Mark 9.50; Luke 14.34,35)
\p
\v 13 \x - \xo 5.13: \xt Mk 9.50; Lk 14.34,35.\x*“You are like salt for the whole
human race. But if salt loses its saltiness, there is no way to make it salty
again. It has become worthless, so it is thrown out and people trample on it.Example 2. Corresponding target references with auto-generated ref tags - Matthew 5.13 (GNT)
<usx version="3.1">
<book code="MAT" style="id"/>
<chapter number="5" style="c" sid="MAT 5"/>
<para style="p">
<verse number="13" style="v" sid="MAT 5:13"/>
<note caller="-" style="x">
<char style="xo">5.13: </char>
<char style="xt">
<ref loc="MRK 9:50" gen="true">Mk 9.50</ref>; <ref loc="LUK 14:34"
gen="true">Lk 14.34</ref>,<ref loc="LUK 14:35"
gen="true">35</ref>.</char>
</note>“You are like salt for the whole human race. But if salt loses its
saltiness, there is no way to make it salty again. It has become worthless,
so it is thrown out and people trample on it.<verse eid="MAT 5:13"/></para>
</usx>Example 3. Corresponding target references with auto-generated ref tags - Matthew 5.13 (GNT)
{
"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": "13",
"sid": "MAT 5:13"
},
{
"type": "note",
"marker": "x",
"caller": "-",
"content": [
{
"type": "char",
"marker": "xo",
"content": ["5.13: "]
},
{
"type": "char",
"marker": "xt",
"content": [
{
"type": "ref",
"loc": "MRK 9:50",
"gen": "true",
"content": ["Mk 9.50"]
},
"; ",
{
"type": "ref",
"loc": "LUK 14:34",
"gen": "true",
"content": ["Lk 14.34"]
},
",",
{
"type": "ref",
"loc": "LUK 14:35",
"gen": "true",
"content": ["35"]
},
"."
]
}
]
},
"“You are like salt for the whole human race. But if salt loses its saltiness, there is no way to make it salty again. It has become worthless, so it is thrown out and people trample on it."
]
}
]
}-
USFM
-
USX
-
USJ
Example 4. Target references in \xt with supplied \ref - Matthew 5.13 (GNT)
\id MAT
\c 13
\s1 Salt and Light
\r (Mark 9.50; Luke 14.34,35)
\p
\v 13 \x - \xo 5.13: \xt \ref Mk 9.50|MRK 9:50\ref*;
\ref Lk 14.34|LUK 14:34\ref*,\ref 35|LUK 14:35\ref*.\x*“You are like salt for the
whole human race. But if salt loses its saltiness, there is no way to make it
salty again. It has become worthless, so it is thrown out and people trample on it.Example 5. Target references with ref tags - Matthew 5.13 (GNT)
<usx version="3.1">
<book code="MAT" style="id"/>
<chapter number="5" style="c" sid="MAT 5"/>
<para style="p">
<verse number="13" style="v" sid="MAT 5:13"/>
<note caller="-" style="x">
<char style="xo">5.13: </char>
<char style="xt">
<ref loc="MRK 9:50">Mk 9.50</ref>; <ref loc="LUK 14:34">Lk 14.34</ref>,<ref
loc="LUK 14:35">35</ref>.</char>
</note>“You are like salt for the whole human race. But if salt loses its
saltiness, there is no way to make it salty again. It has become worthless,
so it is thrown out and people trample on it.<verse eid="MAT 5:13"/></para>
</usx>Example 6. Target references with ref tags - Matthew 5.13 (GNT)
{
"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": "13",
"sid": "MAT 5:13"
},
{
"type": "note",
"marker": "x",
"caller": "-",
"content": [
{
"type": "char",
"marker": "xo",
"content": ["5.13: "]
},
{
"type": "char",
"marker": "xt",
"content": [
{
"type": "ref",
"loc": "MRK 9:50",
"content": ["Mk 9.50"]
},
"; ",
{
"type": "ref",
"loc": "LUK 14:34",
"content": ["Lk 14.34"]
},
",",
{
"type": "ref",
"loc": "LUK 14:35",
"content": ["35"]
},
"."
]
}
]
},
"“You are like salt for the whole human race. But if salt loses its saltiness, there is no way to make it salty again. It has become worthless, so it is thrown out and people trample on it."
]
}
]
}