Skip to content

Commit

Permalink
1.4.0
Browse files Browse the repository at this point in the history
  • Loading branch information
kuchejak committed Oct 1, 2022
1 parent 0a89c99 commit bdab365
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 22 deletions.
48 changes: 29 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,35 +2,24 @@
Plugin for easier linking of multiple bible verses in Obsdian.md note taking app.

## Usage
1. Use command "Copy bible verses" or "Create obsidian links to bible verses" (described bellow)
1. Use command "Copy bible verses" or "Create obsidian links to bible verses" (described bellow).
2. Insert bible link, for example "Gen 1,1-3 or Gen 1.1". Note: Links across more chapters are not supported (yet?).
3. Watch the magic.
3. Enjoy.

## Copy and Link Bible verses command
Copies given verses from your bible files and inserts obsidian links to them.
Copies given verses from your bible files and inserts obsidian links to them. This is the main command of the plugin, with many more features than the other one.

### Example output (input: `Gen 1,1-3`)
```md
>[[Gen-01#v1|Gen 1,1-3]] In the beginning, God created the heavens and the earth. The earth was formless and empty. Darkness was on the surface of the deep and God's Spirit was hovering over the surface of the waters. God said, "Let there be light," and there was light. [[Gen-01#v1|]][[Gen-01#v2|]][[Gen-01#v3|]]
```
Note that linking is done using "invisible" links after the verses (those links are visible only in source mode) - this can be turned off in the settings.
Note that linking is done using "invisible" links after the verses (those links are visible only in source mode) - this can be turned off in the settings, but it is not recommended if you want to use the full power of Obsidian linking.

### Pros of this approach
- More verses can be displayed as one block of text, which is more visually pleasing than multiple link blocks after each other.
- You can edit the text if you want (for example add some in-line notes, bold important part...) without effecting the original.


## Link Bible verses command
Simpler command that only creates obsidian links based on input. You can choose if you want standard links (e.g. `[[Gen-01#v1]]`), embedded links (e.g. `![[Gen-01#v1]]`) or links invisible in the preview mode (e.g. `[[Gen-01#v1|]]`). This command is less powerful, but it also has looser requirements for your bible files, so you can use it even when the copy command does not work.

![obrazek](https://user-images.githubusercontent.com/94016085/160867853-5bff3b17-d8a7-4ec9-8672-eb1fa3acc88c.png)


## Requirements
### Link command
Basically no requirements, it just parses your input and creates links based on it. If it does not do what you want, look into the settings.

### Copy command
### Requirements
Requires you to have bible in markdown in your vault, with similar structure to [Obsidian bible study kit](https://forum.obsidian.md/t/bible-study-in-obsidian-kit-including-the-bible-in-markdown/12503) - that is:
- 1 file = 1 chapter
- All verses of given chapter are present
Expand All @@ -52,17 +41,38 @@ Requires you to have bible in markdown in your vault, with similar structure to
3rd verse text
```

## Input format
#### Input format
- File names are deduced from the link you enter:
- if your file is named "Gen 1", you will have to enter "Gen 1,1-4"
- if your file is named "Genesis 1", you will have to enter "Genesis 1,1-4"
- *exception*: if your file is named "Gen-01", you can type either "Gen-01,1-4" or "Gen 1,1-4"

## Wrong verses are linked? Or linking doesn't work and you have files with right format?
### Multiple translation support
The copy command can be used with multiple bible translations, as long as the following requirements are met:
1. Each translation must be kept in its own folder - for example Bible/NIV and Bible/KJV.
2. All translations must use the same naming conventions for files - for example if the file is named "Gen 1" in NIV, it can not be "Gn 1" in KJV.
3. The structure of the files must be roughly the same, so that they all work with the same "Verse offset" and "Verse heading level" settings.

Multiple translation support must be enabled in the settings, it is off by default.

### Wrong verses are linked? Or linking doesn't work and you have files with right format?
- Go to Plugin settings and try changing "Verse offset" or "Verse heading level" accordingly.

## Link Bible verses command
Simpler command that only creates obsidian links based on input. You can choose if you want standard links (e.g. `[[Gen-01#v1]]`), embedded links (e.g. `![[Gen-01#v1]]`) or links invisible in the preview mode (e.g. `[[Gen-01#v1|]]`). This command is less powerful, but it also has looser requirements for your bible files, so you can use it even when the copy command does not work.

![image](https://user-images.githubusercontent.com/94016085/160867853-5bff3b17-d8a7-4ec9-8672-eb1fa3acc88c.png)


### Requirements
Basically no requirements, it just parses your input and creates links based on it. If it does not do what you want, look into the settings.


## Support
If you want to support this plugin, star it on GitHub. Thank you.

## Installing
Available through Obsidian Community plugins (Settings/Comumnity plugins)
Available through Obsidian Community plugins (Settings/Community plugins)

### Manual install
Copy over `main.js`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`
2 changes: 1 addition & 1 deletion manifest.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"id": "obsidian-bible-linker",
"name": "Bible Linker",
"version": "1.3.4",
"version": "1.4.0",
"minAppVersion": "0.12.0",
"description": "Link multiple bible verses easily",
"author": "Jakub Kuchejda",
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "obsidian-bible-linker",
"version": "1.3.4",
"version": "1.4.0",
"description": "Obsidian bible linker plugin",
"main": "main.js",
"scripts": {
Expand Down
3 changes: 2 additions & 1 deletion versions.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,6 @@
"1.3.1": "0.12.0",
"1.3.2": "0.12.0",
"1.3.3": "0.12.0",
"1.3.4": "0.12.0"
"1.3.4": "0.12.0",
"1.4.0": "0.12.0",
}

0 comments on commit bdab365

Please sign in to comment.