diff options
Diffstat (limited to 'docs/handbook/en/docbook')
| -rw-r--r-- | docs/handbook/en/docbook/hdbk-config.docbook | 65 | ||||
| -rw-r--r-- | docs/handbook/en/docbook/hdbk-intro.docbook | 29 | ||||
| -rw-r--r-- | docs/handbook/en/docbook/hdbk-operation.docbook | 72 | ||||
| -rw-r--r-- | docs/handbook/en/docbook/hdbk-reference.docbook | 22 | ||||
| -rw-r--r-- | docs/handbook/en/docbook/hdbk-start.docbook | 25 | ||||
| -rw-r--r-- | docs/handbook/en/docbook/index.docbook | 11 |
6 files changed, 129 insertions, 95 deletions
diff --git a/docs/handbook/en/docbook/hdbk-config.docbook b/docs/handbook/en/docbook/hdbk-config.docbook index 81f9bed..a829ace 100644 --- a/docs/handbook/en/docbook/hdbk-config.docbook +++ b/docs/handbook/en/docbook/hdbk-config.docbook @@ -12,6 +12,7 @@ <guimenu>Settings</guimenu> </menuchoice> <guimenuitem>Configure &bibletime;</guimenuitem>.</para> + <sect2 id="hdbk-config-bt-display"> <title> <guimenu>Display</guimenu> @@ -27,6 +28,23 @@ 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-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 them, the Mag will show the content of the verses + referred to, according to the standard Bible you + specified. With the use of text filters, you can control the + appearance of the text.</para> + </sect2> + <sect2 id="hdbk-config-bt-languages"> <title> <guimenu>Languages</guimenu> @@ -139,8 +157,9 @@ <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> + + <entry>Several fonts available from the &cbs; + FTP site.</entry> </row> <row> <entry> @@ -177,31 +196,27 @@ 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 them, 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"> + + <sect2 id="hdbk-config-bt-shortcuts"> <title> - <guimenu>HotKeys</guimenu> + <guimenu>Shortcuts</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> + + <para>Shortcuts (previously known as 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 Shortcuts (see + <link linkend="hdbk-reference-shortcuts">this section</link> for a + complete listing). Most of &bibletime;'s commands can be + assigned Shortcuts. This is very helpful to quickly access the + functions that you need the most.</para> + + <imageobject> + <imagedata fileref="ss_shortcuts.png" format="PNG" /> + </imageobject> + + <para>In the preceding example, F2, Bible Study Howto has a + secondary shortcut defined, CTRL+2.</para> </sect2> </sect1> </chapter> diff --git a/docs/handbook/en/docbook/hdbk-intro.docbook b/docs/handbook/en/docbook/hdbk-intro.docbook index ce72462..3cb1b99 100644 --- a/docs/handbook/en/docbook/hdbk-intro.docbook +++ b/docs/handbook/en/docbook/hdbk-intro.docbook @@ -2,27 +2,26 @@ <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> + 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">&cbs;</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> + 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, &cbs;.</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: + <ulink url="http://www.crosswire.org">&cbs;</ulink>. + These include: <variablelist> <varlistentry> <term>Bibles</term> @@ -33,7 +32,7 @@ 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> + the &sword; project.</para> </listitem> </varlistentry> <varlistentry> diff --git a/docs/handbook/en/docbook/hdbk-operation.docbook b/docs/handbook/en/docbook/hdbk-operation.docbook index abf7062..7ab4ec9 100644 --- a/docs/handbook/en/docbook/hdbk-operation.docbook +++ b/docs/handbook/en/docbook/hdbk-operation.docbook @@ -71,7 +71,7 @@ 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 + this page</ulink> on the &cbs; web site.</para> </sect3> @@ -168,11 +168,11 @@ <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> + Bible, you have install a certain work from the library of the + <ulink url="http://www.crosswire.org">&cbs;</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 @@ -211,7 +211,7 @@ 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 + <guimenuitem>Find...</guimenuitem>, or by using the shortcut <keycombo action="simul"> <keycap>&Ctrl;F</keycap></keycombo>. Read on to learn how you can search in entire works.</para> @@ -266,57 +266,79 @@ 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>Enter the search phrase separated by spaces. By default the + search function will return results that match all the + words. If you want to find any of the words entered, select + the <guimenu>Some words</guimenu> button. If you want to + perform a more complex search, select the + <guimenu>Free</guimenu> button. You can see examples of + searches by clicking on <guimenu>full syntax</guimenu>. + </para> + + <para>You can use wildcards: '*' matches any number of + characters, while '?' will match 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> + type followed by ':', and then the search term. Refer to the + table below for examples.</para> + <para>Available text types: <table id="hd-op-search-config-syntax-table"> <title>Search Types</title> - <tgroup cols="2"> + <tgroup cols="3"> <thead> <row> <entry>Prefix</entry> <entry>Meaning</entry> + <entry>Example</entry> </row> </thead> <tbody> <row> <entry>heading:</entry> <entry>searches headings</entry> + <entry>heading:Jesus</entry> </row> <row> <entry>footnote:</entry> <entry>searches footnotes</entry> + <entry>footnote:Moses</entry> </row> <row> <entry>strong:</entry> <entry>searches Strong's Numbers</entry> + <entry>strong:G535</entry> </row> <row> <entry>morph:</entry> <entry>searches morphology codes</entry> + <entry>morph:N-GSM</entry> </row> </tbody> </tgroup> </table></para> + + <tip> + <para>You can right click on an installed work and select + <guimenu>About</guimenu> to find which of the above search + criteria may work for you. Not all works have the + built in features for performing this type of search.</para> + </tip> + <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> + 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 @@ -387,9 +409,9 @@ <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 + 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> diff --git a/docs/handbook/en/docbook/hdbk-reference.docbook b/docs/handbook/en/docbook/hdbk-reference.docbook index 1ee4cc9..111fba9 100644 --- a/docs/handbook/en/docbook/hdbk-reference.docbook +++ b/docs/handbook/en/docbook/hdbk-reference.docbook @@ -6,9 +6,9 @@ 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 + the shortcut of each item;a complete listing of all shortcuts can be found in - <link linkend="hdbk-reference-hotkeys">this section</link>.</para> + <link linkend="hdbk-reference-shortcuts">this section</link>.</para> <sect2 id="hdbk-reference-menus-file"> <title> <guimenu>File</guimenu> @@ -435,7 +435,7 @@ </term> <listitem> <para> - <action>Opens a dialog where you can change your Sword + <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> @@ -811,22 +811,22 @@ </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 + <sect1 id="hdbk-reference-shortcuts"> + <title>Shortcuts index</title> + <para>This is index of all shortcuts and their corresponding + description in the handbook. The shortcuts are sorted (roughly) + alphabetical. If you want to directly find out which shortcuts 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 + &bibletime; (as it always shows the shortcut), 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="shortcut" /> <colspec colname="desc" /> <thead> <row> - <entry>Hotkey</entry> + <entry>Shortcut</entry> <entry>Description</entry> </row> </thead> diff --git a/docs/handbook/en/docbook/hdbk-start.docbook b/docs/handbook/en/docbook/hdbk-start.docbook index 111985d..77cc67d 100644 --- a/docs/handbook/en/docbook/hdbk-start.docbook +++ b/docs/handbook/en/docbook/hdbk-start.docbook @@ -1,7 +1,9 @@ <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 @@ -15,29 +17,24 @@ <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> + <screen>bibletime</screen></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> + 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 diff --git a/docs/handbook/en/docbook/index.docbook b/docs/handbook/en/docbook/index.docbook index 7671567..5eb8415 100644 --- a/docs/handbook/en/docbook/index.docbook +++ b/docs/handbook/en/docbook/index.docbook @@ -4,6 +4,7 @@ [ <!ENTITY bibletime '<application>BibleTime</application>'> <!ENTITY sword '<application>Sword</application>'> + <!ENTITY cbs '<application>Crosswire Bible Society</application>'> <!ENTITY kde '<application>KDE</application>'> <!ENTITY qt '<application>Qt</application>'> @@ -47,14 +48,14 @@ <para>The &bibletime; handbook is part of &bibletime;.</para> </legalnotice> - <date>2009-09</date> - <releaseinfo>2.3</releaseinfo> + <date>2009-10</date> + <releaseinfo>2.4</releaseinfo> <abstract> - <para>&bibletime; is a Bible study tool based on the Sword - framework.</para> + <para>&bibletime; is a Bible study tool based on the &sword; + framework.</para> </abstract> <keywordset> - <keyword>QT4</keyword> + <keyword>Qt4</keyword> <keyword>bibletime</keyword> <keyword>sword</keyword> <keyword>crosswire</keyword> |