Difference in JSON Outputs of 2.x and 3.x

⚠️ The output of 3.0.0-alpha.5 python module has been added here and is still under finalization process.

The main changes brought in JSON strcuture of 3.x versions are shown below

The Basic USFM Components

The minimal set of markers

Input

usfm-grammar 2.x

usfm-grammar 3.x

 \id GEN
 \c 1
 \p
 \v 1 verse one
 \v 2 verse two

      
 {"book":{"bookCode":"GEN"},
   "chapters":[
   {"chapterNumber":"1",
       "contents":[
         {"p":null},
         {"verseNumber":"1",
           "verseText":"verse one",
           "contents":[
           "verse one"
             ]},
         {"verseNumber":"2",
           "verseText":"verse two",
           "contents":[
           "verse two"
             ]}
         ]}
     ],
   "_messages":{"_warnings":[]}}

{"book": {
    "bookCode": "GEN",
    "chapters": [
      {
        "chapterNumber": "1",
        "contents": [
          {
            "p": [
              {"verseNumber": "1"},
              {"verseText": "verse one"},
              {"verseNumber": "2"},
              {"verseText": "verse two"}
            ]
          }
        ]
      }
    ]
  }
}

Multiple chapters

Input

usfm-grammar 2.x

usfm-grammar 3.x

 \id GEN
 \c 1
 \p
 \v 1 the first verse
 \v 2 the second verse
 \c 2
 \p
 \v 1 the third verse
 \v 2 the fourth verse

      
 {"book":{"bookCode":"GEN"},
   "chapters":[
   {"chapterNumber":"1",
       "contents":[
       {"p":null},
         {"verseNumber":"1",
           "verseText":"the first verse",
           "contents":[
           "the first verse"
             ]},
         {"verseNumber":"2",
           "verseText":"the second verse",
           "contents":[
           "the second verse"
             ]}
         ]},
     {"chapterNumber":"2",
       "contents":[
       {"p":null},
         {"verseNumber":"1",
           "verseText":"the third verse",
           "contents":[
           "the third verse"
             ]},
         {"verseNumber":"2",
           "verseText":"the fourth verse",
           "contents":[
           "the fourth verse"
             ]}
         ]}
     ],
   "_messages":{"_warnings":[]}}

{
"book": {
"bookCode": "GEN",
"chapters": [
{
"chapterNumber": "1",
"contents": [
{
"p": [
{"verseNumber": "1"},
{"verseText": "the first verse"},
{"verseNumber": "2"},
{"verseText": "the second verse"}
]
}
]
},
{
"chapterNumber": "2",
"contents": [
{
"p": [
{"verseNumber": "1"},
{"verseText": "the third verse"},
{"verseNumber": "2"},
{"verseText": "the fourth verse"}
]
}
]
}
]
}
}

Section headings

Input

usfm-grammar 2.x

usfm-grammar 3.x

 \id GEN
 \c 1
 \p
 \v 1 the first verse
 \v 2 the second verse
 \s A new section
 \p
 \v 3 the third verse
 \v 4 the fourth verse

      
   {"book":{"bookCode":"GEN"},
     "chapters":[
     {"chapterNumber":"1",
         "contents":[
         {"p":null},
           {"verseNumber":"1",
             "verseText":"the first verse",
             "contents":[
             "the first verse"
               ]},
           {"verseNumber":"2",
             "verseText":"the second verse",
             "contents":[
             "the second verse",
               [
               {"s":[
                   "A new section"
                     ]}
                 ],
               {"p":null}
               ]},
           {"verseNumber":"3",
             "verseText":"the third verse",
             "contents":[
             "the third verse"
               ]},
           {"verseNumber":"4",
             "verseText":"the fourth verse",
             "contents":[
             "the fourth verse"
               ]}
           ]}
       ],
     "_messages":{"_warnings":[]}}

{
"book": {
"bookCode": "GEN",
"chapters": [
{
"chapterNumber": "1",
"contents": [
{
"p": [
{ "verseNumber": "1"},
{ "verseText": "the first verse"},
{ "verseNumber": "2"},
{ "verseText": "the second verse"}
]
},
{
"s": "A new section"
},
{
"p": [
{ "verseNumber": "3"},
{ "verseText": "the third verse"},
{ "verseNumber": "4"},
{ "verseText": "the fourth verse"}
]
}
]
}
]
}
}

Header section markers

Input

usfm-grammar 2.x

usfm-grammar 3.x

 \id MRK The Gospel of Mark
 \ide UTF-8
 \usfm 3.0
 \h Mark
 \mt2 The Gospel according to
 \mt1 MARK
 \is Introduction
 \ip \bk The Gospel according to Mark\bk* 
 begins with the statement...
 \c 1
 \p
 \v 1 the first verse
 \v 2 the second verse

      
   {"book":{"bookCode":"MRK",
       "description":"The Gospel of Mark",
       "meta":[
       {"ide":"UTF-8"},
         {"usfm":"3.0"},
         {"h":"Mark"},
         [
         {"mt2":[
             "The Gospel according to"
               ]},
           {"mt1":[
             "MARK"
               ]}
           ],
         {"is":[
           "Introduction"
             ]},
         {"ip":[
           {"bk":[
               "The Gospel according to Mark"
                 ],
               "closing":"\\bk*"},
             "begins with the statement..."
             ]}
         ]},
     "chapters":[
     {"chapterNumber":"1",
         "contents":[
         {"p":null},
           {"verseNumber":"1",
             "verseText":"the first verse",
             "contents":[
             "the first verse"
               ]},
           {"verseNumber":"2",
             "verseText":"the second verse",
             "contents":[
             "the second verse"
               ]}
           ]}
       ],
     "_messages":{"_warnings":[]}}

{
"book": {
"bookCode": "MRK",
"fileDescription": "The Gospel of Mark",
"headers": [
{"ide": "UTF-8"},
{"usfm": []},
{"h": "Mark"},
[
{"mt2": "The Gospel according to"},
{"mt1": "MARK"}
],
{"is": "Introduction"},
{"ip": "begins with the statement..."
}
],
"chapters": [
{"chapterNumber": "1","contents": [
{
"p": [
{"verseNumber": "1"},
{"verseText": "the first verse"},
{"verseNumber": "2"},
{"verseText": "the second verse"}
]
}
]
}
]
}
}

Footnotes

Input

usfm-grammar 2.x

usfm-grammar 3.x

 \id MAT
 \c 1
 \p
 \v 1 the first verse
 \v 2 the second verse
 \v 3 This is the Good News about Jesus 
 Christ, the Son of God. \f + \fr 1.1: 
 \ft Some manuscripts do not have \fq 
 the Son of God.\f*

      
   {"book":{"bookCode":"MAT"},
     "chapters":[
     {"chapterNumber":"1",
         "contents":[
         {"p":null},
           {"verseNumber":"1",
             "verseText":"the first verse",
             "contents":[
             "the first verse"
               ]},
           {"verseNumber":"2",
             "verseText":"the second verse",
             "contents":[
             "the second verse"
               ]},
           {"verseNumber":"3",
             "verseText":"This is the Good News about Jesus Christ,
             the Son of God.",
             "contents":[
             "This is the Good News about Jesus Christ,
               the Son of God.",
               {"footnote":[
                 {"caller":"+"},
                   {"fr":"1.1:"},
                   {"ft":"Some manuscripts do not have"},
                   {"fq":"the Son of God."}
                   ],
                 "closing":"\\f*"}
               ]}
           ]}
       ],
     "_messages":{"_warnings":[]}}

{
"book": {
"bookCode": "MAT",
"chapters": [
{
"chapterNumber": "1",
"contents": [
{
"p": [
{ "verseNumber": "1"},
{ "verseText": "the first verse"},
{ "verseNumber": "2"},
{ "verseText": "the second verse"},
{ "verseNumber": "3"},
{ "verseText": "This is the Good News about Jesus \n Christ, the Son of God."},
{ "f": [
{"caller": "+"},
{"fr": "1.1:"},
{"ft": "Some manuscripts do not have"},
{"fq": "the Son of God."}
], "closing": "\f*"},
{ "verseText": ""}
]
}
]
}
]
}
}

Cross-refs

Input

usfm-grammar 2.x

usfm-grammar 3.x

 \id MAT
 \c 1
 \p
 \v 1 the first verse
 \v 2 the second verse
 \v 3 \x - \xo 2.23: \xt Mrk 1.24; 
 Luk 2.39; Jhn 1.45.\x* and made his 
 home in a town named Nazareth.

      
 {"book":{"bookCode":"MAT"},
   "chapters":[
   {"chapterNumber":"1",
       "contents":[
       {"p":null},
         {"verseNumber":"1",
           "verseText":"the first verse",
           "contents":[
           "the first verse"
             ]},
         {"verseNumber":"2",
           "verseText":"the second verse",
           "contents":[
           "the second verse"
             ]},
         {"verseNumber":"3",
           "verseText":"and made his home in a town named Nazareth.",
           "contents":[
           {"cross-ref":[
               {"caller":"-"},
                 {"xo":"2.23:"},
                 {"xt":"Mrk 1.24; Luk 2.39; Jhn 1.45."}
                 ],
               "closing":"\\x* "},
             "and made his home in a town named Nazareth."
             ]}
         ]}
     ],
   "_messages":{"_warnings":[]}}

{
"book": {
"bookCode": "MAT",
"chapters": [
{
"chapterNumber": "1",
"contents": [
{
"p": [
{"verseNumber": "1"},
{"verseText": "the first verse"},
{"verseNumber": "2"},
{"verseText": "the second verse"},
{"verseNumber": "3"},
{
"x": [
{"caller": "-"},
{"xo": "2.23:"},
{"xt": "Mrk 1.24; \n Luk 2.39; Jhn 1.45."}
],
"closing": "\x*"
},
{"verseText": "and made his \n home in a town named Nazareth."}
]
}
]
}
]
}
}

Multiple para markers

Input

usfm-grammar 2.x

usfm-grammar 3.x

 \id JHN
 \c 1
 \s1 The Preaching of John the 
 Baptist
 \r (Matthew 3.1-12; Luke 3.1-18; 
 John 1.19-28)
 \p
 \v 1 This is the Good News about 
 Jesus Christ, the Son of God.
 \v 2 It began as the prophet 
 Isaiah had written:
 \q1 “God said, ‘I will send my 
 messenger ahead of you
 \q2 to open the way for you.’
 \q1
 \v 3 Someone is shouting in 
 the desert,
 \q2 ‘Get the road ready for 
 the Lord;
 \q2 make a straight path for 
 him to travel!’”
 \p
 \v 4 So John appeared in the 
 desert, baptizing and preaching. 
 “Turn away from your sins and 
 be baptized,” he told the people, 
 “and God will forgive your sins.”

      
   {"book":{"bookCode":"JHN"},
     "chapters":[
     {"chapterNumber":"1",
         "contents":[
         [
           {"s1":[
               "The Preaching of John the Baptist"
                 ]},
             {"r":[
               "(Matthew 3.1-12; Luke 3.1-18; John 1.19-28)"
                 ]}
             ],
           {"p":null},
           {"verseNumber":"1",
             "verseText":"This is the Good News about Jesus Christ,
             the Son of God.",
             "contents":[
             "This is the Good News about Jesus Christ,
               the Son of God."
               ]},
           {"verseNumber":"2",
             "verseText":"It began as the prophet Isaiah had written: �God said,
             �I will send my messenger ahead of you to open the way for you.�",
             "contents":[
             "It began as the prophet Isaiah had written:",
               {"q1":null},
               "�God said,
               �I will send my messenger ahead of you",
               {"q2":null},
               "to open the way for you.�",
               {"q1":null}
               ]},
           {"verseNumber":"3",
             "verseText":"Someone is shouting in the desert,
             �Get the road ready for the Lord; make a straight path for him to travel!��",
             "contents":[
             "Someone is shouting in the desert,
               ",
               {"q2":null},
               "�Get the road ready for the Lord;",
               {"q2":null},
               "make a straight path for him to travel!��",
               {"p":null}
               ]},
           {"verseNumber":"4",
             "verseText":"So John appeared in the desert,
             baptizing and preaching. �Turn away from your sins and be baptized,
             � he told the people,
             �and God will forgive your sins.�",
             "contents":[
             "So John appeared in the desert,
               baptizing and preaching. �Turn away from your sins and be baptized,
               � he told the people,
               �and God will forgive your sins.�"
               ]}
           ]}
       ],
     "_messages":{"_warnings":[]}}

{
"book": {
"bookCode": "JHN",
"chapters": [
{
"chapterNumber": "1",
"contents": [
{
"s1": "The Preaching of John the \n Baptist"
},
{
"p": [
{ "verseNumber": "1"},
{ "verseText": "This is the Good News about \n Jesus Christ, the Son of God."},
{ "verseNumber": "2"},
{ "verseText": "It began as the prophet \n Isaiah had written:"}
]
},
{
"poetry": [
{
"q1": { "verseText": "“God said, ‘I will send my \n messenger ahead of you"}
},
{
"q2": { "verseText": "to open the way for you.’"}
},
{
"q1": [
{"verseNumber": "3"},
{"verseText": "Someone is shouting in \n the desert,"}
]
},
{
"q2": { "verseText": "‘Get the road ready for \n the Lord;"}
},
{
"q2": { "verseText": "make a straight path for \n him to travel!’”"}
}
]
},
{
"p": [
{ "verseNumber": "4"},
{ "verseText": "So John appeared in the \n desert, baptizing and preaching. \n “Turn away from your sins and \n be baptized,” he told the people, \n “and God will forgive your sins.”"}
]
}
]
}
]
}
}

Character markers

Input

usfm-grammar 2.x

usfm-grammar 3.x

 \id GEN
 \c 1
 \p
 \v 1 the first verse
 \v 2 the second verse
 \v 15 Tell the Israelites that I, 
 the \nd Lord\nd*, the God of their 
 ancestors, the God of Abraham, Isaac, 
 and Jacob,

      
   {"book":{"bookCode":"GEN"},
     "chapters":[
     {"chapterNumber":"1",
         "contents":[
         {"p":null},
           {"verseNumber":"1",
             "verseText":"the first verse",
             "contents":[
             "the first verse"
               ]},
           {"verseNumber":"2",
             "verseText":"the second verse",
             "contents":[
             "the second verse"
               ]},
           {"verseNumber":"15",
             "verseText":"Tell the Israelites that I,
             the Lord,
             the God of their ancestors,
             the God of Abraham,
             Isaac,
             and Jacob,
             ",
             "contents":[
             "Tell the Israelites that I,
               the",
               {"nd":[
                 "Lord"
                   ],
                 "closing":"\\nd*"},
               ",
               the God of their ancestors,
               the God of Abraham,
               Isaac,
               and Jacob,
               "
               ]}
           ]}
       ],
     "_messages":{"_warnings":[]}}

{
"book": {
"bookCode": "GEN",
"chapters": [
{
"chapterNumber": "1",
"contents": [
{
"p": [
{"verseNumber": "1"},
{"verseText": "the first verse"},
{"verseNumber": "2"},
{"verseText": "the second verse"},
{"verseNumber": "15"},
[
{"verseText": "Tell the Israelites that I, \n the"},
{"nd": "Lord",
"closing": "\nd*"},
{"verseText": ", the God of their \n ancestors, the God of Abraham, Isaac, \n and Jacob,"}
]
]
}
]
}
]
}
}

Markers with attributes

Input

usfm-grammar 2.x

usfm-grammar 3.x

 \id GEN
 \c 1
 \p
 \v 1 the first verse
 \v 2 the second verse \w gracious|lemma="grace"\w*

      
   {"book":{"bookCode":"GEN"},
     "chapters":[
     {"chapterNumber":"1",
         "contents":[
         {"p":null},
           {"verseNumber":"1",
             "verseText":"the first verse",
             "contents":[
             "the first verse"
               ]},
           {"verseNumber":"2",
             "verseText":"the second verse gracious",
             "contents":[
             "the second verse",
               {"w":[
                 "gracious"
                   ],
                 "attributes":[
                 {"lemma":"grace"}
                   ],
                 "closing":"\\w*"}
               ]}
           ]}
       ],
     "_messages":{"_warnings":[]}}

{
"book": {
"bookCode": "GEN",
"chapters": [
{
"chapterNumber": "1",
"contents": [
{
"p": [
{"verseNumber": "1"},
{"verseText": "the first verse"},
{"verseNumber": "2"},
[
{"verseText": "the second verse"},
{"w": "gracious",
"attributes": [
{"lemma": "grace"}
],
"closing": "\w*"},
{"verseText": ""}
]
]
}
]
}
]
}
}

More Complex Components

Lists

Input

usfm-grammar 2.x

usfm-grammar 3.x

 \id GEN
 \c 1
 \p
 \v 1 the first verse
 \v 2 the second verse
 \c 2
 \p
 \v 1 the third verse
 \v 2 the fourth verse
 \s1 Administration of the Tribes of Israel
 \lh
 \v 16-22 This is the list of the 
 administrators of the tribes of Israel:
 \li1 Reuben - Eliezer son of Zichri
 \li1 Simeon - Shephatiah son of Maacah
 \li1 Levi - Hashabiah son of Kemuel
 \lf This was the list of the 
 administrators of the tribes of Israel.

   {"book":{"bookCode":"GEN"},
     "chapters":[
     {"chapterNumber":"1",
         "contents":[
         {"p":null},
           {"verseNumber":"1",
             "verseText":"the first verse",
             "contents":[
             "the first verse"
               ]},
           {"verseNumber":"2",
             "verseText":"the second verse",
             "contents":[
             "the second verse"
               ]}
           ]},
       {"chapterNumber":"2",
         "contents":[
         {"p":null},
           {"verseNumber":"1",
             "verseText":"the third verse",
             "contents":[
             "the third verse"
               ]},
           {"verseNumber":"2",
             "verseText":"the fourth verse",
             "contents":[
             "the fourth verse",
               [
               {"s1":[
                   "Administration of the Tribes of Israel",
                     {"list":[
                       {"lh":null}
                         ]}
                     ]}
                 ]
               ]},
           {"verseNumber":"16-22",
             "verseText":"This is the list of the administrators of the tribes of Israel: Reuben - Eliezer son of Zichri Simeon - Shephatiah son of Maacah Levi - Hashabiah son of Kemuel This was the list of the administrators of the tribes of Israel.",
             "contents":[
             "This is the list of the administrators of the tribes of Israel:",
               {"list":[
                 {"li1":[
                     "Reuben - Eliezer son of Zichri"
                       ]},
                   {"li1":[
                     "Simeon - Shephatiah son of Maacah"
                       ]},
                   {"li1":[
                     "Levi - Hashabiah son of Kemuel"
                       ]},
                   {"lf":[
                     "This was the list of the administrators of the tribes of Israel."
                       ]}
                   ]}
               ]}
           ]}
       ],
     "_messages":{"_warnings":[]}}

{
"book": {
"bookCode": "GEN",
"chapters": [
{
"chapterNumber": "1",
"contents": [
{
"p": [
{"verseNumber": "1"},
{"verseText": "the first verse"},
{"verseNumber": "2"},
{"verseText": "the second verse"}
]
}
]
},
{
"chapterNumber": "2",
"contents": [
{
"p": [
{"verseNumber": "1"},
{"verseText": "the third verse"},
{"verseNumber": "2"},
{"verseText": "the fourth verse"}
]
},
{"s1": "Administration of the Tribes of Israel"},
{
"list": [
{"verseNumber": "16-22"},
{"verseText": "This is the list of the \n administrators of the tribes of Israel:"}
]
}
]
}
]
}
}

Header section with more markers

Input

usfm-grammar 2.x

usfm-grammar 3.x

 \id MRK 41MRKGNT92.SFM, Good News Translation, June 2003
 \h John
 \toc1 The Gospel according to John
 \toc2 John
 \mt2 The Gospel
 \mt3 according to
 \mt1 JOHN
 \ip The two endings to the Gospel, 
 which are enclosed in brackets, 
 are generally regarded as written 
 by someone other than the author 
 of \bk Mark\bk*
 \iot Outline of Contents
 \io1 The beginning of the 
 gospel \ior (1.1-13)\ior*
 \io1 Jesus' public ministry in 
 Galilee \ior (1.14–9.50)\ior*
 \io1 From Galilee to 
 Jerusalem \ior (10.1-52)\ior*
 \c 1
 \ms BOOK ONE
 \mr (Psalms 1–41)
 \p
 \v 1 the first verse
 \v 2 the second verse

{"book":{"bookCode":"MRK",
"description":"41MRKGNT92.SFM,
Good News Translation,
June 2003",
"meta":[
{"h":"John"},
{"toc1":[
"The Gospel according to John"
]},
{"toc2":[
"John"
]},
[
{"mt2":[
"The Gospel"
]},
{"mt3":[
"according to"
]},
{"mt1":[
"JOHN"
]}
],
{"ip":[
"The two endings to the Gospel,
which are enclosed in brackets,
are generally regarded as written by someone other than the author of",
{"bk":[
"Mark"
],
"closing":"\bk*"}
]},
{"iot":[
"Outline of Contents"
]},
[
{"io1":[
"The beginning of the gospel",
{"ior":[
"(1.1-13)"
],
"closing":"\ior*"}
]},
{"io1":[
"Jesus' public ministry in Galilee",
{"ior":[
"(1.14�9.50)"
],
"closing":"\ior*"}
]},
{"io1":[
"From Galilee to Jerusalem",
{"ior":[
"(10.1-52)"
],
"closing":"\ior*"}
]}
]
]},
"chapters":[
{"chapterNumber":"1",
"contents":[
[
{"ms":"BOOK ONE"},
{"mr":"(Psalms 1�41)"}
],
{"p":null},
{"verseNumber":"1",
"verseText":"the first verse",
"contents":[
"the first verse"
]},
{"verseNumber":"2",
"verseText":"the second verse",
"contents":[
"the second verse"
]}
]}
],
"_messages":{"_warnings":[]}}

{
"book": {
"bookCode": "MRK",
"fileDescription": "41MRKGNT92.SFM, Good News Translation, June 2003",
"headers": [
{"h": "John"},
[
{"toc1": "The Gospel according to John"},
{"toc2": "John"}
],
[
{"mt2": "The Gospel"},
{"mt3": "according to"},
{"mt1": "JOHN"}
],
{"ip": ""},
{"iot": "Outline of Contents"},
{"io1": "The beginning of the \n gospel"},
{"io1": "Jesus' public ministry in \n Galilee"},
{"io1": "From Galilee to \n Jerusalem"}
],
"chapters": [
{
"chapterNumber": "1",
"contents": [
{"ms": "BOOK ONE"},
{
"p": [
{"verseNumber": "1"},
{"verseText": "the first verse"},
{"verseNumber": "2"},
{"verseText": "the second verse"}
]
}
]
}
]
}
}

Character marker nesting

Input

usfm-grammar 2.x

usfm-grammar 3.x

 \id GEN
 \c 1
 \p
 \v 1 the first verse
 \v 2 the second verse
 \v 14 That is why \bk The Book of 
 the \+nd Lord\+nd*'s Battles\bk* 
 speaks of “...the town of Waheb in 
 the area of Suphah

   {"book":{"bookCode":"GEN"},
     "chapters":[
     {"chapterNumber":"1",
         "contents":[
         {"p":null},
           {"verseNumber":"1",
             "verseText":"the first verse",
             "contents":[
             "the first verse"
               ]},
           {"verseNumber":"2",
             "verseText":"the second verse",
             "contents":[
             "the second verse"
               ]},
           {"verseNumber":"14",
             "verseText":"That is why The Book of the Lord's Battles speaks of �...the town of Waheb in the area of Suphah",
             "contents":[
             "That is why",
               {"bk":[
                 "The Book of the",
                   {"+nd":[
                     "Lord"
                       ],
                     "closing":"\\+nd*"},
                   "'s Battles"
                   ],
                 "closing":"\\bk*"},
               "speaks of �...the town of Waheb in the area of Suphah"
               ]}
           ]}
       ],
     "_messages":{"_warnings":[]}}

{
"book": {
"bookCode": "GEN",
"chapters": [
{
"chapterNumber": "1",
"contents": [
{
"p": [
{"verseNumber": "1"},
{"verseText": "the first verse"},
{"verseNumber": "2"},
{"verseText": "the second verse"},
{"verseNumber": "14"},
[
{"verseText": "That is why"},
{
"bk": "'s Battles",
"closing": "\bk*"},
{"verseText": "speaks of “...the town of Waheb in \n the area of Suphah"}
]
]
}
]
}
]
}
}

Markers with default attributes

Input

usfm-grammar 2.x

usfm-grammar 3.x

 \id GEN
 \c 1
 \p
 \v 1 the first verse
 \v 2 the second verse \w gracious|grace\w*

 {"book":{"bookCode":"GEN"},
   "chapters":[
   {"chapterNumber":"1",
       "contents":[
       {"p":null},
         {"verseNumber":"1",
           "verseText":"the first verse",
           "contents":[
           "the first verse"
             ]},
         {"verseNumber":"2",
           "verseText":"the second verse gracious",
           "contents":[
           "the second verse",
             {"w":[
               "gracious"
                 ],
               "attributes":[
               {"defaultAttribute":"grace"}
                 ],
               "closing":"\\w*"}
             ]}
         ]}
     ],
   "_messages":{"_warnings":[]}}

{
"book": {
"bookCode": "GEN",
"chapters": [
{
"chapterNumber": "1",
"contents": [
{
"p": [
{"verseNumber": "1"},
{"verseText": "the first verse"},
{"verseNumber": "2"},
[
{"verseText": "the second verse"},
{"w": "gracious",
"attributes": [
{"lemma": "grace"}
],
"closing": "\w*"},
{"verseText": ""}
]
]
}
]
}
]
}
}

Link-attributes and custom attributes

Input

usfm-grammar 2.x

usfm-grammar 3.x

 \id GEN
 \c 1
 \p
 \v 1 the first verse
 \v 2 the second 
 verse \w gracious|x-myattr="metadata"\w*
 \q1 “Someone is shouting in the desert,
 \q2 ‘Prepare a road for the Lord;
 \q2 make a straight path for him to travel!’ ”
 \ms \jmp |link-id="article-john_the_baptist"\jmp*
 John the Baptist
 \p John is sometimes called...

   {"book":{"bookCode":"GEN"},
     "chapters":[
     {"chapterNumber":"1",
         "contents":[
         {"p":null},
           {"verseNumber":"1",
             "verseText":"the first verse",
             "contents":[
             "the first verse"
               ]},
           {"verseNumber":"2",
             "verseText":"the second verse gracious �Someone is shouting in the desert,
             �Prepare a road for the Lord; make a straight path for him to travel!� � s John the Baptist John is sometimes called...",
             "contents":[
             "the second",
               "verse",
               {"w":[
                 "gracious"
                   ],
                 "attributes":[
                 {"x-myattr":"metadata"}
                   ],
                 "closing":"\\w*"},
               {"q1":null},
               "�Someone is shouting in the desert,
               ",
               {"q2":null},
               "�Prepare a road for the Lord;",
               {"q2":null},
               "make a straight path for him to travel!� �",
               {"m":null},
               "s",
               {"jmp":[],
                 "attributes":[
                 {"link-id":"article-john_the_baptist"}
                   ],
                 "closing":"\\jmp*"},
               "John the Baptist",
               {"p":null},
               "John is sometimes called..."
               ]}
           ]}
       ],
     "_messages":{"_warnings":[]}}

{
"book": {
"bookCode": "GEN",
"chapters": [
{
"chapterNumber": "1",
"contents": [
{
"p": [
{"verseNumber": "1"},
{"verseText": "the first verse"},
{"verseNumber": "2"},
[
{"verseText": "the second \n verse"},
{"w": "gracious",
"attributes": [
{"x-myattr": "metadata"}
],
"closing": "\w*"},
{"verseText": ""}
]
]
},
{
"poetry": [
{
"q1": {"verseText": "“Someone is shouting in the desert,"}
},
{
"q2": {"verseText": "‘Prepare a road for the Lord;"}
},
{
"q2": {"verseText": "make a straight path for him to travel!’ ”"}
}
]
},
{
"ms": "John the Baptist"
},
{
"p": [
{"verseText": "John is sometimes called..."}
]
}
]
}
]
}
}

Table

Input

usfm-grammar 2.x

usfm-grammar 3.x

 \id GEN
 \c 1
 \p
 \v 1 the first verse
 \v 2 the second verse
 \p
 \v 12-83 They presented their 
 offerings in the following order:
 \tr \th1 Day \th2 Tribe \th3 Leader
 \tr \tcr1 1st \tc2 Judah \tc3 Nahshon 
 son of Amminadab
 \tr \tcr1 2nd \tc2 Issachar \tc3 Nethanel
  son of Zuar
 \tr \tcr1 3rd \tc2 Zebulun \tc3 Eliab 
 son of Helon

   {"book":{"bookCode":"GEN"},
     "chapters":[
     {"chapterNumber":"1",
         "contents":[
         {"p":null},
           {"verseNumber":"1",
             "verseText":"the first verse",
             "contents":[
             "the first verse"
               ]},
           {"verseNumber":"2",
             "verseText":"the second verse",
             "contents":[
             "the second verse",
               {"p":null}
               ]},
           {"verseNumber":"12-83",
             "verseText":"They presented their offerings in the following order: Day ~ Tribe ~ Leader ~ //1st ~ Judah ~ Nahshon son of Amminadab ~ //2nd ~ Issachar ~ Nethanel son of Zuar ~ //3rd ~ Zebulun ~ Eliab son of Helon ~ //",
             "contents":[
             "They presented their offerings in the following order:",
               {"table":{"header":[
                   {"th1":"Day"},
                     {"th2":"Tribe"},
                     {"th3":"Leader"}
                     ],
                   "rows":[
                   [
                     {"tcr1":"1st"},
                       {"tc2":"Judah"},
                       {"tc3":"Nahshon son of Amminadab"}
                       ],
                     [
                     {"tcr1":"2nd"},
                       {"tc2":"Issachar"},
                       {"tc3":"Nethanel son of Zuar"}
                       ],
                     [
                     {"tcr1":"3rd"},
                       {"tc2":"Zebulun"},
                       {"tc3":"Eliab son of Helon"}
                       ]
                     ]},
                 "text":"Day ~ Tribe ~ Leader ~ //1st ~ Judah ~ Nahshon son of Amminadab ~ //2nd ~ Issachar ~ Nethanel son of Zuar ~ //3rd ~ Zebulun ~ Eliab son of Helon ~ //"}
               ]}
           ]}
       ],
     "_messages":{"_warnings":[]}}

{
"book": {
"bookCode": "GEN",
"chapters": [
{
"chapterNumber": "1",
"contents": [
{
"p": [
{"verseNumber": "1"},
{"verseText": "the first verse"},
{"verseNumber": "2"},
{"verseText": "the second verse"}
]
},
{
"p": [
{"verseNumber": "12-83"},
{"verseText": "They presented their \n offerings in the following order:"}
]
},
{
"table": [
{
"tr": [
{"th1": {"verseText": "Day"}},
{"th2": {"verseText": "Tribe"}},
{"th3": {"verseText": "Leader"}}
]
},
{
"tr": [
{"tcr1": {"verseText": "1st"}},
{"tc2": {"verseText": "Judah"}},
{"tc3": {"verseText": "Nahshon \n son of Amminadab"}}
]
},
{
"tr": [
{"tcr1": {"verseText": "2nd"}},
{"tc2": {"verseText": "Issachar"}},
{"tc3": {"verseText": "Nethanel\n  son of Zuar"}}
]
},
{
"tr": [
{"tcr1": {"verseText": "3rd"}},
{"tc2": {"verseText": "Zebulun"}},
{"tc3": {"verseText": "Eliab \n son of Helon"}}
]
}
]
}
]
}
]
}
}

Milestones

Input

usfm-grammar 2.x

usfm-grammar 3.x

 \id GEN
 \c 1
 \p
 \v 1 the first verse
 \v 2 the second verse
 \v 3 \qt-s |sid="qt_123" who="Pilate"\*“Are you the king of the Jews?”\qt-e |eid="qt_123"\*

   {"book":{"bookCode":"GEN"},
     "chapters":[
     {"chapterNumber":"1",
         "contents":[
         {"p":null},
           {"verseNumber":"1",
             "verseText":"the first verse",
             "contents":[
             "the first verse"
               ]},
           {"verseNumber":"2",
             "verseText":"the second verse",
             "contents":[
             "the second verse"
               ]},
           {"verseNumber":"3",
             "verseText":"�Are you the king of the Jews?�",
             "contents":[
             {"milestone":"qt",
                 "delimter":"-s",
                 "closing":"\\*",
                 "attributes":[
                 {"sid":"qt_123"},
                   {"who":"Pilate"}
                   ]},
               "�Are you the king of the Jews?�",
               {"milestone":"qt",
                 "delimter":"-e",
                 "closing":"\\*",
                 "attributes":[
                 {"eid":"qt_123"}
                   ]}
               ]}
           ]}
       ],
     "_messages":{"_warnings":[]}}

{
"book": {
"bookCode": "GEN",
"chapters": [
{
"chapterNumber": "1",
"contents": [
{
"p": [
{"verseNumber": "1"},
{"verseText": "the first verse"},
{"verseNumber": "2"},
{"verseText": "the second verse"},
{"verseNumber": "3"},
{
"milestone": "qt-s",
"attributes": [
{"sid": "qt_123"},
{"who": "Pilate"}
]
},
{"verseText": "“Are you the king of the Jews?”"},
{
"milestone": "qt-e",
"attributes": [
{"eid": "qt_123"}
]
},
{"verseText": ""}
]
}
]
}
]
}
}

Alignment files

Input

usfm-grammar 2.x

usfm-grammar 3.x

 \id ACT
 \h प्रेरितों के काम
 \toc1 प्रेरितों के काम
 \toc2 प्रेरितों के काम
 \mt प्रेरितों के काम
 \c 1
 \v 1 \w हे|x-occurrence="1" x-occurrences="1"\w*\zaln-s | x-verified="true" x-occurrence="1"    x-occurrences="1" x-content="Θεόφιλε"
 \w थियुफिलुस|x-occurrence="1" x-occurrences="1"\w*
 \zaln-e\*
 \w मैंने|x-occurrence="1" x-occurrences="1"\w*\zaln-s | x-verified="true" x-occurrence="1"  x-occurrences="1" x-content="πρῶτον"
 \w पहली|x-occurrence="1" x-occurrences="1"\w*
 \zaln-e\*
 \w पुस्तिका|x-occurrence="1" x-occurrences="1"\w*\w उन|x-occurrence="1" x-occurrences="1"\w*\w सब|  x-occurrence="1" x-occurrences="1"\w*\zaln-s | x-verified="true" x-occurrence="1" x-occurrences="1"   x-content="λόγον"
 \w बातों|x-occurrence="1" x-occurrences="1"\w*
 \zaln-e\*
 \zaln-s | x-verified="true" x-occurrence="1" x-occurrences="1" x-content="ἀνελήμφθη"
 \w ऊपर|x-occurrence="1" x-occurrences="1"\w*\w उठाया|x-occurrence="1" x-occurrences="1"\w*
 \zaln-e\*
 \zaln-s | x-verified="true" x-occurrence="1" x-occurrences="1" x-content="ἄχρι"
 \w न|x-occurrence="1" x-occurrences="1"\w*
 \zaln-e\*
 \w गया|x-occurrence="1" x-occurrences="1"\w* 
 \v 30 और पौलुस पूरे दो वर्ष अपने किराये के घर में रहा,
 \v 31 और जो उसके पास आते थे, उन सबसे मिलता रहा और बिना रोक-टोक बहुत निडर होकर परमेश्‍वर के राज्य का     प्रचार करता और प्रभु यीशु मसीह की बातें सिखाता रहा।

   {"book":{"bookCode":"ACT",
       "meta":[
       {"h":"प्रेरितों के काम"},
         {"toc1":[
           "प्रेरितों के काम"
             ]},
         {"toc2":[
           "प्रेरितों के काम"
             ]},
         [
         {"mt":[
             "प्रेरितों के काम"
               ]}
           ]
         ]},
     "chapters":[
     {"chapterNumber":"1",
         "contents":[
         {"p":null},
           {"verseNumber":"1",
             "verseText":"हेथियुफिलुसमैंनेपहलीपुस्तिकाउनसबबातोंऊपरउठायानगया",
             "contents":[
             {"w":[
                 "हे"
                   ],
                 "attributes":[
                 {"x-occurrence":"1"},
                   {"x-occurrences":"1"}
                   ],
                 "closing":"\\w*"},
               {"milestone":"zaln",
                 "delimter":"-s",
                 "closing":"\\*",
                 "attributes":[
                 {"x-verified":"true"},
                   {"x-occurrence":"1"},
                   {"x-occurrences":"1"},
                   {"x-content":"Θεόφιλε"}
                   ]},
               {"w":[
                 "थियुफिलुस"
                   ],
                 "attributes":[
                 {"x-occurrence":"1"},
                   {"x-occurrences":"1"}
                   ],
                 "closing":"\\w*"},
               {"milestone":"zaln",
                 "delimter":"-e",
                 "closing":"\\*"},
               {"w":[
                 "मैंने"
                   ],
                 "attributes":[
                 {"x-occurrence":"1"},
                   {"x-occurrences":"1"}
                   ],
                 "closing":"\\w*"},
               {"milestone":"zaln",
                 "delimter":"-s",
                 "closing":"\\*",
                 "attributes":[
                 {"x-verified":"true"},
                   {"x-occurrence":"1"},
                   {"x-occurrences":"1"},
                   {"x-content":"πρῶτον"}
                   ]},
               {"w":[
                 "पहली"
                   ],
                 "attributes":[
                 {"x-occurrence":"1"},
                   {"x-occurrences":"1"}
                   ],
                 "closing":"\\w*"},
               {"milestone":"zaln",
                 "delimter":"-e",
                 "closing":"\\*"},
               {"w":[
                 "पुस्तिका"
                   ],
                 "attributes":[
                 {"x-occurrence":"1"},
                   {"x-occurrences":"1"}
                   ],
                 "closing":"\\w*"},
               {"w":[
                 "उन"
                   ],
                 "attributes":[
                 {"x-occurrence":"1"},
                   {"x-occurrences":"1"}
                   ],
                 "closing":"\\w*"},
               {"w":[
                 "सब"
                   ],
                 "attributes":[
                 {"x-occurrence":"1"},
                   {"x-occurrences":"1"}
                   ],
                 "closing":"\\w*"},
               {"milestone":"zaln",
                 "delimter":"-s",
                 "closing":"\\*",
                 "attributes":[
                 {"x-verified":"true"},
                   {"x-occurrence":"1"},
                   {"x-occurrences":"1"},
                   {"x-content":"λόγον"}
                   ]},
               {"w":[
                 "बातों"
                   ],
                 "attributes":[
                 {"x-occurrence":"1"},
                   {"x-occurrences":"1"}
                   ],
                 "closing":"\\w*"},
               {"milestone":"zaln",
                 "delimter":"-e",
                 "closing":"\\*"},
               {"milestone":"zaln",
                 "delimter":"-s",
                 "closing":"\\*",
                 "attributes":[
                 {"x-verified":"true"},
                   {"x-occurrence":"1"},
                   {"x-occurrences":"1"},
                   {"x-content":"ἀνελήμφθη"}
                   ]},
               {"w":[
                 "ऊपर"
                   ],
                 "attributes":[
                 {"x-occurrence":"1"},
                   {"x-occurrences":"1"}
                   ],
                 "closing":"\\w*"},
               {"w":[
                 "उठाया"
                   ],
                 "attributes":[
                 {"x-occurrence":"1"},
                   {"x-occurrences":"1"}
                   ],
                 "closing":"\\w*"},
               {"milestone":"zaln",
                 "delimter":"-e",
                 "closing":"\\*"},
               {"milestone":"zaln",
                 "delimter":"-s",
                 "closing":"\\*",
                 "attributes":[
                 {"x-verified":"true"},
                   {"x-occurrence":"1"},
                   {"x-occurrences":"1"},
                   {"x-content":"ἄχρι"}
                   ]},
               {"w":[
                 "न"
                   ],
                 "attributes":[
                 {"x-occurrence":"1"},
                   {"x-occurrences":"1"}
                   ],
                 "closing":"\\w*"},
               {"milestone":"zaln",
                 "delimter":"-e",
                 "closing":"\\*"},
               {"w":[
                 "गया"
                   ],
                 "attributes":[
                 {"x-occurrence":"1"},
                   {"x-occurrences":"1"}
                   ],
                 "closing":"\\w*"}
               ]},
           {"verseNumber":"30",
             "verseText":"और पौलुस पूरे दो वर्ष अपने किराये के घर में रहा,
             ",
             "contents":[
             "और पौलुस पूरे दो वर्ष अपने किराये के घर में रहा,
               "
               ]},
           {"verseNumber":"31",
             "verseText":"और जो उसके पास आते थे,
             उन सबसे मिलता रहा और बिना रोक-टोक बहुत निडर होकर परमेश्‍वर के राज्य का प्रचार करता और प्रभु यीशु मसीह की बातें सिखाता रहा।",
             "contents":[
             "और जो उसके पास आते थे,
               उन सबसे मिलता रहा और बिना रोक-टोक बहुत निडर होकर परमेश्‍वर के राज्य का प्रचार करता और प्रभु यीशु मसीह की बातें सिखाता रहा।"
               ]}
           ]}
       ],
     "_messages":{"_warnings":[      ]}}

The USFM Grammar Outputs V2

The comparison of JSON outputs obtained from usfm-grammar with varying parameters.

The minimal set of markers

Input

Normal Mode

LEVEL.RELAXED

FILTER.SCRIPTURE

 \id GEN
 \c 1
 \p
 \v 1 verse one
 \v 2 verse two

 {
   "book": { "bookCode": "GEN" },
   "chapters": [
     {
       "chapterNumber": "1",
       "contents": [
         { "p": null },
         {
           "verseNumber": "1",
           "verseText": "verse one",
           "contents": [ "verse one" ]
         },
         {
           "verseNumber": "2",
           "verseText": "verse two",
           "contents": [ "verse two" ]
         } ]
     }
   ],
   "_messages": {
     "_warnings": []
   }
 }

      
 {
   "book": { "bookCode": "GEN" },
   "chapters": [
     {
       "chapterNumber": "1",
       "contents": [
         { "p": null },
         {
           "verseNumber": "1",
           "contents": [ "verse one" ],
           "verseText": "verse one"
         },
         {
           "verseNumber": "2",
           "contents": [ "verse two" ],
           "verseText": "verse two"
         }
       ]
     }
   ],
   "_messages": {
     "_warnings": []
   }
 }

 {
   "book": {
     "bookCode": "GEN"
   },
   "chapters": [
     {
       "chapterNumber": "1",
       "contents": [
         {
           "verseNumber": "1",
           "verseText": "verse one"
         },
         {
           "verseNumber": "2",
           "verseText": "verse two"
         }
       ]
     }
   ],
   "_messages": {
     "_warnings": []
   }
 }

Multiple chapters

Input

Normal Mode

LEVEL.RELAXED

FILTER.SCRIPTURE

\id GEN
\c 1
\p
\v 1 the first verse
\v 2 the second verse
\c 2
\p
\v 1 the third verse
\v 2 the fourth verse

{
  "book": { "bookCode": "GEN" },
  "chapters": [
    {
      "chapterNumber": "1",
      "contents": [
        { "p": null },
        {
          "verseNumber": "1",
          "verseText": "the first verse",
          "contents": [ "the first verse" ]
        },
        {
          "verseNumber": "2",
          "verseText": "the second verse",
          "contents": [ "the second verse" ]
        }
      ]
    },
    {
      "chapterNumber": "2",
      "contents": [
        { "p": null },
        {
          "verseNumber": "1",
          "verseText": "the third verse",
          "contents": [ "the third verse" ]
        },
        {
          "verseNumber": "2",
          "verseText": "the fourth verse",
          "contents": [ "the fourth verse" ]
        }
      ]
    }
  ],
  "_messages": { "_warnings": [] }
}

      
{
  "book": { "bookCode": "GEN" },
  "chapters": [
    {
      "chapterNumber": "1",
      "contents": [
        { "p": null  },
        {
          "verseNumber": "1",
          "contents": [ "the first verse" ],
          "verseText": "the first verse"
        },
        {
          "verseNumber": "2",
          "contents": [ "the second verse" ],
          "verseText": "the second verse"
        }
      ]
    },
    {
      "chapterNumber": "2",
      "contents": [
        { "p": null },
        {
          "verseNumber": "1",
          "contents": [ "the third verse" ],
          "verseText": "the third verse"
        },
        {
          "verseNumber": "2",
          "contents": [ "the fourth verse" ],
          "verseText": "the fourth verse"
        } ]
    }
  ],
  "_messages": { "_warnings": [] }
}

{
  "book": { "bookCode": "GEN" },
  "chapters": [
    {
      "chapterNumber": "1",
      "contents": [
        {
          "verseNumber": "1",
          "verseText": "the first verse"
        },
        {
          "verseNumber": "2",
          "verseText": "the second verse"
        } ]
    },
    {
      "chapterNumber": "2",
      "contents": [
        {
          "verseNumber": "1",
          "verseText": "the third verse"
        },
        {
          "verseNumber": "2",
          "verseText": "the fourth verse"
        } ]
    }
  ],
  "_messages": { "_warnings": [] }
}

Section headers, \p and others markers before chapters and inside them

Input

Normal Mode

LEVEL.RELAXED

FILTER.SCRIPTURE

\id MRK The Gospel of Mark \ide UTF-8 \usfm 3.0 \h Mark \mt2 The Gospel according to \mt1 MARK \is Introduction \ip \bk The Gospel according to Mark\bk* begins with the statement... \c 1 \s the first section \p \v 1 the first verse \s1 A new section \v 2 the second verse \q1 a peom

{
"book": {
"bookCode": "MRK",
"description": "The Gospel of Mark",
"meta": [
{ "id": "UTF-8" },
{ "usfm": "3.0" },
{ "h": "Mark" },
[
{ "mt2": [ "The Gospel according to" ] },
{ "mt1": [ "MARK" ] }
],
{ "is": [ "Introduction" ] },
{ "ip": [ { "bk": [ "The Gospel according to Mark" ],
"closing": "\bk*" },
"begins with the statement..." ] } ]},
"chapters": [
{ "chapterNumber": "1",
"contents": [
[ { "s": "the first section" } ],
{ "p": null },
{
"verseNumber": "1",
"verseText": "the first verse",
"contents": [
"the first verse",
[ { "s1": "A new section" } ] ]
},
{
"verseNumber": "2",
"verseText": "the second verse a peom",
"contents": [
"the second verse",
{ "q1": null },
"a peom" ]
} ]
}
],
"_messages": { "_warnings": ["Trailing spaces present at line end. "]}
}



{
"book": {
"bookCode": "MRK ",
"description": "The Gospel of Mark",
"meta": [
{ "ide": "UTF-8" },
{ "usfm": "3.0" },
{ "h": "Mark" },
{ "mt2": "The Gospel according to" },
{ "mt1": "MARK" },
{ "is": "Introduction" },
{ "ip": [
{ "bk": "The Gospel according to Mark",
"closing": "\bk*" },
"begins with the statement..." ] } ]},
"chapters": [
{ "chapterNumber": "1",
"contents": [
{ "s": "the first section" },
{ "p": null },
{
"verseNumber": "1",
"contents": [
"the first verse",
{ "s1": "A new section" } ],
"verseText": "the first verse"
},
{
"verseNumber": "2",
"contents": [
"the second verse",
{ "q1": null },
"a peom"
],
"verseText": "the second verse a peom"
} ]
}
],
"_messages":{"_warnings":["Trailing spaces present at line end. "]}
}

{
"book": {
"bookCode": "MRK",
"description": "The Gospel of Mark" },
"chapters": [
{ "chapterNumber": "1",
"contents": [
{
"verseNumber": "1",
"verseText": "the first verse"
},
{
"verseNumber": "2",
"verseText": "the second verse a peom"
}
]
}
],
"_messages": {
"_warnings": [
"Trailing spaces present at line end. "
]
}
}

Footnote, inline markers and attributes

Input

Normal Mode

LEVEL.RELAXED

FILTER.SCRIPTURE

\id MAT \c 1 \p \v 1 the first verse \v 2 the second verse \v 3 This is the Good News about Jesus Christ, the Son of God. \f + \fr 1.1: \ft Some manuscripts do not have \fq the Son of God.\f* \c 2 \p \v 1 \f footnote \ft content \f* \v 2 nm,n \s text1 \em text2 \em* \v 1 This is the Good News about Jesus Christ, the Son of God. \f + \fr 1.1: \ft Some manuscripts do not have the Son of God.\f* \v 2 good \w gracious|strong="H1234,G5485"\w* lord

{
"book": {
"bookCode": "MAT" },
"chapters": [
{
"chapterNumber": "1",
"contents": [
{
"p": null },
{
"verseNumber": "1",
"verseText": "the first verse",
"contents": [
"the first verse" ] },
{
"verseNumber": "2",
"verseText": "the second verse",
"contents": [
"the second verse" ] },
{
"verseNumber": "3",
"verseText": "This is the Good News about Jesus Christ, the Son of God.",
"contents": [
"This is the Good News about Jesus",
"Christ, the Son of God.",
{
"footnote": [
{
"caller": "+" },
{
"fr": "1.1:" },
{
"ft": "Some\nmanuscripts do not have" },
{
"fq": "the Son of God." } ],
"closing": "\f*" } ] } ] },
{
"chapterNumber": "2",
"contents": [
{
"p": null },
{
"verseNumber": "1",
"verseText": "",
"contents": [
{
"footnote": [
"footnote",
{
"ft": "content" } ],
"closing": "\f*" } ] },
{
"verseNumber": "2",
"verseText": "nm,n",
"contents": [
"nm,n",
[
{
"s": [
"text1",
{
"em": [
"text2" ],
"closing": "\em*" } ] } ] ] },
{
"verseNumber": "1",
"verseText": "This is the Good News about Jesus Christ, the Son of God.",
"contents": [
"This is the Good News about Jesus Christ,",
"the Son of God.",
{
"footnote": [
{
"caller": "+" },
{
"fr": "1.1:" },
{
"ft": "Some manuscripts\ndo not have the Son of God." } ],
"closing": "\f*" } ] },
{
"verseNumber": "2",
"verseText": "good gracious lord",
"contents": [
"good",
{
"w": [
"gracious" ],
"attributes": [
{
"strong": "H1234,G5485" } ],
"closing": "\w*" },
"lord" ] } ] } ],
"_messages": {
"_warnings": [
"Trailing spaces present at line end. " ] }
}



{
"book": {
"bookCode": "MAT" },
"chapters": [
{
"chapterNumber": "1",
"contents": [
{
"p": null },
{
"verseNumber": "1",
"contents": [
"the first verse" ],
"verseText": "the first verse" },
{
"verseNumber": "2",
"contents": [
"the second verse" ],
"verseText": "the second verse" },
{
"verseNumber": "3",
"contents": [
"This is the Good News about Jesus",
"Christ, the Son of God.",
{
"f": "+" },
{
"fr": "1.1:" },
{
"ft": [
"Some",
"manuscripts do not have",
{
"fq": "the Son of God.",
"closing": "\f*" } ] } ],
"verseText": "This is the Good News about Jesus Christ, the Son of God." } ] },
{
"chapterNumber": "2",
"contents": [
{
"p": null },
{
"verseNumber": "1",
"contents": [
{
"f": [
"footnote",
{
"ft": "content",
"closing": "\f*" } ] } ],
"verseText": "" },
{
"verseNumber": "2",
"contents": [
"nm,n",
{
"s": [
"text1",
{
"em": "text2",
"closing": "\em*" } ] } ],
"verseText": "nm,n" },
{
"verseNumber": "1",
"contents": [
"This is the Good News about Jesus Christ,",
"the Son of God.",
{
"f": "+" },
{
"fr": [
"1.1:",
{
"ft": [
"Some manuscripts",
"do not have the Son of God." ],
"closing": "\f*" } ] } ],
"verseText": "This is the Good News about Jesus Christ, the Son of God." },
{
"verseNumber": "2",
"contents": [
"good",
{
"w": "gracious",
"attributes": "|strong="H1234,G5485"",
"closing": "\w*" },
"lord" ],
"verseText": "good gracious lord" } ] } ],
"_messages": {
"_warnings": [
"Trailing spaces present at line end. " ] }
}

{
"book": {
"bookCode": "MAT" },
"chapters": [
{
"chapterNumber": "1",
"contents": [
{
"verseNumber": "1",
"verseText": "the first verse" },
{
"verseNumber": "2",
"verseText": "the second verse" },
{
"verseNumber": "3",
"verseText": "This is the Good News about Jesus Christ, the Son of God." } ] },
{
"chapterNumber": "2",
"contents": [
{
"verseNumber": "1",
"verseText": "" },
{
"verseNumber": "2",
"verseText": "nm,n" },
{
"verseNumber": "1",
"verseText": "This is the Good News about Jesus Christ, the Son of God." },
{
"verseNumber": "2",
"verseText": "good gracious lord" } ] } ],
"_messages": {
"_warnings": [
"Trailing spaces present at line end. " ] }
}

Error in Book code, marker name, marker syntax and order of markers

Input

Normal Mode

LEVEL.RELAXED

FILTER.SCRIPTURE

\id GUN
\c 1
\ide the content
\ip
\p
\v 1 verse one
\v 2 verse two
\ver 3 some text
\v4 the next verse

    ERROR

      
{
  "book": {
    "bookCode": "GUN" },
  "chapters": [
    {
      "chapterNumber": "1",
      "contents": [
        {
          "ide": "the content" },
        {
          "ip": "" },
        {
          "p": null },
        {
          "verseNumber": "1",
          "contents": [
            "verse one" ],
          "verseText": "verse one" },
        {
          "verseNumber": "2",
          "contents": [
            "verse two",
            {
              "ver": "3 some text" },
            {
              "v4": "the next verse" } ],
          "verseText": "verse two" } ] } ],
  "_messages": {
    "_warnings": [] }
}

    ERROR

The Normal Mode outputs given in the above tables are what would be obtained when the library is used with the following parameters

const grammar = require('usfm-grammar');
var input = '...';
const myUsfmParser = new grammar.USFMParser(input);
var jsonOutput = myUsfmParser.toJSON();

or in CLI

> usfm-grammar input.usfm

The LEVEL.RELAXED outputs are obtained as follows

const grammar = require('usfm-grammar', LEVEL.RELAXED);
var input = '...';
const myUsfmParser = new grammar.USFMParser(input);
var jsonOutput = myUsfmParser.toJSON();

or in CLI,

> usfm-grammar --level relaxed input.usfm

The FILTER.SCRIPTURE outputs are obtained as shown below

const grammar = require('usfm-grammar');
var input = '...';
const myUsfmParser = new grammar.USFMParser(input, FILTER.SCRIPTURE);
var jsonOutput = myUsfmParser.toJSON();

or in CLI,

> usfm-grammar --filter scripture input.usfm

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

OutputComparisons.md

OutputComparisons.md

Difference in JSON Outputs of 2.x and 3.x

The Basic USFM Components

More Complex Components

The USFM Grammar Outputs V2

Files

OutputComparisons.md

Latest commit

History

OutputComparisons.md

File metadata and controls

Difference in JSON Outputs of 2.x and 3.x

The Basic USFM Components

More Complex Components

The USFM Grammar Outputs V2