|Llewellyn van der Merwe 1160b14bec|
GetBible Loader Integration Guide
getBible class to any element that has a scripture reference on your webpage, you can enable users to see the full scripture text as inline text, a tooltip or a modal.
How to Add GetBible Tooltips to Your Website
First, include the GetBible script in the
<head>section of your HTML document:
<!-- Include the GetBible tooltips script from jsDelivr CDN --> <script src="https://email@example.com/dist/js/getBible.min.js"></script>
Markup Your Scripture References:
In the body of your HTML document, apply the
getBibleclass to any element that should display a scripture tooltip. Here is an example using a
<ul> <li class="getBible">John 3:16</li> <li class="getBible">1 John 3:16-19,22</li> <!-- Add more elements as needed --> </ul>
For a detailed examples, check out the tests in the
Utilizing Data Attributes
Data attributes allow you to customize the behavior and display of the scripture.
data-format: Specify the format you would like to load (e.g.,
modal). There are three options
tooltipyou can just select one at a time.
data-translation: Specify the Reference translations to use, separated by semicolons (e.g.,
kjv;aov). The tooltip will fetch the scripture from each translation listed.
data-show-translation: Set to
1to display the translation name in the tooltip.
data-show-abbreviation: Set to
1to display the abbreviation of the translation in the tooltip.
data-show-language: Set to
1to display the language of the translation in the tooltip.
Here's how you might use these attributes:
<span class="getBible" data-translation="kjv;aov" data-show-translation="1" data-show-language="1">John 3:16,19</span>
In the example above, the tooltip for this list item will show text from both the King James Version (KJV) and another version abbreviated as AOV. It will also display the translation name and language for each scripture reference.
Scripture Reference Formatting
Nearly all abbreviations on almost all languages should work.
Should you see room for improvement to these, please open an issue at our support desk, we welcome any help to make this work even better.
- Reference and Verse: Follow the book name with the chapter number, a colon, and the verse number(s) (e.g., "Jn3:16").
- Multiple Verses: Separate multiple verses with commas (e.g., "Jn 3:16,17").
- Verse Ranges: Indicate a range of verses using a hyphen (e.g., "John 3:16-19").
- Multiple References: Separate different scripture references with semicolons (e.g., "Joh 3:16-17; 1 Jo3:16-19").
- One Reference Per/Reference: Each reference should only target one chapter.
- Missing Reference: All references that does not have a chapter will default to chapter 1 (e.g., "Jhn :16-19").
- Missing Verses: All references that does not have verses will default to verse 1 (e.g., "Jn3").