diff options
Diffstat (limited to 'docs/handbook/en')
39 files changed, 2314 insertions, 0 deletions
diff --git a/docs/handbook/en/docbook/hdbk-config.docbook b/docs/handbook/en/docbook/hdbk-config.docbook new file mode 100644 index 0000000..e784e25 --- /dev/null +++ b/docs/handbook/en/docbook/hdbk-config.docbook @@ -0,0 +1,207 @@ +<chapter id="hdbk-config"> + <title>Configuring &bibletime;</title> + <para>In this section you find an overview to configure &bibletime;, + which can be found under + <guimenu>Settings</guimenu> in the main menu.</para> + <sect1 id="hdbk-config-bt"> + <title>Configure BibleTime Dialog</title> + <para>The &bibletime; user interface can be customized in many + ways depending on your needs. You can access the configuration + dialog by selecting + <menuchoice> + <guimenu>Settings</guimenu> + </menuchoice> + <guimenuitem>Configure &bibletime;</guimenuitem>.</para> + <sect2 id="hdbk-config-bt-display"> + <title> + <guimenu>Display</guimenu> + </title> + <para>The startup behavior can be customized. Select from the + following options: + <itemizedlist> + <listitem> + <para>Show startup logo</para> + </listitem> + </itemizedlist></para> + <para>Display templates define the rendering of text (colors, + size etc.). Various built-in templates are available. If you + select one, you will see a preview on the right pane.</para> + </sect2> + <sect2 id="hdbk-config-bt-languages"> + <title> + <guimenu>Languages</guimenu> + </title> + <para>Here you can specify which language should be used for the + biblical booknames. Set this to your native language, if it is + available, and you'll feel at home.</para> + + <para>By default, &bibletime; uses the default system + display font. You + can override this font if necessary. Some languages require + special fonts to be displayed correctly, and this dialog allows + you to specify a custom font for each language.</para> + <mediaobject> + <imageobject> + <imagedata fileref="ss_configfonts.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Options Dialog - fonts</phrase> + </textobject> + <caption> + <para>The Options dialog - Fonts.</para> + </caption> + </mediaobject> + <para>&bibletime; can now use all supported fonts. + As long as the works you are interested in display correctly + nothing needs to be done here. If a work only displays as a + series of question marks (??????) or empty boxes, then you know + that the standard display font does not contain the + characters used in this work.</para> + + <para>To correct this, choose this work's language from the drop + down menu. Select the use custom font checkbox. Now select a + font. For example, a font that supports many languages is + Code2000. If no installed font can display the work you are + interested in, try installing the localization package + for that language.</para> + <sect3 id="hdbk-config-bt-addfont"> + <title>Installing fonts</title> + <para>Detailed font installation instructions are outside the + scope of this handbook. For further information you might want + to refer to the + <ulink url="http://www.linux.org/docs/ldp/howto/Unicode-HOWTO-2.html"> + Unicode HOWTO</ulink>.</para> + <tip> + <para>If you use a small font like Clearlyu (about 22kb), + &bibletime; will run faster than with a large font like + <trademark class="registered">Bitstream + Cyberbit</trademark>(about 12Mb).</para> + </tip> + </sect3> + <sect3 id="hdbk-config-bt-ob-font"> + <title>Obtaining Fonts</title> + <para>Fonts can be obtained from a number of sources:</para> + <itemizedlist> + <listitem> + <para>Your *nix distribution.</para> + </listitem> + <listitem> + <para>Your distribution's localization packages.</para> + </listitem> + <listitem> + <para>An existing + <trademark class="registered">Microsoft + Windows</trademark>installation on the same + computer.</para> + </listitem> + <listitem> + <para>A font collection, such as are available from Adobe + or Bitstream.</para> + </listitem> + <listitem> + <para>Online font collections.</para> + </listitem> + </itemizedlist> + <para>Unicode fonts support more characters than other fonts, + and some of these fonts are available at no charge. None of + available fonts includes all characters defined in the Unicode + standard, so you may want to use different fonts for different + languages.</para> + <table id="hdbk-config-unicode-fonts-table"> + <title>Unicode Fonts</title> + <tgroup cols="2"> + <tbody> + <row> + <entry> + <ulink url="http://code2000.net/CODE2000.ZIP"> + Code2000</ulink> + </entry> + <entry>Perhaps the best free Unicode font, covering a + wide range of characters.</entry> + </row> + <row> + <entry> + <ulink url="http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&cat_id=FontDownloads"> + SIL unicode fonts</ulink> + </entry> + <entry>Excellent Unicode fonts from the Summer + Institute of Linguistics.</entry> + </row> + <row> + <entry> + <ulink url="http://www.nongnu.org/freefont/"> + FreeFont</ulink> + </entry> + <entry>A new free Unicode font initiative.</entry> + </row> + <row> + <entry> + <ulink url="ftp://ftp.crosswire.org/pub/sword/iso/latest/FONTS"> + Crosswire's font directory</ulink> + </entry> + <entry>Several fonts available from the Crosswire Bible + Society Ftp site.</entry> + </row> + <row> + <entry> + <ulink url="ftp://ftp.netscape.com/pub/communicator/extras/fonts/windows/"> + Bitstream CyberBit</ulink> + </entry> + <entry>Covers almost the entire range of Unicode, but + might slow &bibletime; down because of its + size.</entry> + </row> + <row> + <entry>Clearlyu</entry> + <entry>Included in some distributions. Contains + European, Greek, Hebrew, Thai.</entry> + </row> + <row> + <entry> + <ulink url="http://fontforge.sourceforge.net/sfds/"> + Caslon, Monospace, Cupola, Caliban</ulink> + </entry> + <entry>Partial coverage, see information on linked + site.</entry> + </row> + </tbody> + </tgroup> + </table> + <para>There are good Unicode font lists on the net, as the one + by Christoph Singer ( + <ulink url="http://www.slovo.info/unifonts.htm">Multilingual + Unicode TrueType Fonts in the Internet</ulink>), or the one by + Alan Wood ( + <ulink url="http://www.alanwood.net/unicode/fontsbyrange.html"> + Unicode character ranges and the Unicode fonts that support + them</ulink>).</para> + </sect3> + </sect2> + <sect2 id="hdbk-config-bt-desk"> + <title> + <guimenu>Desk</guimenu> + </title> + <para>Many features provided by the Sword backend can now be + customized in &bibletime;. These features are documented + right in the dialog. You also have the possibility to specify + standard works that should be used when no specific work is + specified in a reference. An example: The standard Bible is used + to display the content of cross references in the Bible. When you + hover over then, the Mag will show the content of the verses + referred to, according to the standard Bible you + specified.</para> + </sect2> + <sect2 id="hdbk-config-bt-hotkeys"> + <title> + <guimenu>HotKeys</guimenu> + </title> + <para>HotKeys are special key commands that can be used in the + place of the menu items and icons. A number of &bibletime;'s + commands have predefined HotKeys (see + <link linkend="hdbk-reference-hotkeys">this section</link> for a + complete listing). Most of &bibletime;'s commands can be + assigned HotKeys here. This is very helpful to quickly access the + functions that you need the most.</para> + </sect2> + </sect1> +</chapter> diff --git a/docs/handbook/en/docbook/hdbk-intro.docbook b/docs/handbook/en/docbook/hdbk-intro.docbook new file mode 100644 index 0000000..ce72462 --- /dev/null +++ b/docs/handbook/en/docbook/hdbk-intro.docbook @@ -0,0 +1,95 @@ +<chapter id="hdbk-intro"> + <title>Introduction</title> + <sect1 id="hdbk-intro-about"> + <title>About &bibletime;</title> + <para>&bibletime; is a Bible study tool with support for + different types of texts and languages. Even large amounts of works + modules are easy to install and manage. It is built on the + <ulink url="http://www.crosswire.org/sword">Sword</ulink> library, + which provides the back-end functionality for &bibletime;, such + as viewing Bible text, searching etc. Sword is the flagship product + of the <ulink url="http://www.crosswire.org">Crosswire Bible + Society</ulink>.</para> + + <para>&bibletime; is designed to be used with works encoded in + one of the formats supported by the Sword project. Complete + information on the supported document formats can be found in the + <ulink url="http://www.crosswire.org/sword/develop/index.jsp"> + developers section</ulink> of the Sword Project, Crosswire Bible + Society.</para> + + <sect2 id="hdbk-intro-works"> + <title>Available works</title> + <para>Over 200 documents in 50 languages are available from the + <ulink url="http://www.crosswire.org">Crosswire Bible + Society</ulink>. These include: + <variablelist> + <varlistentry> + <term>Bibles</term> + <listitem> + <para>The full Bible text, with optional things like + Strong's Numbers, headings and/or footnotes in the text. + Bibles are available in many languages, and include not + only modern versions, but also ancient texts like the Codex + Leningradensis ("WLC", Hebrew), and the Septuagint ("LXX", + Greek). This is the most advanced section in the library of + the Sword project.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>Books</term> + <listitem> + <para>Books available include "Imitation of Christ", "Enuma + Elish", and "Josephus: The Complete Works"</para> + </listitem> + </varlistentry> + <varlistentry> + <term>Commentaries</term> + <listitem> + <para>Commentaries available include classics like John + Wesley's "Notes on the Bible", Matthew Henry's commentary + and Luther's "Commentary on Galatians." With the + <emphasis>Personal</emphasis> commentary you can + <link linkend="hdbk-op-parts-desk-write"> record your own + personal notes</link> to sections of the Bible.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>Daily devotionals</term> + <listitem> + <para>Many people appreciate these daily portions from + God's word. Available works include Daily Light on the + Daily Path, and the Losungen.</para> + </listitem> + </varlistentry> + <varlistentry> + <term>Lexicons/Dictionaries</term> + <listitem> + <para>Lexicons available include: Robinson's Morphological + Analysis Codes, Brown-Driver-Briggs Hebrew Lexicon and the + International Standard Bible Encyclopaedia. Dictionaries + available include Strong's Hebrew Bible Dictionary, + Strong's Greek Bible Dictionary, Webster's Revised + Unabridged Dictionary of the English Language 1913, Nave's + Topical Bible.</para> + </listitem> + </varlistentry> + </variablelist></para> + </sect2> + <sect2 id="hdbk-intro-motivation"> + <title>Motivation</title> + <para>Our desire is to serve God, and to do our part to help + others grow in their relationship with Him. We have striven to + make this a powerful, quality program, and still make it simple + and intuitive to operate. It is our desire that God be praised, + as He is the source of all good things.</para> + <blockquote> + <attribution>James 1:17, NASB</attribution> + <para>Every good thing given and every perfect gift is from + above, coming down from the Father of lights, with whom there + is no variation or shifting shadow.</para> + </blockquote> + <para>God bless you as you use this program.</para> + </sect2> + </sect1> +</chapter> diff --git a/docs/handbook/en/docbook/hdbk-operation.docbook b/docs/handbook/en/docbook/hdbk-operation.docbook new file mode 100644 index 0000000..40275ae --- /dev/null +++ b/docs/handbook/en/docbook/hdbk-operation.docbook @@ -0,0 +1,446 @@ +<chapter id="hdbk-op"> + <title>Program operation</title> + <sect1 id="hdbk-op-overview"> + <title>Program overview</title> + <para>This is what a typical &bibletime; session looks like: + <mediaobject> + <imageobject> + <imagedata fileref="ss_mainterms.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>The &bibletime; application window</phrase> + </textobject> + </mediaobject> + You can easily see the different parts of the + application. The Bookshelf on the left side is used to open works + and to manage your bookmarks. The little "Mag" window below the + Bookshelf is used to display extra information that is embedded in + documents. When you move your mouse over a footnote marker, for + example, then the Mag will display the actual content of the + footnote. The toolbar gives you quick access to important + functions, and the Desk on the right side is where you do your real + work.</para> + + <para>Let us now proceed by looking at the different parts of the + application individually.</para> + </sect1> + <sect1 id="hdbk-op-parts"> + <title>Parts of the &bibletime; application window</title> + <sect2 id="hdbk-op-parts-bookshelf"> + <title>The Bookshelf</title> + <para>The Bookshelf lists all installed works, sorted by category + and language. It also has a category called "Bookmarks". This is + where you can store and access your own bookmarks.</para> + + <sect3 id="hdbk-op-parts-bookshelf-open"> + <title>Reading works</title> + <para>To open a work from the bookshelf for reading, simply + click with the + <mousebutton>left mouse button</mousebutton> on the desired + category (Bibles, Commentaries, Lexicons, Books, Devotionals or + Glossaries) to display its contents. Then just click on one of + the works to open it for reading. A read window will appear in + the Desk area.</para> + + <tip> + <para>Drag & Drop Works Here</para> + </tip> + + <para>If you are reading a certain work, and want to open + another work at the passage you are reading, you can use a + shortcut. Simply click with the + <mousebutton>left mouse button</mousebutton>on the + verse/passage reference (pointer changes to hand) and drag it + to the Bookshelf. Drop it on the work you want to open, and it + will be opened for reading at the specified location. You can + also drag a verse reference into an existing read window, then + it will jump to the specified location.</para> + </sect3> + + <sect3 id="hdbk-op-parts-bookshelf-metainfo"> + <title>Additional information about works</title> + <para>If you click with the + <mousebutton>right</mousebutton>mouse button on the symbol of a + work, you will see a menu with additional entries that are + relevant for this work. + <guimenuitem>"About this work"</guimenuitem>opens a window with + lots of interesting information about the selected work. + <guimenuitem>"Unlock this work"</guimenuitem>opens a small + dialog for encrypted documents, where you can enter the unlock + key to access the work. For additional information on locked + works, please see + <ulink url="http://www.crosswire.org/sword/modules/aboutlocked.jsp"> + this page</ulink> on the Crosswire Bible Society web + site.</para> + </sect3> + + <sect3 id="hdbk-op-parts-bookshelf-search"> + <title>Searching in works</title> + <para>You can search in a work by clicking with the + <mousebutton>right</mousebutton>mouse button on its symbol and + selecting + <guimenuitem>"Search in work(s)"</guimenuitem>. By pressing + &Shift; and clicking on other works you can select more + than one. Then follow the same procedure to open the search + dialog. You will be searching in all of these documents. A + complete description of the operation of the search features + can be found + <link linkend="hdbk-op-search">here</link>.</para> + </sect3> + + <sect3 id="hdbk-op-parts-bookshelf-bookmarks"> + <title>Working with bookmarks</title> + <para> + + <tip> + <para>Drag & Drop Works Here</para> + </tip> + + Click with the + <mousebutton>right</mousebutton>mouse button on the bookmark + category of the bookshelf and select + <guimenuitem>"Create new folder"</guimenuitem> to create a new + bookmark subfolder. You can use normal drag & drop + functions to drag verse references from read windows or search + results to the bookmark folder, and to rearrange bookmarks + between folders.</para> + <para>You can also import bookmarks from other people or export + bookmarks to share them. To do this, open the + <guimenu>context menu</guimenu>of the bookmark folder as + described above, and select + <guimenuitem>"Export bookmarks"</guimenuitem>. This will bring + up a dialog box for you to save the bookmark collection. You + can import bookmarks in a similar way.</para> + + <para>You can also click with the + <mousebutton>right</mousebutton>on folders and bookmarks to + change their names and descriptions.</para> + </sect3> + </sect2> + + <sect2 id="hdbk-op-parts-mag"> + <title>The Mag(nifying glass)</title> + + <para>This little window in the lower left corner of the + &bibletime; window is purely passive. Whenever your mouse + cursor is located over some text with additional information + (e.g., Strong's numbers), then this additional information will + be displayed in the Mag, and not in the text itself. Just try it + out.</para> + </sect2> + + <sect2 id="hdbk-op-parts-desk"> + <title>The Desk</title> + <para>The Desk is where the real work with &bibletime; takes + place. Here you can open works from the Bookshelf, read them, + <link linkend="hdbk-op-search">search</link> in them, and even + save your annotations in the personal commentary module (see + <link linkend="hdbk-op-parts-desk-write">below</link>).</para> + + <sect3 id="hdbk-op-parts-desk-read"> + <title>Reading works</title> + <para>As we have + <link linkend="hdbk-op-parts-bookshelf-open">already + seen</link>, you can open works for reading simply by clicking + on their symbol in the Bookshelf. A read window will open in + the Desk's area. Every read window has a toolbar. There you can + find tools to navigate in the work that this read window is + connected to, as well as history buttons like the ones that you + know from your browser.</para> + </sect3> + + <sect3 id="hdbk-op-parts-desk-placement"> + <title>Read window placement</title> + <para>Of course, you can open multiple works at the same time. + There are several possibilities for arranging the read windows + on the desk. Please have a look at the entry + <guimenu>Window</guimenu>in the main menu. There you can see + that you can either control the placement of the read windows + completely yourself, or have &bibletime; handle the + placement automatically. To achieve this, you have to select + one of the automatic placement modes available at + <menuchoice> + <guimenu>Window</guimenu> + <guimenuitem>Arrangement mode</guimenuitem> + </menuchoice>. Just try it out, it's simple and works.</para> + </sect3> + + <sect3 id="hdbk-op-parts-desk-write"> + <title>Editing your own commentary</title> + <para>To be able to store your own comments about parts of the + Bible, you have install a certain work from the library of the + <ulink url="http://www.crosswire.org">Crosswire Bible + Society</ulink>. This work is called "Personal + commentary".</para> + + <para>If you open the personal commentary by clicking on its + symbol in the Bookshelf with a + <mousebutton>left</mousebutton>mouse button, it opens in read + mode. You will not be able to edit it in this mode. Should you + wish to write annotations into the personal commentary, you + have to open it with the + <mousebutton>right</mousebutton>mouse button and then select + <guimenu>Edit this work</guimenu>and then either + <guimenuitem>Plain text</guimenuitem>(source code editor) or + <guimenuitem>HTML</guimenuitem>(basic gui wysiwyg + editor).</para> + + <tip> + <para>If + <menuchoice> + <guimenu>Edit this work</guimenu> + </menuchoice> is deactivated, please check if you have write + permission for the files of the personal commentary.</para> + </tip> + + <tip> + <para>Drag & drop works here. Drop a verse reference and + the text of the verse will be inserted.</para> + </tip> + </sect3> + </sect2> + </sect1> + <sect1 id="hdbk-op-search"> + <title>Searching in works</title> + + <sect2 id="hdbk-op-search-intext"> + <title>Searching text in an open read window</title> + <para>You can look for a word or phrase in the open read window + (e.g. the chapter of a bible that you're reading) just like you + are used to from other programs. This function can be reached + either by clicking with the + <mousebutton>right</mousebutton>mouse button and selecting + <guimenuitem>Find...</guimenuitem>, or by using the hotkey + <keycombo action="simul">&Ctrl; + <keycap>F</keycap></keycombo>. Read on to learn how you can + search in entire works.</para> + </sect2> + + <sect2 id="hdbk-op-search-access"> + <title>Accessing the search dialog</title> + <para>You can search in a work by clicking with the + <mousebutton>right</mousebutton>mouse button on its symbol in the + + <guimenu>Bookshelf</guimenu>and selecting + <guimenuitem>Search in work(s)</guimenuitem>. By holding + &Shift; or &Ctrl; and clicking on other work's names you + can select more than one. Then follow the same procedure to open + the search dialog. You will be searching in all of these works at + the same time.</para> + + <para>You can also access the search dialog by clicking on + <menuchoice> + <guimenu>Search</guimenu> + </menuchoice> from the main menu, and selecting the appropriate + entry.</para> + + <para>A third possibility to start searches is to click on the + search symbol in an open read window.</para> + </sect2> + + <sect2 id="hdbk-op-search-config"> + <title>Search configuration</title> + <screenshot> + <screeninfo>Search Text Dialog Options Tab</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="ss_searchopts.png" format="PNG" /> + </imageobject> + </mediaobject> + </screenshot> + <sect3 id="hdbk-op-search-config-works"> + <title>Selecting works</title> + <para>At the top of the options tab you will find + <guibutton>Choose</guibutton>(works). If you would like to + search in multiple works, click on this button and you will be + offered a menu where you can select the works you want to + search in.</para> + </sect3> + <sect3 id="hd-op-search-config-scope"> + <title>Using Search Scopes</title> + <para>You can narrow the scope of your search to certain parts + of the Bible by selecting one of the predefined scopes from the + list in + <guimenu>Search scope</guimenu>. You can define your own search + ranges by clicking the + <guibutton>Setup ranges</guibutton>button.</para> + </sect3> + <sect3 id="hd-op-search-config-syntax"> + <title>Basic Search Syntax Introduction</title> + <para>Enter search terms separated by spaces. By default the + search function will return results that match any of the + search terms (OR). To search for all the terms separate the + terms by AND.</para> + <para>You can use wildcards: '*' matches any sequence of + characters, while '?' matches any single character. The use of + brackets allows you to group your search terms, e.g. '(Jesus OR + spirit) AND God'.</para> + <para>To search text other than the main text, enter the text + type followed by ':', and then the search term. For example, to + search for the Strong's number H8077, use + 'strong:H8077'.</para> + <para>Available text types: + <table id="hd-op-search-config-syntax-table"> + <title>Search Types</title> + <tgroup cols="2"> + <thead> + <row> + <entry>Prefix</entry> + <entry>Meaning</entry> + </row> + </thead> + <tbody> + <row> + <entry>heading:</entry> + <entry>searches headings</entry> + </row> + <row> + <entry>footnote:</entry> + <entry>searches footnotes</entry> + </row> + <row> + <entry>strong:</entry> + <entry>searches Strong's Numbers</entry> + </row> + <row> + <entry>morph:</entry> + <entry>searches morphology codes</entry> + </row> + </tbody> + </tgroup> + </table></para> + <para>BibleTime uses the Lucene search engine to perform your + searches. It has many advanced features, and you can read more + about it here: + <ulink url="http://lucene.apache.org/java/docs/index.html"> + http://lucene.apache.org/java/docs/index.html</ulink></para> + </sect3> + </sect2> + <sect2 id="hdbk-op-search-results"> + <title>Search results</title> + <para>Here you can see how many instances of the search string + were found, sorted by works. Clicking on a work with the + <mousebutton>right</mousebutton>mouse button allows you to copy, + save, or print all verses that were found in a certain work at + once. This also works when you click on one or more of the + references to copy, save or print them. Clicking on a particular + reference opens that verse up in context in the preview window + below.</para> + <tip> + <para>Drag a reference and drop it on a work symbol on the + Bookshelf to open the work at that verse in a new read + window.</para> + </tip> + <tip> + <para>Drag a reference and drop it on an open read window, and + it will jump to that verse.</para> + </tip> + <tip> + <para>Select references and drag them to the Bookshelf to + create bookmarks.</para> + </tip> + <sect3 id="hdbk-op-search-analysis"> + <title>Search result analysis</title> + <para>Click on + <guibutton>Search analysis</guibutton>to open the search + analysis display. This gives a simple graphic analysis of the + number of instances the search string was found in each book of + the Bible, and you can also save the analysis.</para> + <screenshot> + <screeninfo>Search Analysis Dialog Box</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="ss_searchanal.png" format="PNG" /> + </imageobject> + </mediaobject> + </screenshot> + </sect3> + </sect2> + </sect1> + <sect1 id="hdbk-op-bookshelfmanager"> + <title>The + <guimenuitem>Bookshelf Manager</guimenuitem></title> + <para>The + <guimenuitem>Bookshelf Manager</guimenuitem> is a tool to manage + your Bookshelf. You can install new works to your Bookshelf, and + update or remove existing works from your Bookshelf. Access it by + clicking + <menuchoice> + <guimenu>Settings</guimenu> + <guimenuitem>Bookshelf Manager</guimenuitem> + </menuchoice> in the main menu.</para> + <sect2 id="hdbk-op-bookshelfmanager-path"> + <title>Bookshelf path(s) setup</title> + <para>Here you can specify where &bibletime; may store your + Bookshelf on the hard drive. You can even store it in multiple + directories. Default is "~/.sword/".</para> + <tip> + <para>If you have a sword CD, but do not want to install all + the works on the hard disk, but use them directly from the CD, + then you can add the path to the CD as one of your bookshelf + paths. When you start &bibletime;, it will show all works + on the CD if it is present.</para> + </tip> + </sect2> + <sect2 id="hdbk-op-bookshelfmanager-installupdate"> + <title>Install/update work(s)</title> + <para>With this facility, you can connect to a repository of + works (called "library"), and transfer one or more works to your + local Bookshelf. These libraries may be local (e.g. a Sword CD), + or remote (e.g. Crosswire's online repository of Sword modules, + or another site offering Sword modules). You can manage your + libraries with + <guibutton>Add library</guibutton> and + <guibutton>Delete library</guibutton>.</para> + <para>To begin the installation or update process, select a + library you want to connect to and a local Bookshelf path to + install the work(s) to. Then click on + <guibutton>Connect to library</guibutton>. &bibletime; will + scan the contents of the library and present you with a list of + works that you can add to your Bookshelf, or that you already + have installed but are available in a new version in the library, + and thus can be updated. Then you can mark all works that you + want to install or update, and click on + <guibutton>Install works</guibutton>. They will then be + transferred to your Bookshelf.</para> + </sect2> + <sect2 id="hdbk-op-bookshelfmanager-remove"> + <title>Remove work(s)</title> + <para>This facility allows you to delete one or more of the works + from your Bookshelf too free up disk space. Simply mark the items + and click on + <guibutton>Remove works</guibutton>.</para> + </sect2> + <sect2 id="hdbk-op-bookshelfmanager-searchindexes"> + <title>Search Indexes</title> + <para>This option allows you to create new search indexes and + cleanup orphaned index files for removed works.</para> + <tip> + If you are having problems with your search function, visit + this feature. + </tip> + </sect2> + </sect1> + <sect1 id="hdbk-op-output"> + <title>Exporting and Printing</title> + <para>In many places, you can open a context menu by clicking with + the + <mousebutton>right</mousebutton>mouse button. Depending on context, + it will allow you to + <guimenuitem>Select</guimenuitem>, + <guimenuitem>Copy</guimenuitem> (to clipboard), + <guimenuitem>Save</guimenuitem> or + <guimenuitem>Print</guimenuitem> text. This works for example in the + read windows, when you click on the normal text or the verse + reference, or in the search result page when you click on a work or + one or more verse references. It is pretty straightforward, so just + try it out.</para> + + <para>Printing from &bibletime; is rather basic and is intended + as a utility. If you are composing a document or presentation + containing text from &bibletime; works, we suggest that you use + one of the presentation or editing tools on your system to format + your document, rather than printing from &bibletime; + directly.</para> + </sect1> +</chapter> diff --git a/docs/handbook/en/docbook/hdbk-reference.docbook b/docs/handbook/en/docbook/hdbk-reference.docbook new file mode 100644 index 0000000..7937dce --- /dev/null +++ b/docs/handbook/en/docbook/hdbk-reference.docbook @@ -0,0 +1,725 @@ +<chapter id="hdbk-reference"> + <title>Reference</title> + <sect1 id="hdbk-reference-menus"> + <title>Main menu reference</title> + <para>In this section you can find detailed descriptions of all + entries in the main menu of &bibletime;. They are ordered in + just the way they appear in &bibletime;, with all the sub-items + listed under the major menu item they belong to. You can also see + the hotkey of each item;a complete listing of all hotkeys can be + found in + <link linkend="hdbk-reference-hotkeys">this section</link>.</para> + <sect2 id="hdbk-reference-menus-file"> + <title> + <guimenu>File</guimenu> + </title> + <para> + <variablelist> + <varlistentry id="hdbk-reference-menus-file-quit"> + <term> + <menuchoice> + <shortcut> + <keycombo action="simul">&Ctrl; + <keycap>Q</keycap></keycombo> + </shortcut> + <guimenu> + <inlinemediaobject> + <imageobject> + <imagedata fileref="i_exit.png" format="PNG" /> + </imageobject> + </inlinemediaobject>File</guimenu> + <guimenuitem>Quit</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + <action>Closes BibleTime.</action> BibleTime will ask you + if you want to write unsaved changes to disk.</para> + </listitem> + </varlistentry> + </variablelist> + </para> + </sect2> + + <sect2 id="hdbk-reference-menus-view"> + <title> + <guimenu>View</guimenu> + </title> + + <variablelist> + <varlistentry id="hdbk-reference-menus-view-fullscreenmode"> + <term> + <menuchoice> + <shortcut> + <keycombo action="simul"> + <keycap>F5</keycap> + </keycombo> + </shortcut> + <guimenu> + <inlinemediaobject> + <imageobject> + <imagedata fileref="i_window_fullscreen.png" format="PNG" /> + </imageobject> + </inlinemediaobject>View</guimenu> + <guimenuitem>Fullscreen mode</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + <action>Toggles full screen display.</action> Toggle this + setting to maximize the &bibletime; window.</para> + </listitem> + </varlistentry> + + <varlistentry id="hdbk-reference-menus-view-showtoolbar"> + <term> + <menuchoice> + <shortcut> + <keycombo action="simul"> + <keycap>F6</keycap> + </keycombo> + </shortcut> + <guimenu>View</guimenu> + <guimenuitem>Show toolbar</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + <action>Toggles Toolbar display.</action> Toggle this + setting to turn the main toolbar on or off.</para> + </listitem> + </varlistentry> + + <varlistentry id="hdbk-reference-menus-view-showbookshelf"> + <term> + <menuchoice> + <guimenu>View</guimenu> + <guimenuitem>Show Bookshelf</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + <action>Toggles display of the Bookshelf.</action> Toggle + this setting to turn the Bookshelf on the left pane on or + off. This can be handy if you need more space for the + Mag.</para> + </listitem> + </varlistentry> + + <varlistentry id="hdbk-reference-menus-view-showmag"> + <term> + <menuchoice> + <guimenu>View</guimenu> + <guimenuitem>Show Mag</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + <action>Toggles display of the Mag(nifying + glass).</action> Toggle this setting to turn the Mag on the + left pane on or off.</para> + </listitem> + </varlistentry> + </variablelist> + </sect2> + <sect2 id="hdbk-reference-menus-search"> + <title> + <guimenu>Search</guimenu> + </title> + <variablelist> + <varlistentry id="hdbk-reference-menus-search-defaultbible"> + <term> + <menuchoice> + <shortcut> + <keycombo action="simul">&Alt;&Ctrl; + <keycap>F</keycap></keycombo> + </shortcut> + <guimenu> + <inlinemediaobject> + <imageobject> + <imagedata fileref="i_find.png" format="PNG" /> + </imageobject> + </inlinemediaobject>Search</guimenu> + <guimenuitem>Search in standard bible</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + <action>Opens the Search Dialog to search in the standard + Bible only</action>. More works can be added in the Search + Dialog.</para> + </listitem> + </varlistentry> + <varlistentry id="hdbk-reference-menus-search-openworks"> + <term> + <menuchoice> + <shortcut> + <keycombo action="simul">&Ctrl; + <keycap>O</keycap></keycombo> + </shortcut> + <guimenu> + <inlinemediaobject> + <imageobject> + <imagedata fileref="i_find.png" format="PNG" /> + </imageobject> + </inlinemediaobject>Search</guimenu> + <guimenuitem>Search in open work(s)</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + <action>Opens the Search Dialog to search in all open + works</action>. More works can be added in the Search + Dialog.</para> + </listitem> + </varlistentry> + </variablelist> + </sect2> + <sect2 id="hdbk-reference-menus-window"> + <title> + <guimenu>Window</guimenu> + </title> + <variablelist> + <varlistentry id="hdbk-reference-menus-window-savesession"> + <term> + <menuchoice> + <guimenu> + <inlinemediaobject> + <imageobject> + <imagedata fileref="i_sidetree.png" format="PNG" /> + </imageobject> + </inlinemediaobject>Window</guimenu> + <guimenuitem>Save session</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + <action>Directly saves the current session</action>. This + will open a context menu where you can select an existing + session to save to. It will be overwritten with your + current session. See the next item on how to save to a new + session.</para> + </listitem> + </varlistentry> + <varlistentry id="hdbk-reference-menus-window-savenewsession"> + <term> + <menuchoice> + <shortcut> + <keycombo action="simul">&Alt;&Ctrl; + <keycap>S</keycap></keycombo> + </shortcut> + <guimenu> + <inlinemediaobject> + <imageobject> + <imagedata fileref="i_sidetree.png" format="PNG" /> + </imageobject> + </inlinemediaobject>Window</guimenu> + <guimenuitem>Save as new Session</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + <action>Saves the current session under a new + name</action>. This will ask for a new name to save the + session to.</para> + </listitem> + </varlistentry> + <varlistentry id="hdbk-reference-menus-window-loadsession"> + <term> + <menuchoice> + <guimenu> + <inlinemediaobject> + <imageobject> + <imagedata fileref="i_sidetree.png" format="PNG" /> + </imageobject> + </inlinemediaobject>Window</guimenu> + <guimenuitem>Load session</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + <action>Loads an existing session</action>. This will open + a context menu where you can select an existing session to + load.</para> + </listitem> + </varlistentry> + <varlistentry id="hdbk-reference-menus-window-deletesession"> + <term> + <menuchoice> + <guimenu> + <inlinemediaobject> + <imageobject> + <imagedata fileref="i_sidetree.png" format="PNG" /> + </imageobject> + </inlinemediaobject>Window</guimenu> + <guimenuitem>Delete session</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + <action>Deletes an existing session</action>. This will + open a context menu where you can select an existing + session that should be deleted.</para> + </listitem> + </varlistentry> + <varlistentry id="hdbk-reference-menus-window-arrangement_mode"> + <term> + <menuchoice> + <guimenu> + <inlinemediaobject> + <imageobject> + <imagedata fileref="i_cascade_auto.png" + format="PNG" /> + </imageobject> + </inlinemediaobject>Window</guimenu> + <guimenuitem>Arrangement mode</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + <action>Controls the basic window arrangement + behaviour</action>. In the opening context menu, you can + either specify that you want to take care of the window + arrangement yourself (Manual mode) or have &bibletime; + handle it for you (Automatical modes, just try them + out!).</para> + </listitem> + </varlistentry> + <varlistentry id="hdbk-reference-menus-window-closeall"> + <term> + <menuchoice> + <shortcut> + <keycombo action="simul">&Alt;&Ctrl; + <keycap>W</keycap></keycombo> + </shortcut> + <guimenu> + <inlinemediaobject> + <imageobject> + <imagedata fileref="i_fileclose.png" format="PNG" /> + </imageobject> + </inlinemediaobject>Window</guimenu> + <guimenuitem>Close all</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + <action>Closes all open windows</action>.</para> + </listitem> + </varlistentry> + </variablelist> + </sect2> + <sect2 id="hdbk-reference-menus-settings"> + <title> + <guimenu>Settings</guimenu> + </title> + <variablelist> + <varlistentry id="hdbk-reference-menus-settings-bibletime"> + <term> + <menuchoice> + <guimenu> + <inlinemediaobject> + <imageobject> + <imagedata fileref="i_configure.png" format="PNG" /> + </imageobject> + </inlinemediaobject>Settings</guimenu> + <guimenuitem>Configure &bibletime;</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + <action>Opens &bibletime;'s main configuration + dialog</action>. You can configure all kinds of nice + settings there to adapt &bibletime; to your needs. + Please see + <link linkend="hdbk-config-bt">this section</link> for + details.</para> + </listitem> + </varlistentry> + <varlistentry id="hdbk-reference-menus-settings-bookshelf_manager"> + + <term> + <menuchoice> + <shortcut> + <keycombo action="simul"> + <keycap>F4</keycap> + </keycombo> + </shortcut> + <guimenu> + <inlinemediaobject> + <imageobject> + <imagedata fileref="i_configuresword.png" + format="PNG" /> + </imageobject> + </inlinemediaobject>Settings</guimenu> + <guimenuitem>Bookshelf Manager</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + <action>Opens a dialog where you can change your Sword + configuration and manage your bookshelf</action>. Please + see <link linkend="hdbk-op-bookshelfmanager">this + section</link> for details.</para> + </listitem> + </varlistentry> + </variablelist> + </sect2> + + <sect2 id="hdbk-reference-menus-help"> + <title> + <guimenu>Help</guimenu> + </title> + <variablelist> + <varlistentry id="hdbk-reference-menus-help-bibletime"> + <term> + <menuchoice> + <shortcut> + <keycombo action="simul"> + <keycap>F1</keycap> + </keycombo> + </shortcut> + <guimenu> + <inlinemediaobject> + <imageobject> + <imagedata fileref="i_contents2.png" format="PNG" /> + </imageobject> + </inlinemediaobject>Help</guimenu> + <guimenuitem>Handbook</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + <action>Opens &bibletime;'s user guide</action> + You are reading it now.</para> + </listitem> + </varlistentry> + + <varlistentry id="hdbk-reference-menus-help-bible_study_howto"> + <term> + <menuchoice> + <shortcut> + <keycombo action="simul"> + <keycap>F2</keycap> + </keycombo> + </shortcut> + <guimenu> + <inlinemediaobject> + <imageobject> + <imagedata fileref="i_contents2.png" + format="PNG" /> + </imageobject> + </inlinemediaobject>Help</guimenu> + <guimenuitem>Bible Study Howto</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + <action>Opens a guide on how to study the Bible</action> + It is the hope of the &bibletime; team that this HowTo will + provoke the readers to study the scriptures to see what + they say. This particular study guide has been chosen as + it takes care not to advocate any particular + denominational doctrine. We expect you to read and study + the scriptures to understand what they say. If you start + with the attitude that you want to have the Lord sow his + word in your heart He will not disappoint you.</para> + </listitem> + </varlistentry> + + <varlistentry id="hdbk-reference-menus-help-about"> + <term> + <menuchoice> + <guimenu>Help</guimenu> + <guimenuitem>About</guimenuitem> + </menuchoice> + </term> + <listitem> + <para> + <action>Opens a window about &bibletime; project + information</action> + contains information about &bibletime; software version, + project contributors, &sword; software version, &qt; software + version and the license agreement.</para> + </listitem> + </varlistentry> + </variablelist> + </sect2> + </sect1> + + <sect1 id="hdbk-reference-hotkeys"> + <title>HotKeys index</title> + <para>This is index of all hotkeys and their corresponding + description in the handbook. The hotkeys are sorted (roughly) + alphabetical. If you want to directly find out which hotkey a + certain menu item has, you can either look at the entry itself in + &bibletime; (as it always shows the hotkey), or you can look it + up in + <link linkend="hdbk-reference-menus">this section</link>.</para> + <informaltable> + <tgroup cols="2"> + <colspec colname="hotkey" /> + <colspec colname="desc" /> + <thead> + <row> + <entry>Hotkey</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry> + <keycombo action="simul">&Alt; + <keycap>Left</keycap></keycombo> + </entry> + <entry>Moves back in the history of read windows.</entry> + </row> + <row> + <entry> + <keycombo action="simul">&Alt; + <keycap>Right</keycap></keycombo> + </entry> + <entry>Moves forward in the history of read + windows.</entry> + </row> + <row> + <entry> + <keycombo action="simul">&Alt;&Ctrl; + <keycap>F</keycap></keycombo> + </entry> + <entry> + <link linkend="hdbk-reference-menus-search-defaultbible"> + <menuchoice> + <guimenu>Search</guimenu> + <guimenuitem>Search in default bible</guimenuitem> + </menuchoice> + </link>equivalent; opens the search dialog to search in the + default bible.</entry> + </row> + <row> + <entry> + <keycombo action="simul">&Alt;&Ctrl; + <keycap>G</keycap></keycombo> + </entry> + <entry> + <menuchoice> + <guimenu>Window</guimenu> + <guimenuitem>Arrangement mode</guimenuitem> + <guimenuitem>Auto-tile vertically</guimenuitem> + </menuchoice>equivalent; toggle automatic window + tiling.</entry> + </row> + <row> + <entry> + <keycombo action="simul">&Alt;&Ctrl; + <keycap>H</keycap></keycombo> + </entry> + <entry> + <menuchoice> + <guimenu>Window</guimenu> + <guimenuitem>Arrangement mode</guimenuitem> + <guimenuitem>Auto-tile horizontally</guimenuitem> + </menuchoice>equivalent; toggle automatic window + tiling.</entry> + </row> + <row> + <entry> + <keycombo action="simul">&Alt;&Ctrl; + <keycap>J</keycap></keycombo> + </entry> + <entry> + <menuchoice> + <guimenu>Window</guimenu> + <guimenuitem>Arrangement mode</guimenuitem> + <guimenuitem>Auto-cascade</guimenuitem> + </menuchoice>equivalent; toggle automatic window + cascading.</entry> + </row> + <row> + <entry> + <keycombo action="simul">&Alt;&Ctrl; + <keycap>M</keycap></keycombo> + </entry> + <entry> + <menuchoice> + <guimenu>Window</guimenu> + <guimenuitem>Arrangement mode</guimenuitem> + <guimenuitem>Manual mode</guimenuitem> + </menuchoice>equivalent; toggle manual window + placement.</entry> + </row> + <row> + <entry> + <keycombo action="simul">&Alt;&Ctrl; + <keycap>S</keycap></keycombo> + </entry> + <entry> + <link linkend="hdbk-reference-menus-window-savenewsession"> + <menuchoice> + <guimenu>Window</guimenu> + <guimenuitem>Save as new session</guimenuitem> + </menuchoice> + </link>equivalent; saves current layout as new + session.</entry> + </row> + <row> + <entry> + <keycombo action="simul">&Alt;&Ctrl; + <keycap>W</keycap></keycombo> + </entry> + <entry> + <link linkend="hdbk-reference-menus-window-closeall"> + <menuchoice> + <guimenu>Window</guimenu> + <guimenuitem>Close all</guimenuitem> + </menuchoice> + </link>equivalent; closes all open windows.</entry> + </row> + <row> + <entry> + <keycombo action="simul">&Ctrl; + <keycap>-</keycap></keycombo> + </entry> + <entry>Zoom out. This decreases the font size of read + windows.</entry> + </row> + <row> + <entry> + <keycombo action="simul">&Ctrl; + <keycap>+</keycap></keycombo> + </entry> + <entry>Zoom in. This increases the font size of read + windows.</entry> + </row> + <row> + <entry> + <keycombo action="simul">&Ctrl; + <keycap>A</keycap></keycombo> + </entry> + <entry>Select all. This selects all text in read + windows.</entry> + </row> + <row> + <entry> + <keycombo action="simul">&Ctrl; + <keycap>C</keycap></keycombo> + </entry> + <entry>Copy. This copies the selected text to the + clipboard.</entry> + </row> + <row> + <entry> + <keycombo action="simul">&Ctrl; + <keycap>F</keycap></keycombo> + </entry> + <entry>Search. This lets you search within the text of a + read window.</entry> + </row> + <row> + <entry> + <keycombo action="simul">&Ctrl; + <keycap>O</keycap></keycombo> + </entry> + <entry> + <link linkend="hdbk-reference-menus-search-openworks"> + <menuchoice> + <guimenu>Search</guimenu> + <guimenuitem>Search in open work(s)</guimenuitem> + </menuchoice> + </link>equivalent; opens the search dialog to search in all + currently opened works.</entry> + </row> + <row> + <entry> + <keycombo action="simul">&Ctrl; + <keycap>Q</keycap></keycombo> + </entry> + <entry> + <link linkend="hdbk-reference-menus-file-quit"> + <menuchoice> + <guimenu>File</guimenu> + <guimenuitem>Quit</guimenuitem> + </menuchoice> + </link>equivalent; closes &bibletime;.</entry> + </row> + <row> + <entry> + <keycombo action="simul">&Ctrl; + <keycap>W</keycap></keycombo> + </entry> + <entry>Closes the current window.</entry> + </row> + <row> + <entry> + <keycombo action="simul"> + <keycap>F1</keycap> + </keycombo> + </entry> + <entry> + <menuchoice> + <guimenu>Help</guimenu> + <guimenuitem>Handbook</guimenuitem> + </menuchoice>equivalent; opens the handbook.</entry> + </row> + <row> + <entry> + <keycombo action="simul"> + <keycap>F2</keycap> + </keycombo> + </entry> + <entry> + <menuchoice> + <guimenu>Help</guimenu> + <guimenuitem>BibleStudy Howto</guimenuitem> + </menuchoice>equivalent; opens the BibleStudy + Howto.</entry> + </row> + <row> + <entry> + <keycombo action="simul"> + <keycap>F4</keycap> + </keycombo> + </entry> + <entry> + <link linkend="hdbk-reference-menus-settings-bookshelf_manager"> + + <menuchoice> + <guimenu>Settings</guimenu> + <guimenuitem>Bookshelf Manager</guimenuitem> + </menuchoice> + </link>equivalent; opens the Bookshelf Manager.</entry> + </row> + <row> + <entry> + <keycombo action="simul"> + <keycap>F8</keycap> + </keycombo> + </entry> + <entry> + <link linkend="hdbk-reference-menus-view-showbookshelf"> + <menuchoice> + <guimenu>View</guimenu> + <guimenuitem>Show Bookshelf</guimenuitem> + </menuchoice> + </link>equivalent; toggles display of the + Bookshelf.</entry> + </row> + <row> + <entry> + <keycombo action="simul"> + <keycap>F9</keycap> + </keycombo> + </entry> + <entry> + <link linkend="hdbk-reference-menus-view-showmag"> + <menuchoice> + <guimenu>View</guimenu> + <guimenuitem>Show mag</guimenuitem> + </menuchoice> + </link>equivalent; toggles display of the mag(nifying + glass).</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </sect1> +</chapter> diff --git a/docs/handbook/en/docbook/hdbk-start.docbook b/docs/handbook/en/docbook/hdbk-start.docbook new file mode 100644 index 0000000..111985d --- /dev/null +++ b/docs/handbook/en/docbook/hdbk-start.docbook @@ -0,0 +1,77 @@ +<chapter id="hdbk-term"> + <title>Starting &bibletime;</title> + <sect1 id="hdbk-start"> + <title>How to start &bibletime;</title> + <sect2 id="hdbk-start"> + <title>Starting &bibletime;</title> + <para>&bibletime; is an executable file that is integrated + with the desktop. You can launch &bibletime; from + the Start Menu with this icon: + <mediaobject> + <imageobject> + <imagedata fileref="i_bibletime.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>&bibletime; start icon</phrase> + </textobject> + </mediaobject></para> + <para>&bibletime; can also be launched from a terminal + command prompt. To launch &bibletime;, open a terminal window + and type: + <screen>&bibletime;</screen></para> + </sect2> + <sect2 id="hdbk-start-otherwm"> + <title>Other window managers</title> + <para>&bibletime; can be used with other window managers such + as Gnome, BlackBox, Fluxbox, OpenBox or Sawfish, providing the + appropriate base libraries are already + installed on your computer.</para> + </sect2> + <sect2 id="hdbk-start-custom"> + <title>Startup customization</title> + <para>From a terminal you can use &bibletime; to open a + random verse in the default bible: + <screen>bibletime --open-default-bible + "<random>"</screen>To open at a given passage like John + 3:16, use: + <screen>bibletime --open-default-bible "John 3:16"</screen>You + can also use booknames in your current bookname language.</para> + </sect2> + </sect1> + <sect1 id="hdbk-startsequence"> + <title>Startup sequence</title> + <para>As &bibletime; launches you may see the following screens + before the main &bibletime; window opens:</para> + <variablelist> + <varlistentry> + <term> + <interface>Bookshelf Manager</interface> + </term> + <listitem> + <para> + <action>Modifies your Bookshelf.</action> This dialog lets you + modify your Bookshelf, add or delete works from your system. + It will only be shown if no default Bookshelf can be found. + Please see + <link linkend="hdbk-op-bookshelfmanager"> this + section</link> for further details. If you start off with an + empty Bookshelf, it will be helpful to install at least one + Bible, Commentary, Lexicon and one Book to get to know + &bibletime;'s basic features quickly.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <interface>Configure &bibletime; dialog</interface> + </term> + <listitem> + <para> + <action>Customizes &bibletime;.</action>This dialog lets + you adapt &bibletime; to your needs. Please see + <link linkend="hdbk-config-bt">the detailed + description</link> of this dialog.</para> + </listitem> + </varlistentry> + </variablelist> + </sect1> +</chapter> diff --git a/docs/handbook/en/docbook/index.docbook b/docs/handbook/en/docbook/index.docbook new file mode 100644 index 0000000..944a217 --- /dev/null +++ b/docs/handbook/en/docbook/index.docbook @@ -0,0 +1,73 @@ +<?xml version="1.0"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" +[ + <!ENTITY bibletime '<application>BibleTime</application>'> + <!ENTITY sword '<application>Sword</application>'> + <!ENTITY kde '<application>KDE</application>'> + <!ENTITY qt '<application>Qt</application>'> + + <!ENTITY Shift 'Shift'> + <!ENTITY Ctrl 'Ctrl'> + <!ENTITY Alt 'Alt'> + + <!ENTITY hdbkchap1 SYSTEM "hdbk-intro.docbook"> + <!ENTITY hdbkchap2 SYSTEM "hdbk-start.docbook"> + <!ENTITY hdbkchap3 SYSTEM "hdbk-operation.docbook"> + <!ENTITY hdbkchap4 SYSTEM "hdbk-config.docbook"> + <!ENTITY hdbkchap5 SYSTEM "hdbk-reference.docbook"> +]> +<book> +<bookinfo> + <title>The &bibletime; handbook</title> + <authorgroup> + <author> + <firstname>Fred</firstname> + <surname>Saalbach</surname> + </author> + <author> + <firstname>Jeffrey</firstname> + <surname>Hoyt</surname> + </author> + <author> + <firstname>Martin</firstname> + <surname>Gruner</surname> + </author> + <author> + <firstname>Thomas</firstname> + <surname>Abthorpe</surname> + </author> + </authorgroup> + <!-- TRANS:ROLES_OF_TRANSLATORS --> + <copyright> + <year>1999-2009</year> + <holder>the &bibletime; team</holder> + </copyright> + <legalnotice> + <para>The &bibletime; handbook is part of + &bibletime;.</para> + </legalnotice> + <date>2009-04</date> + <releaseinfo>2.0</releaseinfo> + <abstract> + <para>&bibletime; is a Bible study tool based on the Sword + framework.</para> + </abstract> + <keywordset> + <keyword>QT4</keyword> + <keyword>bibletime</keyword> + <keyword>sword</keyword> + <keyword>crosswire</keyword> + <keyword>help dialog</keyword> + </keywordset> +</bookinfo>&hdbkchap1; &hdbkchap2; &hdbkchap3; +&hdbkchap4; &hdbkchap5;</book> +<!-- +Local Variables: +mode: sgml +sgml-minimize-attributes:nil +sgml-general-insert-case:lower +sgml-indent-step:0 +sgml-indent-data:nil +End: +--> diff --git a/docs/handbook/en/html/hdbk-config.html b/docs/handbook/en/html/hdbk-config.html new file mode 100644 index 0000000..77c690e --- /dev/null +++ b/docs/handbook/en/html/hdbk-config.html @@ -0,0 +1,104 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter 4. Configuring BibleTime</title><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"><meta name="keywords" content="QT4, bibletime, sword, crosswire, help dialog"><link rel="home" href="index.html" title="The BibleTime handbook"><link rel="up" href="index.html" title="The BibleTime handbook"><link rel="prev" href="hdbk-op-output.html" title="Exporting and Printing"><link rel="next" href="hdbk-reference.html" title="Chapter 5. Reference"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 4. Configuring BibleTime</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="hdbk-op-output.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="hdbk-reference.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="hdbk-config"></a>Chapter 4. Configuring <span class="application">BibleTime</span></h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="hdbk-config.html#hdbk-config-bt">Configure BibleTime Dialog</a></span></dt><dd><dl><dt><span class="sect2"><a href="hdbk-config.html#hdbk-config-bt-display"> + Display + </a></span></dt><dt><span class="sect2"><a href="hdbk-config.html#hdbk-config-bt-languages"> + Languages + </a></span></dt><dt><span class="sect2"><a href="hdbk-config.html#hdbk-config-bt-desk"> + Desk + </a></span></dt><dt><span class="sect2"><a href="hdbk-config.html#hdbk-config-bt-hotkeys"> + HotKeys + </a></span></dt></dl></dd></dl></div><p>In this section you find an overview to configure <span class="application">BibleTime</span>, + which can be found under + <span class="guimenu">Settings</span> in the main menu.</p><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="hdbk-config-bt"></a>Configure BibleTime Dialog</h2></div></div></div><p>The <span class="application">BibleTime</span> user interface can be customized in many + ways depending on your needs. You can access the configuration + dialog by selecting + <span class="guimenu">Settings</span> + <span class="guimenuitem">Configure <span class="application">BibleTime</span></span>.</p><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="hdbk-config-bt-display"></a> + <span class="guimenu">Display</span> + </h3></div></div></div><p>The startup behavior can be customized. Select from the + following options: + </p><div class="itemizedlist"><ul type="disc"><li><p>Show startup logo</p></li></ul></div><p>Display templates define the rendering of text (colors, + size etc.). Various built-in templates are available. If you + select one, you will see a preview on the right pane.</p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="hdbk-config-bt-languages"></a> + <span class="guimenu">Languages</span> + </h3></div></div></div><p>Here you can specify which language should be used for the + biblical booknames. Set this to your native language, if it is + available, and you'll feel at home.</p><p>By default, <span class="application">BibleTime</span> uses the default system + display font. You + can override this font if necessary. Some languages require + special fonts to be displayed correctly, and this dialog allows + you to specify a custom font for each language.</p><div class="mediaobject"><img src="ss_configfonts.png" alt="Options Dialog - fonts"><div class="caption"><p>The Options dialog - Fonts.</p></div></div><p><span class="application">BibleTime</span> can now use all supported fonts. + As long as the works you are interested in display correctly + nothing needs to be done here. If a work only displays as a + series of question marks (??????) or empty boxes, then you know + that the standard display font does not contain the + characters used in this work.</p><p>To correct this, choose this work's language from the drop + down menu. Select the use custom font checkbox. Now select a + font. For example, a font that supports many languages is + Code2000. If no installed font can display the work you are + interested in, try installing the localization package + for that language.</p><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="hdbk-config-bt-addfont"></a>Installing fonts</h4></div></div></div><p>Detailed font installation instructions are outside the + scope of this handbook. For further information you might want + to refer to the + <a class="ulink" href="http://www.linux.org/docs/ldp/howto/Unicode-HOWTO-2.html" target="_top"> + Unicode HOWTO</a>.</p><div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Tip</h3><p>If you use a small font like Clearlyu (about 22kb), + <span class="application">BibleTime</span> will run faster than with a large font like + <span class="trademark">Bitstream + Cyberbit</span>®(about 12Mb).</p></div></div><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="hdbk-config-bt-ob-font"></a>Obtaining Fonts</h4></div></div></div><p>Fonts can be obtained from a number of sources:</p><div class="itemizedlist"><ul type="disc"><li><p>Your *nix distribution.</p></li><li><p>Your distribution's localization packages.</p></li><li><p>An existing + <span class="trademark">Microsoft + Windows</span>®installation on the same + computer.</p></li><li><p>A font collection, such as are available from Adobe + or Bitstream.</p></li><li><p>Online font collections.</p></li></ul></div><p>Unicode fonts support more characters than other fonts, + and some of these fonts are available at no charge. None of + available fonts includes all characters defined in the Unicode + standard, so you may want to use different fonts for different + languages.</p><div class="table"><a name="hdbk-config-unicode-fonts-table"></a><p class="title"><b>Table 4.1. Unicode Fonts</b></p><div class="table-contents"><table summary="Unicode Fonts" border="1"><colgroup><col><col></colgroup><tbody><tr><td> + <a class="ulink" href="http://code2000.net/CODE2000.ZIP" target="_top"> + Code2000</a> + </td><td>Perhaps the best free Unicode font, covering a + wide range of characters.</td></tr><tr><td> + <a class="ulink" href="http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&cat_id=FontDownloads" target="_top"> + SIL unicode fonts</a> + </td><td>Excellent Unicode fonts from the Summer + Institute of Linguistics.</td></tr><tr><td> + <a class="ulink" href="http://www.nongnu.org/freefont/" target="_top"> + FreeFont</a> + </td><td>A new free Unicode font initiative.</td></tr><tr><td> + <a class="ulink" href="ftp://ftp.crosswire.org/pub/sword/iso/latest/FONTS" target="_top"> + Crosswire's font directory</a> + </td><td>Several fonts available from the Crosswire Bible + Society Ftp site.</td></tr><tr><td> + <a class="ulink" href="ftp://ftp.netscape.com/pub/communicator/extras/fonts/windows/" target="_top"> + Bitstream CyberBit</a> + </td><td>Covers almost the entire range of Unicode, but + might slow <span class="application">BibleTime</span> down because of its + size.</td></tr><tr><td>Clearlyu</td><td>Included in some distributions. Contains + European, Greek, Hebrew, Thai.</td></tr><tr><td> + <a class="ulink" href="http://fontforge.sourceforge.net/sfds/" target="_top"> + Caslon, Monospace, Cupola, Caliban</a> + </td><td>Partial coverage, see information on linked + site.</td></tr></tbody></table></div></div><br class="table-break"><p>There are good Unicode font lists on the net, as the one + by Christoph Singer ( + <a class="ulink" href="http://www.slovo.info/unifonts.htm" target="_top">Multilingual + Unicode TrueType Fonts in the Internet</a>), or the one by + Alan Wood ( + <a class="ulink" href="http://www.alanwood.net/unicode/fontsbyrange.html" target="_top"> + Unicode character ranges and the Unicode fonts that support + them</a>).</p></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="hdbk-config-bt-desk"></a> + <span class="guimenu">Desk</span> + </h3></div></div></div><p>Many features provided by the Sword backend can now be + customized in <span class="application">BibleTime</span>. These features are documented + right in the dialog. You also have the possibility to specify + standard works that should be used when no specific work is + specified in a reference. An example: The standard Bible is used + to display the content of cross references in the Bible. When you + hover over then, the Mag will show the content of the verses + referred to, according to the standard Bible you + specified.</p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="hdbk-config-bt-hotkeys"></a> + <span class="guimenu">HotKeys</span> + </h3></div></div></div><p>HotKeys are special key commands that can be used in the + place of the menu items and icons. A number of <span class="application">BibleTime</span>'s + commands have predefined HotKeys (see + <a class="link" href="hdbk-reference-hotkeys.html" title="HotKeys index">this section</a> for a + complete listing). Most of <span class="application">BibleTime</span>'s commands can be + assigned HotKeys here. This is very helpful to quickly access the + functions that you need the most.</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="hdbk-op-output.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="hdbk-reference.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Exporting and Printing </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 5. Reference</td></tr></table></div></body></html> diff --git a/docs/handbook/en/html/hdbk-intro.html b/docs/handbook/en/html/hdbk-intro.html new file mode 100644 index 0000000..448c381 --- /dev/null +++ b/docs/handbook/en/html/hdbk-intro.html @@ -0,0 +1,42 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter 1. Introduction</title><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"><meta name="keywords" content="QT4, bibletime, sword, crosswire, help dialog"><link rel="home" href="index.html" title="The BibleTime handbook"><link rel="up" href="index.html" title="The BibleTime handbook"><link rel="prev" href="index.html" title="The BibleTime handbook"><link rel="next" href="hdbk-term.html" title="Chapter 2. Starting BibleTime"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 1. Introduction</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="index.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="hdbk-term.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="hdbk-intro"></a>Chapter 1. Introduction</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="hdbk-intro.html#hdbk-intro-about">About BibleTime</a></span></dt><dd><dl><dt><span class="sect2"><a href="hdbk-intro.html#hdbk-intro-works">Available works</a></span></dt><dt><span class="sect2"><a href="hdbk-intro.html#hdbk-intro-motivation">Motivation</a></span></dt></dl></dd></dl></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="hdbk-intro-about"></a>About <span class="application">BibleTime</span></h2></div></div></div><p><span class="application">BibleTime</span> is a Bible study tool with support for + different types of texts and languages. Even large amounts of works + modules are easy to install and manage. It is built on the + <a class="ulink" href="http://www.crosswire.org/sword" target="_top">Sword</a> library, + which provides the back-end functionality for <span class="application">BibleTime</span>, such + as viewing Bible text, searching etc. Sword is the flagship product + of the <a class="ulink" href="http://www.crosswire.org" target="_top">Crosswire Bible + Society</a>.</p><p><span class="application">BibleTime</span> is designed to be used with works encoded in + one of the formats supported by the Sword project. Complete + information on the supported document formats can be found in the + <a class="ulink" href="http://www.crosswire.org/sword/develop/index.jsp" target="_top"> + developers section</a> of the Sword Project, Crosswire Bible + Society.</p><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="hdbk-intro-works"></a>Available works</h3></div></div></div><p>Over 200 documents in 50 languages are available from the + <a class="ulink" href="http://www.crosswire.org" target="_top">Crosswire Bible + Society</a>. These include: + </p><div class="variablelist"><dl><dt><span class="term">Bibles</span></dt><dd><p>The full Bible text, with optional things like + Strong's Numbers, headings and/or footnotes in the text. + Bibles are available in many languages, and include not + only modern versions, but also ancient texts like the Codex + Leningradensis ("WLC", Hebrew), and the Septuagint ("LXX", + Greek). This is the most advanced section in the library of + the Sword project.</p></dd><dt><span class="term">Books</span></dt><dd><p>Books available include "Imitation of Christ", "Enuma + Elish", and "Josephus: The Complete Works"</p></dd><dt><span class="term">Commentaries</span></dt><dd><p>Commentaries available include classics like John + Wesley's "Notes on the Bible", Matthew Henry's commentary + and Luther's "Commentary on Galatians." With the + <span class="emphasis"><em>Personal</em></span> commentary you can + <a class="link" href="hdbk-op-parts.html#hdbk-op-parts-desk-write" title="Editing your own commentary"> record your own + personal notes</a> to sections of the Bible.</p></dd><dt><span class="term">Daily devotionals</span></dt><dd><p>Many people appreciate these daily portions from + God's word. Available works include Daily Light on the + Daily Path, and the Losungen.</p></dd><dt><span class="term">Lexicons/Dictionaries</span></dt><dd><p>Lexicons available include: Robinson's Morphological + Analysis Codes, Brown-Driver-Briggs Hebrew Lexicon and the + International Standard Bible Encyclopaedia. Dictionaries + available include Strong's Hebrew Bible Dictionary, + Strong's Greek Bible Dictionary, Webster's Revised + Unabridged Dictionary of the English Language 1913, Nave's + Topical Bible.</p></dd></dl></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="hdbk-intro-motivation"></a>Motivation</h3></div></div></div><p>Our desire is to serve God, and to do our part to help + others grow in their relationship with Him. We have striven to + make this a powerful, quality program, and still make it simple + and intuitive to operate. It is our desire that God be praised, + as He is the source of all good things.</p><div class="blockquote"><table border="0" width="100%" cellspacing="0" cellpadding="0" class="blockquote" summary="Block quote"><tr><td width="10%" valign="top"> </td><td width="80%" valign="top"><p>Every good thing given and every perfect gift is from + above, coming down from the Father of lights, with whom there + is no variation or shifting shadow.</p></td><td width="10%" valign="top"> </td></tr><tr><td width="10%" valign="top"> </td><td colspan="2" align="right" valign="top">--<span class="attribution">James 1:17, NASB</span></td></tr></table></div><p>God bless you as you use this program.</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="index.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="hdbk-term.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">The BibleTime handbook </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 2. Starting BibleTime</td></tr></table></div></body></html> diff --git a/docs/handbook/en/html/hdbk-op-bookshelfmanager.html b/docs/handbook/en/html/hdbk-op-bookshelfmanager.html new file mode 100644 index 0000000..2758c71 --- /dev/null +++ b/docs/handbook/en/html/hdbk-op-bookshelfmanager.html @@ -0,0 +1,38 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>The Bookshelf Manager</title><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"><meta name="keywords" content="QT4, bibletime, sword, crosswire, help dialog"><link rel="home" href="index.html" title="The BibleTime handbook"><link rel="up" href="hdbk-op.html" title="Chapter 3. Program operation"><link rel="prev" href="hdbk-op-search.html" title="Searching in works"><link rel="next" href="hdbk-op-output.html" title="Exporting and Printing"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">The + Bookshelf Manager</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="hdbk-op-search.html">Prev</a> </td><th width="60%" align="center">Chapter 3. Program operation</th><td width="20%" align="right"> <a accesskey="n" href="hdbk-op-output.html">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="hdbk-op-bookshelfmanager"></a>The + <span class="guimenuitem">Bookshelf Manager</span></h2></div></div></div><p>The + <span class="guimenuitem">Bookshelf Manager</span> is a tool to manage + your Bookshelf. You can install new works to your Bookshelf, and + update or remove existing works from your Bookshelf. Access it by + clicking + <span class="guimenu">Settings</span> → <span class="guimenuitem">Bookshelf Manager</span> in the main menu.</p><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="hdbk-op-bookshelfmanager-path"></a>Bookshelf path(s) setup</h3></div></div></div><p>Here you can specify where <span class="application">BibleTime</span> may store your + Bookshelf on the hard drive. You can even store it in multiple + directories. Default is "~/.sword/".</p><div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Tip</h3><p>If you have a sword CD, but do not want to install all + the works on the hard disk, but use them directly from the CD, + then you can add the path to the CD as one of your bookshelf + paths. When you start <span class="application">BibleTime</span>, it will show all works + on the CD if it is present.</p></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="hdbk-op-bookshelfmanager-installupdate"></a>Install/update work(s)</h3></div></div></div><p>With this facility, you can connect to a repository of + works (called "library"), and transfer one or more works to your + local Bookshelf. These libraries may be local (e.g. a Sword CD), + or remote (e.g. Crosswire's online repository of Sword modules, + or another site offering Sword modules). You can manage your + libraries with + <span class="guibutton">Add library</span> and + <span class="guibutton">Delete library</span>.</p><p>To begin the installation or update process, select a + library you want to connect to and a local Bookshelf path to + install the work(s) to. Then click on + <span class="guibutton">Connect to library</span>. <span class="application">BibleTime</span> will + scan the contents of the library and present you with a list of + works that you can add to your Bookshelf, or that you already + have installed but are available in a new version in the library, + and thus can be updated. Then you can mark all works that you + want to install or update, and click on + <span class="guibutton">Install works</span>. They will then be + transferred to your Bookshelf.</p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="hdbk-op-bookshelfmanager-remove"></a>Remove work(s)</h3></div></div></div><p>This facility allows you to delete one or more of the works + from your Bookshelf too free up disk space. Simply mark the items + and click on + <span class="guibutton">Remove works</span>.</p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="hdbk-op-bookshelfmanager-searchindexes"></a>Search Indexes</h3></div></div></div><p>This option allows you to create new search indexes and + cleanup orphaned index files for removed works.</p><div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Tip</h3> + If you are having problems with your search function, visit + this feature. + </div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="hdbk-op-search.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="hdbk-op.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="hdbk-op-output.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Searching in works </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Exporting and Printing</td></tr></table></div></body></html> diff --git a/docs/handbook/en/html/hdbk-op-output.html b/docs/handbook/en/html/hdbk-op-output.html new file mode 100644 index 0000000..dbc3a32 --- /dev/null +++ b/docs/handbook/en/html/hdbk-op-output.html @@ -0,0 +1,18 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Exporting and Printing</title><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"><meta name="keywords" content="QT4, bibletime, sword, crosswire, help dialog"><link rel="home" href="index.html" title="The BibleTime handbook"><link rel="up" href="hdbk-op.html" title="Chapter 3. Program operation"><link rel="prev" href="hdbk-op-bookshelfmanager.html" title="The Bookshelf Manager"><link rel="next" href="hdbk-config.html" title="Chapter 4. Configuring BibleTime"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Exporting and Printing</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="hdbk-op-bookshelfmanager.html">Prev</a> </td><th width="60%" align="center">Chapter 3. Program operation</th><td width="20%" align="right"> <a accesskey="n" href="hdbk-config.html">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="hdbk-op-output"></a>Exporting and Printing</h2></div></div></div><p>In many places, you can open a context menu by clicking with + the + <span class="mousebutton">right</span>mouse button. Depending on context, + it will allow you to + <span class="guimenuitem">Select</span>, + <span class="guimenuitem">Copy</span> (to clipboard), + <span class="guimenuitem">Save</span> or + <span class="guimenuitem">Print</span> text. This works for example in the + read windows, when you click on the normal text or the verse + reference, or in the search result page when you click on a work or + one or more verse references. It is pretty straightforward, so just + try it out.</p><p>Printing from <span class="application">BibleTime</span> is rather basic and is intended + as a utility. If you are composing a document or presentation + containing text from <span class="application">BibleTime</span> works, we suggest that you use + one of the presentation or editing tools on your system to format + your document, rather than printing from <span class="application">BibleTime</span> + directly.</p></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="hdbk-op-bookshelfmanager.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="hdbk-op.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="hdbk-config.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">The + Bookshelf Manager </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 4. Configuring BibleTime</td></tr></table></div></body></html> diff --git a/docs/handbook/en/html/hdbk-op-parts.html b/docs/handbook/en/html/hdbk-op-parts.html new file mode 100644 index 0000000..018fb11 --- /dev/null +++ b/docs/handbook/en/html/hdbk-op-parts.html @@ -0,0 +1,98 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Parts of the BibleTime application window</title><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"><meta name="keywords" content="QT4, bibletime, sword, crosswire, help dialog"><link rel="home" href="index.html" title="The BibleTime handbook"><link rel="up" href="hdbk-op.html" title="Chapter 3. Program operation"><link rel="prev" href="hdbk-op.html" title="Chapter 3. Program operation"><link rel="next" href="hdbk-op-search.html" title="Searching in works"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Parts of the BibleTime application window</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="hdbk-op.html">Prev</a> </td><th width="60%" align="center">Chapter 3. Program operation</th><td width="20%" align="right"> <a accesskey="n" href="hdbk-op-search.html">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="hdbk-op-parts"></a>Parts of the <span class="application">BibleTime</span> application window</h2></div></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="hdbk-op-parts-bookshelf"></a>The Bookshelf</h3></div></div></div><p>The Bookshelf lists all installed works, sorted by category + and language. It also has a category called "Bookmarks". This is + where you can store and access your own bookmarks.</p><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="hdbk-op-parts-bookshelf-open"></a>Reading works</h4></div></div></div><p>To open a work from the bookshelf for reading, simply + click with the + <span class="mousebutton">left mouse button</span> on the desired + category (Bibles, Commentaries, Lexicons, Books, Devotionals or + Glossaries) to display its contents. Then just click on one of + the works to open it for reading. A read window will appear in + the Desk area.</p><div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Tip</h3><p>Drag & Drop Works Here</p></div><p>If you are reading a certain work, and want to open + another work at the passage you are reading, you can use a + shortcut. Simply click with the + <span class="mousebutton">left mouse button</span>on the + verse/passage reference (pointer changes to hand) and drag it + to the Bookshelf. Drop it on the work you want to open, and it + will be opened for reading at the specified location. You can + also drag a verse reference into an existing read window, then + it will jump to the specified location.</p></div><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="hdbk-op-parts-bookshelf-metainfo"></a>Additional information about works</h4></div></div></div><p>If you click with the + <span class="mousebutton">right</span>mouse button on the symbol of a + work, you will see a menu with additional entries that are + relevant for this work. + <span class="guimenuitem">"About this work"</span>opens a window with + lots of interesting information about the selected work. + <span class="guimenuitem">"Unlock this work"</span>opens a small + dialog for encrypted documents, where you can enter the unlock + key to access the work. For additional information on locked + works, please see + <a class="ulink" href="http://www.crosswire.org/sword/modules/aboutlocked.jsp" target="_top"> + this page</a> on the Crosswire Bible Society web + site.</p></div><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="hdbk-op-parts-bookshelf-search"></a>Searching in works</h4></div></div></div><p>You can search in a work by clicking with the + <span class="mousebutton">right</span>mouse button on its symbol and + selecting + <span class="guimenuitem">"Search in work(s)"</span>. By pressing + Shift and clicking on other works you can select more + than one. Then follow the same procedure to open the search + dialog. You will be searching in all of these documents. A + complete description of the operation of the search features + can be found + <a class="link" href="hdbk-op-search.html" title="Searching in works">here</a>.</p></div><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="hdbk-op-parts-bookshelf-bookmarks"></a>Working with bookmarks</h4></div></div></div><p> + + </p><div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Tip</h3><p>Drag & Drop Works Here</p></div><p> + + Click with the + <span class="mousebutton">right</span>mouse button on the bookmark + category of the bookshelf and select + <span class="guimenuitem">"Create new folder"</span> to create a new + bookmark subfolder. You can use normal drag & drop + functions to drag verse references from read windows or search + results to the bookmark folder, and to rearrange bookmarks + between folders.</p><p>You can also import bookmarks from other people or export + bookmarks to share them. To do this, open the + <span class="guimenu">context menu</span>of the bookmark folder as + described above, and select + <span class="guimenuitem">"Export bookmarks"</span>. This will bring + up a dialog box for you to save the bookmark collection. You + can import bookmarks in a similar way.</p><p>You can also click with the + <span class="mousebutton">right</span>on folders and bookmarks to + change their names and descriptions.</p></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="hdbk-op-parts-mag"></a>The Mag(nifying glass)</h3></div></div></div><p>This little window in the lower left corner of the + <span class="application">BibleTime</span> window is purely passive. Whenever your mouse + cursor is located over some text with additional information + (e.g., Strong's numbers), then this additional information will + be displayed in the Mag, and not in the text itself. Just try it + out.</p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="hdbk-op-parts-desk"></a>The Desk</h3></div></div></div><p>The Desk is where the real work with <span class="application">BibleTime</span> takes + place. Here you can open works from the Bookshelf, read them, + <a class="link" href="hdbk-op-search.html" title="Searching in works">search</a> in them, and even + save your annotations in the personal commentary module (see + <a class="link" href="hdbk-op-parts.html#hdbk-op-parts-desk-write" title="Editing your own commentary">below</a>).</p><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="hdbk-op-parts-desk-read"></a>Reading works</h4></div></div></div><p>As we have + <a class="link" href="hdbk-op-parts.html#hdbk-op-parts-bookshelf-open" title="Reading works">already + seen</a>, you can open works for reading simply by clicking + on their symbol in the Bookshelf. A read window will open in + the Desk's area. Every read window has a toolbar. There you can + find tools to navigate in the work that this read window is + connected to, as well as history buttons like the ones that you + know from your browser.</p></div><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="hdbk-op-parts-desk-placement"></a>Read window placement</h4></div></div></div><p>Of course, you can open multiple works at the same time. + There are several possibilities for arranging the read windows + on the desk. Please have a look at the entry + <span class="guimenu">Window</span>in the main menu. There you can see + that you can either control the placement of the read windows + completely yourself, or have <span class="application">BibleTime</span> handle the + placement automatically. To achieve this, you have to select + one of the automatic placement modes available at + <span class="guimenu">Window</span> → <span class="guimenuitem">Arrangement mode</span>. Just try it out, it's simple and works.</p></div><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="hdbk-op-parts-desk-write"></a>Editing your own commentary</h4></div></div></div><p>To be able to store your own comments about parts of the + Bible, you have install a certain work from the library of the + <a class="ulink" href="http://www.crosswire.org" target="_top">Crosswire Bible + Society</a>. This work is called "Personal + commentary".</p><p>If you open the personal commentary by clicking on its + symbol in the Bookshelf with a + <span class="mousebutton">left</span>mouse button, it opens in read + mode. You will not be able to edit it in this mode. Should you + wish to write annotations into the personal commentary, you + have to open it with the + <span class="mousebutton">right</span>mouse button and then select + <span class="guimenu">Edit this work</span>and then either + <span class="guimenuitem">Plain text</span>(source code editor) or + <span class="guimenuitem">HTML</span>(basic gui wysiwyg + editor).</p><div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Tip</h3><p>If + <span class="guimenu">Edit this work</span> is deactivated, please check if you have write + permission for the files of the personal commentary.</p></div><div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Tip</h3><p>Drag & drop works here. Drop a verse reference and + the text of the verse will be inserted.</p></div></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="hdbk-op.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="hdbk-op.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="hdbk-op-search.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 3. Program operation </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Searching in works</td></tr></table></div></body></html> diff --git a/docs/handbook/en/html/hdbk-op-search.html b/docs/handbook/en/html/hdbk-op-search.html new file mode 100644 index 0000000..8eb5d84 --- /dev/null +++ b/docs/handbook/en/html/hdbk-op-search.html @@ -0,0 +1,58 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Searching in works</title><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"><meta name="keywords" content="QT4, bibletime, sword, crosswire, help dialog"><link rel="home" href="index.html" title="The BibleTime handbook"><link rel="up" href="hdbk-op.html" title="Chapter 3. Program operation"><link rel="prev" href="hdbk-op-parts.html" title="Parts of the BibleTime application window"><link rel="next" href="hdbk-op-bookshelfmanager.html" title="The Bookshelf Manager"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Searching in works</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="hdbk-op-parts.html">Prev</a> </td><th width="60%" align="center">Chapter 3. Program operation</th><td width="20%" align="right"> <a accesskey="n" href="hdbk-op-bookshelfmanager.html">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="hdbk-op-search"></a>Searching in works</h2></div></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="hdbk-op-search-intext"></a>Searching text in an open read window</h3></div></div></div><p>You can look for a word or phrase in the open read window + (e.g. the chapter of a bible that you're reading) just like you + are used to from other programs. This function can be reached + either by clicking with the + <span class="mousebutton">right</span>mouse button and selecting + <span class="guimenuitem">Find...</span>, or by using the hotkey + <span class="keycap"><strong>F</strong></span>. Read on to learn how you can + search in entire works.</p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="hdbk-op-search-access"></a>Accessing the search dialog</h3></div></div></div><p>You can search in a work by clicking with the + <span class="mousebutton">right</span>mouse button on its symbol in the + + <span class="guimenu">Bookshelf</span>and selecting + <span class="guimenuitem">Search in work(s)</span>. By holding + Shift or Ctrl and clicking on other work's names you + can select more than one. Then follow the same procedure to open + the search dialog. You will be searching in all of these works at + the same time.</p><p>You can also access the search dialog by clicking on + <span class="guimenu">Search</span> from the main menu, and selecting the appropriate + entry.</p><p>A third possibility to start searches is to click on the + search symbol in an open read window.</p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="hdbk-op-search-config"></a>Search configuration</h3></div></div></div><div class="screenshot"><div class="mediaobject"><img src="ss_searchopts.png"></div></div><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="hdbk-op-search-config-works"></a>Selecting works</h4></div></div></div><p>At the top of the options tab you will find + <span class="guibutton">Choose</span>(works). If you would like to + search in multiple works, click on this button and you will be + offered a menu where you can select the works you want to + search in.</p></div><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="hd-op-search-config-scope"></a>Using Search Scopes</h4></div></div></div><p>You can narrow the scope of your search to certain parts + of the Bible by selecting one of the predefined scopes from the + list in + <span class="guimenu">Search scope</span>. You can define your own search + ranges by clicking the + <span class="guibutton">Setup ranges</span>button.</p></div><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="hd-op-search-config-syntax"></a>Basic Search Syntax Introduction</h4></div></div></div><p>Enter search terms separated by spaces. By default the + search function will return results that match any of the + search terms (OR). To search for all the terms separate the + terms by AND.</p><p>You can use wildcards: '*' matches any sequence of + characters, while '?' matches any single character. The use of + brackets allows you to group your search terms, e.g. '(Jesus OR + spirit) AND God'.</p><p>To search text other than the main text, enter the text + type followed by ':', and then the search term. For example, to + search for the Strong's number H8077, use + 'strong:H8077'.</p><p>Available text types: + </p><div class="table"><a name="hd-op-search-config-syntax-table"></a><p class="title"><b>Table 3.1. Search Types</b></p><div class="table-contents"><table summary="Search Types" border="1"><colgroup><col><col></colgroup><thead><tr><th>Prefix</th><th>Meaning</th></tr></thead><tbody><tr><td>heading:</td><td>searches headings</td></tr><tr><td>footnote:</td><td>searches footnotes</td></tr><tr><td>strong:</td><td>searches Strong's Numbers</td></tr><tr><td>morph:</td><td>searches morphology codes</td></tr></tbody></table></div></div><p><br class="table-break"></p><p>BibleTime uses the Lucene search engine to perform your + searches. It has many advanced features, and you can read more + about it here: + <a class="ulink" href="http://lucene.apache.org/java/docs/index.html" target="_top"> + http://lucene.apache.org/java/docs/index.html</a></p></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="hdbk-op-search-results"></a>Search results</h3></div></div></div><p>Here you can see how many instances of the search string + were found, sorted by works. Clicking on a work with the + <span class="mousebutton">right</span>mouse button allows you to copy, + save, or print all verses that were found in a certain work at + once. This also works when you click on one or more of the + references to copy, save or print them. Clicking on a particular + reference opens that verse up in context in the preview window + below.</p><div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Tip</h3><p>Drag a reference and drop it on a work symbol on the + Bookshelf to open the work at that verse in a new read + window.</p></div><div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Tip</h3><p>Drag a reference and drop it on an open read window, and + it will jump to that verse.</p></div><div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Tip</h3><p>Select references and drag them to the Bookshelf to + create bookmarks.</p></div><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="hdbk-op-search-analysis"></a>Search result analysis</h4></div></div></div><p>Click on + <span class="guibutton">Search analysis</span>to open the search + analysis display. This gives a simple graphic analysis of the + number of instances the search string was found in each book of + the Bible, and you can also save the analysis.</p><div class="screenshot"><div class="mediaobject"><img src="ss_searchanal.png"></div></div></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="hdbk-op-parts.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="hdbk-op.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="hdbk-op-bookshelfmanager.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Parts of the BibleTime application window </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> The + Bookshelf Manager</td></tr></table></div></body></html> diff --git a/docs/handbook/en/html/hdbk-op.html b/docs/handbook/en/html/hdbk-op.html new file mode 100644 index 0000000..542e16e --- /dev/null +++ b/docs/handbook/en/html/hdbk-op.html @@ -0,0 +1,13 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter 3. Program operation</title><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"><meta name="keywords" content="QT4, bibletime, sword, crosswire, help dialog"><link rel="home" href="index.html" title="The BibleTime handbook"><link rel="up" href="index.html" title="The BibleTime handbook"><link rel="prev" href="hdbk-startsequence.html" title="Startup sequence"><link rel="next" href="hdbk-op-parts.html" title="Parts of the BibleTime application window"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 3. Program operation</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="hdbk-startsequence.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="hdbk-op-parts.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="hdbk-op"></a>Chapter 3. Program operation</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="hdbk-op.html#hdbk-op-overview">Program overview</a></span></dt><dt><span class="sect1"><a href="hdbk-op-parts.html">Parts of the BibleTime application window</a></span></dt><dd><dl><dt><span class="sect2"><a href="hdbk-op-parts.html#hdbk-op-parts-bookshelf">The Bookshelf</a></span></dt><dt><span class="sect2"><a href="hdbk-op-parts.html#hdbk-op-parts-mag">The Mag(nifying glass)</a></span></dt><dt><span class="sect2"><a href="hdbk-op-parts.html#hdbk-op-parts-desk">The Desk</a></span></dt></dl></dd><dt><span class="sect1"><a href="hdbk-op-search.html">Searching in works</a></span></dt><dd><dl><dt><span class="sect2"><a href="hdbk-op-search.html#hdbk-op-search-intext">Searching text in an open read window</a></span></dt><dt><span class="sect2"><a href="hdbk-op-search.html#hdbk-op-search-access">Accessing the search dialog</a></span></dt><dt><span class="sect2"><a href="hdbk-op-search.html#hdbk-op-search-config">Search configuration</a></span></dt><dt><span class="sect2"><a href="hdbk-op-search.html#hdbk-op-search-results">Search results</a></span></dt></dl></dd><dt><span class="sect1"><a href="hdbk-op-bookshelfmanager.html">The + Bookshelf Manager</a></span></dt><dd><dl><dt><span class="sect2"><a href="hdbk-op-bookshelfmanager.html#hdbk-op-bookshelfmanager-path">Bookshelf path(s) setup</a></span></dt><dt><span class="sect2"><a href="hdbk-op-bookshelfmanager.html#hdbk-op-bookshelfmanager-installupdate">Install/update work(s)</a></span></dt><dt><span class="sect2"><a href="hdbk-op-bookshelfmanager.html#hdbk-op-bookshelfmanager-remove">Remove work(s)</a></span></dt><dt><span class="sect2"><a href="hdbk-op-bookshelfmanager.html#hdbk-op-bookshelfmanager-searchindexes">Search Indexes</a></span></dt></dl></dd><dt><span class="sect1"><a href="hdbk-op-output.html">Exporting and Printing</a></span></dt></dl></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="hdbk-op-overview"></a>Program overview</h2></div></div></div><p>This is what a typical <span class="application">BibleTime</span> session looks like: + </p><div class="mediaobject"><img src="ss_mainterms.png" alt="The BibleTime application window"></div><p> + You can easily see the different parts of the + application. The Bookshelf on the left side is used to open works + and to manage your bookmarks. The little "Mag" window below the + Bookshelf is used to display extra information that is embedded in + documents. When you move your mouse over a footnote marker, for + example, then the Mag will display the actual content of the + footnote. The toolbar gives you quick access to important + functions, and the Desk on the right side is where you do your real + work.</p><p>Let us now proceed by looking at the different parts of the + application individually.</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="hdbk-startsequence.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="hdbk-op-parts.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Startup sequence </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Parts of the BibleTime application window</td></tr></table></div></body></html> diff --git a/docs/handbook/en/html/hdbk-reference-hotkeys.html b/docs/handbook/en/html/hdbk-reference-hotkeys.html new file mode 100644 index 0000000..e97abc7 --- /dev/null +++ b/docs/handbook/en/html/hdbk-reference-hotkeys.html @@ -0,0 +1,98 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>HotKeys index</title><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"><meta name="keywords" content="QT4, bibletime, sword, crosswire, help dialog"><link rel="home" href="index.html" title="The BibleTime handbook"><link rel="up" href="hdbk-reference.html" title="Chapter 5. Reference"><link rel="prev" href="hdbk-reference.html" title="Chapter 5. Reference"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">HotKeys index</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="hdbk-reference.html">Prev</a> </td><th width="60%" align="center">Chapter 5. Reference</th><td width="20%" align="right"> </td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="hdbk-reference-hotkeys"></a>HotKeys index</h2></div></div></div><p>This is index of all hotkeys and their corresponding + description in the handbook. The hotkeys are sorted (roughly) + alphabetical. If you want to directly find out which hotkey a + certain menu item has, you can either look at the entry itself in + <span class="application">BibleTime</span> (as it always shows the hotkey), or you can look it + up in + <a class="link" href="hdbk-reference.html#hdbk-reference-menus" title="Main menu reference">this section</a>.</p><div class="informaltable"><table border="1"><colgroup><col><col></colgroup><thead><tr><th>Hotkey</th><th>Description</th></tr></thead><tbody><tr><td> + <span class="keycap"><strong>Left</strong></span> + </td><td>Moves back in the history of read windows.</td></tr><tr><td> + <span class="keycap"><strong>Right</strong></span> + </td><td>Moves forward in the history of read + windows.</td></tr><tr><td> + <span class="keycap"><strong>F</strong></span> + </td><td> + <a class="link" href="hdbk-reference.html#hdbk-reference-menus-search-defaultbible"> + <span class="guimenu">Search</span> → <span class="guimenuitem">Search in default bible</span> + </a>equivalent; opens the search dialog to search in the + default bible.</td></tr><tr><td> + <span class="keycap"><strong>G</strong></span> + </td><td> + <span class="guimenu">Window</span> → <span class="guimenuitem">Arrangement mode</span> → <span class="guimenuitem">Auto-tile vertically</span>equivalent; toggle automatic window + tiling.</td></tr><tr><td> + <span class="keycap"><strong>H</strong></span> + </td><td> + <span class="guimenu">Window</span> → <span class="guimenuitem">Arrangement mode</span> → <span class="guimenuitem">Auto-tile horizontally</span>equivalent; toggle automatic window + tiling.</td></tr><tr><td> + <span class="keycap"><strong>J</strong></span> + </td><td> + <span class="guimenu">Window</span> → <span class="guimenuitem">Arrangement mode</span> → <span class="guimenuitem">Auto-cascade</span>equivalent; toggle automatic window + cascading.</td></tr><tr><td> + <span class="keycap"><strong>M</strong></span> + </td><td> + <span class="guimenu">Window</span> → <span class="guimenuitem">Arrangement mode</span> → <span class="guimenuitem">Manual mode</span>equivalent; toggle manual window + placement.</td></tr><tr><td> + <span class="keycap"><strong>S</strong></span> + </td><td> + <a class="link" href="hdbk-reference.html#hdbk-reference-menus-window-savenewsession"> + <span class="guimenu">Window</span> → <span class="guimenuitem">Save as new session</span> + </a>equivalent; saves current layout as new + session.</td></tr><tr><td> + <span class="keycap"><strong>W</strong></span> + </td><td> + <a class="link" href="hdbk-reference.html#hdbk-reference-menus-window-closeall"> + <span class="guimenu">Window</span> → <span class="guimenuitem">Close all</span> + </a>equivalent; closes all open windows.</td></tr><tr><td> + <span class="keycap"><strong>-</strong></span> + </td><td>Zoom out. This decreases the font size of read + windows.</td></tr><tr><td> + <span class="keycap"><strong>+</strong></span> + </td><td>Zoom in. This increases the font size of read + windows.</td></tr><tr><td> + <span class="keycap"><strong>A</strong></span> + </td><td>Select all. This selects all text in read + windows.</td></tr><tr><td> + <span class="keycap"><strong>C</strong></span> + </td><td>Copy. This copies the selected text to the + clipboard.</td></tr><tr><td> + <span class="keycap"><strong>F</strong></span> + </td><td>Search. This lets you search within the text of a + read window.</td></tr><tr><td> + <span class="keycap"><strong>O</strong></span> + </td><td> + <a class="link" href="hdbk-reference.html#hdbk-reference-menus-search-openworks"> + <span class="guimenu">Search</span> → <span class="guimenuitem">Search in open work(s)</span> + </a>equivalent; opens the search dialog to search in all + currently opened works.</td></tr><tr><td> + <span class="keycap"><strong>Q</strong></span> + </td><td> + <a class="link" href="hdbk-reference.html#hdbk-reference-menus-file-quit"> + <span class="guimenu">File</span> → <span class="guimenuitem">Quit</span> + </a>equivalent; closes <span class="application">BibleTime</span>.</td></tr><tr><td> + <span class="keycap"><strong>W</strong></span> + </td><td>Closes the current window.</td></tr><tr><td> + <span class="keycap"><strong>F1</strong></span> + </td><td> + <span class="guimenu">Help</span> → <span class="guimenuitem">Handbook</span>equivalent; opens the handbook.</td></tr><tr><td> + <span class="keycap"><strong>F2</strong></span> + </td><td> + <span class="guimenu">Help</span> → <span class="guimenuitem">BibleStudy Howto</span>equivalent; opens the BibleStudy + Howto.</td></tr><tr><td> + <span class="keycap"><strong>F4</strong></span> + </td><td> + <a class="link" href="hdbk-reference.html#hdbk-reference-menus-settings-bookshelf_manager"> + + <span class="guimenu">Settings</span> → <span class="guimenuitem">Bookshelf Manager</span> + </a>equivalent; opens the Bookshelf Manager.</td></tr><tr><td> + <span class="keycap"><strong>F8</strong></span> + </td><td> + <a class="link" href="hdbk-reference.html#hdbk-reference-menus-view-showbookshelf"> + <span class="guimenu">View</span> → <span class="guimenuitem">Show Bookshelf</span> + </a>equivalent; toggles display of the + Bookshelf.</td></tr><tr><td> + <span class="keycap"><strong>F9</strong></span> + </td><td> + <a class="link" href="hdbk-reference.html#hdbk-reference-menus-view-showmag"> + <span class="guimenu">View</span> → <span class="guimenuitem">Show mag</span> + </a>equivalent; toggles display of the mag(nifying + glass).</td></tr></tbody></table></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="hdbk-reference.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="hdbk-reference.html">Up</a></td><td width="40%" align="right"> </td></tr><tr><td width="40%" align="left" valign="top">Chapter 5. Reference </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html> diff --git a/docs/handbook/en/html/hdbk-reference-toolbar.html b/docs/handbook/en/html/hdbk-reference-toolbar.html new file mode 100644 index 0000000..f9ededd --- /dev/null +++ b/docs/handbook/en/html/hdbk-reference-toolbar.html @@ -0,0 +1,14 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Toolbar reference</title><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"><meta name="keywords" content="QT4, bibletime, sword, crosswire, help dialog"><link rel="home" href="index.html" title="The BibleTime handbook"><link rel="up" href="hdbk-reference.html" title="Chapter 5. Reference"><link rel="prev" href="hdbk-reference.html" title="Chapter 5. Reference"><link rel="next" href="hdbk-reference-hotkeys.html" title="HotKeys index"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Toolbar reference</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="hdbk-reference.html">Prev</a> </td><th width="60%" align="center">Chapter 5. Reference</th><td width="20%" align="right"> <a accesskey="n" href="hdbk-reference-hotkeys.html">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="hdbk-reference-toolbar"></a>Toolbar reference</h2></div></div></div><p>Please review + <a class="link" href="hdbk-reference.html#hdbk-reference-menus" title="Main menu reference">the preceding + section</a> for an explanation of the buttons that you find on + the toolbar. You can also + <span class="action">move the cursor over a button and wait a few + seconds</span> to activate the button's tooltip with a short + description.</p><p>You can adapt the toolbar to your needs. Please use the + following entry in the main menu: + </p><div class="variablelist"><dl><dt><span class="term"> + <span class="guimenu"> + <span class="inlinemediaobject"><img src="i_configuretoolbars.png"></span>Settings</span> → <span class="guimenuitem">Configure toolbars</span> + </span></dt><dd><p>Configure toolbars</p></dd></dl></div><p>Please see + <a class="link" href="">this + section</a> for detailed instructions.</p></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="hdbk-reference.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="hdbk-reference.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="hdbk-reference-hotkeys.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 5. Reference </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> HotKeys index</td></tr></table></div></body></html> diff --git a/docs/handbook/en/html/hdbk-reference.html b/docs/handbook/en/html/hdbk-reference.html new file mode 100644 index 0000000..26ac76f --- /dev/null +++ b/docs/handbook/en/html/hdbk-reference.html @@ -0,0 +1,149 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter 5. Reference</title><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"><meta name="keywords" content="QT4, bibletime, sword, crosswire, help dialog"><link rel="home" href="index.html" title="The BibleTime handbook"><link rel="up" href="index.html" title="The BibleTime handbook"><link rel="prev" href="hdbk-config.html" title="Chapter 4. Configuring BibleTime"><link rel="next" href="hdbk-reference-hotkeys.html" title="HotKeys index"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 5. Reference</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="hdbk-config.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="hdbk-reference-hotkeys.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="hdbk-reference"></a>Chapter 5. Reference</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="hdbk-reference.html#hdbk-reference-menus">Main menu reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="hdbk-reference.html#hdbk-reference-menus-file"> + File + </a></span></dt><dt><span class="sect2"><a href="hdbk-reference.html#hdbk-reference-menus-view"> + View + </a></span></dt><dt><span class="sect2"><a href="hdbk-reference.html#hdbk-reference-menus-search"> + Search + </a></span></dt><dt><span class="sect2"><a href="hdbk-reference.html#hdbk-reference-menus-window"> + Window + </a></span></dt><dt><span class="sect2"><a href="hdbk-reference.html#hdbk-reference-menus-settings"> + Settings + </a></span></dt><dt><span class="sect2"><a href="hdbk-reference.html#hdbk-reference-menus-help"> + Help + </a></span></dt></dl></dd><dt><span class="sect1"><a href="hdbk-reference-hotkeys.html">HotKeys index</a></span></dt></dl></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="hdbk-reference-menus"></a>Main menu reference</h2></div></div></div><p>In this section you can find detailed descriptions of all + entries in the main menu of <span class="application">BibleTime</span>. They are ordered in + just the way they appear in <span class="application">BibleTime</span>, with all the sub-items + listed under the major menu item they belong to. You can also see + the hotkey of each item;a complete listing of all hotkeys can be + found in + <a class="link" href="hdbk-reference-hotkeys.html" title="HotKeys index">this section</a>.</p><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="hdbk-reference-menus-file"></a> + <span class="guimenu">File</span> + </h3></div></div></div><p> + </p><div class="variablelist"><dl><dt><a name="hdbk-reference-menus-file-quit"></a><span class="term"> + <span class="guimenu"> + <span class="inlinemediaobject"><img src="i_exit.png"></span>File</span> → <span class="guimenuitem">Quit</span> (<span class="shortcut"><strong><span class="keycap"><strong>Q</strong></span></strong></span>) + </span></dt><dd><p> + <span class="action">Closes BibleTime.</span> BibleTime will ask you + if you want to write unsaved changes to disk.</p></dd></dl></div><p> + </p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="hdbk-reference-menus-view"></a> + <span class="guimenu">View</span> + </h3></div></div></div><div class="variablelist"><dl><dt><a name="hdbk-reference-menus-view-fullscreenmode"></a><span class="term"> + <span class="guimenu"> + <span class="inlinemediaobject"><img src="i_window_fullscreen.png"></span>View</span> → <span class="guimenuitem">Fullscreen mode</span> (<span class="shortcut"><strong><span class="keycap"><strong>F5</strong></span></strong></span>) + </span></dt><dd><p> + <span class="action">Toggles full screen display.</span> Toggle this + setting to maximize the <span class="application">BibleTime</span> window.</p></dd><dt><a name="hdbk-reference-menus-view-showtoolbar"></a><span class="term"> + <span class="guimenu">View</span> → <span class="guimenuitem">Show toolbar</span> (<span class="shortcut"><strong><span class="keycap"><strong>F6</strong></span></strong></span>) + </span></dt><dd><p> + <span class="action">Toggles Toolbar display.</span> Toggle this + setting to turn the main toolbar on or off.</p></dd><dt><a name="hdbk-reference-menus-view-showbookshelf"></a><span class="term"> + <span class="guimenu">View</span> → <span class="guimenuitem">Show Bookshelf</span> + </span></dt><dd><p> + <span class="action">Toggles display of the Bookshelf.</span> Toggle + this setting to turn the Bookshelf on the left pane on or + off. This can be handy if you need more space for the + Mag.</p></dd><dt><a name="hdbk-reference-menus-view-showmag"></a><span class="term"> + <span class="guimenu">View</span> → <span class="guimenuitem">Show Mag</span> + </span></dt><dd><p> + <span class="action">Toggles display of the Mag(nifying + glass).</span> Toggle this setting to turn the Mag on the + left pane on or off.</p></dd></dl></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="hdbk-reference-menus-search"></a> + <span class="guimenu">Search</span> + </h3></div></div></div><div class="variablelist"><dl><dt><a name="hdbk-reference-menus-search-defaultbible"></a><span class="term"> + <span class="guimenu"> + <span class="inlinemediaobject"><img src="i_find.png"></span>Search</span> → <span class="guimenuitem">Search in standard bible</span> (<span class="shortcut"><strong><span class="keycap"><strong>F</strong></span></strong></span>) + </span></dt><dd><p> + <span class="action">Opens the Search Dialog to search in the standard + Bible only</span>. More works can be added in the Search + Dialog.</p></dd><dt><a name="hdbk-reference-menus-search-openworks"></a><span class="term"> + <span class="guimenu"> + <span class="inlinemediaobject"><img src="i_find.png"></span>Search</span> → <span class="guimenuitem">Search in open work(s)</span> (<span class="shortcut"><strong><span class="keycap"><strong>O</strong></span></strong></span>) + </span></dt><dd><p> + <span class="action">Opens the Search Dialog to search in all open + works</span>. More works can be added in the Search + Dialog.</p></dd></dl></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="hdbk-reference-menus-window"></a> + <span class="guimenu">Window</span> + </h3></div></div></div><div class="variablelist"><dl><dt><a name="hdbk-reference-menus-window-savesession"></a><span class="term"> + <span class="guimenu"> + <span class="inlinemediaobject"><img src="i_sidetree.png"></span>Window</span> → <span class="guimenuitem">Save session</span> + </span></dt><dd><p> + <span class="action">Directly saves the current session</span>. This + will open a context menu where you can select an existing + session to save to. It will be overwritten with your + current session. See the next item on how to save to a new + session.</p></dd><dt><a name="hdbk-reference-menus-window-savenewsession"></a><span class="term"> + <span class="guimenu"> + <span class="inlinemediaobject"><img src="i_sidetree.png"></span>Window</span> → <span class="guimenuitem">Save as new Session</span> (<span class="shortcut"><strong><span class="keycap"><strong>S</strong></span></strong></span>) + </span></dt><dd><p> + <span class="action">Saves the current session under a new + name</span>. This will ask for a new name to save the + session to.</p></dd><dt><a name="hdbk-reference-menus-window-loadsession"></a><span class="term"> + <span class="guimenu"> + <span class="inlinemediaobject"><img src="i_sidetree.png"></span>Window</span> → <span class="guimenuitem">Load session</span> + </span></dt><dd><p> + <span class="action">Loads an existing session</span>. This will open + a context menu where you can select an existing session to + load.</p></dd><dt><a name="hdbk-reference-menus-window-deletesession"></a><span class="term"> + <span class="guimenu"> + <span class="inlinemediaobject"><img src="i_sidetree.png"></span>Window</span> → <span class="guimenuitem">Delete session</span> + </span></dt><dd><p> + <span class="action">Deletes an existing session</span>. This will + open a context menu where you can select an existing + session that should be deleted.</p></dd><dt><a name="hdbk-reference-menus-window-arrangement_mode"></a><span class="term"> + <span class="guimenu"> + <span class="inlinemediaobject"><img src="i_cascade_auto.png"></span>Window</span> → <span class="guimenuitem">Arrangement mode</span> + </span></dt><dd><p> + <span class="action">Controls the basic window arrangement + behaviour</span>. In the opening context menu, you can + either specify that you want to take care of the window + arrangement yourself (Manual mode) or have <span class="application">BibleTime</span> + handle it for you (Automatical modes, just try them + out!).</p></dd><dt><a name="hdbk-reference-menus-window-closeall"></a><span class="term"> + <span class="guimenu"> + <span class="inlinemediaobject"><img src="i_fileclose.png"></span>Window</span> → <span class="guimenuitem">Close all</span> (<span class="shortcut"><strong><span class="keycap"><strong>W</strong></span></strong></span>) + </span></dt><dd><p> + <span class="action">Closes all open windows</span>.</p></dd></dl></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="hdbk-reference-menus-settings"></a> + <span class="guimenu">Settings</span> + </h3></div></div></div><div class="variablelist"><dl><dt><a name="hdbk-reference-menus-settings-bibletime"></a><span class="term"> + <span class="guimenu"> + <span class="inlinemediaobject"><img src="i_configure.png"></span>Settings</span> → <span class="guimenuitem">Configure <span class="application">BibleTime</span></span> + </span></dt><dd><p> + <span class="action">Opens <span class="application">BibleTime</span>'s main configuration + dialog</span>. You can configure all kinds of nice + settings there to adapt <span class="application">BibleTime</span> to your needs. + Please see + <a class="link" href="hdbk-config.html#hdbk-config-bt" title="Configure BibleTime Dialog">this section</a> for + details.</p></dd><dt><a name="hdbk-reference-menus-settings-bookshelf_manager"></a><span class="term"> + <span class="guimenu"> + <span class="inlinemediaobject"><img src="i_configuresword.png"></span>Settings</span> → <span class="guimenuitem">Bookshelf Manager</span> (<span class="shortcut"><strong><span class="keycap"><strong>F4</strong></span></strong></span>) + </span></dt><dd><p> + <span class="action">Opens a dialog where you can change your Sword + configuration and manage your bookshelf</span>. Please + see <a class="link" href="hdbk-op-bookshelfmanager.html" title="The Bookshelf Manager">this + section</a> for details.</p></dd></dl></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="hdbk-reference-menus-help"></a> + <span class="guimenu">Help</span> + </h3></div></div></div><div class="variablelist"><dl><dt><a name="hdbk-reference-menus-help-bibletime"></a><span class="term"> + <span class="guimenu"> + <span class="inlinemediaobject"><img src="i_contents2.png"></span>Help</span> → <span class="guimenuitem">Handbook</span> (<span class="shortcut"><strong><span class="keycap"><strong>F1</strong></span></strong></span>) + </span></dt><dd><p> + <span class="action">Opens <span class="application">BibleTime</span>'s user guide</span> + You are reading it now.</p></dd><dt><a name="hdbk-reference-menus-help-bible_study_howto"></a><span class="term"> + <span class="guimenu"> + <span class="inlinemediaobject"><img src="i_contents2.png"></span>Help</span> → <span class="guimenuitem">Bible Study Howto</span> (<span class="shortcut"><strong><span class="keycap"><strong>F2</strong></span></strong></span>) + </span></dt><dd><p> + <span class="action">Opens a guide on how to study the Bible</span> + It is the hope of the <span class="application">BibleTime</span> team that this HowTo will + provoke the readers to study the scriptures to see what + they say. This particular study guide has been chosen as + it takes care not to advocate any particular + denominational doctrine. We expect you to read and study + the scriptures to understand what they say. If you start + with the attitude that you want to have the Lord sow his + word in your heart He will not disappoint you.</p></dd><dt><a name="hdbk-reference-menus-help-about"></a><span class="term"> + <span class="guimenu">Help</span> → <span class="guimenuitem">About</span> + </span></dt><dd><p> + <span class="action">Opens a window about <span class="application">BibleTime</span> project + information</span> + contains information about <span class="application">BibleTime</span> software version, + project contributors, <span class="application">Sword</span> software version, <span class="application">Qt</span> software + version and the license agreement.</p></dd></dl></div></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="hdbk-config.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="hdbk-reference-hotkeys.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 4. Configuring BibleTime </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> HotKeys index</td></tr></table></div></body></html> diff --git a/docs/handbook/en/html/hdbk-startsequence.html b/docs/handbook/en/html/hdbk-startsequence.html new file mode 100644 index 0000000..e1328f7 --- /dev/null +++ b/docs/handbook/en/html/hdbk-startsequence.html @@ -0,0 +1,19 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Startup sequence</title><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"><meta name="keywords" content="QT4, bibletime, sword, crosswire, help dialog"><link rel="home" href="index.html" title="The BibleTime handbook"><link rel="up" href="hdbk-term.html" title="Chapter 2. Starting BibleTime"><link rel="prev" href="hdbk-term.html" title="Chapter 2. Starting BibleTime"><link rel="next" href="hdbk-op.html" title="Chapter 3. Program operation"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Startup sequence</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="hdbk-term.html">Prev</a> </td><th width="60%" align="center">Chapter 2. Starting BibleTime</th><td width="20%" align="right"> <a accesskey="n" href="hdbk-op.html">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="hdbk-startsequence"></a>Startup sequence</h2></div></div></div><p>As <span class="application">BibleTime</span> launches you may see the following screens + before the main <span class="application">BibleTime</span> window opens:</p><div class="variablelist"><dl><dt><span class="term"> + <span class="interface">Bookshelf Manager</span> + </span></dt><dd><p> + <span class="action">Modifies your Bookshelf.</span> This dialog lets you + modify your Bookshelf, add or delete works from your system. + It will only be shown if no default Bookshelf can be found. + Please see + <a class="link" href="hdbk-op-bookshelfmanager.html" title="The Bookshelf Manager"> this + section</a> for further details. If you start off with an + empty Bookshelf, it will be helpful to install at least one + Bible, Commentary, Lexicon and one Book to get to know + <span class="application">BibleTime</span>'s basic features quickly.</p></dd><dt><span class="term"> + <span class="interface">Configure <span class="application">BibleTime</span> dialog</span> + </span></dt><dd><p> + <span class="action">Customizes <span class="application">BibleTime</span>.</span>This dialog lets + you adapt <span class="application">BibleTime</span> to your needs. Please see + <a class="link" href="hdbk-config.html#hdbk-config-bt" title="Configure BibleTime Dialog">the detailed + description</a> of this dialog.</p></dd></dl></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="hdbk-term.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="hdbk-term.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="hdbk-op.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 2. Starting BibleTime </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 3. Program operation</td></tr></table></div></body></html> diff --git a/docs/handbook/en/html/hdbk-term.html b/docs/handbook/en/html/hdbk-term.html new file mode 100644 index 0000000..bb6be76 --- /dev/null +++ b/docs/handbook/en/html/hdbk-term.html @@ -0,0 +1,16 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter 2. Starting BibleTime</title><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"><meta name="keywords" content="QT4, bibletime, sword, crosswire, help dialog"><link rel="home" href="index.html" title="The BibleTime handbook"><link rel="up" href="index.html" title="The BibleTime handbook"><link rel="prev" href="hdbk-intro.html" title="Chapter 1. Introduction"><link rel="next" href="hdbk-startsequence.html" title="Startup sequence"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 2. Starting BibleTime</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="hdbk-intro.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="hdbk-startsequence.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="hdbk-term"></a>Chapter 2. Starting <span class="application">BibleTime</span></h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="hdbk-term.html#hdbk-start">How to start BibleTime</a></span></dt><dd><dl><dt><span class="sect2"><a href="hdbk-term.html#hdbk-start">Starting BibleTime</a></span></dt><dt><span class="sect2"><a href="hdbk-term.html#hdbk-start-otherwm">Other window managers</a></span></dt><dt><span class="sect2"><a href="hdbk-term.html#hdbk-start-custom">Startup customization</a></span></dt></dl></dd><dt><span class="sect1"><a href="hdbk-startsequence.html">Startup sequence</a></span></dt></dl></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="hdbk-start"></a>How to start <span class="application">BibleTime</span></h2></div></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="hdbk-start"></a>Starting <span class="application">BibleTime</span></h3></div></div></div><p><span class="application">BibleTime</span> is an executable file that is integrated + with the desktop. You can launch <span class="application">BibleTime</span> from + the Start Menu with this icon: + </p><div class="mediaobject"><img src="i_bibletime.png" alt="BibleTime start icon"></div><p><span class="application">BibleTime</span> can also be launched from a terminal + command prompt. To launch <span class="application">BibleTime</span>, open a terminal window + and type: + </p><pre class="screen"><span class="application">BibleTime</span></pre></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="hdbk-start-otherwm"></a>Other window managers</h3></div></div></div><p><span class="application">BibleTime</span> can be used with other window managers such + as Gnome, BlackBox, Fluxbox, OpenBox or Sawfish, providing the + appropriate base libraries are already + installed on your computer.</p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="hdbk-start-custom"></a>Startup customization</h3></div></div></div><p>From a terminal you can use <span class="application">BibleTime</span> to open a + random verse in the default bible: + </p><pre class="screen">bibletime --open-default-bible + "<random>"</pre><p>To open at a given passage like John + 3:16, use: + </p><pre class="screen">bibletime --open-default-bible "John 3:16"</pre><p>You + can also use booknames in your current bookname language.</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="hdbk-intro.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="hdbk-startsequence.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 1. Introduction </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Startup sequence</td></tr></table></div></body></html> diff --git a/docs/handbook/en/html/i_bibletime.png b/docs/handbook/en/html/i_bibletime.png Binary files differnew file mode 100644 index 0000000..7dcbc90 --- /dev/null +++ b/docs/handbook/en/html/i_bibletime.png diff --git a/docs/handbook/en/html/i_cascade.png b/docs/handbook/en/html/i_cascade.png Binary files differnew file mode 100644 index 0000000..070f5d1 --- /dev/null +++ b/docs/handbook/en/html/i_cascade.png diff --git a/docs/handbook/en/html/i_cascade_auto.png b/docs/handbook/en/html/i_cascade_auto.png Binary files differnew file mode 100644 index 0000000..4171ffc --- /dev/null +++ b/docs/handbook/en/html/i_cascade_auto.png diff --git a/docs/handbook/en/html/i_configure.png b/docs/handbook/en/html/i_configure.png Binary files differnew file mode 100644 index 0000000..1141564 --- /dev/null +++ b/docs/handbook/en/html/i_configure.png diff --git a/docs/handbook/en/html/i_configuresword.png b/docs/handbook/en/html/i_configuresword.png Binary files differnew file mode 100644 index 0000000..b8f3d30 --- /dev/null +++ b/docs/handbook/en/html/i_configuresword.png diff --git a/docs/handbook/en/html/i_configuretoolbars.png b/docs/handbook/en/html/i_configuretoolbars.png Binary files differnew file mode 100644 index 0000000..653479b --- /dev/null +++ b/docs/handbook/en/html/i_configuretoolbars.png diff --git a/docs/handbook/en/html/i_contents2.png b/docs/handbook/en/html/i_contents2.png Binary files differnew file mode 100644 index 0000000..6f4723c --- /dev/null +++ b/docs/handbook/en/html/i_contents2.png diff --git a/docs/handbook/en/html/i_exit.png b/docs/handbook/en/html/i_exit.png Binary files differnew file mode 100644 index 0000000..4877f19 --- /dev/null +++ b/docs/handbook/en/html/i_exit.png diff --git a/docs/handbook/en/html/i_fileclose.png b/docs/handbook/en/html/i_fileclose.png Binary files differnew file mode 100644 index 0000000..8acc84d --- /dev/null +++ b/docs/handbook/en/html/i_fileclose.png diff --git a/docs/handbook/en/html/i_find.png b/docs/handbook/en/html/i_find.png Binary files differnew file mode 100644 index 0000000..de88913 --- /dev/null +++ b/docs/handbook/en/html/i_find.png diff --git a/docs/handbook/en/html/i_fullscreen.png b/docs/handbook/en/html/i_fullscreen.png Binary files differnew file mode 100644 index 0000000..5c9864f --- /dev/null +++ b/docs/handbook/en/html/i_fullscreen.png diff --git a/docs/handbook/en/html/i_sidetree.png b/docs/handbook/en/html/i_sidetree.png Binary files differnew file mode 100644 index 0000000..2970a1c --- /dev/null +++ b/docs/handbook/en/html/i_sidetree.png diff --git a/docs/handbook/en/html/i_tile.png b/docs/handbook/en/html/i_tile.png Binary files differnew file mode 100644 index 0000000..3cab67e --- /dev/null +++ b/docs/handbook/en/html/i_tile.png diff --git a/docs/handbook/en/html/i_view_index.png b/docs/handbook/en/html/i_view_index.png Binary files differnew file mode 100644 index 0000000..a23418b --- /dev/null +++ b/docs/handbook/en/html/i_view_index.png diff --git a/docs/handbook/en/html/i_view_mag.png b/docs/handbook/en/html/i_view_mag.png Binary files differnew file mode 100644 index 0000000..6c9ca5e --- /dev/null +++ b/docs/handbook/en/html/i_view_mag.png diff --git a/docs/handbook/en/html/i_window_fullscreen.png b/docs/handbook/en/html/i_window_fullscreen.png Binary files differnew file mode 100644 index 0000000..3d6b7ef --- /dev/null +++ b/docs/handbook/en/html/i_window_fullscreen.png diff --git a/docs/handbook/en/html/index.html b/docs/handbook/en/html/index.html new file mode 100644 index 0000000..69bda1f --- /dev/null +++ b/docs/handbook/en/html/index.html @@ -0,0 +1,24 @@ +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>The BibleTime handbook</title><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"><meta name="description" content="BibleTime is a Bible study tool based on the Sword framework."><meta name="keywords" content="QT4, bibletime, sword, crosswire, help dialog"><link rel="home" href="index.html" title="The BibleTime handbook"><link rel="next" href="hdbk-intro.html" title="Chapter 1. Introduction"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">The BibleTime handbook</th></tr><tr><td width="20%" align="left"> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="hdbk-intro.html">Next</a></td></tr></table><hr></div><div class="book" lang="en"><div class="titlepage"><div><div><h1 class="title"><a name="id11527980"></a>The <span class="application">BibleTime</span> handbook</h1></div><div><div class="authorgroup"><div class="author"><h3 class="author"><span class="firstname">Fred</span> <span class="surname">Saalbach</span></h3></div><div class="author"><h3 class="author"><span class="firstname">Jeffrey</span> <span class="surname">Hoyt</span></h3></div><div class="author"><h3 class="author"><span class="firstname">Martin</span> <span class="surname">Gruner</span></h3></div><div class="author"><h3 class="author"><span class="firstname">Thomas</span> <span class="surname">Abthorpe</span></h3></div></div></div><div><p class="releaseinfo">2.0</p></div><div><p class="copyright">Copyright © 1999-2009 the <span class="application">BibleTime</span> team</p></div><div><div class="legalnotice"><a name="id11545565"></a><p>The <span class="application">BibleTime</span> handbook is part of + <span class="application">BibleTime</span>.</p></div></div><div><div class="abstract"><p class="title"><b>Abstract</b></p><p><span class="application">BibleTime</span> is a Bible study tool based on the Sword + framework.</p></div></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="hdbk-intro.html">1. Introduction</a></span></dt><dd><dl><dt><span class="sect1"><a href="hdbk-intro.html#hdbk-intro-about">About BibleTime</a></span></dt><dd><dl><dt><span class="sect2"><a href="hdbk-intro.html#hdbk-intro-works">Available works</a></span></dt><dt><span class="sect2"><a href="hdbk-intro.html#hdbk-intro-motivation">Motivation</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="hdbk-term.html">2. Starting BibleTime</a></span></dt><dd><dl><dt><span class="sect1"><a href="hdbk-term.html#hdbk-start">How to start BibleTime</a></span></dt><dd><dl><dt><span class="sect2"><a href="hdbk-term.html#hdbk-start">Starting BibleTime</a></span></dt><dt><span class="sect2"><a href="hdbk-term.html#hdbk-start-otherwm">Other window managers</a></span></dt><dt><span class="sect2"><a href="hdbk-term.html#hdbk-start-custom">Startup customization</a></span></dt></dl></dd><dt><span class="sect1"><a href="hdbk-startsequence.html">Startup sequence</a></span></dt></dl></dd><dt><span class="chapter"><a href="hdbk-op.html">3. Program operation</a></span></dt><dd><dl><dt><span class="sect1"><a href="hdbk-op.html#hdbk-op-overview">Program overview</a></span></dt><dt><span class="sect1"><a href="hdbk-op-parts.html">Parts of the BibleTime application window</a></span></dt><dd><dl><dt><span class="sect2"><a href="hdbk-op-parts.html#hdbk-op-parts-bookshelf">The Bookshelf</a></span></dt><dt><span class="sect2"><a href="hdbk-op-parts.html#hdbk-op-parts-mag">The Mag(nifying glass)</a></span></dt><dt><span class="sect2"><a href="hdbk-op-parts.html#hdbk-op-parts-desk">The Desk</a></span></dt></dl></dd><dt><span class="sect1"><a href="hdbk-op-search.html">Searching in works</a></span></dt><dd><dl><dt><span class="sect2"><a href="hdbk-op-search.html#hdbk-op-search-intext">Searching text in an open read window</a></span></dt><dt><span class="sect2"><a href="hdbk-op-search.html#hdbk-op-search-access">Accessing the search dialog</a></span></dt><dt><span class="sect2"><a href="hdbk-op-search.html#hdbk-op-search-config">Search configuration</a></span></dt><dt><span class="sect2"><a href="hdbk-op-search.html#hdbk-op-search-results">Search results</a></span></dt></dl></dd><dt><span class="sect1"><a href="hdbk-op-bookshelfmanager.html">The + Bookshelf Manager</a></span></dt><dd><dl><dt><span class="sect2"><a href="hdbk-op-bookshelfmanager.html#hdbk-op-bookshelfmanager-path">Bookshelf path(s) setup</a></span></dt><dt><span class="sect2"><a href="hdbk-op-bookshelfmanager.html#hdbk-op-bookshelfmanager-installupdate">Install/update work(s)</a></span></dt><dt><span class="sect2"><a href="hdbk-op-bookshelfmanager.html#hdbk-op-bookshelfmanager-remove">Remove work(s)</a></span></dt><dt><span class="sect2"><a href="hdbk-op-bookshelfmanager.html#hdbk-op-bookshelfmanager-searchindexes">Search Indexes</a></span></dt></dl></dd><dt><span class="sect1"><a href="hdbk-op-output.html">Exporting and Printing</a></span></dt></dl></dd><dt><span class="chapter"><a href="hdbk-config.html">4. Configuring BibleTime</a></span></dt><dd><dl><dt><span class="sect1"><a href="hdbk-config.html#hdbk-config-bt">Configure BibleTime Dialog</a></span></dt><dd><dl><dt><span class="sect2"><a href="hdbk-config.html#hdbk-config-bt-display"> + Display + </a></span></dt><dt><span class="sect2"><a href="hdbk-config.html#hdbk-config-bt-languages"> + Languages + </a></span></dt><dt><span class="sect2"><a href="hdbk-config.html#hdbk-config-bt-desk"> + Desk + </a></span></dt><dt><span class="sect2"><a href="hdbk-config.html#hdbk-config-bt-hotkeys"> + HotKeys + </a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="hdbk-reference.html">5. Reference</a></span></dt><dd><dl><dt><span class="sect1"><a href="hdbk-reference.html#hdbk-reference-menus">Main menu reference</a></span></dt><dd><dl><dt><span class="sect2"><a href="hdbk-reference.html#hdbk-reference-menus-file"> + File + </a></span></dt><dt><span class="sect2"><a href="hdbk-reference.html#hdbk-reference-menus-view"> + View + </a></span></dt><dt><span class="sect2"><a href="hdbk-reference.html#hdbk-reference-menus-search"> + Search + </a></span></dt><dt><span class="sect2"><a href="hdbk-reference.html#hdbk-reference-menus-window"> + Window + </a></span></dt><dt><span class="sect2"><a href="hdbk-reference.html#hdbk-reference-menus-settings"> + Settings + </a></span></dt><dt><span class="sect2"><a href="hdbk-reference.html#hdbk-reference-menus-help"> + Help + </a></span></dt></dl></dd><dt><span class="sect1"><a href="hdbk-reference-hotkeys.html">HotKeys index</a></span></dt></dl></dd></dl></div><div class="list-of-tables"><p><b>List of Tables</b></p><dl><dt>3.1. <a href="hdbk-op-search.html#hd-op-search-config-syntax-table">Search Types</a></dt><dt>4.1. <a href="hdbk-config.html#hdbk-config-unicode-fonts-table">Unicode Fonts</a></dt></dl></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="hdbk-intro.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"> </td><td width="40%" align="right" valign="top"> Chapter 1. Introduction</td></tr></table></div></body></html> diff --git a/docs/handbook/en/html/ss_configfonts.png b/docs/handbook/en/html/ss_configfonts.png Binary files differnew file mode 100644 index 0000000..02c8823 --- /dev/null +++ b/docs/handbook/en/html/ss_configfonts.png diff --git a/docs/handbook/en/html/ss_mainterms.png b/docs/handbook/en/html/ss_mainterms.png Binary files differnew file mode 100644 index 0000000..7d0ed9e --- /dev/null +++ b/docs/handbook/en/html/ss_mainterms.png diff --git a/docs/handbook/en/html/ss_searchanal.png b/docs/handbook/en/html/ss_searchanal.png Binary files differnew file mode 100644 index 0000000..e091c63 --- /dev/null +++ b/docs/handbook/en/html/ss_searchanal.png diff --git a/docs/handbook/en/html/ss_searchopts.png b/docs/handbook/en/html/ss_searchopts.png Binary files differnew file mode 100644 index 0000000..903713a --- /dev/null +++ b/docs/handbook/en/html/ss_searchopts.png |