BibleGateway-to-Obsidian-Catholic

This is a fork of selfire1/BibleGateway-to-Obsidian to support Catholic translations of the Bible.

Updates include

• bg2md.rb:
  • Move to same directory as bg2obs.sh
• bg2obs.sh:
  • Update total book count to 73
  • Update book list for Catholic bible (source: USCCB)
  • Update abbreviations in abbarray to match the USCCB definitions page 9 here
  • Change default translation from "WEB" to "NABRE"
  • Add translation to note title to facilitate working with multiple translations in Obsidian
• The Bible.md updates:
  • Update book list for Catholic bible (source: USCCB)

Setup & Usage

These are the steps I followed to get set up:

• clone this repo
• install missing packages: sudo gem install colorize optparse clipboard
• add custom CSS snippet for verse h6 headers using this link
• I ran the script for three Catholic translations:
  • bash bg2obs.sh -v NABRE -i -e
  • bash bg2obs.sh -v RSVCE -i -e
  • bash bg2obs.sh -v NRSVCE -i -e
• copy resulting Scripture (NABRE) to your Obsidian vault

Multiple Translations in Obsidian

It is possible to work with multiple translations in Obsidian by pasting each translation into a separate folder. My Obsidian directory in iCloud looks like this, using several translations recommended by the USCCB:

.
└── Obsidian
    ├── Scripture (NABRE)
    ├── Scripture (NRSVCE)
    └── Scripture (RSVCE)

You can then reference multiple translations:

When I use a short filepath ([[Job-01#v21]]) rather than the full filepath ([[Scripture (NABRE)/22 - Job/Job-01#v21]]) it defaults to the NABRE translation, which I think may be because I copied it into my Obsidian vault first? If you know how Obsidian handles this please let me know.

Linking Ranges

The forum has suggested a couple of options for linking ranges of verses:

• in line or hyphenated
• separated by hyphen
• headers

This is what I tried:

---

the remainder of this README is unchanged

BibleGateway-to-Obsidian

This script adapts jgclark's wonderful BibleGateway-to-Markdown script to export for use in Obsidian. It accompanies a Bible Study in Obsidian Kit that gets you hands-on with using Scripture in your personal notes.

What the script does is fetch the text from Bible Gateway and save it as formatted markdown file. Each chapter is saved as one file and navigation between files as well as a book-file is automatically created. All of the chapter files of a book are saved in its numbered folder.

This script is intended to be as simple as possible to use, even if you have no idea about Scripting. If you have any questions, please reach out to me either on github or Discord (selfire#3095).

---

You can help me keep creating tools like this by buying me a coffee ☕️.

Important Disclaimers

• This is not affiliated to, or approved by, BibleGateway.com. In my understanding it fits into the conditions of usage but I make no guarantee regarding the usage of the script, it is at your own disgression.
• By default, the version is set to the WEB Bible. You can change the version, as long as you honour the copyright standards of different translations of the Bible (See: BibleGateways overview).
• I have little experience in scripting–through this project I taught myself bash and regex basics. If you run into issues or have a way to simplify this script, please raise an issue or reach out on Discord (selfire#3095).

Installation

Here are the tools we are going to use:

• Our command line (Terminal)
• A text editor (like Atom).
• A text editor is no longer necessary but if you're on Windows you might need to install perl.

Setting ruby up

Updating

In order to run the scripts, we will need to install ruby. Ruby comes pre-installed on MacOS but if you run into issues, update to the latest version.

Downloading BibleGateway-to-Markdown.rb

Follow the instructions to download and set up jgclark's BibleGateway-to-Markdown.

Usage

1. Install scripts

Put both scripts (bg2md.rb and bg2obs.sh) in the same directory, open your terminal application, and navigate to that directory with commands like the following:

• pwd Show your current directory
• ls List all contents in the current directory
• cd Enter a subdirectory (e.g., cd Desktop)
• cd .. Brings you 'up' one directory

2. Run the script

Once you have navigated to the directory containing both scripts, run bash bg2obs.sh. This will run the bash script.

NOTE: In this directory, a folder called Scripture with subfolders like 01 - Genesis, 02 - Exodus and so on will be created.

Several options are available via command-line switches. Type bash bg2obs.sh -h at any time to display them.

Script option summary

Option	Description
-v [VERSION]	Specify the version of the Bible to download (default is WEB)
-b	Set words of Jesus in bold (default is Off)
-e	Include editorial headers (default is Off)
-a	Create an alias in the YAML front matter with a more user-friendly chapter title (e.g., "Genesis 1") (default is Off)
-i	Show progress information while the script is running (i.e. "verbose" mode) (default is Off)
-h	Display help

Example usage

Command	Description
bash bg2obs.sh -i -v NIV	Download a copy of the NIV Bible with no other options.
bash bg2obs.sh -b	Download a copy of the WEB Bible (default) with Jesus' words in bold.
bash bg2obs.sh -v NET -beai	Download a copy of the NET Bible with all options enabled.

3. Format the text in a text editor

Some crossreferences are sometimes still included, run \<crossref intro.*crossref\> to delete.

There you go! Now, just move the "Scripture" folder into your Obsidian vault. You can use the provided The Bible.md file as an overview file.

Translations

This script downloads the World English Bible by default. If you want to download a different translation, specify the version using the -v command-line switch as documented above. The list of abbreviations is available on the Bible Gateway site under the version drop-down menu in the search bar. Make sure to honour copyright guidelines. The script has not been tested with all versions of the Bible available at Bible Gateway, though most of the more commonly-used ones should work.