diff options
| author | Unit 193 <unit193@ubuntu.com> | 2015-03-19 21:18:06 -0400 |
|---|---|---|
| committer | Unit 193 <unit193@ubuntu.com> | 2015-03-19 21:18:06 -0400 |
| commit | 1809e0b34ae5219974c45d9d55553a13f370f972 (patch) | |
| tree | b0a9c4982ef8196903dce699a061f4f39680195f /help/C | |
| parent | 3a4503409225e77cdf51273771606d3f9d6a815f (diff) | |
Imported Upstream version 3.2.2+dfsg1
Diffstat (limited to 'help/C')
24 files changed, 1547 insertions, 110 deletions
diff --git a/help/C/ar01s02.html b/help/C/ar01s02.html new file mode 100644 index 0000000..89e3732 --- /dev/null +++ b/help/C/ar01s02.html @@ -0,0 +1,53 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> + <title>Getting Started with Xiphos</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"><meta name="keywords" content="gnome, xiphos, sword, crosswire, help dialog"><link rel="home" href="index.html" title="Xiphos Manual"><link rel="up" href="index.html" title="Xiphos Manual"><link rel="prev" href="index.html" title="Xiphos Manual"><link rel="next" href="ar01s03.html" title="Interface"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="familiar"></a>Getting Started with Xiphos</h2></div></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="xiphos-getting-started"></a>Starting Xiphos</h3></div></div></div><p> + You can start <span class="application">Xiphos</span> in the following ways: + </p><div class="variablelist"><dl class="variablelist"><dt><span class="term">Applications menu</span></dt><dd><p> + Choose <span class="guisubmenu">Education</span> → <span class="guimenuitem">Xiphos Bible Guide</span>. + </p></dd><dt><span class="term">Command line</span></dt><dd><p> + Type <span class="command"><strong>xiphos</strong></span>, then press <span class="keycap"><strong>Return</strong></span>. + </p></dd><dt><span class="term">Windows</span></dt><dd><p> + Go to <span class="guisubmenu">All Programs</span> → <span class="guisubmenu">Xiphos + </span> → <span class="guimenuitem">Xiphos</span>. + </p></dd></dl></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="xiphos-first-start"></a>Starting Xiphos For The First Time</h3></div></div></div><p> + When you start <span class="application">Xiphos</span> for the first time, <span class="application">Xiphos</span> creates a default + selection of options for display. Also, if no other Sword application has ever been run, and thus there are no Bible + modules installed, then <span class="application">Xiphos</span> starts the Module Manager so that you can select and install a + Bible module in your language preference. + </p><div class="figure"><a name="xiphos-start-question"></a><p class="title"><b>Figure 3. Xiphos Download Question</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="figures/first_start.png" alt="Xiphos Download Instruction"></div></div></div></div><br class="figure-break"><p> + <span class="application">Xiphos</span> then opens its interface with one tab displayed, showing Romans 8:28. Once the + interface is open, you can use + <span class="guimenuitem">Edit</span> → <span class="guimenuitem">Preferences</span> to change any of the + selections already made by default. + </p></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="xiphos-when-you-start"></a>Launching Xiphos</h3></div></div></div><p> + When you start <span class="application">Xiphos</span>, the following interface is displayed: + </p><div class="figure"><a name="xiphos-start-interface"></a><p class="title"><b>Figure 4. Xiphos interface</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="figures/interface.png" alt="The Xiphos Interface"></div></div></div></div><br class="figure-break"><p> + The <span class="application">Xiphos</span> interface contains the following elements: + </p><div class="variablelist"><dl class="variablelist"><dt><span class="term">Menubar</span></dt><dd><p> + The menus on the menubar contain several commands which extend the use of <span class="application">Xiphos + </span>. These include the StudyPad and advanced search functions. The menus also help you to customize + your use of <span class="application">Xiphos</span>. + </p></dd><dt><span class="term">Toolbar</span></dt><dd><p> + The <span class="interface">toolbar</span> contains buttons that let you quickly navigate through the Bible. + </p></dd><dt><span class="term">Sidebar</span></dt><dd><p> + The <span class="interface">Sidebar</span> provides access to several features. + It contains your bookmarks and the list of installed books. It can also be + used to perform simple searches. + </p></dd><dt><span class="term">Bible Text Pane</span></dt><dd><p> + The <span class="interface">Bible Text pane</span> displays the Bible text which is currently being viewed. + </p></dd><dt><span class="term">Previewer</span></dt><dd><p> + The <span class="interface">Previewer</span> displays Bible text module options. These include Strong's + numbers, footnotes and morphological tags. It is located below the Bible Text Pane. + </p></dd><dt><span class="term">Commentary Pane</span></dt><dd><p> + The <span class="interface">Commentary pane</span> displays commentaries on the current Bible Text being used. + </p></dd><dt><span class="term">Book Pane</span></dt><dd><p> + The <span class="interface">Book Pane</span> displays general books available from the Sword Project. These include modules like + "Calvin's Institutes", "Josephus: The Complete Works" etc. This Pane can be accessed via the Book View tab just below the + Commentary Pane. + </p></dd><dt><span class="term">Dictionary/Book Pane</span></dt><dd><p> + The <span class="interface">Dictionary/Book Pane</span> displays dictionary information + on selected words in the <span class="interface">Bible Text Pane</span>. It is located just below the Commentary Pane + </p></dd></dl></div><p> + When you right-click in the different interface sections, the interface displays a context popup menu, which + provides access to more module-specific options, including display controls and printing services. + </p></div></div></body></html>
\ No newline at end of file diff --git a/help/C/ar01s03.html b/help/C/ar01s03.html new file mode 100644 index 0000000..e5b0ba8 --- /dev/null +++ b/help/C/ar01s03.html @@ -0,0 +1,283 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> + <title>Interface</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"><meta name="keywords" content="gnome, xiphos, sword, crosswire, help dialog"><link rel="home" href="index.html" title="Xiphos Manual"><link rel="up" href="index.html" title="Xiphos Manual"><link rel="prev" href="ar01s02.html" title="Getting Started with Xiphos"><link rel="next" href="ar01s04.html" title="Preferences"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="interface"></a>Interface</h2></div></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="menubar"></a>Menubar</h3></div></div></div><p> + At the top of the <span class="application">Xiphos</span> main window is the menubar. + Almost all of the functions are available by activating the appropriate + menu item. The functions have been grouped according to their type. For + example, the file operations have been grouped into + the <span class="guisubmenu">File</span> menu. + </p><div class="figure"><a name="menubar_figure"></a><p class="title"><b>Figure 5. Menubar</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="figures/interface_menubar.png" alt="Xiphos menubar"></div></div></div></div><br class="figure-break"></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="toolbars"></a>Toolbars</h3></div></div></div><p> + The function of the Toolbar is to provide control over the Bible and Commentary Panes. + Activation of the Toolbar option is done by moving the mouse cursor over the + desired toolbar button and selecting it. A tooltip will appear if the mouse cursor + is held stationary over a toolbar button, describing the function of the button. + </p><div class="figure"><a name="toolbar_figure"></a><p class="title"><b>Figure 6. ToolBar</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="figures/interface_toolbar.png" alt="The Toolbar"></div></div></div></div><br class="figure-break"><p> + The <span class="interface">Toolbar</span> consists of the following functions: + </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p> + History View Toggle and drop-down menu + </p></li><li class="listitem"><p> + Bible Book Selector + </p></li><li class="listitem"><p> + Bible Chapter Selector + </p></li><li class="listitem"><p> + Bible Verse Selector + </p></li><li class="listitem"><p> + Bible Passage Summary + </p></li></ul></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="d0e533"></a>History Forward/Backward Selector</h4></div></div></div><p> + Switches between current and previous passage selections. + </p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="xiphos-toolbar-book"></a>Bible Book Selector</h4></div></div></div><p> + Selects the Biblical book to be displayed in the <span class="interface">Bible Text Pane</span> and + <span class="interface">Commentary Pane</span>. Changes take immediate effect. + </p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="xiphos-toolbar-chapter"></a>Bible Chapter Selector</h4></div></div></div><p> + Selects the Biblical chapter of current book to be displayed in the <span class="interface">Bible Text Pane</span> and + <span class="interface">Commentary Pane</span>. Changes take immediate effect. + </p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="xiphos-toolbar-verse"></a>Bible Verse Selector</h4></div></div></div><p> + Selects the Biblical verse of current chapter to be displayed in the <span class="interface">Bible Text Pane</span> and + <span class="interface">Commentary Pane</span>. Changes take immediate effect. + </p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="xiphos-toolbar-summary"></a>Bible Passage Summary</h4></div></div></div><p> + Allows manual editing of passages which are displayed in the <span class="interface">Bible Text Pane</span> and + <span class="interface">Commentary Pane</span>. Changes take effect once Enter is typed. + </p><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p> + Ensure that edited book,chapter and verse naming is correct, otherwise the wrong or no information + will be displayed. + </p></div></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="xiphos-sidebar"></a>The Sidebar</h3></div></div></div><div class="figure"><a name="sidebar_figure"></a><p class="title"><b>Figure 7. Sidebar</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="figures/interface_sidepane.png" alt="The Sidebar"></div></div></div></div><br class="figure-break"><p> + On the left hand side of <span class="application">Xiphos</span> there is the Sidebar. Here the + user can switch between the different Sword modules, view bookmarks, do simple searches and view verse lists. + To switch between all Sidebar functions, buttons have been placed at the top of the Sidebar. + </p><div class="figure"><a name="shortcut_figure"></a><p class="title"><b>Figure 8. Sidebar Shortcuts</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="figures/interface_shortcut.png" alt="Sidebar shortcuts"></div></div></div></div><br class="figure-break"></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="xiphos-bible"></a>The Bible Text Pane</h3></div></div></div><div class="figure"><a name="textpane_figure"></a><p class="title"><b>Figure 9. The Bible Textpane</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="figures/interface_biblepane.png" alt="The Bible textpane"></div></div></div></div><br class="figure-break"><p> + Positioned to the right of the Shortcut bar is the Bible text pane. All translations are displayed here. When starting + <span class="application">Xiphos</span>, the translation last used in the leftmost tab will be displayed. + </p><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="xiphos-bible-open"></a>Opening A Specific Bible Translation</h4></div></div></div><p> + In order to change the current Bible translation to another of your choice: + </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p> + right-click in the <span class="interface">Bible Text Pane</span>. In the popup menu choose + <span class="guimenuitem">File</span> → <span class="guimenuitem">Open Module</span> + and select your specific translation that you want to view. + </p></li><li class="listitem"><p> + under the <span class="guibutton">Modules</span> option in the <span class="interface">Sidebar</span>, choose <span class="guimenuitem">Biblical Texts</span> → <span class="guimenuitem">language choice</span> + and select your specific translation. + </p></li></ul></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="xiphos-bible-parallel"></a>Using the Parallel View Mode</h4></div></div></div><p> + A nice function in <span class="application">Xiphos</span> is the ability to view your specified bible text in several + parallel translations of your choice. The Parallel View mode can be accessed by selecting <span class="guimenuitem">Parallel + View</span> just below the <span class="interface">Bible Text Pane</span>, next to the <span class="guimenuitem">Standard + View</span> tab. + </p><p> + You must choose which modules to display in parallel with the <span class="guibutton">Preferences</span> dialog found under + the <span class="guimenuitem">Edit</span> menu. In the dialog, choose Modules, then Parallel. You can add or subtract + from the list of modules that will be shown in the parallel view. The toolbar gives you a selector tool to erase + the list, delete a module from the list, and add modules to the list. + </p><p> + The <span class="guimenuitem">Parallel View</span> shows just one verse at a time. You can change the verse by selecting + another verse, chapter, or book at the toolbar. Also note that modules that are Old Testament or New Testament only + (e.g. Westminster Leningrad Codex, Byzantine Majority Text) will not be able to display books that they don't have. + </p><div class="figure"><a name="parallel_figure"></a><p class="title"><b>Figure 10. Bible textpane - parallel view</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="figures/interface_parallel.png" alt="Bible textpane - parallel view"></div></div></div></div><br class="figure-break"><p> + Additionally, a separate Parallel View window can be selected from the right click menu with <span class="guimenuitem">Detach/Attach</span>. + Your Bible pane will return to its normal single text view, and the new Parallel View window will show the complete + chapter, showing the same translations. + </p><div class="figure"><a name="parallel_figure_separate"></a><p class="title"><b>Figure 11. Parallel View - separate window</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="figures/interface_parallel-separate.png" alt="Parallel View - separate window"></div></div></div></div><br class="figure-break"></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="xiphos-bible-open-separate"></a>Opening A Separate Bible Translation</h4></div></div></div><p> + In order to view a Bible translation separate from the <span class="application">Xiphos</span> interface: + </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p> + Under the <span class="guibutton">Modules</span> option in the <span class="interface">Sidebar</span>,choose <span class="guimenuitem">Biblical Texts</span> → <span class="guimenuitem">language choice</span>. + Then right-click on a translation and choose the <span class="guimenuitem">Open in dialog</span> + option. + </p></li></ul></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="xiphos-bible-about"></a>Finding Out About The Current Translation</h4></div></div></div><p> + To find out about the Bible translation currently being displayed: + </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p> + right-click in the <span class="interface">Bible Text pane</span>. In the popup menu choose + <span class="guimenuitem">About </span> module name. + </p></li><li class="listitem"><p> + Under the <span class="guibutton">Modules</span> option in the <span class="interface">Sidebar</span>,choose <span class="guimenuitem">Biblical Texts</span> → <span class="guimenuitem">language choice</span>. + Then right-click on a translation and choose the <span class="guimenuitem">About</span> + option. + </p></li></ul></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="xiphos-bible-options"></a>Module Options</h4></div></div></div><p> + Most Bible translations have additional options which the user can select. + </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p> + Words Of Christ In Red + </p></li><li class="listitem"><p> + Strong's Numbers + </p></li><li class="listitem"><p> + Morphological Tags + </p></li><li class="listitem"><p> + Footnotes + </p></li><li class="listitem"><p> + Scripture Cross-Reference + </p></li><li class="listitem"><p> + Headings + </p></li><li class="listitem"><p> + Image Content + </p></li></ul></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p> + Translations in other languages such as Greek or Hebrew have specific options which deal only with the specific language. + </p></div><p> + In order to access these options: + </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p> + right-click in the <span class="interface">Bible Text pane</span>. In the popup menu (example shown), choose + <span class="guibutton">Module Options</span> and select the specific option. + </p></li></ul></div><div class="figure"><a name="module_options"></a><p class="title"><b>Figure 12. Module Options</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="figures/interface_biblepane-options.png" alt="Module Options"></div></div></div></div><br class="figure-break"></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="xiphos-view-options"></a>View Options</h4></div></div></div><p> + There are several additional modes that can be selected from the menubar's <span class="guimenuitem">View</span> pulldown. + </p><div class="figure"><a name="view_options"></a><p class="title"><b>Figure 13. View Options</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="figures/interface_menubar-view.png" alt="View Options"></div></div></div></div><br class="figure-break"><p> + The first 4 checkboxes control whether each named subwindow is displayed. The viewable state of the subwindows is remembered on a + per-tab basis. This makes it possible, for example, to have a tab dedicated to a maps module alone (in a dictionary module, having + alphabetically-listed places), by turning off the display of Bible, Previewer, and Commentary for that tab. + </p><p> + The remaining checkboxes control these other display features: + </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p> + Link Tabs - When more than one tab is open, each one's verse is navigated separately in the disabled + case. If tab linking is enabled, then all tabs navigate together, keeping all translations on the + same verse. + </p></li><li class="listitem"><p> + Read Aloud - If you enable this, then <span class="application">Xiphos</span> will funnel all selected verses + through the <span class="application">festival</span> text-to-speech system. <span class="application">Festival</span> is + a widely-available TTS, often installed by default in Linux distributions. + </p><p> + Also, mouse-selected text may be read aloud from Bibles, commentaries, and general books, using the + right-click menu, regardless of whether Read Aloud is selected. + </p></li><li class="listitem"><p> + Show Verse Numbers - Normally enabled, this toggle can be disabled to prevent display of verse + numbers within the text. + </p></li><li class="listitem"><p> + Highlight Current Verse - Initially disabled, this toggle replaces mere alternate colorization of + the current verse with a substitute high-contrast highlight. The colors used may be selected from + the Preferences dialog. + </p></li></ul></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="xiphos-user-annotation"></a>User Annotation</h4></div></div></div><p> + Many users wish to make personal annotations on individual verses, without the need to put a full "personal + commentary" module to use. <span class="application">Xiphos</span> provides this in the right-click context menu in the + Bible pane. This brings up a dialog showing the current verse reference and offering a text box into which to enter + a brief personal note. Once the user closes the dialog with "Annotate Verse," the verse will be displayed in + reverse-highlight (default, blue on yellow) and a marker <span class="guibutton">*u</span> will be inserted at the verse's + beginning. This is metaphorically similar for users who mark verses in paper Bibles with a yellow highlighter and + write personal notes in the margins. + </p><p> + Selecting an already-annotated verse will (in the usual case) bring up the existing content for re-editing. An + already-annotated verse can be unmarked; the verse will cease to show in reverse-highlight. + </p><p> + If the user deletes the module name from the reference at the top of the dialog, then the annotation will apply to any Bible + module at the selected verse. However, in this case, re-selecting the annotated verse will not initialize with the existing + content, because the dialog is created based on the specific module reference. + </p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="xiphos-geography-support"></a>Geography Support</h4></div></div></div><p> + A connection to browsing BibleMap.org is available by mouse-selecting a place name in any text. Use the right-click context + menu to select <span class="guimenuitem">Lookup Selection</span> → <span class="guimenuitem">Browse in + BibleMap.org</span>. A web browser will be brought up to show the selected name's geography via + BibleMap, which provides Biblical detail overlaid on a Google Maps interface. + </p><p> + </p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="xiphos-bible-dictionary"></a>Specific Word Meanings</h4></div></div></div><p> + In order to check the meaning of a specific word, double-click on the word you wish to lookup. The word should then highlight itself and the + explanation should be displayed, if available, in the <span class="interface">Dictionary Pane</span>. + </p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="xiphos-bible-find"></a>Finding A Specific Word</h4></div></div></div><p> + To find a specific word within a passage: + </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p> + right-click in the <span class="interface">Bible Text Pane</span>. In the popup menu, choose + <span class="guisubmenu">Edit</span> → <span class="guimenuitem">Find</span>. A dialog will + appear, which provides text searches. Fill out dialog and click the <span class="guibutton">Find</span> and + <span class="guibutton">Find Next</span> buttons. </p></li></ul></div></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="xiphos-viewer"></a>Previewer</h3></div></div></div><div class="figure"><a name="viewer_figure"></a><p class="title"><b>Figure 14. PreViewer</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="figures/interface_viewer.png" alt="Previewer"></div></div></div></div><br class="figure-break"><p> + The Previewer is where the user sees Strong's numbers, morphological tags, footnotes, and cross-references that the + <span class="interface">Bible Text Pane</span> provides. + </p><p> + Footnote content is displayed in the Previewer when you hover over the indicator <span class="guibutton">*n</span> in the Bible text; + it remains visible until your mouse moves over another indicator, Strong's number, etc. Sometimes you may want the text to + remain anchored until you can move the mouse to the previewer to click on a link or to read large footnotes. To anchor the text so + that you can scroll it in the Previewer, middle-click the indicator (or hold down the <span class="guibutton">Shift key</span>) + and move to the Previewer. + </p><p> + Cross-reference indicators <span class="guibutton">*x</span> work much the same way. Clicking the + indicator will send the set of references to the <span class="guibutton">Verse List</span> in the + <span class="interface">Sidebar</span>, where you can click them individually for reading in the Previewer. + Alternately, a Preferences selector is available, so that cross-reference lists are sent to the + verse list instead. + </p><p> + Any verses shown in reverse-highlight have personal annotation associated with them, and such verses will include + <span class="guibutton">*u</span> at the beginning of the verse. Hovering on this marker will show the annotation in the previewer, just as + for publisher's footnotes. + </p><p> + If a devotional has been set via the Preferences dialog, then the day's devotional reference will also appear in the + previewer, either on program startup or when the user requests it via the <span class="guimenuitem">View</span> menu. + </p></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="xiphos-commentaries"></a>The Commentary Pane</h3></div></div></div><div class="figure"><a name="commentary_figure"></a><p class="title"><b>Figure 15. The Commentary Pane</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="figures/interface_commentarypane.png" alt="Commentary Pane"></div></div></div></div><br class="figure-break"><p> + The <span class="interface">Commentary pane</span> is where the commentary modules are displayed. This provides easy + reading, reference, and access to different commentaries currently installed. The passage viewed by the + <span class="interface">Commentary pane</span> is directly controlled by the current passage viewed in the <span class="interface">Bible + Text pane</span>, so in order to change to a different passage commentary, select the desired passage + on the <span class="interface">Toolbar</span>. + </p><p> + If there are images that are part of a commentary, general book, or dictionary/lexicon, they may be clicked to invoke a + viewer on that single image, in order to get a better view. This is particularly useful if image resizing has been enabled + with the result that images are made very small in the subwindow. + </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p> + By changing to passage settings on the <span class="interface">Toolbar</span>, the contents in the + <span class="interface">Bible Text pane</span> and the <span class="interface">Commentary Pane</span> will be changed. + </p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="xiphos-commentary-about"></a>Finding Out About The Commentary Module</h4></div></div></div><p> + To find out about the commentary currently being displayed: + </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p> + right-click in the <span class="interface">Commentary Pane</span>. In the popup menu choose + <span class="guimenuitem">About </span> module name. + </p></li></ul></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="xiphos-commentary-headings"></a>Commentary Headings.</h4></div></div></div><p> + Many commentaries have additional headings which enable introductory information about the book and chapter currently + being displayed in the <span class="interface">Bible Text pane</span>. In order to view them: + </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p> + right-click in the <span class="interface">Commentary Pane</span>. In the popup menu choose + <span class="guimenuitem">Display Book Heading</span> or <span class="guimenuitem">Display Chapter Heading</span>. + </p></li></ul></div></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="xiphos-dictionary"></a>Dictionary Pane</h3></div></div></div><div class="figure"><a name="dict_figure"></a><p class="title"><b>Figure 16. The Dictionary Pane</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="figures/interface_dictionary.png" alt="The Dictionary Pane"></div></div></div></div><br class="figure-break"><p> + The Dictionary Pane's content is driven by its up/down selectors, typing in its navbar text, or double-clicks in the Bible, Commentary, or Book Panes. + </p></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="xiphos-shortcut"></a>Keyboard Shortcuts</h3></div></div></div><p> + Several keyboard shortcuts exist in <span class="application">Xiphos</span>, listed below in rough functional groupings. + </p><p> + Window selection/opening and navbar selection: + </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p> + <span class="guibutton">Ctrl-L</span> focuses and selects the main verse navbar text. You can then immediately type + in new verse selection text. Be aware that, as is the case with most Sword applications, + <span class="application">Xiphos</span> understands many abbreviations: "G" is adequate to specify Genesis, + for example, and any book name by itself implies 1:1. + </p></li><li class="listitem"><p> + <span class="guibutton">Alt-C</span> brings the Commentary View forward when previously obscured by the Book View. + </p></li><li class="listitem"><p> + <span class="guibutton">Alt-G</span> is the opposite of Alt-C, focusing on the general book. + </p></li><li class="listitem"><p> + <span class="guibutton">Alt-D</span> focuses on the dictionary navbar text. + </p></li><li class="listitem"><p> + <span class="guibutton">Ctrl-T</span> opens a new tab. + </p></li><li class="listitem"><p> + <span class="guibutton">Ctrl-[1-9]</span> makes the Nth tab current. + </p></li></ul></div><p> + Verse navigation and Bible features: + </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><span class="guibutton">Ctrl-p/Ctrl-n</span>: Verse previous/next. Also <span class="guibutton">k/j</span>.</p></li><li class="listitem"><p><span class="guibutton">p/n</span>: Chapter previous/next.</p></li><li class="listitem"><p><span class="guibutton">P/N</span>: Book previous/next.</p></li><li class="listitem"><p><span class="guibutton">Shift-F10</span> brings up the context menu for the Bible pane.</p></li><li class="listitem"><p><span class="guibutton">Alt-S</span>: Toggle Strong's display.</p></li><li class="listitem"><p><span class="guibutton">Alt-M</span>: Toggle morphology display.</p></li><li class="listitem"><p><span class="guibutton">Alt-R</span>: Toggle "red words of Christ" display.</p></li></ul></div><p> + Opening special windows: + </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p> + <span class="guibutton">F1</span> opens this manual. + </p></li><li class="listitem"><p> + <span class="guibutton">F2</span>: opens the <span class="guibutton">Preferences</span> dialog. + </p></li><li class="listitem"><p> + <span class="guibutton">F3</span>: opens <span class="guibutton">Advanced Search</span>. + </p></li><li class="listitem"><p> + <span class="guibutton">Ctrl-F3</span>: brings forward the simple sidebar search. + </p></li><li class="listitem"><p> + <span class="guibutton">F4</span>: opens the <span class="guibutton">Module Manager</span>. + </p></li><li class="listitem"><p> + <span class="guibutton">Alt-A</span> opens an annotation dialog on the current verse. + </p></li><li class="listitem"><p> + <span class="guibutton">Alt-B</span> opens a bookmark dialog on the current verse. + </p></li><li class="listitem"><p> + <span class="guibutton">Ctrl-F</span> opens the "Find" dialog. The subwindow to which it applies depends on which + of them are visible: The Bible is first preference, then the commentary or general book, then the + dictionary. So a tab can be dedicated to just a book, and Ctrl-F will perform "Find" within that pane. + </p></li><li class="listitem"><p> + <span class="guibutton">Alt-P</span> detaches/re-attaches the parallel view dialog. + </p></li><li class="listitem"><p> + <span class="guibutton">Alt-Z</span> opens editor on the personal commentary named Personal. + </p></li></ul></div><p> + Font size control: + </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p> + <span class="guibutton">Ctrl-Plus/Ctrl-Minus</span> increases/decreases the base font size. + </p></li><li class="listitem"><p> + <span class="guibutton">Ctrl-0</span> (zero) sets the base font size to zero. + </p></li></ul></div><p> + BibleSync: + </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p> + <span class="guibutton">Ctrl-Alt-Shift-P</span> puts BibleSync into Personal mode. + </p></li><li class="listitem"><p> + <span class="guibutton">Ctrl-Alt-Shift-S</span> puts BibleSync into Speaker mode. + </p></li><li class="listitem"><p> + <span class="guibutton">Ctrl-Alt-Shift-A</span> puts BibleSync into Audience mode. + </p></li><li class="listitem"><p> + <span class="guibutton">Ctrl-Alt-Shift-O</span> turns off BibleSync. + </p></li><li class="listitem"><p> + <span class="guibutton">Ctrl-Alt-Shift-N</span> causes BibleSync to navigate your current main window point + transiently as a one-shot event. BibleSync must be in transmit-ready, that is, in Personal or Speaker mode. + </p></li></ul></div></div></div></body></html>
\ No newline at end of file diff --git a/help/C/ar01s04.html b/help/C/ar01s04.html new file mode 100644 index 0000000..1ac370c --- /dev/null +++ b/help/C/ar01s04.html @@ -0,0 +1,75 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> + <title>Preferences</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"><meta name="keywords" content="gnome, xiphos, sword, crosswire, help dialog"><link rel="home" href="index.html" title="Xiphos Manual"><link rel="up" href="index.html" title="Xiphos Manual"><link rel="prev" href="ar01s03.html" title="Interface"><link rel="next" href="ar01s05.html" title="Module Manager"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="preferences"></a>Preferences</h2></div></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="preferences-introduction"></a>Introduction To Preferences</h3></div></div></div><div class="figure"><a name="d0e1320"></a><p class="title"><b>Figure 17. The Preference Dialog</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="figures/preferences.png" alt="The Preferences Dialog"></div></div></div></div><br class="figure-break"></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="general-settings"></a>General Settings</h3></div></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="tab-pane2"></a>Locale, General Preferences and StudyPad directory</h4></div></div></div><div class="figure"><a name="d0e1339"></a><p class="title"><b>Figure 18. Locale, General Preferences and StudyPad directory</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="figures/preferences_general-misc.png" alt="General Preferences and StudyPad directory"></div></div></div></div><br class="figure-break"><p> + If you wish <span class="application">Xiphos</span> to display its interface in a language other than the default, you may select + one here. A restart will be required, so that the locale can be initialized. + </p><p> + If you enable <span class="guilabel">Default Dictionary</span>, then that named dictionary (see <span class="guimenuitem">Special</span> + below) module will always be used when double-clicking a word anywhere in <span class="application">Xiphos</span>. + </p><p> + Certain dictionary-style modules are <span class="guilabel">Daily Devotionals</span> whose keys are numerically in the form "Month.Day". If you have + such a module installed and it has been selected as your preferred devotional, then you can ask that <span class="application">Xiphos</span> + display today's selection during startup. + </p><p> + If you enable <span class="guilabel">Resize images</span>, <span class="application">Xiphos</span> will automatically resize image + content in commentaries, general books, and dictionaries so as to fit the subwindow which contains them. + </p><p> + <span class="guilabel">Highlight current verse</span>, if enabled, will cause <span class="application">Xiphos</span> to substitute + mere current verse colorization with a high-contrast alternate color scheme on the current verse. The colors used may be + chosen from the color selector pane (see below). + </p><p> + <span class="guilabel">Highlight user annotations</span> uses inverted the highlight color choices when marking user-annotated + verses. + </p><p> + By default, <span class="guilabel">Cross-references</span> go into the Previewer. Selecting this checkbox puts them into the verse + list instead. + </p><p> + Verse number display can be offset in several ways provided by the checkboxes. + </p></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="biblesync"></a>BibleSync Settings</h3></div></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="tab-pane2"></a>Controls for BibleSync</h4></div></div></div><div class="figure"><a name="d0e1410"></a><p class="title"><b>Figure 19. Controls for BibleSync</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="figures/preferences_general-biblesync.png" alt="BibleSync Settings"></div></div></div></div><br class="figure-break"><p> + BibleSync is a shared navigation protocol using LAN multicast. It is useful for a single person when running Bible programs on + multiple machines or devices, all of which you wish to navigate through the Bible together, or for a group working closely together, + such as translators. Also, it has a "lecture" mode, where a speaker's Bible program induces the audience's programs to follow along. + The difference in the modes regards who transmits and who receives navigation. In Personal mode, BibleSync navigation is both + transmitted and received; as Speaker, it transmits only; as Audience, it receives only. + </p><p> + To enable BibleSync, select a mode from the radio buttons. Also, choose whether to accept navigation directly, so that Xiphos moves + immediately to a specified verse, or whether incoming navigation is instead sent to the verse list, where you can decide whether to + follow. + </p><p> + If you use a firewall, you must punch a hole in it for UDP port 22272. + </p><p> + If you run more than one BibleSync-compatible program on your computer and do not wish your activity among them to be shared on the + local net, you can use Personal mode combined with the Private checkbox. This will tell <span class="application">Xiphos</span> not to + broadcast outside your system. + </p><p> + You can send a verse list from the sidebar search or Advanced Search window via BibleSync; see the context (right-click) menu. A + particularly good use case for this is when using a simpler Bible program, such as on a mobile device, with another such as + <span class="application">Xiphos</span> that has significant search capability: Do searches in <span class="application">Xiphos</span> and send + the resulting verse list to the mobile device. Be aware that size limitations on the protocol are small, and though a search may + generate hundreds of results in the verse list, at most a few dozen will pass in the protocol to the receivers. For + <span class="application">Xiphos</span>, receipt of multi-references always induces indirect verse list navigation. + </p><p> + <span class="application">Xiphos</span> is the first Bible program with a BibleSync implementation; as such, its utility may be limited for + now. But a number of other programs' authors and support organizations have indicated their intention to support BibleSync as well, + including Laridian, theWord, BibleAnalyzer, and Accordance, as well as other Sword Project applications. + </p></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="fonts-and-colors"></a>Fonts And Colors</h3></div></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="font-color"></a>Setting Font Colors</h4></div></div></div><div class="figure"><a name="d0e1454"></a><p class="title"><b>Figure 20. Font Colour Settings</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="figures/preferences_fonts-color.png" alt="Font Colour Settings"></div></div></div></div><br class="figure-break"><p> + The <span class="guibutton">Invert color pairs</span> buttons are provided to make it easy, for example, to move the main window + into "night mode," with white text on black background. + </p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="font-misc"></a>Miscellaneous Font Settings</h4></div></div></div><div class="figure"><a name="d0e1474"></a><p class="title"><b>Figure 21. Miscellaneous Font Settings</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="figures/preferences_fonts-misc.png" alt="Miscellaneous Font Settings"></div></div></div></div><br class="figure-break"><p> + In individual modules' display, the right-click menu's <span class="guimenuitem">Module Options</span> selector provides font name + and size selection. + </p><p> + The base font size is the size initially chosen for all modules displayed by <span class="application">Xiphos</span>. The + verse number and individual modules' font size choices are relative to the base font size. + </p><p> + The font name and size used for display is chosen from this order: + </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p> + The selection made via the context menu for the specific module, under <span class="guimenuitem">Module + Options</span>. + </p></li><li class="listitem"><p> + The per-language selection made under Preferences, here. + </p></li><li class="listitem"><p> + The module's own default selection, in its configuration file. + </p></li><li class="listitem"><p> + The application default. + </p></li></ul></div></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="module-settings"></a>Module Settings</h3></div></div></div><div class="figure"><a name="d0e1518"></a><p class="title"><b>Figure 22. Parallel Preferences</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="figures/preferences_modules-parallel.png" alt="Parallel Preferences"></div></div></div></div><br class="figure-break"><div class="figure"><a name="d0e1530"></a><p class="title"><b>Figure 23. Various preferences Modules </b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="figures/preferences_modules-misc.png" alt="Various Preferences Modules"></div></div></div></div><br class="figure-break"></div></div></body></html>
\ No newline at end of file diff --git a/help/C/ar01s05.html b/help/C/ar01s05.html new file mode 100644 index 0000000..fd2162c --- /dev/null +++ b/help/C/ar01s05.html @@ -0,0 +1,91 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> + <title>Module Manager</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"><meta name="keywords" content="gnome, xiphos, sword, crosswire, help dialog"><link rel="home" href="index.html" title="Xiphos Manual"><link rel="up" href="index.html" title="Xiphos Manual"><link rel="prev" href="ar01s04.html" title="Preferences"><link rel="next" href="ar01s06.html" title="The Search Function"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="module-manager"></a>Module Manager</h2></div></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="module-introduction"></a>Introduction To The Module Manager</h3></div></div></div><p> + The "module" is the unit of content in <span class="application">Xiphos</span>, and Sword generally; a Sword module is a resource + available for viewing in Sword applications. There are several varieties: Most importantly, Bible texts, as well as + dictionaries and lexicons, commentaries, and general books, any of which may include image content (e.g. atlases). They are + installed either from a local directory structure (typically on removable media, such as a CDROM distribution) or remotely + via ftp from a repository such as Crosswire, which is the home of Sword, and from which all officially Sword-sanctioned + modules are available. Also, many other modules are available from non-Crosswire repositories. In particular, there is the + Xiphos repository, containing a variety of otherwise-unofficial modules produced primarily by contributors to + <span class="application">Xiphos</span> itself. + </p><p> + If you have other Sword applications installed, they will all share the same set of Sword modules that you install through + the Module Manager. + </p><div class="figure"><a name="d0e1561"></a><p class="title"><b>Figure 24. The Module Manager Dialog</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="figures/module.png" alt="The Module Manager Dialog"></div></div></div></div><br class="figure-break"><p> + Notice the <span class="guibutton">View Intro</span> button above. You may see an introductory explanation of Module Manager + operation at any time. + </p></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="sword-config"></a>Sword Module Configurations</h3></div></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="sword-sources"></a>Module Sources Settings</h4></div></div></div><div class="figure"><a name="d0e1585"></a><p class="title"><b>Figure 25. Module Sources Settings</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="figures/sword_sources.png" alt="Module Installation"></div></div></div></div><br class="figure-break"><p> + There are other repositories available besides CrossWire's own, though the modules available from other repositories do not + represent content officially sanctioned by Crosswire. On the web, see this page for list of those repositories known: + <a class="ulink" href="http://www.crosswire.org/wiki/Module_Repositories" target="_top">http://www.crosswire.org/wiki/Module_Repositories</a> + </p><p> + The list of standard repositories is maintained at CrossWire. Xiphos normally auto-synchronizes with that list one time, + when the user first puts the Module Manager to use. The list may change, as new repositories come into existence; + occasional re-synchronization with the list is suggested, which is accomplished by clicking <span class="guibutton">Load Standard</span>. + </p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="installation"></a>Sword Module Installations</h4></div></div></div><div class="figure"><a name="d0e1610"></a><p class="title"><b>Figure 26. Sword Module Installations</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="figures/sword_config.png" alt="Module Installation"></div></div></div></div><br class="figure-break"><p> + After you have selected your Install Source, click the <span class="guimenuitem">Refresh</span> button to cause + <span class="application">Xiphos</span> to find the module summary available from that source before moving on. + </p><p> + Take note of the "Install Destination". In most cases, you will have a choice of a personal area or a system area. + The details vary according to your operating system. + </p><div class="sect4"><div class="titlepage"><div><div><h5 class="title"><a name="destination-linux"></a>Linux</h5></div></div></div><p> + Unless you run as root (via su or sudo) you will only be able to install in your personal area, under ~/.sword. + If you run as root, or change permissions on the shared directory, you will also be able to install modules for + all users, typically in /usr/share/sword. There have been some requests for Xiphos to provide a means by which + an ordinary (non-root) user could start the program, gain temporary write access to the system area while installing + modules, and then revoke that access after installation is complete. Attempting to devise a scheme to do this has + proven quite difficult, given the different superuser management schemes employed by various Linux distributions. + Therefore, at this time there are no ongoing plans to try to solve this problem, and users are advised to enable + write access to the system area outside Xiphos. + </p></div><div class="sect4"><div class="titlepage"><div><div><h5 class="title"><a name="destination-xp"></a>Windows XP</h5></div></div></div><p> + You may install modules to a shared folder so the modules are available to all users. If you have previously used + "The Sword Project for Windows", this folder will be "C:\Program Files\Crosswire\The Sword Project\Sword". Otherwise + it will be "C:\Documents and Settings\All Users\Application Data\Sword". You may also install modules to a location + that can only be seen by you. This location is "C:\Documents and Settings\YOUR NAME\Application Data\Sword". + </p></div><div class="sect4"><div class="titlepage"><div><div><h5 class="title"><a name="destination-vista"></a>Windows Vista</h5></div></div></div><p> + Vista works much the same as XP, except for the locations. The private location is + "C:\Users\YOUR NAME\AppData\Roaming\Sword". The shared location is "C:\ProgramData\Sword". + </p></div></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="module-management"></a>Installing, Updating, and Maintaining Modules</h3></div></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="add-module"></a>Installing, Updating, and Maintaining Modules</h4></div></div></div><div class="figure"><a name="d0e1654"></a><p class="title"><b>Figure 27. Installing and Updating Modules</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="figures/sword_install.png" alt="Module Installation"></div></div></div></div><br class="figure-break"><p> + The module manager generates both a per-type module list as well as a parallel availability list. The latter is + intended to make it easier to find new items without having to work one's way through the per-type list, one subtree at a + time. Modules which are either not yet installed or updated beyond what is currently installed will appear in both lists. + </p><p> + Modules that are already installed will show a checkmark beside them. If a fast search ("lucene") index is available, a magnifying glass will be + displayed, otherwise an "X" will be shown; creation of the index is available on the Maintenance pane. Locked modules, which require that you + purchase an unlock key from the module's copyright holder, will show a lock symbol. If there are modules installed for which a more recent + version is available, a refresh icon will appear between the differing old and new version stamps. There may be an approximate size displayed, + if the repository management provides this information, otherwise a question mark ("-?-") will be shown. + </p><p> + Select new modules to be installed by clicking the checkboxes and then the Install button at the bottom. Any number of + modules may be requested for installation at one time. + </p><p> + If you acquire a locked module and have obtained the cipher key for it, the module is then unlocked in the main window: Open + the module, which will probably appear blank, then using the right-click context menu, choose "Unlock This Module." + </p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="remove-module"></a>Module Maintenance</h4></div></div></div><div class="figure"><a name="d0e1677"></a><p class="title"><b>Figure 28. Module Maintenance</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="figures/sword_remove.png" alt="Module Maintenance"></div></div></div></div><br class="figure-break"><p> + Several maintenance functions are available: Removal, archival, index, and index deletion. + </p><p> + Removal disposes of a module entirely. There is no recovery of the module unless you have previously archived a copy of it. + </p><p> + Archival is available for any module, although it is provided with personal commentaries specifically in mind. A *.zip of + the module is left in the directory ~/.sword/zip. Archival prior to removal of personal commentaries is recommended, in + order to be available for future re-install if the subject matter of the personal commentary becomes important again. + </p><p> + Indexing is provided so that the underlying Sword search support can create the index needed for the "lucene" fast-search + functions. If the index is not created, plain multi-word search will still be available, but it will be much slower. With + the index in place, searches through an entire Bible can take just a few seconds. + </p><p> + Indexes may be deleted as well. + </p></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="non-standard-modules"></a>Installing Non-Standard Modules</h3></div></div></div><p> + Some resource modules in Sword Project format are available from sources other than Crosswire and not from a module manager-ready repository. + Necessarily, installing such a module is a manual task. + </p><p> + Modules are normally packaged as *.zip files; they contain a configuration file plus a number of data files. Installation + of such a module is done by cd'ing to your personal Sword (not <span class="application">Xiphos</span>) configuration + directory, ~/.sword, and unzipping the file there. The configuration file will be left in "mods.d", and the module's data + files will go into a subdirectory of "modules". Alternatively, if you have write access to the system Sword directory, + typically /usr/share/sword, you may cd there instead before unzipping. + </p><p> + Restart <span class="application">Xiphos</span> after installing such a module, so that a fresh instance of the program can + notice the new module in place. + </p></div></div></body></html>
\ No newline at end of file diff --git a/help/C/ar01s06.html b/help/C/ar01s06.html new file mode 100644 index 0000000..7ca7224 --- /dev/null +++ b/help/C/ar01s06.html @@ -0,0 +1,236 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> + <title>The Search Function</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"><meta name="keywords" content="gnome, xiphos, sword, crosswire, help dialog"><link rel="home" href="index.html" title="Xiphos Manual"><link rel="up" href="index.html" title="Xiphos Manual"><link rel="prev" href="ar01s05.html" title="Module Manager"><link rel="next" href="ar01s07.html" title="The Studypad"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="search"></a>The Search Function</h2></div></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="xiphos-searchpane"></a>Simple Searches</h3></div></div></div><p> + To conduct a quick search within the current Bible or commentary module, the Search Bar in the Sidebar should usually be + adequate. Click either in the menu bar + <span class="guisubmenu">Edit</span> → <span class="guimenuitem">Search</span> or in the Sidebar + <span class="guisubmenu">Modules</span> → <span class="guimenuitem">Search</span> to access it. </p><div class="figure"><a name="d0e1737"></a><p class="title"><b>Figure 29. The Search Bar</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="figures/interface_searchpane.png" alt="The Search Bar"></div></div></div></div><br class="figure-break"><p> + The <span class="interface">Search Dialog</span> consists of the following parts: + </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p> + Search Key Entry box + </p></li><li class="listitem"><p> + Search Module Selector + </p></li><li class="listitem"><p> + Search Type Selector + </p></li><li class="listitem"><p> + Search Options Checkbox + </p></li><li class="listitem"><p> + Search Scope Selector + </p></li><li class="listitem"><p> + Search Results View + </p></li></ul></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="xiphos-search-key"></a>Search Key Entry Box</h4></div></div></div><p>Allows entry of the key for which you would like to search. The + search key can be a word, part of a word, several words, a phrase, or + a regular expression depending on the type of search selected. When + the search key is entered and all other selections in the search dialog + are complete, click the <span class="guibutton">Find</span> button to begin + the search. + </p><p> + This search uses the optimized search method (see next section) if + the module has previously been indexed, and will use AND semantics by default + (matched verses contain all words you entered). + </p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="xiphos-search-modselect"></a>Search Module Selector</h4></div></div></div><p>Allows selection of which modules you would like to search. + Select <span class="guibutton">Bible</span> to search Bible versions or + <span class="guibutton">Commentary</span> to search commentaries. Only + the currently active module will be searched.</p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="xiphos-search-typeselect"></a>Search Type Selector</h4></div></div></div><p>Allows selection of the type of search. There are three search + types available: + </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><span class="guibutton">Multi word</span></span></dt><dd><p>This type will match any verse that has + all the words in the search key, regardless of where + they appear in the verse. By default, "lucene" fast search + will be used, with fallback to the slower plain version of + multi-word search in the absence of an index.</p></dd><dt><span class="term"><span class="guibutton">Regular expression</span></span></dt><dd><p>This search uses a regular expression + as a search key. A regular expression is a pattern used + to match a string of text. A regular expression can be + used to find verses with words that match a particular + pattern. For example the regular expression + <strong class="userinput"><code>[a-z]*iah </code></strong> will match verses that contain + the words Aiah, Ahaziah, Athaliah and Amariah.</p><p>A complete discussion of regular expressions is + beyond the scope of this manual, but more information + can be found in the grep man page.</p></dd><dt><span class="term"><span class="guibutton">Exact phrase</span></span></dt><dd><p>This type will match the search key + exatly as entered. If the search key is <strong class="userinput"><code> + it is good</code></strong>, this search would match a verse + which contains "<span class="emphasis"><em>it is good</em></span>," but + would not match a verse which contains "<span class="emphasis"><em> + good</em></span>, and doeth <span class="emphasis"><em>it</em></span> not, + to him it <span class="emphasis"><em>is</em></span> sin."</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="xiphos-search-options"></a>Search Options Checkbox</h4></div></div></div><p>Allows selecting of search options. The only available option + is <span class="guibutton">Match case</span>. Check this box to make the + search case sensitive.</p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="xiphos-search-scopeselect"></a>Search Scope Selector</h4></div></div></div><p>Allows defining the range within the specificed module that will + be searched. There are three search scopes available:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><span class="guibutton">No scope</span></span></dt><dd><p>This button causes the search to + to include the entire module.</p></dd><dt><span class="term"><span class="guibutton">Use bounds</span></span></dt><dd><p>Selecting this button produces two dropdown + selector boxes marked <span class="guilabel">Lower</span> and + <span class="guilabel">Upper</span>. Select the first book + to search in the <span class="guilabel">Lower</span> box and + the last book to search in the <span class="guilabel">Upper</span> + box. The search will begin with the <span class="guilabel">Lower + </span> book and end with the <span class="guilabel">Upper + </span> book and include all books in between. + </p><p>Chapter and verse numbers can be entered into + the search bound boxes as well to further narrow the + search. </p></dd><dt><span class="term"><span class="guibutton">Last search</span></span></dt><dd><p>Select this button to do a new + search including only the verses returned as a + result of the last search. Use this with a new + search key to narrow the search further.</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="xiphos-search-results"></a>Search Results View</h4></div></div></div><p>This shows a list of the current search results for previewing, navigation, or saving.</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">Preview</span></dt><dd><p>To preview the search result, simply click on an individual result. + The entry will show in the preview pane. + </p></dd><dt><span class="term">Navigation</span></dt><dd><p>Navigation to the search result can be done in two ways. To open the result + in a new tab, middle-click the mouse. To open the result in the current tab, double-click the result. + </p></dd><dt><span class="term">Save Results</span></dt><dd><p>You may save your results as a list of bookmarks. To do this, right-click and select + <span class="guilabel">Save List</span>. You will be prompted to enter a name for the folder that your results + will be saved to. After you have saved the results, you may view them by going to your bookmarks and + finding the folder you just named. + </p></dd></dl></div></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="xiphos-advanced-search"></a>Advanced Searches</h3></div></div></div><p> + More complicated searches might require the use of the advanced search functions, found under + <span class="guisubmenu">Edit</span> → <span class="guimenuitem">Advanced Search</span>. + </p><div class="figure"><a name="d0e1934"></a><p class="title"><b>Figure 30. The Advanced Search Dialogue</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="figures/search_search.png" alt="The Advanced Search Dialog"></div></div></div></div><br class="figure-break"><p> + In <span class="guimenuitem">Advanced Search</span>, much more complex queries can be constructed, involving custom search ranges, + custom lists of modules over which to search, regular expression matching (see next section), and attribute-based searches + such as are found in footnotes or Strong's Hebrew and Greek dictionary references. + </p><p> + The default search uses "lucene" fast searching. It is an optimized search requiring a pre-built index; see the + <span class="guilabel">Module Manager's</span> Maintenance page for index creation. In the absence of an index, fallback to the + slower, plain multi-word search will be done, or can be selected deliberately here. A web search will provide several + references to the syntax needed to put to use the power of optimized Lucene search. A few examples follow: + </p><p> + Simple Searches: just type in the words you want to search for. To return only verses that include all of the words, + prefix the word with "+". So, in the KJV, you could find Psalm 23 by searching for "+Lord +shepherd +want". To search for + an entire phrase, surround the entire phrase with quotes, like "maketh me to lie down" (note that quotes are unnecessary + in all of the other examples). + </p><p> + Single Letter Wildcard: to search for "veil" or "vail", use this syntax "v?il". The "?" represents a single character + that could be anything. A more complex example returns both spellings for Isaiah used in the KJV. "?saia?" will return + results for "Isaiah" and "Esaias". + </p><p> + Multiple Letter Wildcard: to search for "prophet" or "prophesy" or "prophecy" or "prophesied", use this syntax "prophe*". + </p><p> + AND syntax: in the advanced search to return results for all of the search terms, you must put "AND" in between the terms. + To continue our example, if we wish to search for any occurrence of Isaiah or Esaias that also mention either prophet, or + prophecy, or prophesy, we can do a search like this: "?saia? AND prophe*". + </p><p> + By default, two standard search ranges are defined, for Old and New Testament; you may wish to define others for + e.g. "Gospels" or "Paul's Epistles". One custom module list containing only the first Bible found will be present. + If desired, new searches can be performed across only the current results of the previous search. Any modules may be + searched, including general books and even dictionaries, in any combination. + </p><p> + Note the tooltip in the screenshot above, for Attributes search. This qualifier is used to perform searches on attributes + that are carried with verses, instead of verse content proper, such as footnote content or Strong's Hebrew and Greek + references. If this button is selected, specific attribute qualifiers must be made in the Attribute Search tab, at the + right end of the tab set. Strong's references are identified with a leading "H" or "G" and the numeric Strong's identifier. + Thus, a search of KJV for Strong's Greek #140, using "G140", will return the single result of Matthew 12:18. + </p><p> + If you have indexed your modules, there is a much faster way to search for Strong's references. Enter your search preceded by + "lemma:", so to search for Strong's Greek #140, enter "lemma:G140". You must have selected <span class="guibutton">Optimized ("Lucene")</span> + for this to work. + </p><p> + Explanations of search syntax are available when either Optimized or Attribute search is selected. + </p><p> + The "Find" button also stops an in-progress search, as its tooltip indicates. + </p><p> + Results will show in the <span class="guibutton">Results</span> tab. If you wish to show Strongs, Morphology, or Footnote tags, + make those selections on the <span class="guibutton">Attributes Search</span> tab. Clicking once on the result will show the result + in the <span class="guibutton">Advanced Search</span> previewer. Hovering over Strongs, Morphology, Footnote, or Cross-reference + tags will show the results in the main previewer. Double-clicking a result will cause the current tab to navigate to that + result. This applies to search results in general books and commentaries as well, but note that the respective tab must + be visible. + </p><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p> + Changes to some of the settings (e.g. scope of search, searched modules, etc.) in Advanced Search will affect the simple search via the side pane but not vice versa. + </p></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="hdbk-op-search-dialog-text-regexp"></a>Search Syntax using Regular Expression</h3></div></div></div><p> + Regular expression searches provide a way to do simple or complex searches for strings that match a pattern or set of patterns (branches) separated by vertical bars "|". While a pattern can be built to look for a word or phrase, a simple pattern that consists of a word does not look for only that word but for any place the string of letters that make that word are found. A search for "right" will return verses that contain the word "right", but also "<span class="emphasis"><em>right</em></span>eous", "<span class="emphasis"><em>right</em></span>eousness", "un<span class="emphasis"><em>right</em></span>eous", "up<span class="emphasis"><em>right</em></span>" and even "b<span class="emphasis"><em>right</em></span>". A search for "hall not" is not a search for "hall" AND "not" but for the string "hall not" with a space between the second "l" and the "n". The search for "hall not" will find occurrences of "s<span class="emphasis"><em>hall not</em></span>". + </p><p> + The power of Regular Expressions is in the patterns (or templates) used to define a search. A pattern consists of +ordinary characters and some special characters that are used and interpreted by a set of rules. Special characters include +.\[^*$?+. Ordinary (or simple) characters are any characters that are not special. The backslash, "\", is used to convert special characters to ordinary and ordinary characters to special. + </p><p> + Example: the pattern "<span class="emphasis"><em>i. love\.</em></span>" will find sentences that end with "h<span class="emphasis"><em>i</em></span>s <span class="emphasis"><em>love</em></span>" or "<span class="emphasis"><em>i</em></span>n <span class="emphasis"><em>love</em></span>" or "<span class="emphasis"><em>i</em></span>s <span class="emphasis"><em>love</em></span>" followed by +a period. The first period in "i. love\." is a special character that means allow any character in this position. The +backslash in "i. love\." means that the period following it is not to be considered a special character, but is +an ordinary period. + </p><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="hdbk-op-search-dialog-text-regexp-rules"></a>Rules for Regular Expression Search Requests</h4></div></div></div><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>. The period matches any character.</p></li><li class="listitem"><p>* The asterisk matches 0 or more characters of the + preceding: set, character or indicated character.</p></li><li class="listitem"><p>+ The plus sign matches 1 or more characters of the + preceding: set, character or indicated character.</p></li><li class="listitem"><p>? The question mark matches 0 or 1 character of the + preceding: set, character or indicated character.</p></li><li class="listitem"><p>[ ] Square brackets match any one of the characters + specified inside [ ].</p></li><li class="listitem"><p>^ A caret as the first character inside [ ] means NOT.</p></li><li class="listitem"><p>^ A caret beginning a pattern anchors the beginning of a + line.</p></li><li class="listitem"><p>$ A dollar at the end of a pattern anchors the end of a + line.</p></li><li class="listitem"><p>| A vertical bar means logical OR.</p></li><li class="listitem"><p>( ) Parentheses enclose expressions for grouping. +<span class="emphasis"><em>Not supported!</em></span></p></li><li class="listitem"><p>\ A backslash can be used prior to any special character + to match that character.</p></li><li class="listitem"><p>\ A backslash can be used prior to an ordinary character + to make it a special character.</p></li></ul></div><div class="sect4"><div class="titlepage"><div><div><h5 class="title"><a name="period"></a>The Period</h5></div></div></div><p>The Period "." will match any single character even +a space or other non-alphabet character. +<span class="emphasis"><em>s.t</em></span> matches <span class="emphasis"><em>s</em></span>i<span class="emphasis"><em>t</em></span>, +<span class="emphasis"><em>s</em></span>e<span class="emphasis"><em>t</em></span>,<span class="emphasis"><em> s</em></span>o<span class="emphasis"><em>t</em></span>, +etc., which could be located in <span class="emphasis"><em>s</em></span>i<span class="emphasis"><em>t</em></span>ting, +compas<span class="emphasis"><em>s</em></span>e<span class="emphasis"><em>t</em></span>h and <span class="emphasis"><em>s</em></span>o<span class="emphasis"><em>t</em></span>tish +<span class="emphasis"><em>b..t</em></span> matches <span class="emphasis"><em>b</em></span>oo<span class="emphasis"><em>t</em></span>, +<span class="emphasis"><em>b</em></span>oa<span class="emphasis"><em>t</em></span> and <span class="emphasis"><em>b</em></span>ea<span class="emphasis"><em>t +foot.tool </em></span>matches <span class="emphasis"><em>foot</em></span>s<span class="emphasis"><em>tool </em></span>and +<span class="emphasis"><em>foot tool</em></span></p></div><div class="sect4"><div class="titlepage"><div><div><h5 class="title"><a name="asterisk"></a>The Asterisk</h5></div></div></div><p>The asterisk "*" matches zero or more characters of the preceding: +set, character or indicated character. Using +a period asterisk combination ".*" after a commonly +found pattern can cause the search to take a very long time, +making the program seem to freeze. +<span class="emphasis"><em>be*n</em></span> matches<span class="emphasis"><em> beeen, been, ben</em></span>, +and <span class="emphasis"><em>bn</em></span> which could locate Reu<span class="emphasis"><em>ben</em></span> +and She<span class="emphasis"><em>bn</em></span>a.</p></div><div class="sect4"><div class="titlepage"><div><div><h5 class="title"><a name="plus"></a>The Plus Sign</h5></div></div></div><p>The Plus Sign "+" matches one or more characters of the preceding: +set, character or indicated character. Using +a period and plus sign combination ".+" after a +commonly found pattern can cause the search to take a very long +time, making the program seem to freeze. +<span class="emphasis"><em>be+n</em></span> matches <span class="emphasis"><em>beeen, been</em></span> and <span class="emphasis"><em>ben</em></span>, +but not <span class="emphasis"><em>bn</em></span>.</p></div><div class="sect4"><div class="titlepage"><div><div><h5 class="title"><a name="question"></a>The Question Mark</h5></div></div></div><p>The Question Mark "?"matches zero or one character of the +preceding: set, character or indicated character. +<span class="emphasis"><em>be?n</em></span> matches <span class="emphasis"><em>ben</em></span> and <span class="emphasis"><em>bn</em></span> +but not <span class="emphasis"><em>been</em></span>. +<span class="emphasis"><em>trees?</em></span> matches <span class="emphasis"><em>trees</em></span> or <span class="emphasis"><em>tree</em></span>.</p></div><div class="sect4"><div class="titlepage"><div><div><h5 class="title"><a name="bracket"></a>The Square Brackets </h5></div></div></div><p>The Square Brackets "[]" enclose a set of characters that can +match. The period, asterisk, plus sign and question mark are not +special inside the brackets. A minus sign can be used to indicate +a range. If you want a caret "^" to be part of the +range do not place it first after the left bracket or it will be +a special character. To include a "]" in the set make +it the first (or second after a special "^") character +in the set. To include a minus sign in the set make it the first +(or second after a special "^") or last character in +the set. +<span class="emphasis"><em>s[eia]t</em></span> matches <span class="emphasis"><em>set</em></span>, <span class="emphasis"><em>sit</em></span>, +and <span class="emphasis"><em>sat</em></span>, but not <span class="emphasis"><em>s</em></span>o<span class="emphasis"><em>t</em></span>. +<span class="emphasis"><em>s[eia]+t </em></span>matches as above but also, <span class="emphasis"><em>seat, +seet, siet</em></span>, etc. +<span class="emphasis"><em>[a-d]</em></span> matches <span class="emphasis"><em>a, b, c,</em></span> or <span class="emphasis"><em>d</em></span>. +<span class="emphasis"><em>[A-Z]</em></span> matches any uppercase letter. +[.;:?!] matches ., ;, :, ?, or ! but not a comma. +[ ]^-] matches ] or ^ or -</p></div><div class="sect4"><div class="titlepage"><div><div><h5 class="title"><a name="caret"></a>The Caret first in Square Brackets </h5></div></div></div><p>If the Caret is the first character after the left bracket ("[^") it +means NOT. +<span class="emphasis"><em>s[^io]t</em></span> matches <span class="emphasis"><em>set, sat</em></span>, etc., +but not <span class="emphasis"><em>s</em></span>i<span class="emphasis"><em>t</em></span> and <span class="emphasis"><em>s</em></span>o<span class="emphasis"><em>t</em></span>.</p></div><div class="sect4"><div class="titlepage"><div><div><h5 class="title"><a name="caret-s"></a>The Caret as Start of Line Anchor </h5></div></div></div><p>If the Caret is the first character in a pattern ("^xxx") it anchors +the pattern to the start of a line. Any match must be at the +beginning of a line. Because of unfiltered +formatting characters in some texts, this feature does not always +work, but may if a few periods are placed after the caret to +account for the formatting characters. +<span class="emphasis"><em>^In the beginning</em></span> matches lines that +start with "<span class="emphasis"><em>In the beginning</em></span>". +(May need to use: <span class="emphasis"><em>^.....In the beginning</em></span>)</p></div><div class="sect4"><div class="titlepage"><div><div><h5 class="title"><a name="dollar"></a>The Dollar Sign as End of Line Anchor </h5></div></div></div><p>If the Dollar Sign is the last character ("xxx$") in a pattern it +anchors the pattern to the end of a line. Any match must be at +the end of a line. Because of unfiltered +formatting characters in some texts, this feature does not always +work, but may if a few periods are placed before the dollar sign +to account for the formatting characters. +<span class="emphasis"><em>Amen\.$</em></span> matches lines that end with +"<span class="emphasis"><em>Amen.</em></span>" (May +need to use Amen\....$, Amen\..........$, or even +Amen\....................$)</p></div><div class="sect4"><div class="titlepage"><div><div><h5 class="title"><a name="bar"></a>The Vertical Bar </h5></div></div></div><p>The Vertical Bar "|" between patterns means OR. +<span class="emphasis"><em>John|Peter</em></span> matches <span class="emphasis"><em>John</em></span> or <span class="emphasis"><em>Peter. +John .*Peter|Peter .*John</em></span> matches <span class="emphasis"><em>John</em></span> +... <span class="emphasis"><em>Peter</em></span> or <span class="emphasis"><em>Peter</em></span> ... <span class="emphasis"><em>John</em></span>. +(.* slows a search) +<span class="emphasis"><em>pain|suffering|sorrow</em></span> matches <span class="emphasis"><em>pain</em></span>, +or <span class="emphasis"><em>suffering</em></span>, or <span class="emphasis"><em>sorrow</em></span>.</p></div><div class="sect4"><div class="titlepage"><div><div><h5 class="title"><a name="parenth"></a>The Parentheses</h5></div></div></div><p><span class="emphasis"><em>The use of Parentheses "( )" is +not supported!</em></span></p></div><div class="sect4"><div class="titlepage"><div><div><h5 class="title"><a name="backslash"></a>The Backslash Prior to a Special Character</h5></div></div></div><p>The Backslash prior to a special character ("\*") indicates that the +character is not being used in its special meaning, but is just +to match itself. +<span class="emphasis"><em>amen\.</em></span> matches <span class="emphasis"><em>amen.</em></span> but not <span class="emphasis"><em>amen</em></span>t +and will not locate firm<span class="emphasis"><em>amen</em></span>t.</p></div><div class="sect4"><div class="titlepage"><div><div><h5 class="title"><a name="backslash-o"></a>The Backslash Prior to an Ordinary Character </h5></div></div></div><p>The Backslash prior to an ordinary character ("\o") indicates that +the character is not being used to match itself, but has special +meaning.</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p> +\b if use outside [ ] means word boundary. If used inside [ ] means backspace. +<span class="emphasis"><em>\brighteous\b</em></span> matches <span class="emphasis"><em>righteous</em></span> but +not un<span class="emphasis"><em>righteous</em></span> or <span class="emphasis"><em>righteous</em></span>ness</p></li><li class="listitem"><p>\B means non-word boundary. <span class="emphasis"><em>\Brighteous\B</em></span> +matches un<span class="emphasis"><em>righteous</em></span>ness and un<span class="emphasis"><em>righteous</em></span>ly +but not <span class="emphasis"><em>righteous</em></span>, un<span class="emphasis"><em>righteous</em></span> or <span class="emphasis"><em> +righteous</em></span>ness.</p></li><li class="listitem"><p>\d means digit; same as [0-9].</p></li><li class="listitem"><p>\D means non-digit, same as [^0-9].</p></li><li class="listitem"><p>\s means space. </p></li><li class="listitem"><p>\S means not a space. </p></li><li class="listitem"><p>\w means alphanumeric; same as [a-zA-Z0-9_].</p></li><li class="listitem"><p>\W means not alphanumeric; same as [^a-zA-Z0-9_].</p></li></ul></div></div></div></div></div></body></html>
\ No newline at end of file diff --git a/help/C/ar01s07.html b/help/C/ar01s07.html new file mode 100644 index 0000000..ab2ee44 --- /dev/null +++ b/help/C/ar01s07.html @@ -0,0 +1,10 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> + <title>The Studypad</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"><meta name="keywords" content="gnome, xiphos, sword, crosswire, help dialog"><link rel="home" href="index.html" title="Xiphos Manual"><link rel="up" href="index.html" title="Xiphos Manual"><link rel="prev" href="ar01s06.html" title="The Search Function"><link rel="next" href="ar01s08.html" title="The Personal Commentary"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="studypad"></a>The Studypad</h2></div></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="xiphos-studypad"></a>Using The Studypad</h3></div></div></div><p> + The Studypad can be opened by choosing <span class="guisubmenu">File</span> → <span class="guimenuitem">Open StudyPad</span> + </p><p> + This is what the Studypad typically looks like: + </p><div class="figure"><a name="d0e2445"></a><p class="title"><b>Figure 31. The Studypad</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="figures/studypad.png" alt="The Studypad"></div></div></div></div><br class="figure-break"><p> The Studypad will save into your working directory, making it useful for collecting and exporting information and Bible study material from Xiphos into other programmes.</p><p> Toolbar 1</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>Font Size and Environment</p></li><li class="listitem"><p>Font Type</p></li><li class="listitem"><p>Bold, Italics, Underscored, Crossed Out</p></li><li class="listitem"><p>Left, Centre and Right Bound</p></li><li class="listitem"><p>Shift Paragraph Right or Left</p></li><li class="listitem"><p>Colour Selector</p></li></ul></div><p> Toolbar 2</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>New, Save, Delete and Print</p></li><li class="listitem"><p>Cut, Copy, Paste and Undo</p></li><li class="listitem"><p>Find and 'Find and Replace'</p></li><li class="listitem"><p>Spellcheck</p></li></ul></div><p> + In order for spellcheck to be available, one of the languages under + <span class="guisubmenu">Edit</span> → <span class="guimenuitem">Current languages</span> must be set. + </p></div></div></body></html>
\ No newline at end of file diff --git a/help/C/ar01s08.html b/help/C/ar01s08.html new file mode 100644 index 0000000..1d45cc9 --- /dev/null +++ b/help/C/ar01s08.html @@ -0,0 +1,61 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> + <title>The Personal Commentary</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"><meta name="keywords" content="gnome, xiphos, sword, crosswire, help dialog"><link rel="home" href="index.html" title="Xiphos Manual"><link rel="up" href="index.html" title="Xiphos Manual"><link rel="prev" href="ar01s07.html" title="The Studypad"><link rel="next" href="ar01s09.html" title="Journals and Prayer Lists"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="personal"></a>The Personal Commentary</h2></div></div></div><p> + To build up a personal commentary you will need to install the + editable 'Personal' sword module from the English Commentaries + section. Right click it and choose + <span class="guisubmenu">Edit</span> → <span class="guisubmenu">Note</span> → <span class="guimenuitem">Personal</span> + in the menu. + </p><p> + An editor window similar to the + <span class="guimenuitem">Study Pad</span> + will appear. Edit your comment and save it; in the future it will + appear as your comment to the relevant verse. + </p><div class="figure"><a name="d0e2523"></a><p class="title"><b>Figure 32. The Personal Commentary Editor </b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="figures/personal.png" alt="The Personal Commentary"></div></div></div></div><br class="figure-break"><p> + Locationbar + </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p> Synchronise Button</p></li><li class="listitem"><p>Bible Book, Chapter and Verse Selectors</p></li><li class="listitem"><p>Location Summary</p></li></ul></div><p> + Use the <span class="guimenuitem">Synchronise Button</span> to + quickly change location of your editor to that of the + underlying Bibletext or use the + <span class="guimenuitem">Book</span>, + <span class="guimenuitem">Chapter</span>, and + <span class="guimenuitem">Verse</span> + selectors to choose to edit your comment to one particular + verse. + </p><p>Toolbar 1</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>Font Size and Environment</p></li><li class="listitem"><p>Font Type</p></li><li class="listitem"><p>Bold, Italics, Underscored, Crossed Out</p></li><li class="listitem"><p>Left, Centre and Right Bound</p></li><li class="listitem"><p>Shift Paragraph Right or Left</p></li><li class="listitem"><p>Colour Selector</p></li></ul></div><p>Toolbar 2</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>Save, Delete and Print</p></li><li class="listitem"><p>Cut, Copy, Paste and Undo</p></li><li class="listitem"><p>Find and 'Find and Replace'</p></li><li class="listitem"><p>Spellcheck</p></li></ul></div><p> + In order for spellcheck to be available, one of the languages + under <span class="guisubmenu">Edit</span> → <span class="guimenuitem">Current + languages</span> must be set. + </p><p> + To create a link to other verses right click the text and + choose <span class="guimenuitem">Link..</span>. In the pop-up window + enter the link location and the module linked to. + </p><p> + It is possible to rename a personal commentary to suit a + particular subject of study for that commentary. Thus, + multiple personal commentaries may be installed: Rename the + existing personal commentary, and then re-install another + instance of the personal commentary if desired. Personal + commentary names can consist only of letters and digits, and + cannot duplicate an existing module's name. Rename is + accessible off the right-click menu. + </p><p> + If the study embodied in a particular personal commentary is + no longer needed, archival is available in the module manager, + prior to removal, for possible future re-installation. See + the module manager's Remove/Archive page. Any module may be + archived, not just personal commentaries. + </p><p> + Although there are 31,102 verses in standard versification, it + is unlikely that more than a tiny fraction of all verses will + have personal commentary attached to them. A verse list + showing where personal commentary notes exist is available + from <span class="guisubmenu">Right Click</span> → <span class="guimenuitem"> + Dump Pers.Comm.</span>. + </p><div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Tip</h3><p> + The created commentary page will be attached to an individual + verse only. To write commentary pages from within + Xiphos, attached to longer stretches of text use the + <span class="guimenuitem">Link..</span> function to link several + pages together + </p></div></div></body></html>
\ No newline at end of file diff --git a/help/C/ar01s09.html b/help/C/ar01s09.html new file mode 100644 index 0000000..d2dc2c4 --- /dev/null +++ b/help/C/ar01s09.html @@ -0,0 +1,85 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> + <title>Journals and Prayer Lists</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"><meta name="keywords" content="gnome, xiphos, sword, crosswire, help dialog"><link rel="home" href="index.html" title="Xiphos Manual"><link rel="up" href="index.html" title="Xiphos Manual"><link rel="prev" href="ar01s08.html" title="The Personal Commentary"><link rel="next" href="ar01s10.html" title="Getting Help Online"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="journals"></a>Journals and Prayer Lists</h2></div></div></div><p> + <span class="application">Xiphos</span> supports + user-created and -editable modules to contain general + content. Initially conceived as simple prayer lists, + they have expanded to include daily journals and + topic-outline content. The user can maintain prayer + lists, or prepare sermons, or write any structured + content desired. + </p><p> + To enable prayer list and journal support, see the + Preferences dialog as previously described. There, in + <span class="guisubmenu">General</span> → <span class="guimenuitem"> + Options</span>, check the + item labeled + <span class="guimenuitem">Enable Prayer Lists</span>. + You will see a new item appear at the bottom of the + sidebar's module list for "Prayer Lists/Journals". + </p><p> + Right-click on this entry, and you will be offered a + context menu to create new modules. All the offered + options are of the same type, but what is offered is a + variety of templates from which to work. There are 5 + templates at this time. + </p><div class="figure"><a name="d0e2651"></a><p class="title"><b>Figure 33. Creating a journal or prayer list</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="figures/journal.png" alt="New journal or prayer list"></div></div></div></div><br class="figure-break"><p> + Their structure is the same, but the offered templates + provide a variety of hints regarding ways to organize + content. <span class="guimenuitem">Simple</span> is + trivial, and can be considered a mental Post-It + note. <span class="guimenuitem">Subject</span> is useful as + a more organized version. + <span class="guimenuitem">Monthly</span> provides a + per-month structure in which to track needed content. + <span class="guimenuitem">Daily Journal</span> is a full + 365-day calendar in which to track a personal journal + or ongoing prayer needs. And finally, + <span class="guimenuitem">Outlined Topic</span> is a full, + expandable outline suitable for topics and subtopics. + </p><p> + Journals and prayer lists have the structure of a + general book: If simply selected for display from the + module list, they will appear in the usual subwindow + for general books. + </p><p> + Editing a journal or prayer list is done by + right-clicking the module name to get its context + menu, whose middle item is <span class="guimenuitem">Open in + Editor</span>. The sections and subsections + will be listed in the left margin. Click one, and the + editor navigates to that section. The context menu on + right-click of section keys provides for adding, + deleting, and editing the names of sections and + subsections. + </p><p> + If the general book subwindow is currently displaying + the journal or prayer list being edited, it will + synchronize with new content when + <span class="guimenuitem">Save</span> is used. + </p><p> + As mentioned, these user-edited modules are in effect + general books. This means they can be viewed in any + Sword Project application. Thus, you can use these + modules immediately in + <span class="application">BibleTime</span>, for example; or + from the Module Manager's + <span class="guimenuitem">Maintenance</span> page, you can + archive a zip file to copy to a Windows system where + you can then install the zip content as a module for + the Windows user interface. Few other Sword Project + applications provide for editing these modules, + however, meaning that they will appear in such other + applications as just ordinary general books. + </p><p> + In the future, it is planned that a module sharing + facility will become available, by which user-edited + modules such as these can be uploaded to become + available to a wide audience. The current install + repository facility will be expanded to provide upload + as well as the existing download capability in order + to support this. Thus, users will be able to share + their sermons, Bible studies, and other + personally-authored content with other Sword + application users. + </p></div></body></html>
\ No newline at end of file diff --git a/help/C/ar01s10.html b/help/C/ar01s10.html new file mode 100644 index 0000000..e948cf0 --- /dev/null +++ b/help/C/ar01s10.html @@ -0,0 +1,12 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> + <title>Getting Help Online</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"><meta name="keywords" content="gnome, xiphos, sword, crosswire, help dialog"><link rel="home" href="index.html" title="Xiphos Manual"><link rel="up" href="index.html" title="Xiphos Manual"><link rel="prev" href="ar01s09.html" title="Journals and Prayer Lists"><link rel="next" href="ar01s11.html" title="Original Language Research"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="onlinehelp"></a>Getting Help Online</h2></div></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="xiphos-mailing-list"></a>Users Mailing List</h3></div></div></div><p>One way you can get help with Xiphos is using our low-traffic users' mailing list. + You can sign up by clicking <a class="ulink" href="https://lists.sourceforge.net/lists/listinfo/gnomesword-users/" target="_top"> + this link</a>. Once you are signed up, you can email the list with any problems you are having + and other users or the developers will respond, typically within a day. + </p></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="xiphos-live-chat"></a>Live Chat</h3></div></div></div><p>Another way to get help is with online chat. Xiphos has an IRC channel on freenode, #xiphos. + If you don't know what that means, it's ok. Just click <a class="ulink" href="http://webchat.freenode.net/?randomnick=1&channels=xiphos&prompt=1" target="_top">this link</a> (it will open your web browser), type a nickname or accept the default, and click "Click to join chatroom". + This will take you to a chatroom where the developers and other users are available to help you with issues + you may be having. Although many times someone will answer your question immediately, sometimes you may + have to wait a few minutes or longer. + </p></div></div></body></html>
\ No newline at end of file diff --git a/help/C/ar01s11.html b/help/C/ar01s11.html new file mode 100644 index 0000000..837de15 --- /dev/null +++ b/help/C/ar01s11.html @@ -0,0 +1,67 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> + <title>Original Language Research</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"><meta name="keywords" content="gnome, xiphos, sword, crosswire, help dialog"><link rel="home" href="index.html" title="Xiphos Manual"><link rel="up" href="index.html" title="Xiphos Manual"><link rel="prev" href="ar01s10.html" title="Getting Help Online"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="originallanguage"></a>Original Language Research</h2></div></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="orig-lang-install-modules"></a>Installing Needed Modules</h3></div></div></div><p>Xiphos is ideally suited for studying the original Greek and Hebrew. + To get started, you will want the following modules: + </p><p> + From Crosswire Repository: + </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p> + StrongsHebrew Dictionary (or get StrongsRealHebrew from the Xiphos Repository) + </p></li><li class="listitem"><p> + StrongsGreek Dictionary (or get StrongsRealGreek from the Xiphos Repository) + </p></li><li class="listitem"><p> + Robinson Dictionary + </p></li><li class="listitem"><p> + KJV Bible + </p></li></ul></div><p> + From Xiphos Repository: + </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p> + StrongsRealGreek Dictionary (same as StrongsGreek, but with Greek characters, B-Greek transliteration, and self-referencing links) + </p></li><li class="listitem"><p> + StrongsRealHebrew Dictionary (same as StrongsHebrew, but with Hebrew characters and self-referencing links) + </p></li><li class="listitem"><p> + InvertedStrongsRealGreek (key in or copy actual Greek word, rather than number) + </p></li></ul></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="orig-lang-setup"></a>Setting Up</h3></div></div></div><p>While still in the module manager, create indexes for all of the modules you just installed. + Then close the module manager and open <span class="guisubmenu">Edit</span> → <span class="guimenuitem"> + Preferences</span> and go to <span class="guisubmenu">Modules</span> → <span class="guimenuitem">Misc</span>. Set your Hebrew and Greek lexicons according to what you installed. + Close preferences and open the KJV module. Turn on the module options <span class="guisubmenu">Right Click</span> → <span class="guisubmenu">Module Options</span> → <span class="guimenuitem">Show Strongs + </span> and <span class="guisubmenu">Right Click</span> → <span class="guisubmenu">Module Options + </span> → <span class="guimenuitem">Show Morphology</span>. You should see the Bible text + change to show Strongs numbers underneath the appropriate English words. Hover over the numbers + (or letters for morphology) with the mouse and you will see the definition displayed in the previewer pane. + Click on the link and the definition will show in the dictionary pane. If you are using StrongsRealGreek or + StrongsRealHebrew, you can click on any other number referenced in the definition and you will be taken to that entry. + </p></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="orig-lang-search"></a>Searching for Strongs Numbers</h3></div></div></div><p>Choose <span class="guisubmenu">Edit</span> → <span class="guimenuitem">Advanced Search</span>or press + <span class="keycap"><strong>F3</strong></span>. Under <span class="interface">Search Type</span>, select <span class="guibutton">Optimized ("Lucene")</span>. + Click on the <span class="interface">Attribute Search</span> tab, and make check the box that says <span class="guibutton"> + Strongs Numbers</span>. Now click in the entry field at the top and search for the number you are looking for + preceded by "lemma:" and "G" for Greek or "H" for Hebrew. So to look for the Hebrew word tsad-deek (6662), enter + "lemma:H6662". Once the search is done, the results pane will be shown. Notice that when you click on a result, + it will show the result in the preview pane, and the strong's numbers will show as well, following immediately + after the words they match. Also note that hovering over these numbers will show the definition in the main preview pane. + </p></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="orig-lang-additional"></a>Additional Modules</h3></div></div></div><p>For more advanced research, the following modules are also available:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p> + 2TGreek (Xiphos Repository) : This module contains the entire Bible in Greek. It combines the LXX + and Tischendorf8 NT into one easy-to-use module. In addition, it contains Strongs, Morphology,Greek Accents, + and primary/secondary readings. As with all modules that include Strongs, Xiphos displays 2TGreek in + beautiful interlinear form. + </p></li><li class="listitem"><p> + Elzevir Textus Receptus (Crosswire Beta Repository as of this writing) : 1624 edition with Strongs and Morphology + </p></li><li class="listitem"><p> + LXX (Crosswire Repository) : the Septuagint with Strongs, Morphology, and footnotes + </p></li><li class="listitem"><p> + MorphGNT (Crosswire Beta Repository as of this writing) : This is derived from the morphologically parsed GNT + provided by UPenn's CCAT. It was reformatted and error-corrected by James Tauber. It includes Greek accents + and Morphology. + </p></li><li class="listitem"><p> + TR (Crosswire Repository) : This is the Textus Receptus with Strongs and Morphology + </p></li><li class="listitem"><p> + TischMorph (Xiphos Repository) : As described above, this has Strongs, Morphology, accents, and alternate readings. + </p></li><li class="listitem"><p> + WHNU (Crosswire Repository) : Westcott-Hort of 1881 with Strongs and Morphology + </p></li><li class="listitem"><p> + GreekHebrew (Crosswire Repository) : This is a dictionary keyed to Strongs. It contains words in the LXX + that are also found in the New Testament. In addition, it contains the equivalent Hebrew words also keyed + to Strongs. + </p></li><li class="listitem"><p> + Didache (Crosswire Beta Repository as of this writing) : This is an early Christian treatise in Greek dated + to the late first or early second century. It includes Strongs, Morphology, and Greek accents. + </p></li></ul></div></div></div></body></html>
\ No newline at end of file diff --git a/help/C/figures/preferences.png b/help/C/figures/preferences.png Binary files differindex 04ca442..934f2c1 100644 --- a/help/C/figures/preferences.png +++ b/help/C/figures/preferences.png diff --git a/help/C/figures/preferences_fonts-color.png b/help/C/figures/preferences_fonts-color.png Binary files differindex 2493a7d..65984fb 100644 --- a/help/C/figures/preferences_fonts-color.png +++ b/help/C/figures/preferences_fonts-color.png diff --git a/help/C/figures/preferences_fonts-misc.png b/help/C/figures/preferences_fonts-misc.png Binary files differindex 3210ddb..1524799 100644 --- a/help/C/figures/preferences_fonts-misc.png +++ b/help/C/figures/preferences_fonts-misc.png diff --git a/help/C/figures/preferences_general-biblesync.png b/help/C/figures/preferences_general-biblesync.png Binary files differnew file mode 100644 index 0000000..b8e47dd --- /dev/null +++ b/help/C/figures/preferences_general-biblesync.png diff --git a/help/C/figures/preferences_general-misc.png b/help/C/figures/preferences_general-misc.png Binary files differindex 3295bf0..198aa9b 100644 --- a/help/C/figures/preferences_general-misc.png +++ b/help/C/figures/preferences_general-misc.png diff --git a/help/C/figures/preferences_modules-misc.png b/help/C/figures/preferences_modules-misc.png Binary files differindex 441be6d..0e1a2f6 100644 --- a/help/C/figures/preferences_modules-misc.png +++ b/help/C/figures/preferences_modules-misc.png diff --git a/help/C/figures/preferences_modules-parallel.png b/help/C/figures/preferences_modules-parallel.png Binary files differindex 0e41fe5..0fdcd9f 100644 --- a/help/C/figures/preferences_modules-parallel.png +++ b/help/C/figures/preferences_modules-parallel.png diff --git a/help/C/htmlhelp.hhp b/help/C/htmlhelp.hhp new file mode 100644 index 0000000..c128a89 --- /dev/null +++ b/help/C/htmlhelp.hhp @@ -0,0 +1,31 @@ +[OPTIONS] +Auto Index=Yes +Binary TOC=Yes +Compatibility=1.1 or later +Compiled file=htmlhelp.chm +Contents file=toc.hhc +Default Window=Main +Default topic=index.html +Display compile progress=Yes +Full-text search=Yes +Index file=index.hhk +Language=0x0409 English (UNITED STATES) +Title=Xiphos Manual +Enhanced decompilation=No + +[WINDOWS] +Main="Xiphos Manual","toc.hhc","index.hhk","index.html","index.html",,,,,0x2520,,0x603006,,,,,,,,0 + + +[FILES] +index.html +ar01s02.html +ar01s03.html +ar01s04.html +ar01s05.html +ar01s06.html +ar01s07.html +ar01s08.html +ar01s09.html +ar01s10.html +ar01s11.html diff --git a/help/C/index.hhk b/help/C/index.hhk new file mode 100644 index 0000000..275a6d0 --- /dev/null +++ b/help/C/index.hhk @@ -0,0 +1,11 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<HTML> +<HEAD> +<meta name="GENERATOR" content="Microsoft® HTML Help Workshop 4.1"> +<!-- Sitemap 1.0 --> +</HEAD><BODY> +<OBJECT type="text/site properties"> +</OBJECT> +<UL> +</UL> +</BODY></HTML> diff --git a/help/C/index.html b/help/C/index.html new file mode 100644 index 0000000..7dae6e2 --- /dev/null +++ b/help/C/index.html @@ -0,0 +1,73 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> + <title>Xiphos Manual</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"><meta name="description" content="Xiphos is an application to aid in study of the Bible."><meta name="keywords" content="gnome, xiphos, sword, crosswire, help dialog"><link rel="home" href="index.html" title="Xiphos Manual"><link rel="next" href="ar01s02.html" title="Getting Started with Xiphos"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div lang="en" class="article"><div class="titlepage"><div><div><h2 class="title"><a name="index"></a><span class="application">Xiphos</span> Manual</h2></div><div><div class="authorgroup"><div class="author"><h3 class="author"><span class="firstname">Andy</span> <span class="surname">Piper</span></h3></div><div class="author"><h3 class="author"><span class="firstname">Pierre</span> <span class="surname">Benz</span></h3></div><div class="author"><h3 class="author"><span class="firstname">Dr Peter</span> <span class="surname">von Kaehne</span></h3></div><div class="author"><h3 class="author"><span class="firstname">Karl</span> <span class="surname">Kleinpaste</span></h3></div><div class="author"><h3 class="author"><span class="firstname">Matthew</span> <span class="surname">Talbert</span></h3></div><div class="othercredit"><h3 class="othercredit"><span class="firstname">Dominique</span> <span class="surname">Corbex</span></h3><span class="contrib">French translation</span> <div class="affiliation"><span class="orgname">Xiphos Development team<br></span></div></div></div></div><div><p class="releaseinfo">This manual describes version 3.2.2 of Xiphos. + </p></div><div><p class="copyright">Copyright © 2003-2014 The Xiphos Team</p></div><div><div class="legalnotice"><a name="d0e34"></a><p class="legalnotice-title"><b>Feedback</b></p><p> + For more information on <span class="application">Xiphos</span>, please visit + the project website at <a class="ulink" href="http://xiphos.org" target="_top">http://xiphos.org</a>. + </p><p>To report a bug or make a suggestion regarding the Xiphos + application or this manual, Use + the <a class="ulink" href="http://sourceforge.net/tracker/?group_id=5528" target="_top"> + Tracker on SourceForge</a> or the mailing + lists <code class="email"><<a class="email" href="mailto:gnomesword-developers@lists.sourceforge.net">gnomesword-developers@lists.sourceforge.net</a>></code> + </p></div></div><div><div class="legalnotice"><a name="legalnotice"></a><p> + Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU General Public License + (GPL), Version 2 or any later version published + by the Free Software Foundation. You can find + a copy of the GPL at this <a class="ulink" href="ghelp:gpl" target="_top">link</a> or in the file COPYING + distributed with this manual. + </p><p> + DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT ARE PROVIDED + UNDER THE TERMS OF THE GNU FREE DOCUMENTATION LICENSE + WITH THE FURTHER UNDERSTANDING THAT: + + </p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><p>DOCUMENT IS PROVIDED ON AN "AS IS" BASIS, + WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR + IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES + THAT THE DOCUMENT OR MODIFIED VERSION OF THE + DOCUMENT IS FREE OF DEFECTS MERCHANTABLE, FIT FOR + A PARTICULAR PURPOSE OR NON-INFRINGING. THE ENTIRE + RISK AS TO THE QUALITY, ACCURACY, AND PERFORMANCE + OF THE DOCUMENT OR MODIFIED VERSION OF THE + DOCUMENT IS WITH YOU. SHOULD ANY DOCUMENT OR + MODIFIED VERSION PROVE DEFECTIVE IN ANY RESPECT, + YOU (NOT THE INITIAL WRITER, AUTHOR OR ANY + CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY + SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER + OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS + LICENSE. NO USE OF ANY DOCUMENT OR MODIFIED + VERSION OF THE DOCUMENT IS AUTHORIZED HEREUNDER + EXCEPT UNDER THIS DISCLAIMER; AND + </p></li><li class="listitem"><p>UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL + THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE), + CONTRACT, OR OTHERWISE, SHALL THE AUTHOR, + INITIAL WRITER, ANY CONTRIBUTOR, OR ANY + DISTRIBUTOR OF THE DOCUMENT OR MODIFIED VERSION + OF THE DOCUMENT, OR ANY SUPPLIER OF ANY OF SUCH + PARTIES, BE LIABLE TO ANY PERSON FOR ANY + DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR + CONSEQUENTIAL DAMAGES OF ANY CHARACTER + INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS + OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR + MALFUNCTION, OR ANY AND ALL OTHER DAMAGES OR + LOSSES ARISING OUT OF OR RELATING TO USE OF THE + DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT, + EVEN IF SUCH PARTY SHALL HAVE BEEN INFORMED OF + THE POSSIBILITY OF SUCH DAMAGES. + </p></li></ol></div><p> + </p></div></div><div><div class="revhistory"><table style="border-style:solid; width:100%;" summary="Revision History"><tr><th align="left" valign="top" colspan="2"><b>Revision History</b></th></tr><tr><td align="left">Revision Xiphos Manual V3.2.2</td><td align="left">January 2014</td></tr><tr><td align="left" colspan="2"> + <p class="author">The Xiphos Team</p> + <p class="publisher">The Xiphos Team</p> + </td></tr></table></div></div><div><div class="abstract"><p class="title"><b>Abstract</b></p><p>Xiphos is an application to aid in study of the Bible.</p></div></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="sect1"><a href="index.html#xiphos-introduction">Introduction</a></span></dt><dt><span class="sect1"><a href="ar01s02.html">Getting Started with Xiphos</a></span></dt><dd><dl><dt><span class="sect2"><a href="ar01s02.html#xiphos-getting-started">Starting Xiphos</a></span></dt><dt><span class="sect2"><a href="ar01s02.html#xiphos-first-start">Starting Xiphos For The First Time</a></span></dt><dt><span class="sect2"><a href="ar01s02.html#xiphos-when-you-start">Launching Xiphos</a></span></dt></dl></dd><dt><span class="sect1"><a href="ar01s03.html">Interface</a></span></dt><dd><dl><dt><span class="sect2"><a href="ar01s03.html#menubar">Menubar</a></span></dt><dt><span class="sect2"><a href="ar01s03.html#toolbars">Toolbars</a></span></dt><dt><span class="sect2"><a href="ar01s03.html#xiphos-sidebar">The Sidebar</a></span></dt><dt><span class="sect2"><a href="ar01s03.html#xiphos-bible">The Bible Text Pane</a></span></dt><dt><span class="sect2"><a href="ar01s03.html#xiphos-viewer">Previewer</a></span></dt><dt><span class="sect2"><a href="ar01s03.html#xiphos-commentaries">The Commentary Pane</a></span></dt><dt><span class="sect2"><a href="ar01s03.html#xiphos-dictionary">Dictionary Pane</a></span></dt><dt><span class="sect2"><a href="ar01s03.html#xiphos-shortcut">Keyboard Shortcuts</a></span></dt></dl></dd><dt><span class="sect1"><a href="ar01s04.html">Preferences</a></span></dt><dd><dl><dt><span class="sect2"><a href="ar01s04.html#preferences-introduction">Introduction To Preferences</a></span></dt><dt><span class="sect2"><a href="ar01s04.html#general-settings">General Settings</a></span></dt><dt><span class="sect2"><a href="ar01s04.html#biblesync">BibleSync Settings</a></span></dt><dt><span class="sect2"><a href="ar01s04.html#fonts-and-colors">Fonts And Colors</a></span></dt><dt><span class="sect2"><a href="ar01s04.html#module-settings">Module Settings</a></span></dt></dl></dd><dt><span class="sect1"><a href="ar01s05.html">Module Manager</a></span></dt><dd><dl><dt><span class="sect2"><a href="ar01s05.html#module-introduction">Introduction To The Module Manager</a></span></dt><dt><span class="sect2"><a href="ar01s05.html#sword-config">Sword Module Configurations</a></span></dt><dt><span class="sect2"><a href="ar01s05.html#module-management">Installing, Updating, and Maintaining Modules</a></span></dt><dt><span class="sect2"><a href="ar01s05.html#non-standard-modules">Installing Non-Standard Modules</a></span></dt></dl></dd><dt><span class="sect1"><a href="ar01s06.html">The Search Function</a></span></dt><dd><dl><dt><span class="sect2"><a href="ar01s06.html#xiphos-searchpane">Simple Searches</a></span></dt><dt><span class="sect2"><a href="ar01s06.html#xiphos-advanced-search">Advanced Searches</a></span></dt><dt><span class="sect2"><a href="ar01s06.html#hdbk-op-search-dialog-text-regexp">Search Syntax using Regular Expression</a></span></dt></dl></dd><dt><span class="sect1"><a href="ar01s07.html">The Studypad</a></span></dt><dd><dl><dt><span class="sect2"><a href="ar01s07.html#xiphos-studypad">Using The Studypad</a></span></dt></dl></dd><dt><span class="sect1"><a href="ar01s08.html">The Personal Commentary</a></span></dt><dt><span class="sect1"><a href="ar01s09.html">Journals and Prayer Lists</a></span></dt><dt><span class="sect1"><a href="ar01s10.html">Getting Help Online</a></span></dt><dd><dl><dt><span class="sect2"><a href="ar01s10.html#xiphos-mailing-list">Users Mailing List</a></span></dt><dt><span class="sect2"><a href="ar01s10.html#xiphos-live-chat">Live Chat</a></span></dt></dl></dd><dt><span class="sect1"><a href="ar01s11.html">Original Language Research</a></span></dt><dd><dl><dt><span class="sect2"><a href="ar01s11.html#orig-lang-install-modules">Installing Needed Modules</a></span></dt><dt><span class="sect2"><a href="ar01s11.html#orig-lang-setup">Setting Up</a></span></dt><dt><span class="sect2"><a href="ar01s11.html#orig-lang-search">Searching for Strongs Numbers</a></span></dt><dt><span class="sect2"><a href="ar01s11.html#orig-lang-additional">Additional Modules</a></span></dt></dl></dd></dl></div><OBJECT type="application/x-oleobject" classid="clsid:1e2a7bd0-dab9-11d0-b93a-00c04fc99f9e"><param name="Keyword" value="Xiphos"></OBJECT><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="xiphos-introduction"></a>Introduction</h2></div></div></div><p><span class="application">Xiphos</span> is a Bible study and research tool based upon the "SWORD Project" libraries + and the GTK libraries. You can use <span class="application">Xiphos</span> to do the following:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>View your favorite Scripture verse</p></li><li class="listitem"><p>Make sermon or personal notes on selected passages</p></li><li class="listitem"><p>Automatically follow Bible footnotes and cross-references</p></li><li class="listitem"><p>Compare translations in parallel</p></li><li class="listitem"><p>Work in original language study using the available Hebrew and Greek + translations</p></li></ul></div><p><span class="application">Xiphos</span> aims to provide a simple and clean user interface while providing a + powerful tool allowing a personalized Bible study environment.</p><div class="figure"><a name="sword-logo"></a><p class="title"><b>Figure 1. The SWORD Project logo</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="figures/sword3.png" alt="The SWORD Project logo"></div></div></div></div><br class="figure-break"><p>"The SWORD Project" is based at <a class="ulink" href="http://www.crosswire.org" target="_top">http://www.crosswire.org</a>. Other + applications under the same banner are <span class="application">MacSword</span> for the Macintosh, <span class="application">BibleDesktop</span>, + a Java application, <span class="application">BibleTime</span> (another Linux program), and <span class="application">The SWORD Project for + Windows</span> (aka <span class="application">BibleCS</span> or <span class="application">WinSword</span>).</p><p> + </p><div class="figure"><a name="main-screenshot"></a><p class="title"><b>Figure 2. Xiphos in action</b></p><div class="figure-contents"><div class="screenshot"><div class="mediaobject"><img src="figures/interface.png" alt="Xiphos in action"></div></div></div></div><p><br class="figure-break"> + </p><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p><span class="application">Xiphos</span> is currently in development, so this manual may not + reflect the program as you see it. If it does not, please file a + bug at the <a class="ulink" href="http://sourceforge.net/projects/xiphos" target="_top"> + project website</a>, or email <code class="email"><<a class="email" href="mailto:xiphos-developers@lists.sourceforge.net">xiphos-developers@lists.sourceforge.net</a>></code>. + All help is appreciated, as it will improve the software.</p></div></div></div></body></html> diff --git a/help/C/interface.xml b/help/C/interface.xml index eead8f8..0fe8ae8 100644 --- a/help/C/interface.xml +++ b/help/C/interface.xml @@ -732,7 +732,12 @@ </listitem> <listitem> <para> - <guibutton>Ctrl-t</guibutton> opens a new tab. + <guibutton>Ctrl-T</guibutton> opens a new tab. + </para> + </listitem> + <listitem> + <para> + <guibutton>Ctrl-[1-9]</guibutton> makes the Nth tab current. </para> </listitem> </itemizedlist> @@ -752,6 +757,15 @@ <listitem> <para><guibutton>Shift-F10</guibutton> brings up the context menu for the Bible pane.</para> </listitem> + <listitem> + <para><guibutton>Alt-S</guibutton>: Toggle Strong's display.</para> + </listitem> + <listitem> + <para><guibutton>Alt-M</guibutton>: Toggle morphology display.</para> + </listitem> + <listitem> + <para><guibutton>Alt-R</guibutton>: Toggle "red words of Christ" display.</para> + </listitem> </itemizedlist> <para> Opening special windows: @@ -774,11 +788,21 @@ </listitem> <listitem> <para> + <guibutton>Ctrl-F3</guibutton>: brings forward the simple sidebar search. + </para> + </listitem> + <listitem> + <para> <guibutton>F4</guibutton>: opens the <guibutton>Module Manager</guibutton>. </para> </listitem> <listitem> <para> + <guibutton>Alt-A</guibutton> opens an annotation dialog on the current verse. + </para> + </listitem> + <listitem> + <para> <guibutton>Alt-B</guibutton> opens a bookmark dialog on the current verse. </para> </listitem> @@ -809,74 +833,41 @@ <guibutton>Ctrl-Plus/Ctrl-Minus</guibutton> increases/decreases the base font size. </para> </listitem> + <listitem> + <para> + <guibutton>Ctrl-0</guibutton> (zero) sets the base font size to zero. + </para> + </listitem> </itemizedlist> - </sect2> - - <sect2 id="xiphos-differences"> - <title>Version Differences in <application>Xiphos</application>' Display</title> - <para> - The <application>Xiphos</application> interface has evolved over time, and there are two display libraries with which - <application>Xiphos</application> can be built. The older, less featureful version is called "gtkhtml3", and the newer, - more capable version is called "webkit". Both of these display libraries render text in a browser-like fashion, using HTML - constructs to control display. - </para> - <para> - Several desirable capabilities are unsupportable in gtkhtml3, and although recent <application>Xiphos</application> is - written to take advantage of webkit features, it is possible that the version running on your computer needed to be built - with gtkhtml3 instead, either because the version of webkit available for your system is not recent enough to support the - needs of <application>Xiphos</application>, or it simply doesn't exist for your system. The following differences will be - apparent, depending on whether gtkhtml3 or webkit is the underlying display engine: + BibleSync: </para> - <itemizedlist> <listitem> <para> - Morphology and Strong's references, enabled via the right-click menu in some modules, are displayed inline - with gtkhtml3; with webkit, a blocked display is used, where these references are aligned beneath the word - to which they refer, for a much more readable, less cluttered display. + <guibutton>Ctrl-Alt-Shift-P</guibutton> puts BibleSync into Personal mode. </para> </listitem> <listitem> <para> - Footnote and cross-reference markers (<guibutton>*n</guibutton>, <guibutton>*x</guibutton>) are displayed as - proper superscripts in webkit, but not in gtkhtml3. + <guibutton>Ctrl-Alt-Shift-S</guibutton> puts BibleSync into Speaker mode. </para> </listitem> <listitem> <para> - Links in gtkhtml3 are necessarily both colored and underlined; in webkit, no underlines are needed. + <guibutton>Ctrl-Alt-Shift-A</guibutton> puts BibleSync into Audience mode. </para> </listitem> <listitem> <para> - Under webkit, double-space display is available using the context menu, but not under gtkhtml3. + <guibutton>Ctrl-Alt-Shift-O</guibutton> turns off BibleSync. </para> </listitem> <listitem> <para> - It is not possible for gtkhtml3 to interpret multiple font face directives in a single window, so the - gtkhtml3 detached parallel view window cannot provide per-module font selections. Also, modules' internal - font requests are ignored in any gtkhtml3 window. - </para> + <guibutton>Ctrl-Alt-Shift-N</guibutton> causes BibleSync to navigate your current main window point + transiently as a one-shot event. BibleSync must be in transmit-ready, that is, in Personal or Speaker mode. + </para> </listitem> </itemizedlist> - - <para> - Using the "About Xiphos" selection under the <guimenuitem>Help</guimenuitem> menu, you will see the display library with - which <application>Xiphos</application> was built. - </para> - <figure id="displib_figure"> - <title>Comparison, gtkhtml3 -vs- webkit</title> - <screenshot> - <mediaobject> - <imageobject> - <imagedata fileref="figures/gtkhtml3-vs-mozembed.png" format="PNG" /> - </imageobject> - <textobject> - <phrase>Comparison, gtkhtml3 -vs- webkit</phrase> - </textobject> - </mediaobject> - </screenshot> - </figure> </sect2> diff --git a/help/C/preferences.xml b/help/C/preferences.xml index ac03072..7d6480a 100644 --- a/help/C/preferences.xml +++ b/help/C/preferences.xml @@ -25,6 +25,124 @@ </figure> </sect2> +<!-- General Settings --> + <sect2 id="general-settings"> + <title>General Settings</title> + <sect3 id="tab-pane2"> + <title>Locale, General Preferences and StudyPad directory</title> + <figure> + <title>Locale, General Preferences and StudyPad directory</title> + <screenshot> + <mediaobject> + <imageobject><imagedata + fileref="figures/preferences_general-misc.png" format="PNG" /> + </imageobject> + <!-- EPS versions of the figures are not required at the moment. --> + <!-- + <imageobject> + <imagedata fileref="figures/preferences_general-misc.eps" format="EPS"/> + </imageobject> + --> + <textobject> + <phrase>General Preferences and StudyPad directory</phrase> + </textobject> + </mediaobject> + + </screenshot> + + </figure> + <para> + If you wish <application>Xiphos</application> to display its interface in a language other than the default, you may select + one here. A restart will be required, so that the locale can be initialized. + </para> + <para> + If you enable <guilabel>Default Dictionary</guilabel>, then that named dictionary (see <guimenuitem>Special</guimenuitem> + below) module will always be used when double-clicking a word anywhere in <application>Xiphos</application>. + </para> + <para> + Certain dictionary-style modules are <guilabel>Daily Devotionals</guilabel> whose keys are numerically in the form "Month.Day". If you have + such a module installed and it has been selected as your preferred devotional, then you can ask that <application>Xiphos</application> + display today's selection during startup. + </para> + <para> + If you enable <guilabel>Resize images</guilabel>, <application>Xiphos</application> will automatically resize image + content in commentaries, general books, and dictionaries so as to fit the subwindow which contains them. + </para> + <para> + <guilabel>Highlight current verse</guilabel>, if enabled, will cause <application>Xiphos</application> to substitute + mere current verse colorization with a high-contrast alternate color scheme on the current verse. The colors used may be + chosen from the color selector pane (see below). + </para> + <para> + <guilabel>Highlight user annotations</guilabel> uses inverted the highlight color choices when marking user-annotated + verses. + </para> + <para> + By default, <guilabel>Cross-references</guilabel> go into the Previewer. Selecting this checkbox puts them into the verse + list instead. + </para> + <para> + Verse number display can be offset in several ways provided by the checkboxes. + </para> + </sect3> + </sect2> + +<!-- General Settings --> + <sect2 id="biblesync"> + <title>BibleSync Settings</title> + <sect3 id="tab-bsp"> + <title>Controls for BibleSync</title> + <figure> + <title>Controls for BibleSync</title> + <screenshot> + <mediaobject> + <imageobject><imagedata + fileref="figures/preferences_general-biblesync.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>BibleSync Settings</phrase> + </textobject> + </mediaobject> + + </screenshot> + + </figure> + <para> + BibleSync is a shared navigation protocol using LAN multicast. It is useful for a single person when running Bible programs on + multiple machines or devices, all of which you wish to navigate through the Bible together, or for a group working closely together, + such as translators. Also, it has a "lecture" mode, where a speaker's Bible program induces the audience's programs to follow along. + The difference in the modes regards who transmits and who receives navigation. In Personal mode, BibleSync navigation is both + transmitted and received; as Speaker, it transmits only; as Audience, it receives only. + </para> + <para> + To enable BibleSync, select a mode from the radio buttons. Also, choose whether to accept navigation directly, so that Xiphos moves + immediately to a specified verse, or whether incoming navigation is instead sent to the verse list, where you can decide whether to + follow. + </para> + <para> + If you use a firewall, you must punch a hole in it for UDP port 22272. + </para> + <para> + If you run more than one BibleSync-compatible program on your computer and do not wish your activity among them to be shared on the + local net, you can use Personal mode combined with the Private checkbox. This will tell <application>Xiphos</application> not to + broadcast outside your system. + </para> + <para> + You can send a verse list from the sidebar search or Advanced Search window via BibleSync; see the context (right-click) menu. A + particularly good use case for this is when using a simpler Bible program, such as on a mobile device, with another such as + <application>Xiphos</application> that has significant search capability: Do searches in <application>Xiphos</application> and send + the resulting verse list to the mobile device. Be aware that size limitations on the protocol are small, and though a search may + generate hundreds of results in the verse list, at most a few dozen will pass in the protocol to the receivers. For + <application>Xiphos</application>, receipt of multi-references always induces indirect verse list navigation. + </para> + <para> + <application>Xiphos</application> is the first Bible program with a BibleSync implementation; as such, its utility may be limited for + now. But a number of other programs' authors and support organizations have indicated their intention to support BibleSync as well, + including Laridian, theWord, BibleAnalyzer, and Accordance, as well as other Sword Project applications. + </para> + </sect3> + </sect2> + <!-- Fonts And Colors --> <sect2 id="fonts-and-colors"> <title>Fonts And Colors</title> @@ -120,65 +238,6 @@ </sect3> </sect2> -<!-- General Settings --> - <sect2 id="general-settings"> - <title>General Settings</title> - <sect3 id="tab-pane2"> - <title>Locale, General Preferences and StudyPad directory</title> - <figure> - <title>Locale, General Preferences and StudyPad directory</title> - <screenshot> - <mediaobject> - <imageobject><imagedata - fileref="figures/preferences_general-misc.png" format="PNG" /> - </imageobject> - <!-- EPS versions of the figures are not required at the moment. --> - <!-- - <imageobject> - <imagedata fileref="figures/preferences_general-misc.eps" format="EPS"/> - </imageobject> - --> - <textobject> - <phrase>General Preferences and StudyPad directory</phrase> - </textobject> - </mediaobject> - - </screenshot> - - </figure> - <para> - If you wish <application>Xiphos</application> to display its interface in a language other than the default, you may select - one here. A restart will be required, so that the locale can be initialized. - </para> - <para> - If you enable <guilabel>Default Dictionary</guilabel>, then that named dictionary (see <guimenuitem>Special</guimenuitem> - below) module will always be used when double-clicking a word anywhere in <application>Xiphos</application>. - </para> - <para> - Certain dictionary-style modules are <guilabel>Daily Devotionals</guilabel> whose keys are numerically in the form "Month.Day". If you have - such a module installed and it has been selected as your preferred devotional, then you can ask that <application>Xiphos</application> - display today's selection during startup. - </para> - <para> - If you enable <guilabel>Resize images</guilabel>, <application>Xiphos</application> will automatically resize image - content in commentaries, general books, and dictionaries so as to fit the subwindow which contains them. - </para> - <para> - <guilabel>Highlight current verse</guilabel>, if enabled, will cause <application>Xiphos</application> to substitute - mere current verse colorization with a high-contrast alternate color scheme on the current verse. The colors used may be - chosen from the color selector pane (see above). - </para> - <para> - <guilabel>Highlight user annotations</guilabel> uses inverted the highlight color choices when marking user-annotated - verses. - </para> - <para> - By default, <guilabel>Cross-references</guilabel> go into the Previewer. Selecting this checkbox puts them into the verse - list instead. - </para> - </sect3> - </sect2> - <!-- Module Settings --> <sect2 id="module-settings"> <title>Module Settings</title> diff --git a/help/C/toc.hhc b/help/C/toc.hhc new file mode 100644 index 0000000..182c646 --- /dev/null +++ b/help/C/toc.hhc @@ -0,0 +1,299 @@ +<HTML> +<HEAD> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + </HEAD> +<BODY> +<OBJECT type="text/site properties"> +<param name="ImageType" value="Folder"> +</OBJECT> +<UL> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Xiphos Manual"> +<param name="Local" value="index.html"></OBJECT></LI> +<UL> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Introduction"> +<param name="Local" value="index.html#xiphos-introduction"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Getting Started with Xiphos"> +<param name="Local" value="ar01s02.html"></OBJECT></LI> +<UL> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Starting Xiphos"> +<param name="Local" value="ar01s02.html#xiphos-getting-started"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Starting Xiphos For The First Time"> +<param name="Local" value="ar01s02.html#xiphos-first-start"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Launching Xiphos"> +<param name="Local" value="ar01s02.html#xiphos-when-you-start"></OBJECT></LI> +</UL><LI><OBJECT type="text/sitemap"> +<param name="Name" value="Interface"> +<param name="Local" value="ar01s03.html"></OBJECT></LI> +<UL> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Menubar"> +<param name="Local" value="ar01s03.html#menubar"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Toolbars"> +<param name="Local" value="ar01s03.html#toolbars"></OBJECT></LI> +<UL> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="History Forward/Backward Selector"> +<param name="Local" value="ar01s03.html#d0e533"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Bible Book Selector"> +<param name="Local" value="ar01s03.html#xiphos-toolbar-book"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Bible Chapter Selector"> +<param name="Local" value="ar01s03.html#xiphos-toolbar-chapter"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Bible Verse Selector"> +<param name="Local" value="ar01s03.html#xiphos-toolbar-verse"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Bible Passage Summary"> +<param name="Local" value="ar01s03.html#xiphos-toolbar-summary"></OBJECT></LI> +</UL><LI><OBJECT type="text/sitemap"> +<param name="Name" value="The Sidebar"> +<param name="Local" value="ar01s03.html#xiphos-sidebar"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="The Bible Text Pane"> +<param name="Local" value="ar01s03.html#xiphos-bible"></OBJECT></LI> +<UL> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Opening A Specific Bible Translation"> +<param name="Local" value="ar01s03.html#xiphos-bible-open"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Using the Parallel View Mode"> +<param name="Local" value="ar01s03.html#xiphos-bible-parallel"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Opening A Separate Bible Translation"> +<param name="Local" value="ar01s03.html#xiphos-bible-open-separate"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Finding Out About The Current Translation"> +<param name="Local" value="ar01s03.html#xiphos-bible-about"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Module Options"> +<param name="Local" value="ar01s03.html#xiphos-bible-options"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="View Options"> +<param name="Local" value="ar01s03.html#xiphos-view-options"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="User Annotation"> +<param name="Local" value="ar01s03.html#xiphos-user-annotation"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Geography Support"> +<param name="Local" value="ar01s03.html#xiphos-geography-support"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Specific Word Meanings"> +<param name="Local" value="ar01s03.html#xiphos-bible-dictionary"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Finding A Specific Word"> +<param name="Local" value="ar01s03.html#xiphos-bible-find"></OBJECT></LI> +</UL><LI><OBJECT type="text/sitemap"> +<param name="Name" value="Previewer"> +<param name="Local" value="ar01s03.html#xiphos-viewer"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="The Commentary Pane"> +<param name="Local" value="ar01s03.html#xiphos-commentaries"></OBJECT></LI> +<UL> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Finding Out About The Commentary Module"> +<param name="Local" value="ar01s03.html#xiphos-commentary-about"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Commentary Headings."> +<param name="Local" value="ar01s03.html#xiphos-commentary-headings"></OBJECT></LI> +</UL><LI><OBJECT type="text/sitemap"> +<param name="Name" value="Dictionary Pane"> +<param name="Local" value="ar01s03.html#xiphos-dictionary"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Keyboard Shortcuts"> +<param name="Local" value="ar01s03.html#xiphos-shortcut"></OBJECT></LI> +</UL><LI><OBJECT type="text/sitemap"> +<param name="Name" value="Preferences"> +<param name="Local" value="ar01s04.html"></OBJECT></LI> +<UL> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Introduction To Preferences"> +<param name="Local" value="ar01s04.html#preferences-introduction"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="General Settings"> +<param name="Local" value="ar01s04.html#general-settings"></OBJECT></LI> +<UL> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Locale, General Preferences and StudyPad directory"> +<param name="Local" value="ar01s04.html#tab-pane2"></OBJECT></LI> +</UL><LI><OBJECT type="text/sitemap"> +<param name="Name" value="BibleSync Settings"> +<param name="Local" value="ar01s04.html#biblesync"></OBJECT></LI> +<UL> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Controls for BibleSync"> +<param name="Local" value="ar01s04.html#tab-pane2"></OBJECT></LI> +</UL><LI><OBJECT type="text/sitemap"> +<param name="Name" value="Fonts And Colors"> +<param name="Local" value="ar01s04.html#fonts-and-colors"></OBJECT></LI> +<UL> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Setting Font Colors"> +<param name="Local" value="ar01s04.html#font-color"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Miscellaneous Font Settings"> +<param name="Local" value="ar01s04.html#font-misc"></OBJECT></LI> +</UL><LI><OBJECT type="text/sitemap"> +<param name="Name" value="Module Settings"> +<param name="Local" value="ar01s04.html#module-settings"></OBJECT></LI> +</UL><LI><OBJECT type="text/sitemap"> +<param name="Name" value="Module Manager"> +<param name="Local" value="ar01s05.html"></OBJECT></LI> +<UL> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Introduction To The Module Manager"> +<param name="Local" value="ar01s05.html#module-introduction"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Sword Module Configurations"> +<param name="Local" value="ar01s05.html#sword-config"></OBJECT></LI> +<UL> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Module Sources Settings"> +<param name="Local" value="ar01s05.html#sword-sources"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Sword Module Installations"> +<param name="Local" value="ar01s05.html#installation"></OBJECT></LI> +<UL> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Linux"> +<param name="Local" value="ar01s05.html#destination-linux"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Windows XP"> +<param name="Local" value="ar01s05.html#destination-xp"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Windows Vista"> +<param name="Local" value="ar01s05.html#destination-vista"></OBJECT></LI> +</UL></UL><LI><OBJECT type="text/sitemap"> +<param name="Name" value="Installing, Updating, and Maintaining Modules"> +<param name="Local" value="ar01s05.html#module-management"></OBJECT></LI> +<UL> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Installing, Updating, and Maintaining Modules"> +<param name="Local" value="ar01s05.html#add-module"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Module Maintenance"> +<param name="Local" value="ar01s05.html#remove-module"></OBJECT></LI> +</UL><LI><OBJECT type="text/sitemap"> +<param name="Name" value="Installing Non-Standard Modules"> +<param name="Local" value="ar01s05.html#non-standard-modules"></OBJECT></LI> +</UL><LI><OBJECT type="text/sitemap"> +<param name="Name" value="The Search Function"> +<param name="Local" value="ar01s06.html"></OBJECT></LI> +<UL> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Simple Searches"> +<param name="Local" value="ar01s06.html#xiphos-searchpane"></OBJECT></LI> +<UL> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Search Key Entry Box"> +<param name="Local" value="ar01s06.html#xiphos-search-key"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Search Module Selector"> +<param name="Local" value="ar01s06.html#xiphos-search-modselect"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Search Type Selector"> +<param name="Local" value="ar01s06.html#xiphos-search-typeselect"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Search Options Checkbox"> +<param name="Local" value="ar01s06.html#xiphos-search-options"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Search Scope Selector"> +<param name="Local" value="ar01s06.html#xiphos-search-scopeselect"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Search Results View"> +<param name="Local" value="ar01s06.html#xiphos-search-results"></OBJECT></LI> +</UL><LI><OBJECT type="text/sitemap"> +<param name="Name" value="Advanced Searches"> +<param name="Local" value="ar01s06.html#xiphos-advanced-search"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Search Syntax using Regular Expression"> +<param name="Local" value="ar01s06.html#hdbk-op-search-dialog-text-regexp"></OBJECT></LI> +<UL> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Rules for Regular Expression Search Requests"> +<param name="Local" value="ar01s06.html#hdbk-op-search-dialog-text-regexp-rules"></OBJECT></LI> +<UL> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="The Period"> +<param name="Local" value="ar01s06.html#period"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="The Asterisk"> +<param name="Local" value="ar01s06.html#asterisk"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="The Plus Sign"> +<param name="Local" value="ar01s06.html#plus"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="The Question Mark"> +<param name="Local" value="ar01s06.html#question"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="The Square Brackets"> +<param name="Local" value="ar01s06.html#bracket"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="The Caret first in Square Brackets"> +<param name="Local" value="ar01s06.html#caret"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="The Caret as Start of Line Anchor"> +<param name="Local" value="ar01s06.html#caret-s"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="The Dollar Sign as End of Line Anchor"> +<param name="Local" value="ar01s06.html#dollar"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="The Vertical Bar"> +<param name="Local" value="ar01s06.html#bar"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="The Parentheses"> +<param name="Local" value="ar01s06.html#parenth"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="The Backslash Prior to a Special Character"> +<param name="Local" value="ar01s06.html#backslash"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="The Backslash Prior to an Ordinary Character"> +<param name="Local" value="ar01s06.html#backslash-o"></OBJECT></LI> +</UL></UL></UL><LI><OBJECT type="text/sitemap"> +<param name="Name" value="The Studypad"> +<param name="Local" value="ar01s07.html"></OBJECT></LI> +<UL> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Using The Studypad"> +<param name="Local" value="ar01s07.html#xiphos-studypad"></OBJECT></LI> +</UL><LI><OBJECT type="text/sitemap"> +<param name="Name" value="The Personal Commentary"> +<param name="Local" value="ar01s08.html"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Journals and Prayer Lists"> +<param name="Local" value="ar01s09.html"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Getting Help Online"> +<param name="Local" value="ar01s10.html"></OBJECT></LI> +<UL> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Users Mailing List"> +<param name="Local" value="ar01s10.html#xiphos-mailing-list"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Live Chat"> +<param name="Local" value="ar01s10.html#xiphos-live-chat"></OBJECT></LI> +</UL><LI><OBJECT type="text/sitemap"> +<param name="Name" value="Original Language Research"> +<param name="Local" value="ar01s11.html"></OBJECT></LI> +<UL> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Installing Needed Modules"> +<param name="Local" value="ar01s11.html#orig-lang-install-modules"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Setting Up"> +<param name="Local" value="ar01s11.html#orig-lang-setup"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Searching for Strongs Numbers"> +<param name="Local" value="ar01s11.html#orig-lang-search"></OBJECT></LI> +<LI><OBJECT type="text/sitemap"> +<param name="Name" value="Additional Modules"> +<param name="Local" value="ar01s11.html#orig-lang-additional"></OBJECT></LI> +</UL></UL></UL> +</BODY></HTML>
\ No newline at end of file diff --git a/help/C/xiphos.xml b/help/C/xiphos.xml index 5fa17de..1d8a3d1 100644 --- a/help/C/xiphos.xml +++ b/help/C/xiphos.xml @@ -14,8 +14,8 @@ <!ENTITY onlinehelp SYSTEM "onlinehelp.xml"> <!ENTITY originallanguage SYSTEM "originallanguage.xml"> - <!ENTITY appversion "3.1.5"> - <!ENTITY manrevision "3.1.5"> + <!ENTITY appversion "3.2.2"> + <!ENTITY manrevision "3.2.2"> <!ENTITY date "2 October 2010"> <!ENTITY app "<application>Xiphos</application>"> <!ENTITY appname "Xiphos"> @@ -162,8 +162,8 @@ Template last modified Apr 11, 2002 </releaseinfo> <revhistory> <revision> - <revnumber>Xiphos Manual V3.1.5</revnumber> - <date>February 2012</date> + <revnumber>Xiphos Manual V3.2.2</revnumber> + <date>January 2014</date> <revdescription> <para role="author">The Xiphos Team</para> <para role="publisher">The Xiphos Team</para> |
