Scipting can access Bibledit's configuration settings. Normally the settings of Bibledit are made in the graphical user interface. But through scripting you can read and write these values too.
The general configuration of Bibledit can be accessed by running command
bibledit --general-configuration
For example, to see whether Bibledit will synchronize all projects on shutdown, type
bibledit --general-configuration --read --key sync_shutdown
This is a boolean value. If it replies "1", that means, true, e.g. Bibledit will sync all projects on shutdown. If it gives "0", that means, false.
To modify the configuration, and have Bibledit synchronize no projects on shutdown, type
bibledit --general-configuration --write --key sync_shutdown --value 0
In the graphical version of Bibledit you can now check this setting and see that it has changed.
Here follows a table of keys, and some information about each key. The first column lists the name of the key. The second one describes what the key is used for. The last column gives what kind of value the key gives, e.g. boolean.
sync_on_open | Whether Bibledit will synchronize a project when opening it. | boolean |
sync_on_close | Whether Bibledit will synchronize a project when closing it. | boolean |
sync_regularly | Whether Bibledit will synchronize a project regularly, while it is open. | boolean |
sync_minutes | If Bibledit synchronizes a project regularly, this gives the interval in minutes, e.g. it will synchronize a project every n minutes. | integer |
sync_startup | Whether all projects get synchronized when Bibledit starts. | boolean |
sync_shutdown | Whether all projects get synchronized when Bibledit shuts down. | boolean |
startup_time | Stores the internal time when Bibledit started, in seconds. | integer |
screen_width | The width of the screen, in pixels. | integer |
screen_height | The height of the screen, in pixels. | integer |
window_width | The width of the main window, in pixels. | integer |
window_height | The height of the main window, in pixels. | integer |
window_x_pos | The position of the left of the main window, in x-direction, in pixels. | integer |
window_y_pos | The position of the top of the main window, in y-direction, in pixels. | integer |
hpane_pos | The position, in pixels, of the grip of the main horizontal pane. It affects the size of the Tools Area. | integer |
vpane_edit_pos | The position, in pixels, of the grip of the editor's vertical pane. It affects the size of the Text Area. | integer |
vpane_bibnote_pos | The position, in pixels, of the grip of the Biblenotes's vertical pane. It affects the size of the Bible Notes Area. | integer |
vpane_qref_pos | The position, in pixels, of the grip of the quick reference's vertical pane. It affects the size of the Quick Reference Area. | integer |
tools_area_left | Whether the Tools Area is at the left. | boolean |
note_std_txt1 | Standard text 1 that can be inserted in a note. | string |
note_std_txt2 | Standard text 2 that can be inserted in a note. | string |
note_std_txt3 | Standard text 3 that can be inserted in a note. | string |
note_std_txt4 | Standard text 4 that can be inserted in a note. | string |
project | The project that is opened. | string |
book | The book that is opened. | string |
chapter | The chapter that is opened. | string |
verse | The verse that is opened. | string |
stylesheet | The stylesheet that is opened. | string |
ref_file | The filename to save referencese to. | string |
exp_bw_file | When exporting a project to Bibleworks, save to this file. | string |
exp_sword_mod | The path to save the module to when exporting to SWORD. | string |
exp_sword_inst | The path where to install the module when exporting to SWORD. | string |
edit_font | The font used in the editor. | string |
paper_format | Paper format to be used when printing. | string |
paper_width | The paper width, in centimeters, to be used when printing. | floating point |
paper_height | The paper height, in centimeters, to be used when printing. | floating point |
paper_l_margin | The left margin, in centimeters, of the paper, when printing. | floating point |
paper_r_margin | The right margin, in centimeters, of the paper, when printing. | floating point |
paper_t_margin | The top margin, in centimeters, of the paper, when printing. | floating point |
paper_b_margin | The bottom margin, in centimeters, of the paper, when printing. | floating point |
print_note_full_width | Whether footnotes will be printed over the full width of the page. | boolean |
java_bin | Full path to the Java binary. | string |
xep_home | The directory where XEP has been installed. | string |
print_date | Whether to print the current date on each page. | boolean |
print_changes_only | Whether to print changes only when comparing two projects. | boolean |
project_compare | Which project to compare the current project with, when comparing two projects. | string |
show_note_select | A selector that decides which set of notes to show. | integer |
show_note_curr_proj_only | Whether to show the notes for the current project only. | boolean |
note_show_proj | Whether to show the project with each note. | boolean |
show_note_cat | Which category of notes to show. | string |
show_note_date_from | Show notes edited from this date and on. | integer |
show_note_date_to | Show notes edited until this date. | integer |
bw_exe | The path of the BibleWorks executable. | string |
ref_to_bw | Whether to send references to BibleWorks. | boolean |
ref_from_bw | Whether to receive references from BibleWorks. | boolean |
ref_to_bt | Whether to send references to BibleTime. | boolean |
ref_from_bt | Whether to receive references from BibleTime. | boolean |
ref_to_sff | Whether to send references to SantaFeFocus enabled programs. | boolean |
ref_from_sff | Whether to receive references from SantaFeFocus enabled programs. | boolean |
chk_mark_comp_with | When comparing USFM markers, which project to compare with. | string |
chk_mark_comp_all | When comparing USFM markers, whether to compare all markers. | boolean |
chk_mark_comp_only | When comparing USFM markers, which markers to include only. | string |
chk_mark_comp_ign | When comparing USFM markers, which markers to ignore. | string |
chk_mark_ign_v0 | When comparing USFM markers, whether to ignore anything in verse zero. | boolean |
chk_cap_punct | When checking capitalization, this gives the punctuation to be followed by a capitalized letter. | string |
chk_cap_ign | When checking capitalization, this lists characters after which a lowercase letter is acceptable without giving an error message. | string |
chk_cap_any_pref | When checking capitalization, whether to allow any prefixes. | boolean |
chk_repeat_ign_case | When checking repeating words, whether to ignore the case. | boolean |
chk_repeat_only_these | When checking repeating words, whether to show only certain words. | boolean |
chk_repeat_ign_these | When checking repeating words, whether to ignore certain words. | boolean |
chk_pairs_ign | When checking matching pairs of punctuation, which punctuation to ignore. | string |
chk_wrd_inv_excl_count | When making a word inventory, words with a count of n and up are not given. | integer |
chk_wrd_extra_chars | When making a word inventory, these are extra characters that form a word. | string |
tools_area_page | The number of the page now being displayed in the Tools Area. | integer |
style_cat_exp | Which categories in the Styles Area are expanded. | boolean list |
ins_footnote_templ | Current template for inserting a footnote. | string |
ins_endnote_templ | Current template for inserting an endnote. | string |
ins_xref_templ | Current template for inserting a crossreference. | string |
par_bible_keep_vs | When printing a Parallel Bible, whether to keep the verses together on one page. | boolean |
par_bible_ch_vs | When printing a Parallel Bible, which chapters and verses, i.e., which portion to print. | string |
par_bible_vs0 | When printing a Parallel Bible, whether to include verse 0. | boolean |
print_fonts2 | When printing something, this is the list of fonts to use. | string list |
par_bible_prj | The projects to include in a parallel Bible. | string list |
The project configuration of Bibledit can be accessed by running command
bibledit --project-configuration
For example, to see which font Bibledit will use to display project Ndebele, type
bibledit --project-configuration --project Ndebele --read --key editor_font
This is a string value. It will show the name of the font.
To modify the configuration, and have Bibledit use another font, type
bibledit --project-configuration --project Ndebele --write --key editor_font --value 'Bitstream Charter 14'
In the graphical version of Bibledit you can now check this setting and see that it has changed.
Here follows a table of keys, and some information about each key. The first column lists the name of the key. The second one describes what the key is used for. The last column gives what kind of value the key gives, e.g. string.
editor_font | The font that Bibledit uses to display the project. | string |
stylesheet | The stylesheet attached to the project. | string |
versification | The project's versification system. | string |
print_fonts2 | List of fonts to be used during printing. | string list |
print_font_size | The size of the fonts for printing. | integer |
print_line_height | The line height for printing, in percentage. | integer |
sword_name | Export to SWORD: Name of module, excluding project name. | string |
sword_desc | Export to SWORD: Description of module, excluding project name. | string |
sword_about | Export to SWORD: Description of module, excluding project name. | string |
sword_lcsh | Export to SWORD: Library of Congress Subject Heading of module. | string |
sword_license | Export to SWORD: License of module. | string |
sword_version | Export to SWORD: Version of module. | string |
sword_lang | Export to SWORD: Language of module. | string |
reorder_books | Books in another order. | string list |
books_incl | Which books to include. | boolean list |
books_portion | Which portion of books to print. | string list |