Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 47 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,21 @@
Olive Tree Url Examples
Olive Tree Custom Url Scheme Examples
=======================

Olive Tree Bible Software supports a custom URL scheme, `olivetree://bible/`, to open the app to specific passages. The URL format looks like this:
Olive Tree Bible Software supports a custom URL scheme.

## Reference

To open the OliveTree app to a specific passage, the URL format looks like this:

olivetree://bible/<book>.<chapter>.<verse>[/<version>]

olivetree://bible/<book>.<chapter>.<verse>

Alternatively, you can put an encoded space (`%20`) between the book, chapter, and verse:

olivetree://bible/<book>%20<chapter>%20<verse>

Book names are case-insensitive. If there is a space in the book name, like 1 Corinthians or 3 John, you need to encode that space as `%20`.
Some example links:

Example reference links:

- `olivetree://bible/romans.8.28` or `olivetree://bible/romans%208%2028` for Romans 8:28
- `olivetree://bible/1%20corinthians.13.1` or `olivetree://bible/1%20corinthians%2013%201` for 1 Corinthians 13:1
Expand All @@ -22,6 +26,42 @@ Here's how you would write a hyperlink in HTML that would open Olive Tree on iOS

<a href='olivetree://bible/43.3.16'>This opens John 3:16</a>

## Search

You can search for term(s) in a specific product by doing the following:

`olivetree://search/<search term(s)>[/<product ID, title, or abbreviated title>]`

Example search links to search current Bible or other product or specific product:

- `olivetree://search/love`
- `olivetree://search/god@20loved/nkjv`

_Note: Search links only work on iOS._

## Lookup

To lookup across any enhanced Bible dictionaries you may have downloaded, tags, notes, saved passages, etc., do the following:

Lookup term(s) across all products by doing the following:

`olivetree://lookup/<lookup term>`

Example lookup link:

- `olivetree://lookup/love`
- `olivetree://lookup/god@20loved`

_Note: Lookup links only work on iOS_

## Reading Plan

Open your default or last-used reading plan by doing the following:

`olivetree://startplan`

_Note: Reading plan links only work on iOS._

iOS
===================

Expand Down