bibledit / cloud

Source code for Bibledit core library and Cloud binary
GNU General Public License v3.0
12 stars 3 forks source link

Bibledit should be able to handle all markers in USFM 3.0 related to Peripheral Material #772

Closed 4etc closed 2 years ago

4etc commented 2 years ago

The following markers – best I can tell – are unknown to Bibledit, so if someone includes them in USFM markup in Bibledit, it just treats them like regular text. Although there is no consensus on whether \periph should really be used or not, seems that if it's in USFM 3.0, then it should be handled in Bibledit.

I do not know much about this, but it seems to me that most of \periph items should have a page break before them (exception: Half Title Page).

\periph along with all the "flavors" of it such as\periph Title Page|id="title" listed here: https://ubsicap.github.io/usfm/peripherals/index.html Some of them are these:

\periph Half Title Page|id="halftitle"
\periph Promotional Page|id="promo"
\periph Publication Data|id="pubdata"
\periph Foreword|id="foreword"
\periph Preface|id="preface"
\periph Table of Contents|id="contents"
\periph Alphabetical Contents|id="alphacontents"
\periph Table of Abbreviations|id="abbreviations"
\periph Weights and Measures|id="measures"
\periph Map Index|id="maps"
\periph Cover|id="cover"
\periph Spine|id="spine"
\id FRT
\id INT
\id BAK
\id CNC
\id GLO
\id TDX
\id NDX
\id OTH

The use of \periph is discouraged by some (https://groups.google.com/g/bibledit-general/c/9Wr5qZDeN48/m/aHT8Ag9wAAAJ) and at this time it may be advisable to "replace all \periph markers with \pb (page break) markers and a \rem comment" (hat tip: Michael Johnson).

A discussion on well-formatted front matter is here: https://community.scripture.software.sil.org/t/well-formatted-front-matter/2484.

Edit on 16 Apr 2022: changed the link about discouraging the use of \periph. The link I originally put in was actually the one about well-formatted front matter.

teusbenschop commented 2 years ago

Bibledit now supports the \periph marker.

This is how to use it: In the USFM editor, enter the \periph marker followed by free text.

More information about this free text is among others in this quote from https://ubsicap.github.io/usfm/peripherals/index.html: "For peripheral books containing divisions, the division title is free-form, and may be expressed in the vernacular language.

Bibledit won't output the \periph markup and its content to the formatted output. In OpenDocument this markup causes a new page.

4etc commented 2 years ago

Thank you, Teus!