Config file reference
"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.
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:
- close the app.
- delete file "config.py"
- open the app again and close properly.
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.
Below are description of available items in config.py
Please ignore this one. This item is created for internal testing only.
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 = ""
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
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
Windows' command used to open file / application
openWindows = 'start'
macOS's command used to open file / application
openMacos = 'open'
Linux's command used to open file / application
openLinux = 'xdg-open'
Linux's command used to open pdf files
openLinuxPdf = 'xdg-open'
linuxStartFullScreen = False
showTtsOnLinux = False
This option may be useful on some Linux systems, where qt4 and qt5 applications use different input method variables.
fcitx = False
This option may be useful on some Linux systems, where qt4 and qt5 applications use different input method variables.
ibus = False
This option may be useful for touch-screen users who want to enter non-English characters for commands or notes.
virtualKeyboard = False
Either a path relative to the UniqueBible folder or a full path is accepted.
marvelData = "marvelData"
To specify the path of music folder.
musicFolder = "music"
To specify the path of video folder.
videoFolder = "video"
Remarks: More tabs may make slower the app to run. Please use a reasonable number here.
numberOfTab = 5
parserStandarisation = "NO"
ENG = English; TC = Traditional Chinese; SC = Simplified Chinese
standardAbbreviation = "ENG"
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'
If True, user interface of user-defined language, i.e. "userLanguage" above, is used.
userLanguageInterface = False
If True, option to Google translate into English is displayed on context menu.
showGoogleTranslateEnglishOptions = 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
If True, result of Google Translate is automatically copied to clipboard.
autoCopyGoogleTranslateOutput = True
If True, result of Chinese pinyin conversion is automatically copied to clipboard.
autoCopyChinesePinyinOutput = True
If True, verse numbers are displayed when a reference of verse range is opened.
showVerseNumbersInRange = True
If Ture, latest note is displayed on Study Window after edited notes are saved in "Note Editor".
openBibleNoteAfterSave = 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
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
landscapeMode = True
noToolBar = False
Options to display the top toolbar only, with all other toolbars hidden: True / False
topToolBarOnly = False
toolBarIconFullSize = False
0 = hidden; 1 = 25% of main window; 2 = 50% of main window; 3 = 75% of main window
parallelMode = 1
instantMode = 1
instantInformationEnabled = True
fontSize = 17
font = ''
You may change the default font here to your favourite font installed on your system, e.g.
font = 'Calibri'
default:
fontChinese = ''
you may change to, e.g.
fontChinese = 'NSimSun'
noteEditorFontSize = 14
"False" here means displaying bible verse in plain format, with each one on a single line.
readFormattedBibles = True
addTitleToPlainChapter = True
hideLexicalEntryInBible = False
importAddVerseLinebreak = False
importDoNotStripStrongNo = False
importDoNotStripMorphCode = False
importRtlOT = False
originalTexts = ['original', 'MOB', 'MAB', 'MTB', 'MIB', 'MPB', 'OHGB', 'OHGBi', 'LXX', 'LXX1', 'LXX1i', 'LXX2', 'LXX2i']
rtlTexts = ["original", "MOB", "MAB", "MIB", "MPB", "OHGB", "OHGBi"]
openBibleInMainViewOnly = False
mainText = "KJV"
mainB = 1
mainC = 1
mainV = 1
studyText = "NET"
studyB = 43
studyC = 3
studyV = 16
favouriteVersion = "OHGB"
Options to display "favouriteVersion" together with the main version for reading multiple references: True / False
addFavouriteToMultiRef = False
commentaryText = "CBSC"
commentaryB = 43
commentaryC = 3
commentaryV = 16
topic = "EXLBT"
dictionary = "EAS"
encyclopedia = "ISB"
book = "Timelines"
bookSearchString = ""
noteSearchString = ""
thirdDictionary = "webster"
defaultLexiconStrongH = "TBESH"
defaultLexiconStrongG = "TBESG"
defaultLexiconETCBC = "ConcordanceMorphology"
defaultLexiconLXX = "LXX"
defaultLexiconGK = "MCGED"
defaultLexiconLN = "LN"
historyRecordAllowed = 50
currentRecord = {"main": 0, "study": 0}
history = {"external": ["notes.uba"], "main": ["BIBLE:::KJV:::Genesis 1:1"], "study": ["BIBLE:::NET:::John 3:16"]}
Do NOT change it! This entry is used for checking availability of newer datasets / modules.
installHistory = {...}
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)'
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.
By default is set to "False". Enable this to log all commands to uba.log. Used during development for debugging commands.
By default is set to "False". Enable this to show "Copy HTML" in context menu. Used during development for debugging generated HTML.
Turns on/off viewing and setting verse highlighting.
Turns on/off macro functionality.
By default is set to "False". See Verse parsing
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.
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.
always speak US English when detected/specified language is en or en-gb
always speak UK English when detected/specified language is en or en-gb
always speak Mandarin when detected/specified language is zh-cn or zh-tw
always speak Cantonese when detected/specified language is zh-cn or zh-tw
If True, command line field on main window is hidden. Control panel is opened when a command prefix is entered programmatically.
If True, control panel is closed after running a command.