Special Text and Character Styles
From Bibledit
Contents |
List of markers
Special Text: \qt...\qt* | \nd...\nd* | \tl...\tl* | \dc...\dc* | \bk...\bk* | \sig...\sig* | \pn...\pn* | \wj...\wj* | \k...\k* | \sls...\sls* | \ord...\ord* | \add...\add* | \lit
Character Styling: \no...\no* | \bd...\bd* | \it...\it* | \bdit...\bdit* | \em...\em* | \sc...\sc*
Spacing and Breaks: \!$ | // | \pb
Special Features: \fig...\fig* | \pro...\pro* | \w...\w* | \wh...\wh* | \wg...\wg* | \ndx...\ndx* Syntax Notes
Required spaces are indicated with _. Parameters are indicated in ALLCAPS or by a special character such as the hash mark #. Optional or suggested information is shown as normal text in (Parentheses).
The following markers are nested (embedded) within a paragraph style, or another character style (esp. Footnotes), but do not cancel out that previous style. Paratext is not yet be capable of rendering all of the display variations that would be indicated due to nesting.
Example (use of \nd):
\f + \fr #.# \ft Sample text \nd Lord\nd* ... \fk sample text... \ft ...\f*.
Special Kinds of Text
Words, Phrases, or Sections of Text
\qt_text\qt*
- Quoted text
- Old Testament quotes in the New Testament, or other quoted text.
Example - Poetic formatted, where all text is an OT quote OR "other" quote:
\q1 \qt ........................................\qt* \q2 \qt ........................................\qt* \q1 \qt ........................................\qt* \q2 \qt.........................................\qt*
Example - Poetic formatted, where text is mixed (only some is quote):
\q1 \qt ...............\qt* ..............\qt ........\qt* \q2 \qt .....\qt* ................................ \q1 .................................................. \q2 \qt.........................................\qt*
Illustrated example - not an OT quote (TEV Act 17.28):
\v 27 He did this so that they would look for him, and perhaps find him as they felt around for him. Yet God is actually not far from any one of us; \v 28 as someone has said, \q1 \qt ?In him we live and move and exist.?\qt* \b \m It is as some of your poets have said, \q1 \qt ?We too are his children.?\qt*
\nd_text\nd*
- Name of deity.
Example of use (TEV Gen 22.14):
\v 14 Abraham named that place ?The \nd Lord\nd* Provides.?
\tl_text\tl*
- Transliterated (or foreign) word(s).
Example of use (TEV 1Co 16.22):
\p Greet one another with the kiss of peace. \p \v 21 With my own hand I write this: \sig Greetings from Paul\sig* \p \v 22 Whoever does not love the Lord?a curse on him! \p \tl Maranatha\tl* ?Our Lord, come!
\dc_text\dc*
- Deuterocanonical/LXX additions or insertions in the Protocanonical text.
\bk_text\bk*
- Quoted book title.
Example of use (TEV Intro to Gen):
\h Genesis \mt1 GENESIS \imt Introduction \ip The name \bk Genesis\bk* means ?origin.?
Example of use (TEV 1Ch 9.1):
\c 9 \s The People Who Returned from Captivity \p \v 1 All the people of Israel were listed according to their families, and this information was recorded in \bk The book of the Kings of Israel\bk* \p The people of Judah had been deported to Babylon as punishment for their sins.
\sig_text\sig*
- Signature of the author of an epistle.
Example of use (TEV 1Co 16.21):
\p Greet one another with the kiss of peace. \p \v 21 With my own hand I write this: \sig Greetings from Paul\sig* \p \v 22 Whoever does not love the Lord?a curse on him! \p \tl Maranatha\tl* ?Our Lord, come!
\pn_text\pn*
- Proper name.
\wj_text\wj*
- Words of Jesus.
\k_text\k*
- Keyword.
\sls_text\sls*
- Passage of text based on a secondary language or alternate text source.
- E.g. The NBS02 has large sections of text in EZR and DAN in italics, to represent where the original text is in Aramaic, not Hebrew.
Example of use:
\p \sls ........................................\sls* \q1 \sls ........................................\sls* \q2 \sls ........................................\sls*
\ord_text\ord*
- Ordinal number ending (i.e. 1st, e.g. 1\ord st\ord*)
\add_text\add*
- Additional material
- E.g. A translator's explanation; words added by the translator for clarity – text which literally is not part of the original but which was supplied to make the original meaning clear.
- In some texts this has been formatted in italic.
\lit_text
- Liturgical note/comment.
- E.g. A guide which tells the reader/worshipper that he should recite a prayer or recitation etc.
- A paragraph style.
Example of use (RSO):
\lit Slava ( = Glory)
Character Styling
This markup is DEPRECATED. Its use is strongly discouraged. Please search for the appropriate USFM code to markup content.
\no_text\no*
- Normal text.
- May be used when a paragraph or other larger body of text is set in italic, and an isolated word or words needs to be displayed in normal text.
\bd_text\bd*
- Bold text.
\it_text\it*
- Italic text
\bdit_text\bdit*
- Bold + Italic text.
\em_text\em*
- Emphasis.
\sc_text\sc*
- Smallcap text.
Special Characters
Diacritics
All character encoding should be in Unicode UTF-8.
Spacing and Breaks
All character encoding should be in Unicode UTF-8.
!$
- Fixed space between letters or between letters and numbers, indicates no separation allowed. Decimal 160 (0xA0, Unicode U+00A0) could be used, but its correct behaviour does not currently operate in Paratext.
//
- Discretionary line break (primarily used in Poetry text, but could also be used in showing opetion breaks for section headings/titles, or table column breaks).
\pb
- Page Break used for new reader portions and children's bibles where content is controlled by the page.
Special Features
\fig Desc|Cat|Size|Loc|Copy|Cap|Ref\fig*
Note: Parameters should be separated by a vertical bar, not a comma. A comma may too easily exist already within one of the parameters.
- Illustrations, figures, maps.
- Desc = Picture description in English. This material does not show up on the printed page.
- Cat = Picture catalog identification number. This material does not show up on the printed page.
- Size = Picture size. This material does not show up on the printed page. Valid options are:
+ col - insert picture inline within current text column. + span - insert picture spanning text columns (at top or bottom of page).
- Loc = Picture location/range. This material does not show up on the printed page.
- Copy = Picture copyright info. This material will be used to give the appropriate picture credits.
- Cap = Picture caption. This text will be printed with the illustration.
- Ref = Picture reference (e.g. Luke 19.5). This text will be printed with the illustration.
Example of use (TEV Mrk 1.18):
\p \v 16 As Jesus walked along the shore of Lake Galilee, he saw two fishermen, Simon and his brother Andrew, catching fish with a net. \v 17 Jesus said to them, ?Come with me, and I will teach you to catch people.? \v 18 At once they left their nets and went with him. \fig Men at work fishing; leaving nets|AVMRK118|span| MRK 1--2|Annie Vallaton; American Bible Society| At once they left their nets.|1.18\fig*
\pro_text\pro*
- Pronunciation information.
- Used for CJK texts.
\w_word list entry\w*
- Wordlist/Glossary/Dictionary entry.
- Mark text with these codes to indicate that it appears in the word list.
\wh_word list entry\wh*
- Hebrew word list entry.
\wg_word list entry\wg*
- Greek word list entry.
\ndx_index entry text\ndx*
- Subject index entry.