Add Component Settings
parent
b29fc934ca
commit
7cb4f2ba40
330
Component-Settings.md
Normal file
330
Component-Settings.md
Normal file
@ -0,0 +1,330 @@
|
||||
## Global Configuration for Get Bible Component
|
||||
|
||||
### 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 for Get Bible Component
|
||||
|
||||
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 for Get Bible Component
|
||||
|
||||
### 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 color for the search terms found in the verses. The color is specified in the hexadecimal color format.
|
||||
|
||||
### Table Selection Colour
|
||||
Allows the user to select the color for the selected table. The color 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 for Get Bible Component
|
||||
|
||||
### Activate Notes
|
||||
Option to activate the feature to add notes on verses. This feature can be toggled on or off.
|
||||
|
||||
## Tag Configuration for Get Bible Component
|
||||
|
||||
### 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 for Get Bible Component
|
||||
|
||||
### 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.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user