JW Library Linker for Obsidian

This Obsidian plugin enhances your note-taking experience by providing seamless integration with JW Library links and Bible references.

Features

1. Bible Reference Linking

Quick Reference Creation: /b command for inserting new Bible references

Plain Text Conversion: Automatically detects and converts Bible references in selected text to JW Library links

2. Bible Quote Citation

Automatic Bible Text Insertion: Fetches and inserts actual Bible text for JW Library links

• Automatically fetches Bible text from JW.org or WOL (Watchtower Online Library)
• Multiple formatting options: short quotes, expandable callouts, or expanded callouts
• Customizable callout types (quote, note, info, etc.)
• Works with existing JW Library links in your notes
• Command to insert quotes for all links or specific cursor position

3. Bulk Link Conversion

Converts JW Library links and web links to formats that work directly in JW Library:

• Converts Bible verse and publication links from jwpub:// to jwlibrary:// format
• Converts jw.org web links to jwlibrary:// format
• Option to maintain the original text of the link while updating the URL
• Command with suggester interface to choose conversion type (all links, Bible verses only, publications only, or web links only)

Usage

Creating Bible References to JW Library

There are two types of methods to use:

Command mode

1. Type /b followed by a space
2. Enter the Bible reference (e.g., matthäus 24:14 or joh 3:16 or off21:3)
   (better suggestions while typing are in the doing)
3. Select the desired option from the suggestions to either create a link or create and open the link

Silent mode

1. Enter the Bible reference (e.g., matthäus 24:14 or joh 3:16 or off21:3).
   Once there is a valid reference possible the suggestion opens.
2. Select the desired option from the suggestions to either create a link or create and open the link

Example conversions:

/b mat 24:14
→ [Matthäus 24:14](jwlibrary:///finder?bible=40024014)

/b joh1:1,2,4
→ [Johannes 1:1-2](link),[4](link)

/b joh1:1,2,4,6,7-8,12-14
→ [Johannes 1:1-2](link),[4](link),[6-8](link),[12-14](link)

Converting Existing Links

Command: Convert to JW Library links

Opens a suggester to choose which type of links to convert (all links, Bible verse links only, publication links only, or web links only) in the selected text

1. Select the text containing the links you want to convert
2. Open the command palette (Ctrl/Cmd + P)
3. Search for "Convert to JW Library links"
4. Choose the type of conversion you want:
   • All: Converts all JW Library links (Bible verses, publications, and web links)
   • Bible: Only converts Bible verse links
   • Publication: Only converts publication links
   • Web: Only converts jw.org web links

Converting Plain Text Bible References

Command: "Link unlinked Bible references"

Converts plain text Bible references in selected text to JW Library links

1. Select text containing Bible references (e.g., "John 3:16" or "Romans 8:28")
2. Open the command palette (Ctrl/Cmd + P)
3. Search for "Link unlinked Bible references"
4. The plugin will automatically detect and convert valid Bible references to JW Library links

Inserting Bible Quotes

Command: "Insert Bible quotes for JW Library links"

Automatically fetches and inserts Bible text for existing JW Library links in your notes

For all links in selection/note:

1. Select text containing JW Library links (optional - if no selection, processes entire note)
2. Open the command palette (Ctrl/Cmd + P)
3. Search for "Insert Bible quotes for JW Library links"
4. The plugin will fetch Bible text and format it according to your settings

For cursor position:

1. Place your cursor on a line containing a JW Library link
2. Open the command palette (Ctrl/Cmd + P)
3. Search for "Insert Bible quote at cursor"
4. Alternatively, right-click on a line with a JW Library link and select "Insert Bible quote" from the context menu

Quote Formatting Options:

The plugin supports three formatting styles configurable in settings:

• Short format: Simple quote block below the link
• Long foldable: Collapsible callout (collapsed by default)
• Long expanded: Expanded callout (visible by default)

Example outputs:

Short format:

[Matthew 6:33](jwlibrary:///finder?bible=40006033)
> But keep on seeking first the Kingdom and his righteousness, and all these other things will be added to you.

Long foldable format:

> [!quote]- [Matthew 6:33](jwlibrary:///finder?bible=40006033)
> But keep on seeking first the Kingdom and his righteousness, and all these other things will be added to you.

Long expanded format:

> [!quote] [Matthew 6:33](jwlibrary:///finder?bible=40006033)
> But keep on seeking first the Kingdom and his righteousness, and all these other things will be added to you.

Local Development

Testing the Plugin Locally

To test the plugin locally in your Obsidian vault:

1. Build the plugin:

   npm run build

2. Create a symlink to your Obsidian vault's plugins directory:

   # Symlink the plugin directory
   ln -s /path/to/jw-library-linker /path/to/your/vault/.obsidian/plugins/jw-library-linker

3. Enable the plugin in Obsidian:

   • Open Obsidian Settings
   • Go to Community Plugins
   • Enable "JW Library Linker"

4. Development workflow:

   • Run npm run dev to rebuild in watch mode
   • Make changes to the source code
   • In Obsidian run command 'Reload app without saving'

Contributing

If you have ideas or want to help improve this plugin take a look at our contribution guidelines

Known Issues

Plugin	Issue	Fix
Iconize	Clock emoji shows when typing :	Edit Iconize trigger from : to ::
Various Complements	Suggestions get overwritten	🤷‍♂️