Bible Module Specifications

Question

In “What is the specification for a Bible module”, I see this as a possible marker:

\mod
Include the content of one module in the content of another module. The module which contains the other is sometimes called a “parent” module, and the module included is sometimes called a “child” module. Example: \mod child_module.sfm

In what situation would this be applied, and how would it be implemented?

Thanks.

Answer 1

anon180868:

In what situation would this be applied, and how would it be implemented?

It is also useful for very large modules. Paratext tends to become slower the larger the module, so sometimes it’s nice to be able to break it up so that you don’t have to view it all at once.

Another similar use is just for organization. It might be nice to be able to move large chunks of a module around just by moving a \mod line instead of moving the entire contents (e.g. if you have a bunch of Bible stories and you’re trying to figure out how to order them).

Answer 2

What is the specification for a Bible module? Helps

The specification for a Bible module is an .sfm text file in UTF-8 format. The specification is a set of instructions to Paratext to gather and format text from your project and produce the content of the Bible module. The specification includes lines which begin with the following special markers. Lines which begin with these special markers are not copied from the specification to the content of the Bible module. Marker | Description \vrs | Identify the versifi…

Answer 3

Introduction to Bible modules Helps

A Bible module brings together text selections from a Paratext project. The content of a Bible module is based on a specification. The specification includes references to verse ranges in ordinary books of a project, and can also contain additions and replacements to the content. You view a Bible module in an Extra book. View menu options for the Extra book allow you to either view the specification for the Bible module or to view the content of the Bible module. Examples of a Bible module: …

Answer 4

anon180868:

In what situation would this be applied, and how would it be implemented?

I’ve never used this feature, but here’s how I’ve considered using it. So this is untested by me, but should be a starting point and I think it would answer your question.

Say you have a series of stories from the Prophets, and you’ve created individual modules and published them as pamphlets over time. So you have a series of files in your Modules directory like:

adam.sfm
abraham.sfm
david.sfm
isaiah.sfm
etc

Now you want to create a book called “Lives of the Prophets”. Rather than create a new module where you copy and paste the contents of those independent files into the new module (and then have to keep two locations up-to-date in the future), you can simply create a new module which says

\mod adam.sfm
\mod abraham.sfm
\mod david.sfm
\mod isaiah.sfm

It would then create a book with each story one after another. You might add in some extra markers to create title pages or page breaks, but most of the work is already done by the original modules.

Comments

I’m working on this sort of thing. Except in our project, we have other sections in between. For example, we have an abraham.sfm and a joseph.sfm that we’ll be published as individual booklets, but in between is info from Isaac & Jacob that will be included in a larger book. Just looked at what we did, and instead of putting all the intervening verses in /ref lines, we actually created a separate Isaac&Jacob.sfm.

Answer 5

Thank you for all the replies. Very helpful.