openlp-core team mailing list archive

[Wesley Stout <wesleystout@xxxxxxxxx>]

Wesley Stout has proposed merging lp:~wesleystout/openlp/documentation into lp:openlp.

Requested reviews:
  OpenLP Core (openlp-core)


Made some corrections etc, added a lot to songs just thought i'd get you guys to look it over if you see any glaring problems before i continue
-- 
https://code.launchpad.net/~wesleystout/openlp/documentation/+merge/42270
Your team OpenLP Core is requested to review the proposed merge of lp:~wesleystout/openlp/documentation into lp:openlp.

=== modified file 'documentation/manual/source/conf.py'
--- documentation/manual/source/conf.py	2010-10-16 19:38:23 +0000
+++ documentation/manual/source/conf.py	2010-11-30 16:34:58 +0000
@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 #
 # OpenLP documentation build configuration file, created by
-# sphinx-quickstart on Fri Jul 10 17:20:40 2009.
+# sphinx-quickstart on Thu Sep 30 21:24:54 2010.
 #
 # This file is execfile()d with the current directory set to its containing dir.
 #
@@ -11,19 +11,22 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
+import sys
 import os
-import sys
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.insert(0, os.path.abspath(os.path.join('..', '..')))
+#sys.path.insert(0, os.path.abspath('.'))
 
 # -- General configuration -----------------------------------------------------
 
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-#extensions = ['sphinx.ext.autodoc']
+extensions = []
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -32,14 +35,14 @@
 source_suffix = '.rst'
 
 # The encoding of source files.
-source_encoding = 'utf-8'
+#source_encoding = 'utf-8-sig'
 
 # The master toctree document.
 master_doc = 'index'
 
 # General information about the project.
 project = u'OpenLP'
-copyright = u'2004-2010 Raoul Snyman'
+copyright = u'2010, Raoul Snyman'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -48,7 +51,7 @@
 # The short X.Y version.
 version = '2.0'
 # The full version, including alpha/beta/rc tags.
-release = '1.9.3'
+release = '2.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -60,12 +63,9 @@
 # Else, today_fmt is used as the format for a strftime call.
 #today_fmt = '%B %d, %Y'
 
-# List of documents that shouldn't be included in the build.
-#unused_docs = []
-
-# List of directories, relative to source directory, that shouldn't be searched
-# for source files.
-exclude_trees = []
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
 
 # The reST default role (used for this markup: `text`) to use for all documents.
 #default_role = None
@@ -75,7 +75,7 @@
 
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
-add_module_names = False
+#add_module_names = True
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
@@ -90,40 +90,33 @@
 
 # -- Options for HTML output ---------------------------------------------------
 
-# The theme to use for HTML and HTML Help pages.  Major themes that come with
-# Sphinx are currently 'default' and 'sphinxdoc'.
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
 html_theme = 'default'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-html_theme_options = {
-    'sidebarbgcolor': '#3a60a9',
-    'relbarbgcolor': '#203b6f',
-    'footerbgcolor': '#26437c',
-    'headtextcolor': '#203b6f',
-    'linkcolor': '#26437c',
-    'sidebarlinkcolor': '#ceceff'
-}
+#html_theme_options = {}
 
 # Add any paths that contain custom themes here, relative to this directory.
 #html_theme_path = []
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-html_title = u'OpenLP 2.0 User Manual'
+#html_title = None
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
 #html_short_title = None
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-#html_logo = None
+html_logo = 'pics/logo.png'
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-#html_favicon = None
+html_favicon = 'pics/openlp.ico'
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
@@ -146,7 +139,7 @@
 #html_additional_pages = {}
 
 # If false, no module index is generated.
-#html_use_modindex = True
+#html_domain_indices = True
 
 # If false, no index is generated.
 #html_use_index = True
@@ -157,16 +150,22 @@
 # If true, links to the reST sources are added to the pages.
 #html_show_sourcelink = True
 
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the
 # base URL from which the finished HTML is served.
 #html_use_opensearch = ''
 
-# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = ''
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'OpenLP-2.0-manual'
+htmlhelp_basename = 'OpenLPdoc'
 
 
 # -- Options for LaTeX output --------------------------------------------------
@@ -180,8 +179,8 @@
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-  ('index', 'OpenLP.tex', u'OpenLP 2.0 User Manual',
-   u'Raoul Snyman', 'manual'),
+  ('index', 'OpenLP.tex', u'OpenLP Documentation',
+   u'Wesley Stout', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -192,6 +191,12 @@
 # not chapters.
 #latex_use_parts = False
 
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
 # Additional stuff for the LaTeX preamble.
 #latex_preamble = ''
 
@@ -199,10 +204,14 @@
 #latex_appendices = []
 
 # If false, no module index is generated.
-#latex_use_modindex = True
-
-# A dictionary that contains LaTeX snippets that override those Sphinx usually
-# puts into the generated .tex files.
-latex_elements = {
-    'fontpkg': '\\usepackage{helvet}'
-}
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'openlp', u'OpenLP Documentation',
+     [u'Wesley Stout'], 1)
+]

=== modified file 'documentation/manual/source/dualmonitors.rst'
--- documentation/manual/source/dualmonitors.rst	2010-10-19 18:54:43 +0000
+++ documentation/manual/source/dualmonitors.rst	2010-11-30 16:34:58 +0000
@@ -4,7 +4,7 @@
 
 The first step in getting OpenLP working on your system is to setup your
 computer properly for dual monitors. This is not very difficult, but the steps
-do vary depending on operating system.
+will vary depending on operating system.
 
 Most modern computers do have the ability for dual monitors. To be certain
 check your computer's documentation. A typical desktop computer capable of dual
@@ -18,16 +18,15 @@
 
 .. image:: pics/dvi.png
 
-A laptop computer setup only varies slightly, generally you will need only one
+A laptop computer setup varies only slightly, generally you will need only one
 of outputs pictured above since your laptops screen serves as one of the
-monitors. Sometimes with older laptops a key stroke generally involving the
-:kbd:`Fn` key and another key is required to enable the second monitor on
-laptops.
+monitors. Sometimes older laptops require a key stroke generally involving the
+:kbd:`Fn` key and another key to enable the second monitor on laptops.
 
 Some computers also incorporate the use of :abbr:`S-Video (Separate Video)` or
 :abbr:`HDMI (High-Definition Multimedia Interface)` connections.
 
-A typical OpenLP set up consist of your normal single monitor setup, with your
+A typical OpenLP setup consist of your normal single monitor setup, with your
 projector setup as the second monitor. With the option of extending your
 desktop across the second monitor, or your operating system's equivalent.
 
@@ -46,14 +45,13 @@
 
 The more traditional way is also fairly straight forward. Go to
 :guilabel:`Control Panel` and click on :guilabel:`Display`. This will open up
-the :guilabel:`Display` dialog. You can also bypass this step by right click on
-a blank area on your desktop and selecting :guilabel:`Resolution`.
+the :guilabel:`Display` dialog. You can also bypass this step by right clicking 
+on a blank area on your desktop and selecting :guilabel:`Resolution`.
 
 .. image:: pics/winsevendisplay.png
 
 Then click on the :guilabel:`Adjust resolution` link in the left pane. Enable
-your projector and make sure that the selected value for :guilabel:`Multiple
-displays` is :guilabel:`Extend these displays`.
+your projector and make sure the selected value for :guilabel:`Multiple displays` is :guilabel:`Extend these displays`.
 
 .. image:: pics/winsevenresolution.png
 

=== modified file 'documentation/manual/source/glossary.rst'
--- documentation/manual/source/glossary.rst	2010-11-25 18:00:58 +0000
+++ documentation/manual/source/glossary.rst	2010-11-30 16:34:58 +0000
@@ -44,11 +44,15 @@
 
 A service item are the **media items** that are in the **service manager**
 
-Service Manger
---------------
+Service Manager
+---------------
 
 The service manager contains the media items in your service file. This is the 
+<<<<<<< TREE
 area from which your media items go live, and you can also save, open, and edit 
+=======
+area where your media items go live, and you can also save, open, and edit 
+>>>>>>> MERGE-SOURCE
 services files.
 
 .. image:: pics/servicemanager.png

=== added file 'documentation/manual/source/pics/addsong.png'
Binary files documentation/manual/source/pics/addsong.png	1970-01-01 00:00:00 +0000 and documentation/manual/source/pics/addsong.png	2010-11-30 16:34:58 +0000 differ
=== added file 'documentation/manual/source/pics/logo.png'
Binary files documentation/manual/source/pics/logo.png	1970-01-01 00:00:00 +0000 and documentation/manual/source/pics/logo.png	2010-11-30 16:34:58 +0000 differ
=== added file 'documentation/manual/source/pics/openlp.ico'
Binary files documentation/manual/source/pics/openlp.ico	1970-01-01 00:00:00 +0000 and documentation/manual/source/pics/openlp.ico	2010-11-30 16:34:58 +0000 differ
=== added file 'documentation/manual/source/pics/songeditor1.png'
Binary files documentation/manual/source/pics/songeditor1.png	1970-01-01 00:00:00 +0000 and documentation/manual/source/pics/songeditor1.png	2010-11-30 16:34:58 +0000 differ
=== added file 'documentation/manual/source/pics/songeditor11.png'
Binary files documentation/manual/source/pics/songeditor11.png	1970-01-01 00:00:00 +0000 and documentation/manual/source/pics/songeditor11.png	2010-11-30 16:34:58 +0000 differ
=== added file 'documentation/manual/source/pics/songeditor2.png'
Binary files documentation/manual/source/pics/songeditor2.png	1970-01-01 00:00:00 +0000 and documentation/manual/source/pics/songeditor2.png	2010-11-30 16:34:58 +0000 differ
=== added file 'documentation/manual/source/pics/songeditor3.png'
Binary files documentation/manual/source/pics/songeditor3.png	1970-01-01 00:00:00 +0000 and documentation/manual/source/pics/songeditor3.png	2010-11-30 16:34:58 +0000 differ
=== added file 'documentation/manual/source/pics/songeditor4.png'
Binary files documentation/manual/source/pics/songeditor4.png	1970-01-01 00:00:00 +0000 and documentation/manual/source/pics/songeditor4.png	2010-11-30 16:34:58 +0000 differ
=== added file 'documentation/manual/source/pics/songeditor5.png'
Binary files documentation/manual/source/pics/songeditor5.png	1970-01-01 00:00:00 +0000 and documentation/manual/source/pics/songeditor5.png	2010-11-30 16:34:58 +0000 differ
=== added file 'documentation/manual/source/pics/songeditor6.png'
Binary files documentation/manual/source/pics/songeditor6.png	1970-01-01 00:00:00 +0000 and documentation/manual/source/pics/songeditor6.png	2010-11-30 16:34:58 +0000 differ
=== added file 'documentation/manual/source/pics/songeditor7.png'
Binary files documentation/manual/source/pics/songeditor7.png	1970-01-01 00:00:00 +0000 and documentation/manual/source/pics/songeditor7.png	2010-11-30 16:34:58 +0000 differ
=== added file 'documentation/manual/source/pics/songeditor8.png'
Binary files documentation/manual/source/pics/songeditor8.png	1970-01-01 00:00:00 +0000 and documentation/manual/source/pics/songeditor8.png	2010-11-30 16:34:58 +0000 differ
=== added file 'documentation/manual/source/pics/songeditor9.png'
Binary files documentation/manual/source/pics/songeditor9.png	1970-01-01 00:00:00 +0000 and documentation/manual/source/pics/songeditor9.png	2010-11-30 16:34:58 +0000 differ
=== added file 'documentation/manual/source/pics/songs12.png'
Binary files documentation/manual/source/pics/songs12.png	1970-01-01 00:00:00 +0000 and documentation/manual/source/pics/songs12.png	2010-11-30 16:34:58 +0000 differ
=== added file 'documentation/manual/source/pics/songs13.png'
Binary files documentation/manual/source/pics/songs13.png	1970-01-01 00:00:00 +0000 and documentation/manual/source/pics/songs13.png	2010-11-30 16:34:58 +0000 differ
=== added file 'documentation/manual/source/pics/songs14.png'
Binary files documentation/manual/source/pics/songs14.png	1970-01-01 00:00:00 +0000 and documentation/manual/source/pics/songs14.png	2010-11-30 16:34:58 +0000 differ
=== added file 'documentation/manual/source/pics/songs15.png'
Binary files documentation/manual/source/pics/songs15.png	1970-01-01 00:00:00 +0000 and documentation/manual/source/pics/songs15.png	2010-11-30 16:34:58 +0000 differ
=== added file 'documentation/manual/source/pics/songs16.png'
Binary files documentation/manual/source/pics/songs16.png	1970-01-01 00:00:00 +0000 and documentation/manual/source/pics/songs16.png	2010-11-30 16:34:58 +0000 differ
=== added file 'documentation/manual/source/pics/songs17.png'
Binary files documentation/manual/source/pics/songs17.png	1970-01-01 00:00:00 +0000 and documentation/manual/source/pics/songs17.png	2010-11-30 16:34:58 +0000 differ
=== modified file 'documentation/manual/source/songs.rst'
--- documentation/manual/source/songs.rst	2010-11-27 14:58:27 +0000
+++ documentation/manual/source/songs.rst	2010-11-30 16:34:58 +0000
@@ -97,4 +97,226 @@
 Press :guilabel:`Finish` and you will now be ready to use your songs imported
 from CCLI SongSelect.
 
+Importing from EasyWorship
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+To import your songs from EasyWorship you need to find the database file.
+Locate the file here:
+
+Windows Vista / Windows 7::
+
+    C:\ProgramData\Documents\Softouch\EasyWorship\Default\Databases\Data\Songs.DB
+
+Windows XP::
+
+    C:\Documents and Settings\All Users\Documents\Softouch\EasyWorship\Default\atabases\Data\Songs.DB
+
+After selecting your EasyWorship database file click :guilabel:`Next` 
+
+.. image:: pics/finishedimport.png
+
+Once the importer is comlplete click :guilabel:`Finish` your EasyWorship songs
+are now ready to use.
+
+Importing OpenLyrics
+^^^^^^^^^^^^^^^^^^^^
+OpenLyrics is a free, open XML standard for Christian worship songs. The goal
+of OpenLyrics is to provide an application-independant and operating 
+system-independant song format for interoperability between applications.
+
+More info can be found it about OpenLyrics at http://openlyrics.info
+
+Importing OpenLyrics formatted songs is very simple. Select the OpenLyrics 
+files from the OpenLP import window and then click :guilabel:`Next` You can
+also select multiple songs for import at once on most operating systems by 
+selecting the first item in the list then holding shift select the last item in
+the list. When finished you should see that your import has completed. 
+
+.. image:: pics/finishedimport.png
+
+Then click :guilabel:`Finish` and your OpenLyrics songs are now ready to use. 
+
+Importing >From Songs of Fellowship
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+To import songs from Songs of Fellowship simply select the .rtf file from the 
+book you are wanting to import and click :guilabel:`Next`. This import may take
+some time so be patient, but when completed you should have your Songs of
+Fellowship songs in OpenLP.
+
+.. image:: pics/finishedimport.png
+
+Once the import is completed click :guilabel:`Finish` to use your songs.
+
+Manually Entering New Songs
+===========================
+
+There maybe times when you need to manually need to enter in a new song with 
+out importing. To do this click on the add song icon 
+
+.. image:: pics/addsong.png
+
+This will bring up the song editor window
+
+.. image:: pics/songeditor1.png
+
+Next you will want to add the song title and an alternate title if any
+
+.. image:: pics/songeditor2.png
+
+You are now ready to add verses, choruses, etc to your new song. Do this by 
+clicking the :guilabel:`Add` button.
+
+.. image:: pics/songeditor3.png
+
+Enter your lyrics into the text box, then select the correct `Verse Type` from
+the menu and also enter the correct number.
+
+.. image:: pics/songeditor4.png
+
+When you are satisfied click the :guilabel:`Save` button. Then repeat the 
+process to add additional lyrics.
+
+.. image:: pics/songeditor5.png
+
+When you have all of your lyrics entered then you can optionally enter the
+order of the song to help while projecting the song live. An example would be
+`V1 C1 V2 C1` This would be the order of verse 1 followed by the chorus 
+followed by verse 2 followed by the chorus. 
+
+You are now ready to move on to the :guilabel:`Authors, Topics & Song Book Tab`
+
+.. image:: pics/songeditor6.png
+
+First you will need to add the author(s) to the song. Simply select the author
+from the list and click :guilabel:`Add to Song` If the author is not available
+click on :guilabel:`Manage Authors, Topics, Song Books`
+
+.. image:: pics/songeditor7.png
+
+From the left select from Authors, Topics or Song Books. Click :guilabel:`Authors`
+then click :guilabel:`Add`
+
+.. image:: pics/songeditor8.png
+
+Enter in your authors information then click :guilabel:`Save` Repeat this 
+process to add authors as needed.
+
+Next you will want to add any topics associated with the song or any song book 
+information. To add that info simply follow the same process as adding authors
+from the Authors Topics and Song Books Manager. Topic and song book info is 
+optional and not required but can be very useful to help track songs.
+
+.. image:: pics/songeditor9.png
+
+After you are finished with the Author, Topic, and Song Book info you can now 
+go to the :guilabel:`Theme, Copyright Info & Comments` tab.
+
+.. image:: pics/songeditor11.png
+
+You can now select a theme for the song. If you do not select a theme the
+global theme or service level theme will be used for the song. You can also 
+enter any copyright or CCLI information and also include notes about the song.
+When you are finished you can click :guilabel:`Save` to save the song and make 
+it ready for you to use in your services.
+
+Editing Songs
+^^^^^^^^^^^^^
+
+Editing songs is very similar to adding a new song. First select the song from 
+the songs tab of the Media Manager. Right clikcing and then select :guilabel:`Edit Song`
+
+.. image:: pics/songs12.png
+
+or you can select the song and press the song edit icon
+
+.. image:: pics/songs13.png
+
+This will open up the `Song Editor`. From the `Title & Lyrics` tab you can edit
+the title, alternate title, lyrics and the verse order.
+
+Editing the title and alternate title just require changing the text in the 
+text box.
+
+To edit the lyrics select the verse you want to edit and click the :guilabel:`Edit`
+button.
+
+.. image:: pics/songeditor4.png
+
+You can edit the text of the selected verse and also change the `Verse Type`
+click :guilabel:`Save` when you are satisfied with your changes.
+
+To add a single verse click the :guilabel:`Add` to add a verse and to delete a
+single verse select the verse from the `Lyrics List` and click :guilabel:`Delete`
+
+You can also edit all the lyrics of a song including all verses at once. To do 
+this click :guilabel:`Edit All`
+
+.. image:: pics/songs15.png
+
+This gives you the ability to edit lyrics across all verses. You can also add
+verses by selecting the correct verse type and number and clicking :guilabel:`Insert`
+when you are satisfied with your changes click :guilabel:`Save`.
+
+From the `Authors, Topics, & Song Book` tab you can edit information about the 
+author, add any related topics, or song books.
+
+.. image:: pics/songeditor9.png
+
+To add an author to the song select the author from the drop menu and click
+:guilabel:`Add to Song` to remove an author click on the author and click
+:guilabel:`Remove`. 
+
+To add a topic to the song select the topic from the drop menu and click
+:guilabel:`Add to Song` to remove an topic click on the author and click
+:guilabel:`Remove`. 
+
+You can change the song book by selecting the correct book from the Song Book
+drop menu and entering the correct number into the text box.
+
+If you need to add an author, topic, or song book, click the 
+:guilabel:`Manage Authors, Topics, Song Books` button.
+
+From the left select from Authors, Topics or Song Books. Click :guilabel:`Authors`
+then click :guilabel:`Add`
+
+.. image:: pics/songeditor8.png
+
+Enter in your authors information then click :guilabel:`Save` Repeat this 
+process to add authors as needed.
+
+Next you will want to add any topics associated with the song or any song book 
+information. To add that info simply follow the same process as adding authors
+from the Authors Topics and Song Books Manager. Topic and song book info is 
+optional and not required but can be very useful to help track songs.
+
+After you are finished with the Author, Topic, and Song Book info you can now 
+go to the :guilabel:`Theme, Copyright Info & Comments` tab.
+
+.. image:: pics/songeditor11.png
+
+You can now select a theme for the song. If you do not select a theme the
+global theme or service level theme will be used for the song. You can also 
+enter any copyright or CCLI information and also include notes about the song.
+When you are finished you can click :guilabel:`Save` to save the song and make 
+it ready for you to use in your services.
+
+Deleting Songs
+^^^^^^^^^^^^^^
+
+**Warning -** when you delete a song it can not be recovered. Please be certain
+that you will not need the song again before deleting.
+
+To delete a song select the song.
+
+.. image:: pics/songs16.png
+
+You can delete the song by right clicking the song and selecting delete. Or by 
+slecting the song and pressing the delete icon.
+
+.. image:: pics/songs17.png 
+
+
+
+