Reformated full page
This commit is contained in:
John Morris
parent
5120b20a26
commit
217600fb56
|
|
@ -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,12 +105,14 @@ 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
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
|
|
@ -123,17 +126,17 @@ as another option and does require an internet connection.
|
|||
|
||||
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 +149,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 +170,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,7 +186,7 @@ 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
|
||||
|
|
@ -195,10 +200,9 @@ Edit Bible Data
|
|||
Some information about a Bible can be edited. What can be edited is dependent on
|
||||
the type of bible.
|
||||
|
||||
|bibleedit| Edit
|
||||
|
||||
Select the Bible you want to edit then select the :guilabel:`Edit` icon
|
||||
to edit the Bible informtion.
|
||||
Select the Bible you want to edit then select the |bibleedit| 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.
|
||||
|
|
@ -231,14 +235,14 @@ or select the :guilabel:`Meta Data` tab to continue editing.
|
|||
Delete a Bible
|
||||
==============
|
||||
|
||||
You can remove a Bible from OpenLP. 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.
|
||||
You can remove a Bible from OpenLP.
|
||||
|
||||
|deleteicon| Delete
|
||||
.. warning::
|
||||
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 :guilabel:`Delete` icon to delete a Bible.
|
||||
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.
|
||||
|
||||
|
|
@ -248,10 +252,8 @@ on :guilabel:`Yes` to delete the Bible or click :guilabel:`No` to cancel.
|
|||
Preview Bible Verses
|
||||
====================
|
||||
|
||||
|biblepreview| Send to Preview
|
||||
|
||||
To Preview the selected verses in the left *Preview* panes, select the :guilabel:`Send to Preview`
|
||||
icon.
|
||||
To Preview the selected verses in the left *Preview* panes, select the
|
||||
|biblepreview| Send to Preview icon.
|
||||
|
||||
|
||||
.. _display_scripture:
|
||||
|
|
@ -259,10 +261,8 @@ icon.
|
|||
Send Scriptures to Live Display
|
||||
===============================
|
||||
|
||||
|biblelive| Send to Live Display
|
||||
|
||||
To Preview the selected verses in the right *Live* panes, select the :guilabel:`Send to Live`
|
||||
icon.
|
||||
To Preview the selected verses in the right *Live* panes, select the
|
||||
|biblelive| Send to Live icon.
|
||||
|
||||
|
||||
.. _add_scripture_to_service:
|
||||
|
|
@ -273,12 +273,11 @@ 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.
|
||||
|
||||
|bibleadd| Add to Service
|
||||
|
||||
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|.
|
||||
This will add your media to the service side at the bottom.
|
||||
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:
|
||||
|
|
@ -286,15 +285,15 @@ This will add your media to the service side at the bottom.
|
|||
Locking Search Results
|
||||
======================
|
||||
|
||||
|biblelock| Lock
|
||||
Selecting the :guilabel:`Lock` icon locks and unlocks the 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 verses, then select
|
||||
the :guilabel:`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 :guilabel:`Lock` icon again
|
||||
to unlock the results and return the search results to be replaced with each search.
|
||||
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:
|
||||
|
||||
|
|
@ -371,3 +370,15 @@ Selecting the :guilabel:`Search` button activates the search.
|
|||
.. |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
|
||||
|
|
@ -0,0 +1,191 @@
|
|||
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.
|
||||
|
||||
Example:
|
||||
--------
|
||||
|
||||
.. _bibles:
|
||||
|
||||
======
|
||||
Bibles
|
||||
======
|
||||
|
||||
end example
|
||||
|
||||
Line Length
|
||||
===========
|
||||
|
||||
Each line of the document should be no longer than 80 charectors. While
|
||||
the build system can wrap the text, lines longer than 80 charectors can cause
|
||||
unwelcome results.
|
||||
|
||||
Pictures
|
||||
========
|
||||
|
||||
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:
|
||||
--------------------
|
||||
|
||||
.. pictures used in this page
|
||||
|
||||
.. |DELETEICON| image:: pics/theme_delete.png
|
||||
|
||||
In Page Example:
|
||||
--------------------
|
||||
|
||||
Click on the |deleteicon| Delete Icon to delete the Bible.
|
||||
|
||||
end of examples
|
||||
|
||||
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.
|
||||
|
||||
Example:
|
||||
--------
|
||||
|
||||
.. _bibles_sublevel:
|
||||
|
||||
Sublevel
|
||||
========
|
||||
|
||||
end of example
|
||||
|
||||
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.
|
||||
|
||||
Example:
|
||||
--------
|
||||
|
||||
To convert a Bible using the command prompt in
|
||||
Windows or a terminal in Linux or macOS you would type:
|
||||
|
||||
mod2osis biblename > biblename.osis
|
||||
|
||||
end of example
|
||||
|
||||
Codeing
|
||||
=======
|
||||
|
||||
When entering coding use the wrap the coding inside two ` characters.
|
||||
|
||||
Example:
|
||||
--------
|
||||
|
||||
``<div align="left">``
|
||||
|
||||
end of example
|
||||
|
||||
|
||||
|
||||
|
||||
so if you're going through and listing each and every action in that toolbar, then use this style: http://manual.openlp.org/mediamanager.html#toolbar
|
||||
[20:57] <superfly> But if you're documenting a feature, and you want to include an icon, you should make it an inline icon.
|
||||
[20:57] <JohnMFL> superfly: so if it is a one liner, then use the toolbar formatting and if we have to explain what to do when you
|
||||
push the icon then use the inline
|
||||
|
||||
Development:String Standards
|
||||
|
||||
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.
|
||||
Loading…
Reference in New Issue