From 29b236c94b3df0951aa7b582d5f371e5cc356a77 Mon Sep 17 00:00:00 2001 From: Charles Coleman Date: Sat, 28 Jan 2023 21:00:34 -0700 Subject: [PATCH] Add more details to custom url scheme examples #3 --- README.md | 54 +++++++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 47 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 49dbf19..f92dc3f 100644 --- a/README.md +++ b/README.md @@ -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/..[/] - olivetree://bible/.. - Alternatively, you can put an encoded space (`%20`) between the book, chapter, and verse: olivetree://bible/%20%20 - + 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 @@ -22,6 +26,42 @@ Here's how you would write a hyperlink in HTML that would open Olive Tree on iOS This opens John 3:16 +## Search + +You can search for term(s) in a specific product by doing the following: + + `olivetree://search/[/]` + +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/` + +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 ===================