File "config.py"

"config.py" is a plain text file, containing configuration settings of UniqueBible.app. This file is generated first time the app is launched and closed.

This document describes items of configuration file "config.py". You may use a text editor to change some of them according to your needs.

Restore All Default Settings

Before changing config.py, you may want to know how to restore all default values in case something may go wrong with your editing. You can always restore to all default settings, by:

1. close the app.
2. delete file "config.py"
3. open the app again and close properly.

Try GUI First

Before you manually edit the file "config.py", please try to configure your settings through the menu first. Many common items are available to configure through the menu.

Items

Below are description of available items in config.py

testing: True / False

Please ignore this one. This item is created for internal testing only.

Personal google api key

You can enter your personal google api key here. Live google maps are embedded in opened articles of "Exhaustive Library of Bible Locations" provided that:

• internet connection is available
• The next item, "alwaysDisplayStaticMaps", is set to "False".

Default string is empty. Please either leave it empty or enter a VALID google api key. After you enter you key, pay attention to console's message, you may need to set permission to use your key on your side.

myGoogleApiKey = ""

Option to always display google static maps: True / False

If this item is set to be "True", item "myGoogleApiKey" is ignored. That means "Exhaustive Library of Bible Locations" always displays static goolge maps even a valid google api key is entered.

alwaysDisplayStaticMaps = False

Options to use remote control: True / False

This feature is created for use in church settings. Please ignore this item if you use the application on your personal computer. If it is set to "True", users can use an additional command field, in an additional window, to control the content being displayed, even the main window of UniqueBible.app is displayed on a extended screen / monitor.

remoteControl = False

openWindows

Windows' command used to open file / application

openWindows = 'start'

openMacos

macOS's command used to open file / application

openMacos = 'open'

openLinux

Linux's command used to open file / application

openLinux = 'xdg-open'

openLinuxPdf

Linux's command used to open pdf files

openLinuxPdf = 'xdg-open'

Linux-only options to launch the app with full screen on startup

linuxStartFullScreen = False

Linux-only options to show text-to-speech feature on right-click context menu on Linux platform

showTtsOnLinux = False

Linux-only-options to use fcitx as input method: True / False

This option may be useful on some Linux systems, where qt4 and qt5 applications use different input method variables.

fcitx = False

Linux-only-options to use ibus as input method: True / False

This option may be useful on some Linux systems, where qt4 and qt5 applications use different input method variables.

ibus = False

Options to use built-in virtual keyboards: True / False

This option may be useful for touch-screen users who want to enter non-English characters for commands or notes.

virtualKeyboard = False

Specify the folder path of resources

Either a path relative to the UniqueBible folder or a full path is accepted.

marvelData = "marvelData"

musicFolder

To specify the path of music folder.

musicFolder = "music"

videoFolder

To specify the path of video folder.

videoFolder = "video"

Specify the number of tabs for bible reading and workspace

Remarks: More tabs may make slower the app to run. Please use a reasonable number here.

numberOfTab = 5

Options to convert all bible book abbreviations to standard ones: YES / NO

parserStandarisation = "NO"

Options of language of book abbreviations: ENG / TC / SC

ENG = English; TC = Traditional Chinese; SC = Simplified Chinese

standardAbbreviation = "ENG"

userLanguage

To specify the destination language of Google Translate. It also define the user interface's language if "userLanguageInterface" is set to True. To avoid errors, use the app's gui dialog to set this option.

userLanguage = 'English'

userLanguageInterface: True / False

If True, user interface of user-defined language, i.e. "userLanguage" above, is used.

userLanguageInterface = False

showGoogleTranslateEnglishOptions: True / False

If True, option to Google translate into English is displayed on context menu.

showGoogleTranslateEnglishOptions = False

showGoogleTranslateChineseOptions: True / False

This item is created for Chiense users only. If True, options to Google translate into Traditional Chinese and Simplified Chinese are displayed on context menu.

showGoogleTranslateChineseOptions = False

autoCopyGoogleTranslateOutput: True / False

If True, result of Google Translate is automatically copied to clipboard.

autoCopyGoogleTranslateOutput = True

autoCopyChinesePinyinOutput: True / False

If True, result of Chinese pinyin conversion is automatically copied to clipboard.

autoCopyChinesePinyinOutput = True

showVerseNumbersInRange: True / False

If True, verse numbers are displayed when a reference of verse range is opened.

showVerseNumbersInRange = True

openBibleNoteAfterSave: True / False

If Ture, latest note is displayed on Study Window after edited notes are saved in "Note Editor".

openBibleNoteAfterSave = False

exportEmbeddedImages: True / False

Images in some book modules are encoded with base64 and embedded within the content. If this option is set to Ture, those images are decoded and exported as normal image files, when they are loaded on Study Window.

exportEmbeddedImages = False

clickToOpenImage: True / False

If Ture, a single-click on an image displayed on Study Window opens its image file with an external application. For embedded images to work with this feature, also set "exportEmbeddedImages" to True.

clickToOpenImage = False

Options to use landscape mode: True / False

landscapeMode = True

Options for NOT displaying any toolbars on startup: True / False

noToolBar = False

Options to display the top toolbar only, with all other toolbars hidden: True / False

topToolBarOnly = False

Options to use button icons in their original sizes: True / False

toolBarIconFullSize = False

Options on parallel mode: 0, 1, 2, 3

0 = hidden; 1 = 25% of main window; 2 = 50% of main window; 3 = 75% of main window

parallelMode = 1

Options to display the window showing instant information: 0, 1

instantMode = 1

Options to trigger instant information: True / False

instantInformationEnabled = True

Default font size of content in main window and workspace

fontSize = 17

Default font

font = ''

You may change the default font here to your favourite font installed on your system, e.g.

font = 'Calibri'

Font for Chinese bibles

default:

fontChinese = ''

you may change to, e.g.

fontChinese = 'NSimSun'

Default font size of content in note editor

noteEditorFontSize = 14

Options to display bibles in formatted layout or paragraphs: True / False

"False" here means displaying bible verse in plain format, with each one on a single line.

readFormattedBibles = True

Options to add sub-headings when "readFormattedBibles" is set to "False": True / False

addTitleToPlainChapter = True

Options to hide lexical entries or Strong's numbers: True / False

hideLexicalEntryInBible = False

Import setting - add a line break after each verse: True / False

importAddVerseLinebreak = False

Import setting - keep Strong's number for search: True / False

importDoNotStripStrongNo = False

Import setting - keep morphology codes for search: True / False

importDoNotStripMorphCode = False

Import setting - import text in right-to-left direction: True / False

importRtlOT = False

List of modules, which contains Hebrew / Greek texts

originalTexts = ['original', 'MOB', 'MAB', 'MTB', 'MIB', 'MPB', 'OHGB', 'OHGBi', 'LXX', 'LXX1', 'LXX1i', 'LXX2', 'LXX2i']

List of modules, which contains right-to-left texts on old testament

rtlTexts = ["original", "MOB", "MAB", "MIB", "MPB", "OHGB", "OHGBi"]

Open bible references on main window instead of workspace: Ture / False

openBibleInMainViewOnly = False

Last-opened bible version and passage to be displayed on main window

mainText = "KJV"

mainB = 1

mainC = 1

mainV = 1

Last-opened bible version and passage to be displayed on workspace

studyText = "NET"

studyB = 43

studyC = 3

studyV = 16

Set your favourite version here.

favouriteVersion = "OHGB"

Options to display "favouriteVersion" together with the main version for reading multiple references: True / False

addFavouriteToMultiRef = False

Last-opened commentary text and passage

commentaryText = "CBSC"

commentaryB = 43

commentaryC = 3

commentaryV = 16

Last-opened module for topical studies

topic = "EXLBT"

Last-opened dictionary module

dictionary = "EAS"

Last-opened encyclopedia module

encyclopedia = "ISB"

Last-opened book module

book = "Timelines"

Last string entered for searching book

bookSearchString = ""

Last string entered for searching note

noteSearchString = ""

Last-opened third-party dictionary

thirdDictionary = "webster"

Default Hebrew lexicon

defaultLexiconStrongH = "TBESH"

Default Greek lexicon

defaultLexiconStrongG = "TBESG"

Default lexicon based on ETCBC data

defaultLexiconETCBC = "ConcordanceMorphology"

Default lexicon on LXX words

defaultLexiconLXX = "LXX"

Default lexicon on GK entries

defaultLexiconGK = "MCGED"

Default lexicon on LN entries

defaultLexiconLN = "LN"

Maximum number of history records allowed to be stored

historyRecordAllowed = 50

Indexes of last-opened records

currentRecord = {"main": 0, "study": 0}

History records are kept in > history

history = {"external": ["notes.uba"], "main": ["BIBLE:::KJV:::Genesis 1:1"], "study": ["BIBLE:::NET:::John 3:16"]}

History records of installing modules

Do NOT change it! This entry is used for checking availability of newer datasets / modules.

installHistory = {...}

translationLanguage

By default, this item is missing from file "config.py". This item is written only after users choose from menu "Transfer Program Interface into my Language" and official interface translation is available in the selected language.

For example,

translationLanguage = 'Chinese (Traditional)'

forceGenerateHtml

By default is set to "False". Enable this to force UBA to create a htmlResources/main.html file when displaying content the main window. Used during development to inspect generated HTML.

logCommands

By default is set to "False". Enable this to log all commands to uba.log. Used during development for debugging commands.

enableCopyHtmlCommand

By default is set to "False". Enable this to show "Copy HTML" in context menu. Used during development for debugging generated HTML.

enableVerseHighlighting

Turns on/off viewing and setting verse highlighting.

enableMacros

Turns on/off macro functionality.

useFastVerseParsing

By default is set to "False". See Verse parsing

espeak

This option is available to Linux users who prefer to use espeak to run text-to-speech feature instead of built-in qt text-to-speech engine.

ttsDefaultLanguage

Use it to specify the default language for text-to-speech feature If language is not specified with entered command, e.g. "SPEAK:::testing", ttsDefaultLanguage is applied by default. ttsDefaultLanguage is set to "en" by default, users can change its value through control panel or file config.py.

ttsEnglishAlwaysUS

        always speak US English when detected/specified language is en or en-gb

ttsEnglishAlwaysUK

        always speak UK English when detected/specified language is en or en-gb

ttsChineseAlwaysMandarin

        always speak Mandarin when detected/specified language is zh-cn or zh-tw

ttsChineseAlwaysCantonese

        always speak Cantonese when detected/specified language is zh-cn or zh-tw

preferRemoteControlForCommandLineEntry

If True, command line field on main window is hidden. Control panel is opened when a command prefix is entered programmatically.

closeControlPanelAfterRunningCommand

If True, control panel is closed after running a command.

disableModulesUpdateCheck

By default, set to False. If set to True, UBA will not check if newer files are available for download.