This rather plain-looking page contains numerous examples of bibleref markup and the intended results of processing them. This serves both to illustrate bibleref markup, and to provide a test suite for bibleref processors. View the page source to see how the class and title attributes are used. All underlying bibleref markup is displayed here with lightblue background.
| ID | Comment | Example | Bibleref Markup | Processor Output |
|---|---|---|---|---|
| 1. Simple Examples | ||||
| 1A |
cite element (no title) |
... in 2Tim 2:15, we read ... | class = "bibleref" |
"2Tim 2:15" (or "2Tim.2.15", or other valid formatting variants) |
| 1B |
cite element (with optional title) |
... in 2Tim 2:15, we read ... | class = "bibleref" title="2Tim.2.15" |
"2Tim.2.15" |
| 1C |
a element |
... in 2Tim.2.15, we read ... | class = "bibleref" title="2Tim.2.15" |
"2Tim.2.15" |
| 1D | Textual content includes a Bible version Processors can probably identify the version, so the title attribute isn't required, though best practice is to include it. |
... in 2Tim.2.15 (ESV), we read ... | class = "bibleref" |
"ESV:2Tim.2.15" |
| 2. Required Use of Title Attribute | ||||
| 2A | A contextually-defined reference in text requires the title attribute |
... Paul's second letter to Timothy ... in verse 15, we read ... |
class = "bibleref" title="2Tim 2:15" |
"2Tim 2:15" |
| 2B | Another contextually-defined reference (Though this vague description may not warrant being called a Bible reference) |
... chapter two of 2nd Timothy ... in the next chapter, we read ... |
class = "bibleref" title="2Tim 3" |
"2Tim 3" |
| 2C | Processors may not be able to identify the version, so it should be included in the title. | ... in Crossway's version of 2Tim.2.15, we read ... | class = "bibleref" title="ESV:2Tim.2.15" |
"ESV:2Tim.2.15" |
| 2D | The version identifier can be omitted by processors if it can't be identified and isn't included in the title |
... in Crossway's version of 2Tim.2.15, we read ... | class = "bibleref" title="2Tim.2.15" |
"2Tim.2.15" |
| 2E | Processors may omit a version identifier in the text if it's non-standard (and not in the title) |
... in the PQT translation of 2Tim.2.15, we read ... | class = "bibleref" | "2Tim.2.15" |
| 2F | Processors may not omit a version identifier that's specified in the title, even if it's non-standard |
... in 2Tim.2.15, we read ... | class = "bibleref" title="PQT:2Tim.2.15" |
"PQT:2Tim.2.15" |
| 3. With Other Elements and Attributes | ||||
| 3A | outer cite element with inner a element: browsers should normally display the title of the inner element as a tooltip |
... in 2Tim 2:15 , we read ... | class = "bibleref" title="2Tim.2.15" |
"2Tim.2.15" |
| 3B | Other class attributes are allowed, as long as bibleref is included | ... in 2Tim 2:15, we read ... | class = "highlight bibleref sidebar" | "2Tim.2.15" |
| 4. Ranges and Compound References | ||||
| 4A | Range reference | ... in 2Tim 2:15-17, we read ... | class = "bibleref" | "2Tim.2.15-17" (or "2Tim.2.15-2Tim.2.17", or other valid variants) |
| 4A | Range reference (across chapters) | ... in 2Tim.2.15-4.8, we read ... | class = "bibleref" | "2Tim.2.15-4.8" |
| 5. Bibleref Data Values | ||||
| 5A | Reference to deutero-canonical book | ... the Wisdom of Solomon 6:1 ... | class = "bibleref" title="Wis 6:1" |
"Wis 6:1" |
| 6. Unusual Cases | ||||
| 6A | Incomplete reference, and no title attribute. This is bibleref, but the reference cannot be determined, and none is provided. The author should either provide a reference, or not mark this as bibleref. |
... my favorite verse ... | class = "bibleref" |
"" |
| 6B | Implicit reference, and no title attribute. Processors are not required to map descriptions to references. The author should either provide a reference, or not mark this as bibleref. |
... the Song of Deborah ... | class = "bibleref" |
"" |
| X. Not Bibleref | ||||
| XA | This is a cite
without the bibleref class attribute. Though the author might have intended a Bible reference, this is not bibleref markup. |
... Mark 4 is an important ... | (nothing) | |