<page id="xiphos-11-interface" type="topic" xmlns="http://projectmallard.org/1.0/"
       xmlns:its="http://www.w3.org/2005/11/its">

  <info>
    <desc>An explanation of the areas shown in the <app>Xiphos</app> window.</desc>

    <link type="guide" xref="index#getting-started" />

    <revision pkgversion="4.1.0" date="2018-04-24" status="draft"/>
    <revision pkgversion="4.1.0" date="2018-05-28" status="candidate"/>
    <revision pkgversion="4.5.0" date="2026-08-10" status="draft"/>

    <title type='link' role="trail"></title>
    <title type='text'>Xiphos</title>

    <credit type="author" its:translate="no">
      <name>Andy Piper</name>
    </credit>
    <credit type="author" its:translate="no">
      <name>Pierre Benz</name>
    </credit>
    <credit type="author" its:translate="no">
      <name>Dr Peter von Kaehne</name>
    </credit>
    <credit type="author" its:translate="no">
      <name>Karl Kleinpaste</name>
    </credit>
    <credit type="author" its:translate="no">
      <name>Matthew Talbert</name>
    </credit>

    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>

  </info>

  <title>Xiphos Main Window</title>

  <section id="menubar">
    <!-- ============= Menubar  ============-->

    <title>Menubar</title>
    <p>At the top of the <app>Xiphos</app> 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 <gui>File</gui> menu.</p>
    <media type="image" mime="image/png" src="figures/interface_menubar.png" />
  </section>

  <section id="toolbars">
    <!-- ============= Toolbars  ============-->

    <title>Toolbars</title>
    <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>
    <media type="image" mime="image/png" src="figures/interface_toolbar.png" />

    <p>The <gui>Toolbar</gui> consists of the following functions:</p>
    <list>
      <item>
	<p>History View Toggle and drop-down menu</p>
      </item>
      <item>
	<p>Bible Book Selector</p>
      </item>
      <item>
	<p>Bible Chapter Selector</p>
      </item>
      <item>
	<p>Bible Verse Selector</p>
      </item>
      <item>
	<p>Bible Passage Summary</p>
      </item>
    </list>

    <section id="xiphos-selector">
      <title>History Forward/Backward Selector</title>
      <p>Switches between current and previous passage selections.</p>
    </section>

    <section id="xiphos-toolbar-book">
      <title>Bible Book Selector</title>
      <p>Selects the Biblical book to be displayed in the <gui>Bible Text Pane
      </gui> and <gui>Commentary Pane</gui>. Changes take immediate effect.</p>
    </section>

    <section id="xiphos-toolbar-chapter">
      <title>Bible Chapter Selector</title>
      <p>Selects the Biblical chapter of current book to be displayed in the
      <gui>Bible Text Pane</gui> and <gui>Commentary Pane</gui>. Changes take
      immediate effect.</p>
    </section>

    <section id="xiphos-toolbar-verse">
      <title>Bible Verse Selector</title>
      <p>Selects the Biblical verse of current chapter to be displayed in the
      <gui>Bible Text Pane</gui> and <gui>Commentary Pane</gui>. Changes take
      immediate effect.</p>
    </section>

    <section id="xiphos-toolbar-summary">
      <title>Bible Passage Summary</title>
      <p>Allows manual editing of passages which are displayed in the <gui>Bible
      Text Pane</gui> and <gui>Commentary Pane</gui>. Changes take effect once
      Enter is typed.</p>
      <note style="warning">
	<p>Ensure that edited book,chapter and verse naming is correct,
	otherwise the wrong or no information will be displayed.</p>
      </note>
    </section>

  </section>

  <section id="xiphos-sidebar">
    <!-- ============= Sidebar  ============-->

    <title>The Sidebar</title>
    <media type="image" mime="image/png" src="figures/interface_sidepane.png" />

    <p>On the left hand side of <app>Xiphos</app> there is the Sidebar. Here
    the user can switch between the different Sword modules, view bookmarks, do
    simple searches and view verse lists. In the Modules listing, a module may
    be chosen for viewing in the current tab of the main window by clicking it.
    Using the context (right-click) menu, other options are to open a new tab
    using the module, open a separate (i.e. detached) window, or to view the
    "About" information for the module.</p>

    <p>To switch between all Sidebar functions, buttons have been placed at the
    top of the Sidebar.</p>
    <media style="image" mime="image/png" src="figures/interface_shortcut.png" />

    <!-- TODO: confirm exact menu labels for Favorites/Hide/Group By against
    source (added by commit 4d90d55a, #1349). -->
    <section id="xiphos-module-tree-organize">
      <title>Organizing The Module Tree</title>
      <p>Right-clicking anywhere in the Modules listing brings up a context
      menu with options for organizing a long list of installed modules:</p>
      <list>
	<item>
	  <p><gui>Add to Favorites</gui> / <gui>Remove from Favorites</gui> -
	  marks a module so that it also appears under a dedicated
	  <gui>Favorites</gui> entry at the top of the module tree, for quick
	  access to the modules you use most.</p>
	</item>
	<item>
	  <p><gui>Hide</gui> / <gui>Show Hidden Modules</gui> - removes a
	  rarely-used module from the visible tree without uninstalling it.
	  Hidden modules can be shown again, and un-hidden, from the same
	  context menu.</p>
	</item>
	<item>
	  <p><gui>Group By</gui> - chooses how the tree is organized:
	  by <gui>Category</gui> (Biblical Texts, Commentaries, Dictionaries,
	  General Books, etc.), by <gui>Language</gui>, or by <gui>Both</gui>
	  (language within category). This is useful once many modules in
	  several languages are installed.</p>
	</item>
      </list>
    </section>
  </section>


  <section id="xiphos-bible">

    <!-- ============= Bible Text Pane  ============-->
    <title>The Bible Text Pane</title>
    <media style="image" mime="image/png" src="figures/interface_biblepane.png" />
    <p>Positioned to the right of the Shortcut bar is the Bible text pane. All
    translations are displayed here.  When starting <app>Xiphos</app>, the
    translation last used in the leftmost tab will be displayed.</p>

    <section id="xiphos-bible-open">
      <title>Opening A Specific Bible Translation</title>
      <p>In order to change the current Bible translation to another of your
      choice:</p>
      <list>
	<item>
	  <p>right-click in the <gui>Bible Text Pane</gui>. In the popup menu
	  choose <guiseq><gui>File</gui><gui>Open Module</gui></guiseq> and
	  select your specific translation that you want to view.</p>
	</item>
	<item>
	  <p>under the <gui>Modules</gui> option in the <gui>Sidebar</gui>,
	  choose <guiseq><gui>Biblical Texts</gui><gui>language choice</gui>
	  </guiseq> and select your specific translation.</p>
	  </item>
      </list>
    </section>

    <section id="xiphos-bible-parallel">
      <title>Using the Parallel View Mode</title>

      <p>A nice function in <app>Xiphos</app> 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 <gui>Parallel View</gui> 
      just below the <gui>Bible Text Pane</gui>, next to the <gui>Standard View
      </gui> tab.</p>

      <p>You must choose which modules to display in parallel with the <gui>
      Preferences</gui> dialog found under the <gui>Edit</gui> 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. Up to 8 modules can be shown side by side.</p>

      <!-- TODO: confirm exact UI wording/location for named parallel Sets
      against source (added by commits 4f13191e/5a0a49c1/62e96f43, #1348). -->
      <p>Instead of rebuilding this list every time you want to switch between
      different combinations of translations (for example, one set for
      original-language study and another for a reading group), you can save
      the current list of parallel modules as a named <gui>Set</gui>. Once you
      have several sets saved, a drop-down selector lets you switch between
      them instantly, and the parallel view is rebuilt with the modules
      belonging to the chosen set. Sets can be renamed or deleted from the same
      selector.</p>

      <p>The <gui>Parallel View</gui> 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>
      <media style="image" mime="image/png" src="figures/interface_parallel.png" />

      <p>Additionally, a separate Parallel View window can be selected from the
      right click menu with <gui>Detach/Attach</gui>. 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>
      <media style="image" mime="image/png" src="figures/interface_parallel-separate.png" />

      <p>Be aware that Bibles have different versification schemes. That is,
      most obviously some Bibles have only Old or New Testament. Beyond that, there
      are historically varying ways of dividing the Bible into chapters and verses.
      Within the parallel view, the first Bible controls what versification is
      in use for all Bibles displayed. This means that if the 1st Bible is
      limited to the Old Testament, none of the other Bibles in parallel views will
      be able to navigate outisde the OT. There are other subtler differences, such
      as KJV versification versus NRSV versification, where 3 John has a 15th
      verse and Revelation 12 has an 18th verse.</p>
    </section>

    <section id="xiphos-bible-open-separate">
      <title>Opening A Separate Bible Translation</title>
      <p>In order to view a Bible translation separate from the <app>Xiphos
      </app> main window interface, under the <gui>Modules</gui> option in the
      <gui>Sidebar</gui>, choose <guiseq><gui>Biblical Texts</gui><gui>language
      choice</gui></guiseq>.  Then right-click on a translation and choose <gui>
      Open in dialog</gui>. The module will open in a separate, detached window
      of its own.</p>

      <p>Detached Bible and commentary windows have a synchronization button in
      the upper-left position beside the navigation bar. When this button is
      depressed, the main window Bible and commentary will synchronize with
      detached Bible and commentary windows. The synchronization goes both ways:
      Any detached window will synchronize navigation with all other detached
      Bibles and commentaries plus the main window, and the main window will
      drive all detached Bibles and commentaries whose synchronization button
      is depressed.</p>
    </section>

    <section id="xiphos-bible-about">
      <title>Finding Out About The Current Translation</title>
      <p>To find out about the Bible translation currently being displayed:</p>
      <list>
	<item>
	  <p>right-click in the <gui>Bible Text pane</gui>. In the popup menu
	  choose <gui>About </gui> module name.</p>
	</item>
	<item>
	  <p>Under the <gui>Modules</gui> option in the <gui>Sidebar</gui>,
	  choose <guiseq><gui>Biblical Texts</gui><gui>language choice</gui>
	  </guiseq>. Then right-click on a translation and choose the <gui>
	  About</gui> option.</p>
	</item>
      </list>
    </section>

    <section id="xiphos-bible-options">
      <title>Module Options</title>
      <p>Most Bible translations have additional options which the user can
      select.</p>
      <list>
	<item>
	  <p>Words Of Christ In Red</p>
	</item>
	<item>
	  <p>Strong's Numbers</p>
	</item>
	<item>
	  <p>Morphological Tags</p>
	</item>
	<item>
	  <p>Footnotes</p>
	</item>
	<item>
	  <p>Scripture Cross-Reference</p>
	</item>
	<item>
	  <p>Headings</p>
	</item>
	<item>
	  <p>Image Content</p>
	</item>
      </list>
      <note>
	<p>Translations in other languages such as Greek or Hebrew have specific
	options which deal only with the specific language.</p>
      </note>
      <p>	In order to access these options:</p>
      <list>
	<item>
	  <p>right-click in the <gui>Bible Text pane</gui>. In the popup menu
	  (example shown), choose <gui>Module Options</gui> and select the
	  specific option.</p>
	</item>
      </list>
      <media style="image" mime="image/png" src="figures/interface_biblepane-options.png" />
    </section>

    <section id="xiphos-view-options">
      <title>View Options</title>
      <p>There are several additional modes that can be selected from the
      menubar's <gui>View</gui> pulldown.</p>
      <media style="image" mime="image/png" src="figures/interface_menubar-view.png" />

      <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>
      <list>
	<item>
	  <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>
	</item>
	<item>
	  <p>Read Aloud - If you enable this, then <app>Xiphos</app> will funnel
	  all selected verses through a text-to-speech system. On Linux,
	  <app>Xiphos</app> uses the <app>festival</app> TTS, often installed
	  by default in Linux distributions. On Windows, and on Linux systems
	  that provide it, <app>Xiphos</app> can instead use the operating
	  system's own text-to-speech ("System TTS"), so no separate speech
	  engine needs to be installed.</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>
	</item>
	<item>
	  <p>Show Verse Numbers - Normally enabled, this toggle can be disabled
	  to prevent display of verse numbers within the text.</p>
	</item>
	<item>
	  <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>
	</item>
      </list>
    </section>

    <section id="xiphos-default-css">
      <title>Display Control with CSS</title>
      <p>Users familiar with CSS (cascading style sheets) may wish to create the
      file "default-style.css" in the .xiphos directory to contain whatever CSS
      controls are desired. Beware, it is very easy to shoot oneself in the foot
      with CSS, and this will affect all modules' display. The facility exists
      to provide the capability that advanced users may wish.</p>
    </section>

    <section id="xiphos-user-annotation">
      <title>User Annotation</title>
      <p>Many users wish to make personal annotations on individual verses,
      without the need to put a full "personal commentary" module to use.
      <app>Xiphos</app> 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
      <gui>*u</gui> 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>
    </section>

    <section id="xiphos-geography-support">
      <title>Geography Support</title>
      <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
      <guiseq><gui>Lookup Selection</gui><gui>Browse in BibleMap.org</gui>
      </guiseq>. 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>
    </section>

    <!-- TODO: confirm exact menu wording/label against src/gui/menu_popup.c or
    equivalent for "Translate Selection" (added by commit 63524ed8, #1355). -->
    <section id="xiphos-translate-selection">
      <title>Translate Selection</title>
      <p>To get a quick machine translation of a word or phrase, mouse-select
      the text anywhere it can be selected (Bible, commentary, general book,
      or dictionary panes) and use the right-click context menu to choose
      <guiseq><gui>Lookup Selection</gui><gui>Translate Selection</gui>
      </guiseq>. A web browser will open with the selection submitted to an
      online translation service.</p>
    </section>

    <section id="xiphos-bible-dictionary">
      <title>Specific Word Meanings</title>
      <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 <gui>Dictionary
      Pane</gui>.</p>
    </section>

    <section id="xiphos-bible-find">
      <title>Finding A Specific Word</title>
      <p>To find a specific word within a passage:</p>
      <list>
	<item>
	  <p>right-click in the <gui>Bible Text Pane</gui>. In the popup menu,
	  choose <guiseq><gui>Edit</gui><gui>Find</gui></guiseq>. A dialog will
	  appear, which provides text searches. Fill out dialog and click the
	  <gui>Find</gui> and <gui>Find Next</gui> buttons.</p>
	</item>
      </list>
    </section>
  </section>

  <section id="xiphos-viewer">
    <!-- ============= Previewer	================ -->

    <title>Previewer</title>
    <media style="image" mime="image/png" src="figures/interface_viewer.png" />

    <p>The Previewer is where the user sees Strong's numbers, morphological
    tags, footnotes, and cross-references that the <gui>Bible Text Pane</gui>
    provides.</p>

    <p>Footnote content is displayed in the Previewer when you hover over the
    indicator <gui>*n</gui> 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 <gui>Shift key</gui>) and move to the Previewer.</p>

    <p>Cross-reference indicators <gui>*x</gui> work much the same way.
    Clicking the indicator will send the set of references to the <gui>Verse
    List</gui> in the <gui>Sidebar</gui>, 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. When a cross-reference resolves to more than one verse, a popup
    menu also lets you jump straight to any one of the listed references
    without first sending the whole set to the verse list; this also works for
    references given only as partial verse ranges.</p>

    <p>Any verses shown in reverse-highlight have personal annotation associated
    with them, and such verses will include <gui>*u</gui> 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 <gui>View</gui> menu.</p>
  </section>

  <section id="xiphos-commentaries">
    <!-- ============= Commentary Pane  ============-->

    <title>The Commentary Pane</title>
    <media style="image" mime="image/png" src="figures/interface_commentarypane.png" />

    <p>The <gui>Commentary pane</gui> is where the commentary modules are
    displayed. This provides easy reading, reference, and access to different
    commentaries currently installed. The passage viewed by the <gui>Commentary
    pane</gui> is directly controlled by the current passage viewed in the
    <gui>Bible Text pane</gui>, so in order to change to a different passage
    commentary, select the desired passage on the <gui>Toolbar</gui>.</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>
    <note>
      <p>By changing to passage settings on the <gui>Toolbar</gui>, the contents
      in the <gui>Bible Text pane</gui> and the <gui>Commentary Pane</gui> will
      be changed.</p>
    </note>

    <section id="xiphos-commentary-about">
      <title>Finding Out About The Commentary Module</title>
      <p>To find out about the commentary currently being displayed:</p>
      <list>
	<item>
	  <p>right-click in the <gui>Commentary Pane</gui>. In the popup menu
	  choose <gui>About </gui> module name.</p>
	</item>
      </list>
    </section>

    <section id="xiphos-commentary-headings">
      <title>Commentary Headings</title>
      <p>Many commentaries have additional headings which enable introductory
      information about the book and chapter currently being displayed in the
      <gui>Bible Text pane</gui>. In order to view them:</p>
      <list>
	<item>
	  <p>right-click in the <gui>Commentary Pane</gui>. In the popup menu
	  choose <gui>Display Book Heading</gui> or <gui>Display Chapter
	  Heading</gui>.</p>
	</item>
      </list>
    </section>
  </section>

  <section id="xiphos-dictionary">
    <title>Dictionary Pane</title>
    <media style="image" mime="image/png" src="figures/interface_dictionary.png" />

    <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>
  </section>

  <!-- TODO: confirm exact tab label, and whether the calendar popover is also
  available (not just Windows) against source before publishing; commits
  9894ccb5 and 5e2bd333 (#1312) reference a "Devotional tab" already existing,
  so this pane predates this help revision and was simply undocumented. -->
  <section id="xiphos-devotional">
    <title>Daily Devotional Tab</title>
	<media style="image" mime="image/png" src="figures/interface_devotional.png" />
    <p>If a <gui>Daily Devotional</gui> module is installed and selected as
    your preferred devotional (see <link xref="xiphos-50-preferences-general-settings"/>
    and the <gui>Special</gui> tab in
    <link xref="xiphos-53-preferences-modules"/>), a dedicated <gui>Devotional
    </gui> tab is available alongside the <gui>Book View</gui> tab below the
    <gui>Commentary Pane</gui>. It shows the reading for the current date by
    default.</p>

    <p>To read a devotional for a different day, click the date shown at the
    top of the tab; a calendar popover lets you pick the day directly, or you
    may type a date in manually. This is in addition to, and independent of,
    the day's devotional reference optionally shown in the Previewer at
    <app>Xiphos</app> startup (see above).</p>
  </section>

</page>
