getBible/support
9
4
Fork 2
Code Issues 6 Pull Requests Projects Wiki Activity

Delete page "Home"

Llewellyn 2024-04-25 07:50:27 +00:00
parent 72febfc711
commit 03337a8f42
1 changed files with 0 additions and 450 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

450
Home.md

@ -1,450 +0,0 @@
# GetBible App Wiki
## Introduction
The GetBible App is an immersive, user-friendly platform designed to enhance your journey through the scriptures. It offers a comprehensive suite of study tools, allowing you to explore the Bible in depth. With features such as customizable study methods, social sharing, integration with OpenAI, and a commitment to bring God's word to every corner of the world, GetBible seeks to revolutionize the way you engage with the Bible.
More than offering Bible study tools at [GetBible.net](https://getbible.net/), you can now install and use this application on your Joomla 3 website as well.
## How to Install GetBible on Your Joomla Website
This wiki will guide you through the process of installing the component.
### Step 1: Upload the Component Package
First, you will need to upload the component package using the Joomla installer. Here's how:
1. **Login to your Joomla Admin**: You'll need administrative access to perform these operations. Use your credentials to log into the back-end of your website.
2. **Access the Extension Manager**: Navigate to "Extensions" in the top menu, then click on "Manage" and select "Install" from the drop-down menu.
3. **Upload Package File**: Now you need to upload the component package. Click on the "Upload Package File" tab. Click on the "Choose File" button, navigate to where you have stored the component's .zip file on your computer, select it, and click on the "Upload & Install" button.
Joomla will then upload the package from your computer and install it onto your website.
### Step 2: Create a Menu Item and Link the Component
The next step is to create a new menu item and link it to your newly installed component. Follow these steps:
1. **Navigate to Menus**: From the top menu, select "Menus", then click on "Main Menu" (or the relevant menu where you want the link to appear), and select "Add".
2. **Create New Menu Item**: You'll be taken to a screen where you can input details about your new menu item. Under "Menu Title", type in what you'd like the menu item to be called.
3. **Link the Component**: Under "Menu Item Type", click on "Select" and a modal window will open. Look for GetBible in this list, and select it to open the options. Be sure to select the **App**. Any other personal preferences can be set and then click "Save & Close".
> If you already have menu items, you will need to do a quick setup in the Global Configurations for Get Bible.
* In the App tab be sure to set the "Bible App Menu Item" to the menu item you just created.
### Step 3: Verify Component Functionality
With the component installed and linked, you should now initiate the app.
1. **Navigate to your Website Front-end**: Open your website front end in a new tab and navigate to the page where the Get Bible app is installed. The component's application page should load with the King James Bible as the default translation.
If the page does not load immediately, refresh your browser tab. Your component should now load properly for the King James Version.
You can now start using the Bible application. Yet there will be certain limitations because all available Bible translations are not yet initiated on the system.
### Step 4: Load Bible Translations
As system administrator you should now load all the Bible translations you want available on your website. There is a few simple steps needed.
1. In the Get Bible global configurations toggle the `Show Install Button` to **YES** This will show the `Install Translation` button on the Bible app page.
> This is normally only needed to be activated once during the setup of your application on your website the first time. It would be best to switch this off again after you have finished installing all the Bibles.
2. Go again to the front end of the Bible app and you should see the install button to the bottom of the page. You can now install all the Bibles you want to have available in the application. Please read the notices and make sure that you have sufficient time to complete these installations.
3. Once you have installed all the translations, you can switch off the global configuration and start using the Get Bible application without any further restrictions.
### GetBible API (Coming Soon)
Starting from 31 August 2023, GetBible API will offer a powerful solution for integrating the profound wisdom of the Bible into your application or website. This will allow you to seamlessly incorporate biblical text into your project.
# Component Configurations for Get Bible
## Global Settings
### Check in timer
Set the intervals for the auto checkin function of tables that checks out the items to an user. The options include:
- Every five hours
- Every twelve hours
- Once a day
- Every second day
- Once a week
- Never
### Enable Versions
Automatically save old versions of an item. If set to Yes, old versions of items are saved automatically. When editing, you may restore from a previous version of the item.
### Maximum Versions
The maximum number of old versions of an item to save. If zero, all old versions will be saved.
### VDM Access Token
To get updates, add your access token from VDM [here](https://git.vdm.dev/user/settings/applications).
### Show Install Button
Show install translation button on the Bible app page. This is normally only needed during the setup of your application on your website the first time.
### GetBible Logo
Option to show or hide the GetBible logo.
### GetBible Link
Option to show or hide the GetBible link.
### Hash Validation
Option to show or hide the hash validation details.
### API Link
Option to show or hide the API link.
## Uikit3 Configuration
Uikit is a lightweight and modular front-end framework for developing fast and powerful web interfaces. For more info visit [https://getuikit.com/](https://getuikit.com/)
### Load Joomla jQuery
Option to decide whether to load the Joomla jQuery Framework.
### Loading Options
Set the uikit loading option. The options include:
- Auto
- Force
- Not
### Load Minified
Option to decide whether the minified version of uikit files should be loaded.
## Search Configuration
### Activate Search
Option to activate the ability to search verses. This feature can be toggled on or off.
### Search Found Colour
Allows the user to select the highlighting colour for the search terms font in the verses. The colour is specified in the hexadecimal color format.
### Table Selection Colour
Allows the user to select the colour for the selected table. The colour is specified in the hexadecimal color format.
### Words
Determines the search behavior around each word. The options include:
- All Words
- Any Words
- Exact Phrase
### Match
Sets the behavior of how each word match is handled during search. The options are:
- Exact Match
- Partial Match
### Case
Determines the case sensitivity of the search. The options include:
- Case Insensitive
- Case Sensitive
## Notes Configuration
### Activate Notes
Option to activate the feature to add notes on verses. This feature can be toggled on or off.
## Tag Configuration
### Activate Tags
Option to activate the feature to tag verses. This feature can be toggled on or off.
### Allow Untagging
Allows users to remove system tags from verses for themselves only. This feature can be toggled on or off.
## Share Configuration for Get Bible Component
### Activate Sharing
Option to activate the feature to share verses. This feature can be toggled on or off.
**Note:** We cache the user selection, which means that these settings only form the default advance options for new visitors, or for those who clear their cache.
### Verse Layout Share
Choose the verse layout when shared. Options include 'Paragraph' and 'Per Line'.
### Verse Number Share
Choose whether to show or hide verse numbers when shared.
### Local Link Share
Choose whether to add or remove local links when shared.
### Text Reference Share
Choose where the text reference should appear when shared. Options include 'None', 'Top', and 'Bottom'.
### Type Translation Share
Choose how to represent translation types when shared. Options include 'None', 'Abbreviation', and 'Name'.
### Default Format Share
Choose the default format for shared content. Options include 'Plain Text', 'Markdown', and 'HTML'.
## Application Configuration
### Bible App Menu Item
Select the menu item of the application page.
### Verse Selected Colour
Choose the colour for the selected verse.
### Show Header
Choose to display or not the header.
### Verse Per Line
This option allows you to load each verse on its own line.
### Show Top Menu
Choose whether to display the top menu or not.
### Top Menu Type
Select the type of the top menu. Options include 'subnav-pill' and 'tabs'.
### Show Bottom Menu
Choose whether to display the bottom menu or not.
### Bottom Menu Type
Select the type of the bottom menu. Options include 'subnav-pill' and 'tabs'.
### Show Previous and Next Navigation
Choose whether to show the previous and next navigation buttons.
### Set Custom Tabs
Activate this option to set your own custom tabs. When activated, you can provide the following details for each tab:
- Tab Name
- Module Position
- Separator (with options 'None', 'div', 'list', 'array', 'break')
- Class (Blank for none)
### Set Default Tab Names
Activate this option to set the default tab names.
### Set Custom Icons
Use this option to set custom icons. The available icons can be found at https://getuikit.com/docs/icon
### Show Scripture Tab Text
Choose to display the scripture tab text.
### Scripture Tab
Set the name for the scripture tab.
### Show Scripture Icon
Choose to display the scripture icon.
### Scripture Icon
Set the custom icon for the scripture. Please input the icon name here.
### Show Books Tab Text
This option allows you to decide if you want to display the text for the Books tab. This is a binary choice, you can either choose "Yes" to show the text, or "No" to hide it.
### Books Tab
This input allows you to set the name for the books tab. This setting will be active only if the 'Show Books Tab Text' option is set to 'Yes' and 'Set Default Tab Names' is enabled.
### Show Books Icon
This option allows you to choose if you want to show an icon for the Books tab. If you choose "Yes", an icon will be displayed, otherwise, it will not be displayed.
### Books Icon
This setting allows you to set a custom icon for the books tab. This setting will be active only if 'Show Books Icon' and 'Custom Icons' are enabled.
### Show Books Card
This option allows you to choose if you want to show a card for the Books. If you select "Yes", a card will be displayed, otherwise, it will not be displayed.
### Books Card Style
This option allows you to choose the style for the Books Card. You can choose from "default", "primary", or "secondary" style.
### Show Chapters Tab Text
This option allows you to decide if you want to display the text for the Chapters tab. You can either choose "Yes" to show the text, or "No" to hide it.
### Chapters Tab
This input allows you to set the name for the chapters tab. This setting will be active only if 'Show Chapters Tab Text' is set to 'Yes' and 'Set Default Tab Names' is enabled.
### Show Chapters Icon
This option allows you to choose if you want to show an icon for the Chapters tab. If you select "Yes", an icon will be displayed, otherwise, it will not be displayed.
### Chapters Icon
This setting allows you to set a custom icon for the chapters tab. This setting will be active only if 'Show Chapters Icon' and 'Custom Icons' are enabled.
### Show Chapters Card
This option allows you to choose if you want to show a card for the Chapters. If you select "Yes", a card will be displayed, otherwise, it will not be displayed.
### Chapters Card Style
This option allows you to choose the style for the Chapters Card. You can choose from "default", "primary", or "secondary" style.
### Show Settings
This option allows you to decide if you want to display the settings tab. You can either select "Yes" to display the tab, or "No" to hide it.
### Show Settings Tab Text
This option allows you to decide if you want to display the text for the Settings tab. You can either select "Yes" to display the text, or "No" to hide it.
### Settings Tab
This input allows you to set the name for the settings tab. This setting will be active only if 'Show Settings', 'Show Settings Tab Text' are set to 'Yes' and 'Set Default Tab Names' is enabled.
### Show Settings Icon
This option allows you to choose if you want to show an icon for the Settings tab. If you select "Yes", an icon will be displayed, otherwise, it will not be displayed.
### Settings Icon
This setting allows you to set a custom icon for the settings tab. This setting will be active only if 'Show Settings Icon', 'Show Settings', and 'Custom Icons' are enabled.
### Show Settings Card
This option allows you to choose if you want to show a card for the Settings. If you select "Yes", a card will be displayed, otherwise, it will not be displayed.
### Settings Card Style
This option allows you to choose the style for the Settings Card. You can choose from "default", "primary", or "secondary" style.
### Show Details
This option allows you to decide if you want to display the Details tab. You can either select "Yes" to display the tab, or "No" to hide it.
### Show Details Tab Text
This option allows you to decide if you want to display the text for the Details tab. You can either select "Yes" to display the text, or "No" to hide it.
### Details Tab
This input allows you to set the name for the details tab. This setting will be active only if 'Show Details', 'Show Details Tab Text' are set to 'Yes' and 'Set Default Tab Names' is enabled.
### Show Details Icon
This option allows you to choose if you want to show an icon for the Details tab. If you select "Yes", an icon will be displayed, otherwise, it will not be displayed.
### Details Icon
This setting allows you to set a custom icon for the details tab. This setting will be active only if 'Show Details Icon', 'Show Details', and 'Custom Icons' are enabled.
### Show Details Card
This option allows you to choose if you want to show a card for the Details. If you select "Yes", a card will be displayed, otherwise, it will not be displayed.
### Details Card Style
This option allows you to choose the style for the Details Card. You can choose from "default", "primary", or "secondary" style.
### Debugging
This option allows you to decide if you want to show debugging information. You can either select "Show" to display the debugging information, or "Hide" to conceal it.
## OpenAI Custom Configuration
### Enable OpenAI
Toggle this setting to enable or disable the integration with OpenAI. If enabled, your application can use the AI models provided by OpenAI for various tasks such as text generation, question answering, and more.
### OpenAI Documentation
Before starting, it's highly recommended to review the OpenAI API documentation, especially the guide on creating a chat conversation. This guide provides a comprehensive understanding of how to create chat completions using OpenAI's model, control model's responses, manage the output, and use additional features.
[OpenAI API Documentation](https://platform.openai.com/docs/api-reference/chat/create)
### Model
Select the model to use for the AI tasks. The model ID will determine the capabilities, and performance of the AI operations. Models range from gpt-3.5-turbo to different versions of gpt-4.
### Get OpenAI API Token
To use the OpenAI services, you need to generate an API token. This token will be used for authentication when making requests to the OpenAI API.
Here are the steps:
1. Sign Up on OpenAI.
2. Confirm your Email.
3. Access the Dashboard.
4. Create a New API Key.
5. Copy your API Key.
6. Use your API Key.
Remember to keep your API key secure. If you believe your API key has been compromised, you can delete it and generate a new one from your OpenAI dashboard.
### OpenAI Token
Enter your OpenAI token here. This token is used to authenticate your application's requests to the OpenAI API.
### Enable Organisation OpenAI
Toggle this setting to enable or disable the use of OpenAI services on an organisational level. If enabled, you can use an organization's API token which represents access to your entire organization's OpenAI account.
### Get OpenAI Organization API Token
Just like the personal OpenAI API token, an organization API token is needed when organization-level access is enabled. The steps to get the organization API token are similar:
1. Sign In to OpenAI.
2. Access the Organization Settings.
3. Create a New Organization API Key.
4. Copy the API Key.
5. Use the Organization API Key.
Remember to handle this key carefully, as it represents access to your entire organization's OpenAI account.
### OpenAI Organisation Token
Enter your OpenAI organisation token here. This token is used to authenticate your organization's requests to the OpenAI API.
### Max Tokens
The "max_tokens" parameter sets the maximum number of tokens that the model generates for each output. The total number of input tokens and generated tokens should not exceed the model's maximum context length.
### Temperature
The "temperature" parameter controls the randomness of the model's output. Higher values result in more randomness, while lower values make the output more deterministic.
### Top P
The "top_p" parameter, also known as nucleus sampling, controls the cumulative probability threshold for token selection by the model. Setting "top_p" to a certain value means the model only considers the tokens for the next word, whose cumulative probability exceeds that value.
### Number of AI Response Per/Prompt
The "n" parameter sets the number of independent completions to generate for each input. This is useful when you want multiple distinct responses to a single prompt.
### Frequency Penalty
The "frequency_penalty" parameter controls the penalty for new tokens based on their frequency in the text. Higher values discourage the model from repeating the same words or phrases.
### Presence Penalty
The "presence_penalty" parameter controls the penalty for new tokens based on their presence in the text so far. Higher values encourage the model to bring up new topics and discourage it from focusing on a single topic.
# Get Bible Reader Guide
### Navigation
The top navbar provides a seamless navigation experience, with menu items such as Active, Translations, Books, Chapters, Settings, and Details.
- **Active**: - Your primary tab is the active tab where you are reading or where you are navigating to.
- **Translations**: - Here you can browse to any available translation of the Bible.
- **Books**: - Search for a specific book in the Bible. You will then be directed to load the specific chapter.
- **Chapters**: - Load for another chapter.
- **Settings**: - Set the Bible according to your preference.
- **Details**: - Find the current translation's specific details here.
### Personalize Your Study
The GetBible App lets you create personal notes and tags, engage with scriptures in a way that suits your study methods, and capture your reflections in a private and secure manner.
- **Create a Note**: Click on the verse number to create a note.
- **Edit a Note**: Click the note icon under a verse to edit it.
- **Delete a Note**: Click on the note and clear the contents to delete it.
### Cross Reference Tags
Use tags to categorize verses under applicable topics. This helps in creating your own chain references and also helps in enhancing your study and comprehension.
- **Tag a Verse**: Click a verse number, select TAGS at the bottom of the pop-up page. The tagging interface will open. Drag an available tag into the active field. This effectively tags your verse under the category.
- **Remove a Tag from a Verse**: Drag an active tag back to the available field to untag the verse.
> Note: GetBible comes preloaded with notes and tags. You can edit or delete these, but be aware you won't see them again in your session.
### Share Your Insights
Share verses and selections from the Bible in any available translation. You can also personalize the layout of your selected verses.
- **Share a Verse**: Click the verse number and select the Share option if the share page is not active. Drag the slider to incorporate your selection and select COPY.
- **Share a Link**: Copy the link to the specific verse of interest.
### Comprehensive Search
A comprehensive search feature is integrated to help you quickly find verses within the Bible.
- **Search a Word**: Click on any word in the Bible text to create a search request.
- **Search a Selection**: Any selection made in the text will bring up the search request.
- **Refine Search**: Default search parameters are set by the system administrator. Yet search requests can be further refined by clicking on Search Options.
- **Translation**: Any translation can be searched
- **Words**: Search for all the word in your search request, or search for any word, or alternatively search for the exact phrase
- **Match**: Match your search request exactly or only partially.
- **Case**: Choose between case insensitive search or case sensitive search.
- **Targeted Books**: Search in all books of the Bible or only the Old Testament or New Testament.to the Wiki.
## Conclusion
Whether you're reading the Bible cover to cover, or focusing on a specific book or verse, the GetBible App provides a seamless and enriching reading and study experience.