Merge branch 'bible2' into 'master'

Fixed #16 Add information about editing a Bible

Closes #16

See merge request openlp/documentation!13

manual/source/bibles.rst

@@ -15,16 +15,13 @@ Bible Import Wizard
 If you are using an earlier version of OpenLP or, come from another software
 package, you may be able to convert your existing database to work in OpenLP
 2.0. To access the Bible Importer :menuselection:`File --> Import --> Bible`.
-You may also enter the Bible Importer by clicking the :guilabel:`Import Icon:`
+You may also enter the Bible Importer by clicking the |importicon| Import Icon.
 
-|importicon| Import Bibles
-    Click on the :guilabel:`Import Bibles` icon to start the Bible import wizard.
-
-.. |IMPORTICON| image:: pics/theme_import.png
+Click on the |importicon| Import Bibles icon to start the Bible import wizard.
 
 You will see the Bible Importer window, click :guilabel:`Next`.
 
-.. image:: pics/import_bible_start.png
+|bibleimportstart|
 
 After clicking :guilabel:`Next` you can select from the various types of
 software that OpenLP will convert Bibles from. Click on the file folder icon to
@@ -32,7 +29,7 @@ choose the file(s) of the Bible database you want to import. See the sections
 below for more information on the different formats that OpenLP will import.
 Click :guilabel:`Next` to continue.
 
-.. image:: pics/import_bible_dropdown.png
+|bibleimportdropdown| 
 
 After selecting your file(s), you'll be asked to fill in the details of the
 Bible you are importing. Remember to check what information you need to display
@@ -42,23 +39,25 @@ copyright notice. Click :guilabel:`Next` to continue.
 **Note:** You can use one blank space using the space bar in the copyright field 
 to continue if you do not have or need copyright information.
 
-.. image:: pics/import_bible_license.png
+|bibleimportdropdown|
 
 After entering the license details, OpenLP will start to import your Bible.
 It may take some time to import your Bible so please be patient.
 
-.. image:: pics/import_bible_finished.png
+|bibleimportfinished|
 
 When the import has finished click :guilabel:`Finish` and you should be
 ready to use your Bible in OpenLP.
 
+.. _bible_import_osis:
+
 Importing OSIS Bibles
 ^^^^^^^^^^^^^^^^^^^^^
 
 Importing OSIS files is very simple. Select OSIS as your import source, select
 your OSIS Bible file and continue the import process.
 
-.. image:: pics/import_bible_osis.png
+|bibleimportosis|
 
 **About OSIS Formatted Bibles**
 
@@ -87,6 +86,8 @@ osis file for example::
 
     mod2osis KJV > /home/user/bibles/kjv.osis
 
+.. bibles_import_opensong:
+
 Importing OpenSong Bibles
 ^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -104,36 +105,39 @@ by right clicking on the downloaded file and select `Extract` or `Extract Here`.
 Note that some of the bibles on OpenSongs webpage are actually in the Zefania
 format, which OpenLP can also import, see :ref:`zefaniaimport`.
 
-.. image:: pics/import_bible_opensong.png
+|bibleimportopensong|
 
 After selecting the OpenSong Bibles you want to import, follow the rest of the
 import process. When the import has finished you should be ready to use your
 OpenSong Bibles.
 
+.. bibles_import_web_download:
+
 Importing Web Download Bibles
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-**About Web Download**
-
 OpenLP provides a Web Download method to import Bibles when you do not have a
 locally installed Bible available. The Web Download method registers the Bible
 in OpenLP like the other Bibles only it downloads the verses as you need them.
-This import is not meant to be used as your sole source for Bibles, but rather
-as another option and does require an internet connection.
+
+.. warning::
+    This import requires an internet connection when installing and when 
+    searching for verses and is not meant to be used as your sole source for 
+    Bibles, but rather as another option.
 
 To use the web download feature select web download from the import wizard.
 
-.. image:: pics/import_bible_web1.png
+|biblewebdownload|
 
 First click :guilabel:`Download bible list` to download a list of available
 bibles.
 
-.. image:: pics/import_bible_web2.png
+|bibleweblist|
 
 This will take a few moments depending on your internet connection and load on
 the servers.
 
-.. image:: pics/import_bible_web3.png
+|bibleweblocation|
 
 When the download is complete you can select from 3 different sources to 
 download from: `Crosswalk <http://www.biblestudytools.com/>`_, `BibleServer
@@ -146,12 +150,14 @@ You can also select a proxy server if needed from the `Proxy Server` tab. Your
 network administrator will know if this is necessary. In most cases this will
 not be needed.
 
-.. image:: pics/import_bible_web_proxy.png
+|biblewebproxy|
 
 After selecting your download location and the Bible you wish to use, click
 :guilabel:`Next` to continue the import process. When your import is completed
 you should now be ready to use the web Bible.
 
+.. _bibles_import_csv:
+
 Importing CSV formatted Bibles
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -165,7 +171,7 @@ Select CSV from the list of Bible types to import.
 You are now ready to select your .csv files. You will need to select both your
 books and verse file location.
 
-.. image:: pics/import_bible_csv.png
+|bibleimportcsv|
 
 After you have selected the file locations you can continue with the import
 process. Once it is complete you should be ready to use your imported CSV Bible.
@@ -181,8 +187,199 @@ Find the Bible you would like to import and download the file. The downloaded
 file is a zip-file from which the Bible must be extracted. This is usually done
 by right clicking on the downloaded file and select `Extract` or `Extract Here`.
 
-.. image:: pics/import_bible_zefania.png
+|bibleimportzefania|
 
 You can now simply select the extracted file for import and click
 :guilabel:`Next` to continue the import process. When your import is completed
 you should now be ready to use the imported Zefania Bible.
+
+.. _edit_bibles:
+
+Edit Bible Data
+===============
+
+Some information about a Bible can be edited.  What can be edited is dependent on
+the type of bible.
+
+
+Select the Bible you want to edit then select the |bibleedit| Bible Edit icon 
+to edit the Bible informtion.
+
+On the :guilabel:`Meta Data` tab you can update the Bible Version name, 
+Copyright information and the Permissions for the Bible.
+    
+You can also select the Book Name Language.  Choosing :guilabel:`Global Settings`, the 
+defualt setting, will display the Book Names of the Bible in the Language 
+set by the Operating System Language.  You can change this setting by using 
+the dropdown to select a different option.
+    
+When you have made your changes you can select the :guilabel:`Save` button to
+save your changes, select the :guilabel:`Cancel` button to discard your changes
+or select the :guilabel:`Custom Book Names` tab to continue editing.
+
+|bibleeditform|
+
+Selecting the :guilabel:`Custom Book Names` tab will allow you to update the book
+names that will be displayed.
+    
+.. warning::
+    Please note that when using a Web Bible you can not change the book names.
+    
+When you have made your changes you can select the :guilabel:`Save` button to
+save your changes, select the :guilabel:`Cancel` button to discard your changes
+or select the :guilabel:`Meta Data` tab to continue editing.
+
+|biblenameform|
+
+.. _delete_bibles:
+
+Delete a Bible
+==============
+
+You can remove a Bible from OpenLP.  
+
+.. danger::
+    The only recovery from deleting a Bible is to reimport the Bible using the 
+    Wizard or copy the files from a Backup of the Data directory.
+
+Select the Bible version on either the :guilabel:`Quick` or the :guilabel:`Advanced` tab
+and click on the |deleteicon| Delete icon to delete a Bible.
+You will be asked to confirm you want to delete the Bible.  Click
+on :guilabel:`Yes` to delete the Bible or click :guilabel:`No` to cancel.
+
+
+.. _preview_scripture:
+
+Preview Bible Verses
+====================
+
+To Preview the selected verses in the left *Preview* panes, select the 
+|biblepreview| Send to Preview icon.
+
+
+.. _display_scripture:
+
+Send Scriptures to Live Display
+===============================
+
+To Preview the selected verses in the right *Live* panes, select the 
+|biblelive| Send to Live icon.
+	
+
+.. _add_scripture_to_service:
+
+Add Scriptures to Service
+=========================
+
+Adding scriptures to a service can be done by selecting a group of verses
+or by moving one verse at a time.
+
+To add Bible verses you can click on a verse, hold and drag your selection
+from the :ref:`media-manager` over to the *Service Manager* 
+or, after clicking the media or verse you want to use, click the 
+|bibleadd| Add to Service icon. This will add your scriptures at the bottom 
+of the *Service*. 
+
+
+.. _lock_results:
+
+Locking Search Results
+======================
+
+Selecting the |biblelock| Lock icon locks and unlocks the search results.  
+    
+This feature can be used to combine multiple search results into one group of 
+scriptures.  To use this feature, do a search for the first gorup of verses, 
+then select the |biblelock| Lock icon and then search to your second group of 
+verses.  The second group of verses will be added to the first group of 
+verses.  You can continue to add more search results or select the |biblelock| Lock
+icon again to unlock the results and return the search results to be replaced 
+with each search.
+
+.. _quick_search:
+
+Quick Search
+============
+
+The quick search tab provides a simple search capability that can search
+for scripture text or a scripture referance.  Use the dropdown in the :guilabel:`Find:`
+data entry box to choose the type of search. 
+
+Select your primary Bible by selecting it in the :guilabel:`Version` dropdown.
+
+Select a second Bible to search using the :guilabel:`Second` dropdown or leave
+it blank if you are not using a second Bible.
+
+Select your desired layout style using the :guilabel:`Layout style` dropdown.
+
+Enter your search text, Pressing the :kbd:`Enter` or selecting the :guilabel:`Search`
+button activates the search.
+
+When using the scripture referance search, the referance needs to be in one of a 
+few formats.  You can see all the formats available by typing a book name and 
+pressing the :kbd:`Enter`.  
+
+A common format is "Bookname Chapter:verse - verse" (Gen 1:1-12) 
+
+|biblequicksearch|
+
+
+.. _advanced_search:
+
+Advanced Search
+===============
+
+The advance search tab provides another search process that can search
+for scripture text using dropdowns to set the search criteria.
+
+To start your search, select your primary Bible by selecting it in the
+:guilabel:`Version` dropdown. 
+
+Select a second Bible to search using the :guilabel:`Second` dropdown or leave 
+it blank if you are not using a second Bible.
+
+Select your desired layout style using the :guilabel:`Layout style` dropdown.
+
+Select the book of the Bible to search using the :guilabel:`Book` dropdown.
+
+Select the starting Chapter of the book using :guilabel:`Chapter` dropdown to 
+the right of *From:*
+
+Select the starting Verse of the chapter using the :guilabel:`Verse` dropdown to 
+the right of *From:*
+
+Select the ending Chapter of the book using :guilabel:`Chapter` dropdown to 
+the right of *To:*
+
+Select the ending Verse of the chapter using the :guilabel:`Verse` dropdown to 
+the right of *To:*
+
+Selecting the :guilabel:`Search` button activates the search.
+
+|bibleadvancesearch|
+
+
+.. pictures used in this page
+
+.. |DELETEICON| image:: pics/theme_delete.png
+.. |BIBLELIVE| image:: pics/system_live.png
+.. |BIBLEPREVIEW| image:: pics/general_preview.png
+.. |BIBLEEDIT| image:: pics/songs13.png
+.. |BIBLEADD| image:: pics/buttons_add.png
+.. |BIBLEEDITFORM| image:: pics/bible_edit_default.png
+.. |BIBLENAMEFORM| image:: pics/bible_edit_names.png
+.. |BIBLEQUICKSEARCH| image:: pics/bible_quick_search.png
+.. |BIBLEADVANCESEARCH| image:: pics/bible_advance_search.png
+.. |BIBLELOCK| image:: pics/bible_lock.png
+.. |IMPORTICON| image:: pics/theme_import.png
+.. |BIBLEIMPORTSTART| image:: pics/import_bible_start.png
+.. |BIBLEIMPORTDROPDOWN| image:: pics/import_bible_dropdown.png
+.. |BIBLEIMPORTFINISHED| image:: pics/import_bible_finished.png
+.. |BIBLEIMPORTOSIS| image:: pics/import_bible_osis.png
+.. |BIBLEIMPORTOPENSONG| image:: pics/import_bible_opensong.png
+.. |BIBLEWEBDOWNLOAD| image:: pics/import_bible_web1.png
+.. |BIBLEWEBLIST| image:: pics/import_bible_web2.png
+.. |BIBLEWEBLOCATION| image:: pics/import_bible_web3.png
+.. |BIBLEWEBPROXY| image:: pics/import_bible_web_proxy.png
+.. |BIBLEIMPORTCSV| image:: pics/import_bible_csv.png
+.. |BIBLEIMPORTZEFANIA| image:: pics/import_bible_zefania.png

style_guide.rst

@@ -0,0 +1,204 @@
+style_guide.rst
+=========================
+OpenLP Manual Style Guide
+=========================
+
+This Style Guide will be used to clarify how the manual is formated and is 
+intended to keep all the pages in the manual consistent.
+
+Page Title
+==========
+
+Each page will begine with a link reference and a title.  The link reference
+should be the same as the title except that it is all in lower case with no 
+spaces.  Titles are to be in Title Case.
+
+.. code-block:: rst
+
+    .. _bibles:
+    
+    ======
+    Bibles
+    ======
+
+
+Line Length
+===========
+
+Each line of the document should be no longer than 120 characters.  While
+the build system can wrap the text, lines longer than 120 characters are 
+difficult to manage in a text editor.
+
+Pictures
+========
+
+All pictures will be in the .png format and stored in the pics directory of 
+the manual.  If the pictures is for a specific page the filename will start 
+with the page name and contain no spaces.
+
+All pictures used in the page will be described at the end of the document and
+image pointers will be used inside the document when an image is to be 
+displayed.  The image deffinition uses upper case for the image title and the
+in line image link uses lower case for the image title.  No spaces are to be
+used in the image deffinition title. The image deffinition title will start 
+with the page name unless the image is used across pages.
+
+End of Page Example:
+
+.. code-block:: rst
+    
+    .. pictures used in this page
+
+    .. |DELETEICON| image:: pics/theme_delete.png
+
+In Page Example:
+
+.. code-block:: rst
+    
+    Click on the |deleteicon| Delete Icon to delete the Bible.
+
+
+On Screen Buttons
+=================
+
+When instructing the user to use an on screen button, use the Gui label formated
+to make the button stand out.  
+
+Gui Label Format :guilabel:`Next`
+
+Menu Paths
+==========
+
+When describing a menu path, use the menu selection format.
+
+:menuselection:`File --> Import --> Bible`
+
+Referance Links For Headers
+===========================
+
+All sublevel headers will have a referance link above the header. 
+The referance link name will start with the page title and then the sublevel
+title.  No spaces are allowed in the link reference.
+
+.. code-block:: rst
+    
+    .. _bibles_sublevel:
+    
+    Sublevel
+    ========
+
+
+Terminal Commands
+=================
+
+When telling the user to enter a command on the command prompt or in a terminal
+window, use a double colon and 1 blank line before what the user is to type. 
+Add 1 blank line after the what the user is to type.
+
+.. code-block:: rst
+    
+    To convert a Bible using the command prompt in
+    Windows or a terminal in Linux or macOS you would type:
+    
+    mod2osis biblename > biblename.osis
+
+
+Codeing
+=======
+
+When entering coding use the wrap the coding inside two ` characters.
+
+.. code-block:: rst
+    
+    ``<div align="left">``
+    
+ 
+Toolbar Descriptions
+====================
+
+When describing the items in a toolbar with one line descriptions, use the 
+toolbar formatting.
+
+.. code-block:: rst
+    
+    |image| image description::
+        some description about the image.
+    
+When the toolbar items need more detail, or you are documenting a feature, 
+then use an inline Icon with Icon name
+
+.. code-block:: rst
+    
+    Selecting the |biblelock| Lock icon locks and unlocks the search results.  
+    
+    This feature can be used to combine multiple search results into one ... 
+
+
+End of File
+===========
+
+Only leave upto one blank line at the end of the page.
+
+Definitions
+===========
+
+Sentence case
++++++++++++++
+
+The first letter of the first word is upper case, all other letters are lower case, unless the word is a proper noun.
+
+Title case
+++++++++++
+The first letter of all words is upper case, except for secondary 2 letter words ("Go to Next Slide").
+
+Names of Widgets
+++++++++++++++++
+All widget names should be normal parts of sentences, e.g. "Cannot drag item from media manager to service manager."
+
+Standards
+=========
+
+Labels
+++++++
+
+All labels should be sentence case and end with a colon, unless the label is attached to check box or radio button: "Select theme file:"
+
+Group Box Labels
+++++++++++++++++
+
+Group box labels should be title case, without any trailing colons: "Display Options"
+
+Menu Items
+++++++++++
+
+Menu items should be title case: "Go to Next Slide", "Save As"
+
+Window/Dialog Titles
+++++++++++++++++++++
+
+All window and dialog titles should be title case: "Open Service File"
+
+Dialog Text
++++++++++++
+
+Dialog text must be full, proper sentences, with each sentence ending in a period.
+
+Tooltips (hints)
+++++++++++++++++
+
+Tooltips should be sentence case, and end with a period: "Open an existing service file."
+
+Combo Boxes
++++++++++++
+
+Data in combo boxes should be in title case: "New International Version"
+
+Check Boxes
++++++++++++
+
+Check boxes should have sentence case labels.
+
+Buttons
++++++++
+
+Buttons should have title case labels.