Peripheral Materials

From Bibledit

Contents

[]

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). Introduction

The following represents a USFM markup proposal for the various peripheral elements which may be prepared for publication in addition to the scripture body text.

In general, all of the existing USFM standard markers may be used when authoring peripheral content. The \id marker should be used for identifying the content of the following text, and content should be created in separate files according to the following general groupings (Front Matter, Back Matter, Other Material). A marker is used to indicate the start of a sub-grouping of content within each file (e.g. \toc, \pref etc.). In each section below there is a recommendation and a brief description of the USFM markers which will likely be most appropriate.

  • Front Matter \id FRT
    • Publication Data (verso) \pub
    • Table of Contents \toc
    • Preface \pref
    • Introduction \intro
  • Back Matter \id BAK
    • Concordance \conc
    • Glossary \glo
    • Index \idx
    • Map Index \maps
  • Other Material \id OTH
    • Cover \cov
  • Spine \spine
    • Illustrations

Authoring peripheral materials within Paratext 6

Support for a set of non-biblical books has been added to Paratet 6. The XXA to XXG books appear at the end of a project's list of books, and may be used to author non-biblical text for Front Matter (titles, preface etc.), Back Matter (glossary, concordance etc.), or any other kind of text.

Suggested use of XX books for Peripheral Materials:

  • XXA used for Front Matter \id FRT
  • XXB used for Back Matter \id BAK
  • XXC used for Other Material \id OTH

Note: Any SFM markers used these books need to be added to the stylesheet associated with the project. All of the peripheral materials discussed on this page are included in the latest usfm.sty stylesheet file.

[]

Front Matter

Suggested \id:

\id FRT

...

\s#

  • Front Matter headings.
  • Used in study bible front matter documents.
  • An example would be pg 20 in 'La Biblia Devocional de Estudio' (Panorama pages).

\li#

  • Front Matter list paragraph.
  • Used in study bible front matter documents.
  • An example would be pgs 10-16 in 'La Biblia Devocional de Estudio'.

\p#

  • Front Matter text paragraph.
  • Two levels are shown in the Panorama, pg 20 of 'La Biblia Devocional de Estudio'.

\q#

  • Front Matter poetry paragraph.
  • Used in study bible front matter documents where scripture poetry is quoted.
  • An example would be pg 8 in 'La Biblia Devocional de Estudio'.
[]

Publication Data (verso)

Sub-group marker:

\id FRT ...

\pub

\mt#

  • Main title of publication on verso page.

\pubinfo_Lang,Credit,Version,Copies,Publisher,Id,Logo

  • Lang = Language name which is printed on the title and copyright pages.
  • Credit = Picture credits given on copyright page.
  • Version = Version number/printing info on copyright page.
  • Copies = Number of copies, printed on copyright page.
  • Publisher = Publisher information on copyright page.
  • Id = Book identification information which is printed on the copyright page.
  • Logo = Publisher name(s) under logo(s) on half title page.
[]

Table of Contents

Sub-group marker:

\id FRT

...

\toc

\mt#

  • Main title for Table of Contents.

\s#

  • (Section) Heading

\tr | \th | \thr | \tc | \tcr

  • For any tabular data.
  • The table of contents is marked up using rows and cells.

\toc1

  • Long Table of Contents text for book.

\toc2

  • Short Table of Contents text for book.

Implementing toc1 and toc2

\toc1 and \toc2 are to be included in the main body text for each book, after \h, not in the FRT peripheral file. They are intended to assist publishing tools in automating Table of Contents generation.


[]

Preface

Sub-group marker:

\id FRT

...

\pref

\mt#

  • Main title for Preface.

\s#

  • Preface (Section) Heading.

\p#

  • Preface Paragraph.

\m

  • Preface flush left (margin) paragraph.

\li#

  • Preface list paragraph
  • # denotes the title level or relative weighting.

\q#

  • Preface poetry line.

\tr | \th | \thr | \tc | \tcr

  • For any tabular data.
[]

Introduction

Sub-group marker:

\id FRT

...

\intro

\mt#

  • Main title for Introduction.

\s#

  • Introduction (Section) Heading.

\p#

  • Introduction Paragraph.

\m

  • Introduction flush left (margin) paragraph.

\li#

  • Introduction list paragraph
  • # denotes the title level or relative weighting.

\q#

  • Introduction poetry line.

\tr | \th | \thr | \tc | \tcr

  • For any tabular data.
[]

Back Matter

Suggested \id:

\id BAK

...

\mt#

  • Main title (if required) for Back Matter.

\s#

  • Back Matter headings.
  • Used in study bible back matter documents.
  • An example of three levels would be the first page of the Bosquejo de temas in 'La Biblia Devocional de Estudio'.

\r

  • Back Matter reference, usually right aligned.
  • Used in study bible back matter documents.
  • An example would be the first page of the Bosquejo de temas in 'La Biblia Devocional de Estudio'.

\li#

  • Back Matter list paragraph.
  • Used in study bible back matter documents.
  • An example of three levels would be pg 1132 in 'La Biblia Devocional de Estudio'.

\p#

  • Back Matter text paragraph.

\q#

  • Back Matter poetry paragraph.
  • Used in study bible front matter documents where scripture poetry is quoted.
  • An example would be pg 8 in 'La Biblia Devocional de Estudio'.
[]

Concordance

Sub-group marker:

\id BAK

...

\conc

\mt#

  • Main title for Concordance.

\k#

  • Concordance main entry text / keyword (required).
  • # denotes the entry level or weighting (main entry, sub entry, etc).

\add

  • Concordance grammar abbreviation (optional).

\p#

  • Concordance Main Entry Information - definitions or references (optional).

\r

  • Concordance example reference (required).

\tr | \th | \thr | \tc | \tcr

  • For any tabular data.
[]

Glossary

Sub-group marker:

\id BAK ... \glo

\mt#

  • Main title for Glossary.

\s#

  • Glossary section heading.

\k#

  • Glossay main entry / keyword (required).
  • # can be used to denote an (optional) sub-entry level.

\p#

  • Glossary definition entry (required).
  • Also used for any additional paragraphs in the defintion entry (optional).

\li#

  • Glossary list paragraph (optional).

\tl...\tl*

  • Glossary national idiom word(s).
[]

Index

Sub-group marker:

\id BAK ... \idx

\mt#

  • Main title for Index.

\ms

  • Topical index major section heading.
  • Often used for alphabetical character dividers (optional).

\s

  • Topical index section heading.

\k#

  • Topical index main entry text / keyword (required).
  • # denotes the entry level or weighting (main entry, sub entry, etc).

\li#

  • Use for simple lists, where more complex tabular layout is not required.

\tr | \th | \thr | \tc | \tcr

  • For any tabular data.

\r

  • Topical index reference (required).
[]

Maps Index

Sub-group marker:

\id BAK ... \maps

\mt#

  • Main title for Map Index.

\s

  • (Section) Heading

\tr | \th | \thr | \tc | \tcr

  • For any tabular data.

\r

  • Map index reference.
[]

Other

Suggested \id:

\id OTH ...

[]

Cover

Sub-group marker:

\id OTH

...

\cov

\mt#

  • Cover main title (required).
  • # denotes the entry level or weighting (main entry, sub entry, etc).
[]

Spine

Sub-group marker:

\id OTH

...

\spine

\mt#

  • Spine book title (required) and language name title.
  • # denotes the entry level or weighting (main entry, sub entry, etc).
  • More than one level is needed on diglots.
[]

Illustrations

See \fig...\fig*

Personal tools