scotttomaszewski/obsidian-bible-references-plugin

Obsidian Bible Reference Plugin

Changes documented in the changelog

I will get this plugin registered in the community plugins when there is some testing and stability. Until then...

ESV.org API Token

The ESV.org API requires a token to use. A public token is provided by default, but there are caps imposed by ESV.org. For details on thresholds, see https://api.esv.org/#conditions. Please be considerate and rate-limit yourselves to not exceed the threshold. If caps are exceeded excessively, I will implement limits and/or disable the public token.

If you plan on using this plugin to pull an excessive amount of passages, I would appreciate if you would generate your own API token to avoid exceeding the threshold and locking out others using the public token. You can get a token by creating an account and requesting a token (https://api.esv.org/account/create-application).

Building and Installing

Basic Installation

1. Download the obsidian-bible-reference-plugin-0.0.1.zip archive from the latest tag here: https://github.com/scottTomaszewski/obsidian-bible-references-plugin/releases
2. Extract the archive to your <vault_path>/.obsidian/plugins/ folder
3. Make sure you have community plugins enabled (Settings > Community Plugins > Safe Mode OFF)
4. Enable the Bible Reference Plugin (Settings > Community Plugins > toggle the plugin)

Manually Building the Plugin

• Clone your repo to a local development folder. For convenience, you can place this folder in your <vault_path>/.obsidian/plugins/obsidian-bible-reference-plugin folder.
• Install NodeJS, then run npm i in the command line under your repo folder.
• Run npm run dev to compile your plugin from main.ts to main.js.
• Make changes to main.ts (or create new .ts files). Those changes should be automatically compiled into main.js.
• Reload Obsidian to load the new version of your plugin.
• Enable plugin in settings window.
• For updates to the Obsidian API run npm update in the command line under your repo folder.

Manually Installing the Plugin

• Copy over main.js, styles.css, manifest.json to your vault <vault_path>/.obsidian/plugins/obsidian-bible-reference-plugin/.

obsidian-bible-references-plugin's Issues

Footer Link to Chapter setting does not work.

Hi Scott,

The "Footer Link to Chapter" setting is not currently working. I think I have fixed it at Geekdude@9def5e5.

Thanks,
Aaron

"File name cannot contain any of the following characters: * " \ / < > : | ?" when using windows.

Hi Scott,

Thank you for creating this obsidian plugin. Out of all the obsidian bible plugins I have looked at, I like this one's behavior the most since it closely mirrors the esv CLI tool I created using the same ESV API to read and listen to the ESV bible via the terminal.

I use Windows, macOS, and Linux, and on Windows, the ':' is an invalid character for the file path. This causes Obsidian to complain with the error message "File name cannot contain any of the following characters: * " \ / < > : | ?".

For a potential workaround, . could be used instead of : as a separator between chapter and verse. This follows the MLA bible reference style. See How to Cite the Bible. I have tried out this solution using a windows fix setting. See Geekdude@73288f8. This solution seems to work well when I tested it. This is my first time working with an Obsidian plugin or using Typescript. I think this solution is good; it allows references to use . or : and, depending on the setting's value, will save the file using . or : as the separator. The setting name could potentially be improved by calling it APA style or MLA style instead of windowsFix.

Thanks,
Aaron Young