diff options
Diffstat (limited to 'docs/handbook/unicode')
| -rw-r--r-- | docs/handbook/unicode/Makefile.am | 31 | ||||
| -rw-r--r-- | docs/handbook/unicode/hdbk-config.docbook | 182 | ||||
| -rw-r--r-- | docs/handbook/unicode/hdbk-intro.docbook | 93 | ||||
| -rw-r--r-- | docs/handbook/unicode/hdbk-operation.docbook | 260 | ||||
| -rw-r--r-- | docs/handbook/unicode/hdbk-reference.docbook | 480 | ||||
| -rw-r--r-- | docs/handbook/unicode/hdbk-start.docbook | 93 | ||||
| -rw-r--r-- | docs/handbook/unicode/index.docbook | 89 |
7 files changed, 1228 insertions, 0 deletions
diff --git a/docs/handbook/unicode/Makefile.am b/docs/handbook/unicode/Makefile.am new file mode 100644 index 0000000..ff6497b --- /dev/null +++ b/docs/handbook/unicode/Makefile.am @@ -0,0 +1,31 @@ +# this Makefile.am was automatically generated by bibletime/maintenance/gen_am.sh +# please do not edit this file but rather run the script to update + + +KDE_OPTIONS = noautodist +EXTRA_DIST = hdbk-config.docbook hdbk-intro.docbook hdbk-operation.docbook hdbk-reference.docbook hdbk-start.docbook index.docbook + + +install-data-local: + mkdir -p $(DESTDIR)$(kde_htmldir)/en/bibletime/handbook/; + chmod -R a+r+X $(DESTDIR)$(kde_htmldir)/en/bibletime; + $(INSTALL_DATA) $(srcdir)/hdbk-config.docbook $(DESTDIR)$(kde_htmldir)/en/bibletime/handbook; + chmod a+r $(DESTDIR)$(kde_htmldir)/en/bibletime/handbook/hdbk-config.docbook; + $(INSTALL_DATA) $(srcdir)/hdbk-intro.docbook $(DESTDIR)$(kde_htmldir)/en/bibletime/handbook; + chmod a+r $(DESTDIR)$(kde_htmldir)/en/bibletime/handbook/hdbk-intro.docbook; + $(INSTALL_DATA) $(srcdir)/hdbk-operation.docbook $(DESTDIR)$(kde_htmldir)/en/bibletime/handbook; + chmod a+r $(DESTDIR)$(kde_htmldir)/en/bibletime/handbook/hdbk-operation.docbook; + $(INSTALL_DATA) $(srcdir)/hdbk-reference.docbook $(DESTDIR)$(kde_htmldir)/en/bibletime/handbook; + chmod a+r $(DESTDIR)$(kde_htmldir)/en/bibletime/handbook/hdbk-reference.docbook; + $(INSTALL_DATA) $(srcdir)/hdbk-start.docbook $(DESTDIR)$(kde_htmldir)/en/bibletime/handbook; + chmod a+r $(DESTDIR)$(kde_htmldir)/en/bibletime/handbook/hdbk-start.docbook; + $(INSTALL_DATA) $(srcdir)/index.docbook $(DESTDIR)$(kde_htmldir)/en/bibletime/handbook; + chmod a+r $(DESTDIR)$(kde_htmldir)/en/bibletime/handbook/index.docbook; + +uninstall-local: + rm -f $(DESTDIR)$(kde_htmldir)/en/bibletime/handbook/hdbk-config.docbook; + rm -f $(DESTDIR)$(kde_htmldir)/en/bibletime/handbook/hdbk-intro.docbook; + rm -f $(DESTDIR)$(kde_htmldir)/en/bibletime/handbook/hdbk-operation.docbook; + rm -f $(DESTDIR)$(kde_htmldir)/en/bibletime/handbook/hdbk-reference.docbook; + rm -f $(DESTDIR)$(kde_htmldir)/en/bibletime/handbook/hdbk-start.docbook; + rm -f $(DESTDIR)$(kde_htmldir)/en/bibletime/handbook/index.docbook; diff --git a/docs/handbook/unicode/hdbk-config.docbook b/docs/handbook/unicode/hdbk-config.docbook new file mode 100644 index 0000000..94a037e --- /dev/null +++ b/docs/handbook/unicode/hdbk-config.docbook @@ -0,0 +1,182 @@ +<chapter id="hdbk-config"><title>Configuring &bibletime;</title> + +<para>In this section you find a description of the different possibilities +to configure &bibletime;: The <link linkend="hdbk-config-bt">Configure BibleTime Dialog +</link> and the <link linkend="hdbk-config-toolbar">Configure Toolbars</link> +dialog. Both can be accessed 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 tip of the day</para></listitem> + <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 &kde; general display font which can + be specified in the &kcontrolcenter;. You can override this font if neccessary. + 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 fonts supported by KDE/QT. + 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 + KDE 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 &kde; 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. + &kde;'s <ulink url="help:/kcontrol/index.html">KControl Center</ulink> contains + an excellent and easy to use font installation module. + Please read <ulink url="help:/kcontrol/kcmfontinst/index.html"> + its documentation</ulink>. For further information you might want to refer to the + <ulink url="http://www.ibiblio.org/pub/Linux/docs/HOWTO/other-formats/html_single/Unicode-HOWTO.html#toc4"> + 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 Linux 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> + <title>Unicode Fonts</title> + <tgroup cols="2"> + <tbody> + + <row><entry><ulink url="http://home.att.net/~jameskass/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://bibliofile.mc.duke.edu/gww/fonts/Unicode.html">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 + crossreferences 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> + + + <sect1 id="hdbk-config-toolbar"><title>Configure Toolbars dialog</title> + <para>You can adapt the toolbar to your needs. Please use the following entry in the main menu: + <variablelist> + <varlistentry> + <term><menuchoice> + <guimenu> + <inlinemediaobject><imageobject> + <imagedata fileref="i_configuretoolbars.png" format="PNG"/></imageobject> + </inlinemediaobject>Settings + </guimenu> + <guimenuitem>Configure toolbars</guimenuitem></menuchoice></term> + <listitem><para>Configure toolbars</para></listitem> + </varlistentry> + </variablelist> + </para> + <para>You will see this dialog, which allows adding and removing buttons from + the main toolbar of &bibletime;. The order of the buttons can also be changed. + </para> + <mediaobject> + <imageobject> + <imagedata fileref="ss_configtoolbar.png" format="PNG"/> + </imageobject> + <textobject><phrase>Toolbar configuration dialog</phrase></textobject> + <caption><para>The Toolbar configuration dialog.</para></caption> + </mediaobject> + <para>Use the 4 buttons in the middle of the window to move buttons to the toolbar, + away from the toolbar or to sort them on the toolbar according to your preference. + </para> + <para>Please see <link linkend="hdbk-reference-menus-settings-toolbars">this section</link> for further information.</para> + </sect1> + +</chapter> diff --git a/docs/handbook/unicode/hdbk-intro.docbook b/docs/handbook/unicode/hdbk-intro.docbook new file mode 100644 index 0000000..811363d --- /dev/null +++ b/docs/handbook/unicode/hdbk-intro.docbook @@ -0,0 +1,93 @@ +<chapter id="hdbk-intro"><title>Introduction</title> + +<sect1 id="hdbk-intro-about"><title>About BibleTime</title> + <para> + &bibletime; is a powerful Bible study tool written for the &kde; environment on the + Linux operating system. It is based 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 Encyclopedia. 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/unicode/hdbk-operation.docbook b/docs/handbook/unicode/hdbk-operation.docbook new file mode 100644 index 0000000..46ad308 --- /dev/null +++ b/docs/handbook/unicode/hdbk-operation.docbook @@ -0,0 +1,260 @@ +<chapter id="hdbk-op"><title>Program operation</title> + +<sect1 id="hdbk-op-overview"> +<title>Program overview</title> + +<para>This is how 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><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/queryparsersyntax.html">http://lucene.apache.org/java/docs/queryparsersyntax.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 harddrive. 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 harddisk, 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> + +</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/unicode/hdbk-reference.docbook b/docs/handbook/unicode/hdbk-reference.docbook new file mode 100644 index 0000000..f23872b --- /dev/null +++ b/docs/handbook/unicode/hdbk-reference.docbook @@ -0,0 +1,480 @@ +<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-showtoolbar"> + <term><menuchoice> + <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> + <shortcut><keycombo action="simul"><keycap>F9</keycap></keycombo></shortcut> + <guimenu> <inlinemediaobject><imageobject> + <imagedata fileref="i_sidetree.png" format="PNG"/></imageobject></inlinemediaobject> + 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> + <shortcut><keycombo action="simul"><keycap>F8</keycap></keycombo></shortcut> + <guimenu> <inlinemediaobject><imageobject> + <imagedata fileref="i_sidetree.png" format="PNG"/></imageobject></inlinemediaobject> + 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-fullscreen"> + <term><menuchoice> + <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>F</keycap></keycombo></shortcut> + <guimenu> <inlinemediaobject><imageobject> + <imagedata fileref="i_fullscreen.png" format="PNG"/></imageobject></inlinemediaobject> + Window</guimenu> <guimenuitem>Fullscreen Mode</guimenuitem></menuchoice></term> + <listitem><para><action>Toggles fullscreen mode</action>. + Here you can turn fullscreen mode on or off. In fullscreen mode, &bibletime; will expand to the full size + of your monitor screen, using as much space as possible.</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-tile-vertically"> + <term><menuchoice> + <shortcut><keycombo action="simul">&Ctrl;<keycap>G</keycap></keycombo></shortcut> + <guimenu> <inlinemediaobject><imageobject> + <imagedata fileref="i_tile.png" format="PNG"/></imageobject></inlinemediaobject> + Window</guimenu> <guimenuitem>Tile vertically</guimenuitem></menuchoice></term> + <listitem><para><action>Tiles all open read windows vertically</action>.</para></listitem> + </varlistentry> + + <varlistentry id="hdbk-reference-menus-window-tile-horizontally"> + <term><menuchoice> + <shortcut><keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo></shortcut> + <guimenu> <inlinemediaobject><imageobject> + <imagedata fileref="i_tile.png" format="PNG"/></imageobject></inlinemediaobject> + Window</guimenu> <guimenuitem>Tile horizontally</guimenuitem></menuchoice></term> + <listitem><para><action>Tiles all open windows horizontally</action>.</para></listitem> + </varlistentry> + + <varlistentry id="hdbk-reference-menus-window-cascade"> + <term><menuchoice> + <shortcut><keycombo action="simul">&Ctrl;<keycap>J</keycap></keycombo></shortcut> + <guimenu> <inlinemediaobject><imageobject> + <imagedata fileref="i_cascade.png" format="PNG"/></imageobject></inlinemediaobject> + Window</guimenu> <guimenuitem>Cascade</guimenuitem></menuchoice></term> + <listitem><para><action>Cascades all open windows</action>.</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-toolbars"> + <term><menuchoice> + <guimenu> <inlinemediaobject><imageobject> + <imagedata fileref="i_configuretoolbars.png" format="PNG"/></imageobject></inlinemediaobject> + Settings</guimenu> <guimenuitem>Configure toolbars</guimenuitem></menuchoice></term> + <listitem><para><action>Opens a dialog where you can customize &bibletime;'s toolbar</action>. + Just try it out, you can move around the toolbar buttons and even add new ones. Most of the entries available from + the main menu can be put on the toolbar as buttons. If you need a certain feature often, you might want to + put a button on the main menu, so that you can access it with only one click. Please see <link linkend="hdbk-config-toolbar">this section</link> for further information.</para></listitem> + </varlistentry> + + <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> + + &help.menu.documentation; + + </sect2> + +</sect1> + +<sect1 id="hdbk-reference-toolbar"><title>Toolbar reference</title> + + <para>Please review <link linkend="hdbk-reference-menus">the preceding section</link> + for an explanation of the buttons that you find on the toolbar. You can also + <action>move the cursor over a button and wait a few seconds</action> to activate + the button's tooltip with a short description.</para> + <para>You can adapt the toolbar to your needs. Please use the following entry in the main menu: + <variablelist> + <varlistentry> + <term><menuchoice> + <guimenu> <inlinemediaobject><imageobject> + <imagedata fileref="i_configuretoolbars.png" format="PNG"/></imageobject></inlinemediaobject> + Settings</guimenu> <guimenuitem>Configure toolbars</guimenuitem></menuchoice></term> + <listitem><para>Configure toolbars</para></listitem> + </varlistentry> + </variablelist> + Please see <link linkend="hdbk-reference-menus-settings-toolbars">this section</link> for detailed instructions. + </para> + +</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 itelf +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>J</keycap> </keycombo></entry> + <entry><link linkend="hdbk-reference-menus-window-cascade"><menuchoice> + <guimenu>Window</guimenu> + <guimenuitem>Cascade</guimenuitem></menuchoice></link> equivalent; + cascades all open windows.</entry> +</row> +<row> + <entry><keycombo action="simul">&Ctrl;<keycap>G</keycap> </keycombo></entry> + <entry><link linkend="hdbk-reference-menus-window-tile-vertically"><menuchoice> + <guimenu>Window</guimenu> + <guimenuitem>Tile vertically</guimenuitem></menuchoice></link> equivalent; + tiles all open windows vertically.</entry> +</row> +<row> + <entry><keycombo action="simul">&Ctrl;<keycap>H</keycap> </keycombo></entry> + <entry><link linkend="hdbk-reference-menus-window-tile-horizontally"><menuchoice> + <guimenu>Window</guimenu> + <guimenuitem>Tile horizontally</guimenuitem></menuchoice></link> equivalent; + tiles all open windows horizontally.</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">&Ctrl;<keycap>X</keycap> </keycombo></entry> + <entry>Moves a bible or commentary read window to the next chapter.</entry> +</row> +<row> + <entry><keycombo action="simul">&Ctrl;<keycap>Y</keycap> </keycombo></entry> + <entry>Moves a bible or commentary read window to the next book.</entry> +</row> +<row> + <entry><keycombo action="simul">&Ctrl;<keycap>V</keycap> </keycombo></entry> + <entry>Moves a read window to the next verse or entry.</entry> +</row> + + +<row> + <entry><keycombo action="simul">&Ctrl;&Shift;<keycap>F</keycap> </keycombo></entry> + <entry><link linkend="hdbk-reference-menus-window-fullscreen"><menuchoice> + <guimenu>Window</guimenu> + <guimenuitem>Fullscreen mode</guimenuitem></menuchoice></link> equivalent; + toggles fullscreen mode.</entry> +</row> +<row> + <entry><keycombo action="simul">&Ctrl;&Shift;<keycap>X</keycap> </keycombo></entry> + <entry>Moves a bible or commentary read window to the previous chapter.</entry> +</row> +<row> + <entry><keycombo action="simul">&Ctrl;&Shift;<keycap>Y</keycap> </keycombo></entry> + <entry>Moves a bible or commentary read window to the previous book.</entry> +</row> +<row> + <entry><keycombo action="simul">&Ctrl;&Shift;<keycap>V</keycap> </keycombo></entry> + <entry>Moves a read window to the previous verse or entry.</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>F3</keycap> </keycombo></entry> + <entry><menuchoice> + <guimenu>Help</guimenu> + <guimenuitem>Daily tip</guimenuitem></menuchoice> equivalent; + opens the tip of the day.</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/unicode/hdbk-start.docbook b/docs/handbook/unicode/hdbk-start.docbook new file mode 100644 index 0000000..0630959 --- /dev/null +++ b/docs/handbook/unicode/hdbk-start.docbook @@ -0,0 +1,93 @@ +<chapter id="hdbk-term"><title>Starting &bibletime;</title> + +<sect1 id="hdbk-start"><title>How to start &bibletime;</title> + + <sect2 id="hdbk-start-kde"><title>Starting &bibletime; from KDE</title> + + <para> &bibletime; is a &kde; program and is integrated with the &kde; desktop. + You can launch &bibletime; from the &kde; Start Menu in + the Applications group 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 or Sawfish, + providing &kde; is already installed on your computer. If your &kde; is installed + in /opt/kde, then the start-up command in a terminal would be:</para> + +<screen> +export KDEDIR=/opt/kde #your KDE directory +bibletime +</screen> + + </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> + + <varlistentry> + <term><interface>Tip of the Day</interface></term> + <listitem><para>These nifty little tips give you helpful hints for working + more efficiently with &bibletime;, and also a few quotations from the Bible. + </para></listitem> + </varlistentry> + + </variablelist> + +</sect1> + +</chapter> + diff --git a/docs/handbook/unicode/index.docbook b/docs/handbook/unicode/index.docbook new file mode 100644 index 0000000..8bef1b4 --- /dev/null +++ b/docs/handbook/unicode/index.docbook @@ -0,0 +1,89 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.1-Based Variant V1.0//EN" "dtd/kdex.dtd" [ + <!ENTITY bibletime '<application>BibleTime</application>'> + <!ENTITY sword '<application>Sword</application>'> + <!--<!ENTITY % addindex "IGNORE"> --> + <!ENTITY % English "INCLUDE"><!-- change language only here --> + + <!-- user entities --> + <!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 lang="&language;"> + +<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> + +</authorgroup> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +<copyright> + <year>1999-2005</year> + <holder>the &bibletime; team</holder> +</copyright> + +<legalnotice> + <para> + The &bibletime; handbook is part of &bibletime;. + </para> +</legalnotice> + +<date>2005-07</date> +<releaseinfo>1.5</releaseinfo> + +<abstract> +<para> + &bibletime; is a powerful Bible study tool for &kde;. +</para> +</abstract> + +<keywordset> +<keyword>KDE</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: +--> |