diff --git a/.bzrignore b/.bzrignore index 378eac2..f1e6669 100644 --- a/.bzrignore +++ b/.bzrignore @@ -1 +1,2 @@ build +.directory diff --git a/user-guide/Makefile b/user-guide/Makefile new file mode 100644 index 0000000..7213404 --- /dev/null +++ b/user-guide/Makefile @@ -0,0 +1,158 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = build + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + -rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/OpenLPUserGuide.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/OpenLPUserGuide.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/OpenLPUserGuide" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/OpenLPUserGuide" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +pdf: + $(SPHINXBUILD) -b pdf $(ALLSPHINXOPTS) build/pdf + @echo + @echo "Build finished. The PDF files are in build/pdf." diff --git a/user-guide/make.bat b/user-guide/make.bat new file mode 100644 index 0000000..c297f99 --- /dev/null +++ b/user-guide/make.bat @@ -0,0 +1,197 @@ +@ECHO OFF + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set BUILDDIR=build +set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source +set I18NSPHINXOPTS=%SPHINXOPTS% source +if NOT "%PAPER%" == "" ( + set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% + set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% +) + +if "%1" == "" goto help + +if "%1" == "help" ( + :help + echo.Please use `make ^` where ^ is one of + echo. html to make standalone HTML files + echo. dirhtml to make HTML files named index.html in directories + echo. singlehtml to make a single large HTML file + echo. pickle to make pickle files + echo. json to make JSON files + echo. htmlhelp to make HTML files and a HTML help project + echo. qthelp to make HTML files and a qthelp project + echo. devhelp to make HTML files and a Devhelp project + echo. epub to make an epub + echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter + echo. text to make text files + echo. man to make manual pages + echo. texinfo to make Texinfo files + echo. gettext to make PO message catalogs + echo. changes to make an overview over all changed/added/deprecated items + echo. linkcheck to check all external links for integrity + echo. doctest to run all doctests embedded in the documentation if enabled + goto end +) + +if "%1" == "clean" ( + for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i + del /q /s %BUILDDIR%\* + goto end +) + +if "%1" == "html" ( + %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/html. + goto end +) + +if "%1" == "dirhtml" ( + %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. + goto end +) + +if "%1" == "singlehtml" ( + %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. + goto end +) + +if "%1" == "pickle" ( + %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the pickle files. + goto end +) + +if "%1" == "json" ( + %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the JSON files. + goto end +) + +if "%1" == "htmlhelp" ( + %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run HTML Help Workshop with the ^ +.hhp project file in %BUILDDIR%/htmlhelp. + goto end +) + +if "%1" == "qthelp" ( + %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run "qcollectiongenerator" with the ^ +.qhcp project file in %BUILDDIR%/qthelp, like this: + echo.^> qcollectiongenerator %BUILDDIR%\qthelp\OpenLPUserGuide.qhcp + echo.To view the help file: + echo.^> assistant -collectionFile %BUILDDIR%\qthelp\OpenLPUserGuide.ghc + goto end +) + +if "%1" == "devhelp" ( + %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. + goto end +) + +if "%1" == "epub" ( + %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The epub file is in %BUILDDIR%/epub. + goto end +) + +if "%1" == "latex" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "text" ( + %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The text files are in %BUILDDIR%/text. + goto end +) + +if "%1" == "man" ( + %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The manual pages are in %BUILDDIR%/man. + goto end +) + +if "%1" == "texinfo" ( + %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. + goto end +) + +if "%1" == "gettext" ( + %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The message catalogs are in %BUILDDIR%/locale. + goto end +) + +if "%1" == "changes" ( + %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes + if errorlevel 1 exit /b 1 + echo. + echo.The overview file is in %BUILDDIR%/changes. + goto end +) + +if "%1" == "linkcheck" ( + %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck + if errorlevel 1 exit /b 1 + echo. + echo.Link check complete; look for any errors in the above output ^ +or in %BUILDDIR%/linkcheck/output.txt. + goto end +) + +if "%1" == "doctest" ( + %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest + if errorlevel 1 exit /b 1 + echo. + echo.Testing of doctests in the sources finished, look at the ^ +results in %BUILDDIR%/doctest/output.txt. + goto end +) + +if "%1" == "pdf" ( + %SPHINXBUILD% -b pdf %ALLSPHINXOPTS% %BUILDDIR%/pdf + echo. + echo.Build finished. The PDF files are in %BUILDDIR%/pdf + goto end +) + +:end diff --git a/user-guide/pdf_optimise.py b/user-guide/pdf_optimise.py new file mode 100755 index 0000000..fc9af02 --- /dev/null +++ b/user-guide/pdf_optimise.py @@ -0,0 +1,60 @@ +#!/usr/bin/env python +import os +import sys +from tempfile import mkdtemp +import re +import shutil + +IMAGE_WIDTH = re.compile(r':width: ([\d]+)px', re.UNICODE) + +def copy_files(source_dir, temp_dir): + for root, dirs, files in os.walk(source_dir): + curr_dir = root[len(source_dir) + 1:] + full_dir = os.path.join(temp_dir, curr_dir) + for name in files: + if name.endswith(u'.rst'): + if not os.path.exists(full_dir): + os.makedirs(full_dir) + shutil.copy2(os.path.join(root, name), + os.path.join(full_dir, name)) + +def restore_files(temp_dir, restore_dir): + copy_files(temp_dir, restore_dir) + shutil.rmtree(temp_dir) + +def adjust_image(match): + try: + width = int(match.group(1)) + width = int(round(width * 2.4)) + return ':width: %spx' % width + except: + return match.group(0) + +def process_images(filename): + fd = open(filename, 'rb') + contents = fd.read() + fd.close() + contents = IMAGE_WIDTH.sub(adjust_image, contents) + fd = open(filename, 'wb') + fd.write(contents) + fd.close() + +def process_files(base_dir): + for root, dirs, files in os.walk(base_dir): + for name in files: + if name.endswith(u'.rst'): + process_images(os.path.join(root, name)) + +def main(): + here = os.path.abspath(os.path.split(__file__)[0]) + if len(sys.argv) > 1 and sys.argv[1] == 'restore': + temp_dir = os.path.abspath(sys.argv[2]) + restore_files(temp_dir, here) + else: + temp_dir = mkdtemp() + print temp_dir + copy_files(here, temp_dir) + process_files(here) + +if __name__ == '__main__': + main() \ No newline at end of file diff --git a/user-guide/source/adding-content.rst b/user-guide/source/adding-content.rst new file mode 100644 index 0000000..a2b369f --- /dev/null +++ b/user-guide/source/adding-content.rst @@ -0,0 +1,18 @@ +.. _adding-content: + +Adding More Content +=================== +Now that you've got a mostly workable OpenLP installation, how do you get all your songs and things into OpenLP? + +Importing Songs +--------------- +You've been using EasyWorship, this is how you get your songs out of it. + +Importing a Bible +----------------- +You need to be able to project Bible verses, this shows you how to get Bibles into OpenLP. + +Loading a Presentation +---------------------- +Adding Videos and Images +------------------------ diff --git a/user-guide/source/conf.py b/user-guide/source/conf.py new file mode 100644 index 0000000..da73df7 --- /dev/null +++ b/user-guide/source/conf.py @@ -0,0 +1,339 @@ +# -*- coding: utf-8 -*- +# +# OpenLP User Guide documentation build configuration file, created by +# sphinx-quickstart on Wed Jul 4 23:35:21 2012. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys, os + +# 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('.')) + +# -- 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','rst2pdf.pdfbuilder'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'OpenLP User Guide' +copyright = u'2012, OpenLP Team' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '2.0' +# The full version, including alpha/beta/rc tags. +release = '2.0' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = [] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + + +# -- Options for HTML output --------------------------------------------------- + +# 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 = {} + +# 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 +# " v documentation". +html_title = 'OpenLP 2.0 User Guide' + +# 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 + +# 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 + +# 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, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# 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 tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# 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-user-guide' + + +# -- Options for LaTeX output -------------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'OpenLP-User-Guide.tex', u'OpenLP User Guide', + u'OpenLP Team', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# 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 + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#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-user-guide', u'OpenLP User Guide', + [u'OpenLP Team'], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------------ + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'OpenLP-User-Guide', u'OpenLP User Guide', + u'OpenLP Team', 'OpenLP-User-Guide', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + +# -- Options for PDF output -------------------------------------------------- +# Grouping the document tree into PDF files. List of tuples +# (source start file, target name, title, author, options). +# +# If there is more than one author, separate them with \\. +# For example: r'Guido van Rossum\\Fred L. Drake, Jr., editor' +# +# The options element is a dictionary that lets you override +# this config per-document. +# For example, +# ('index', u'MyProject', u'My Project', u'Author Name', +# dict(pdf_compressed = True)) +# would mean that specific document would be compressed +# regardless of the global pdf_compressed setting. + +pdf_documents = [ + ('index', u'OpenLP-User-Guide', u'OpenLP User Guide', u'OpenLP Team'), +] + +# A comma-separated list of custom stylesheets. Example: +pdf_stylesheets = ['sphinx','kerning','a4'] + +# A list of folders to search for stylesheets. Example: +pdf_style_path = ['.', '_styles'] + +# Create a compressed PDF +# Use True/False or 1/0 +# Example: compressed=True +pdf_compressed = True + +# A colon-separated list of folders to search for fonts. Example: +# pdf_font_path = ['/usr/share/fonts', '/usr/share/texmf-dist/fonts/'] +# Language to be used for hyphenation support +#pdf_language = "en_US" + +# Mode for literal blocks wider than the frame. Can be +# overflow, shrink or truncate +#pdf_fit_mode = "shrink" + +# Section level that forces a break page. +# For example: 1 means top-level sections start in a new page +# 0 means disabled +#pdf_break_level = 0 + +# When a section starts in a new page, force it to be 'even', 'odd', +# or just use 'any' +#pdf_breakside = 'any' + +# Insert footnotes where they are defined instead of +# at the end. +#pdf_inline_footnotes = True + +# verbosity level. 0 1 or 2 +#pdf_verbosity = 0 + +# If false, no index is generated. +#pdf_use_index = True + +# If false, no modindex is generated. +#pdf_use_modindex = True + +# If false, no coverpage is generated. +#pdf_use_coverpage = True + +# Name of the cover page template to use +#pdf_cover_template = 'sphinxcover.tmpl' + +# Documents to append as an appendix to all manuals. +#pdf_appendices = [] + +# Enable experimental feature to split table cells. Use it + +# if you get "DelayedTable too big" errors +#pdf_splittables = False + +# Set the default DPI for images +#pdf_default_dpi = 72 + +# Enable rst2pdf extension modules (default is only vectorpdf) +# you need vectorpdf if you want to use sphinx's graphviz support +#pdf_extensions = ['vectorpdf'] + +# Page template name for "regular" pages +#pdf_page_template = 'cutePage' + +# Show Table Of Contents at the beginning? +#pdf_use_toc = True + +# How many levels deep should the table of contents be? +pdf_toc_depth = 9999 + +# Add section number to section references +pdf_use_numbered_links = False + +# Background images fitting mode +pdf_fit_background_mode = 'scale' \ No newline at end of file diff --git a/user-guide/source/getting-more.rst b/user-guide/source/getting-more.rst new file mode 100644 index 0000000..c8fa373 --- /dev/null +++ b/user-guide/source/getting-more.rst @@ -0,0 +1,18 @@ +.. _getting-more: + +Getting More Out of OpenLP +========================== + +Using the Web Remote +-------------------- + +Slide Shows +----------- + +Backing Tracks +-------------- + +Finding Out More +---------------- +View our `reference manual `_. + diff --git a/user-guide/source/getting-started/adding-songs.rst b/user-guide/source/getting-started/adding-songs.rst new file mode 100644 index 0000000..1be2b1e --- /dev/null +++ b/user-guide/source/getting-started/adding-songs.rst @@ -0,0 +1,6 @@ +.. _adding-songs: + +Adding Songs +============ +Once you've got OpenLP configured, you can start adding songs. + diff --git a/user-guide/source/getting-started/fedora.rst b/user-guide/source/getting-started/fedora.rst new file mode 100644 index 0000000..2d545dc --- /dev/null +++ b/user-guide/source/getting-started/fedora.rst @@ -0,0 +1,30 @@ +.. _fedora: + +Fedora(KDE) +=========== + +**Note** when installing OpenLP you will need to have administrator privileges. +You will be asked for the administrator password to install. + +From the KickOff open *Software Management*. Type OpenLP into the search +box. Then click :guilabel:`Find by name` or press :kbd:`Enter`. + +.. image:: ../screenshots/install/fedora/1-software-management.png + :width: 831px + +Select OpenLP from the search results. Next, click :guilabel:`Apply` + +.. image:: ../screenshots/install/fedora/2-search-results.png + :width: 831px + +Now give permission to install other software dependencies that are needed by +clicking :guilabel:`Continue` + +.. image:: ../screenshots/install/fedora/3-additional-software.png + :width: 566px + +Once completed you can run OpenLP by clicking on its logo in the completed +install notification, or from the KickOff menu. + +.. image:: ../screenshots/install/fedora/4-installation-complete.png + :width: 521px diff --git a/user-guide/source/getting-started/first-time-wizard.rst b/user-guide/source/getting-started/first-time-wizard.rst new file mode 100644 index 0000000..51b065d --- /dev/null +++ b/user-guide/source/getting-started/first-time-wizard.rst @@ -0,0 +1,6 @@ +.. _first-time-wzard: + +First Time Wizard +================= +When you run OpenLP for the very first time, it will run the First Time Wizard +which helps you get OpenLP set up initially. \ No newline at end of file diff --git a/user-guide/source/getting-started/getting-started.rst b/user-guide/source/getting-started/getting-started.rst new file mode 100644 index 0000000..041efcb --- /dev/null +++ b/user-guide/source/getting-started/getting-started.rst @@ -0,0 +1,44 @@ +.. _getting-started: + +Getting Started +=============== +In this section we'll be taking you through the first steps to getting OpenLP +up and running on your computer. + +Installing +---------- +Follow the instructions below to download and install OpenLP on your operating +system. + +.. toctree:: + windows + mac-os-x + ubuntu + fedora + :maxdepth: 2 + +For more information on installing OpenLP on other platforms, please see the +`Reference Manual `_ + +Running for the First Time +-------------------------- +When OpenLP starts up for the first time, it may take a little while to get +started due to the fact that it needs to perform some initial setup. + +.. toctree:: + first-time-wizard + adding-songs + :maxdepth: 2 + +Creating a Service +****************** +Now that you have a few songs, you can create a proper service. + +Running a Service +***************** +If you have a service, you need to know how to run it. + +Changing How Things Look +************************ +To change how songs look, we need to add or edit **themes**. + diff --git a/user-guide/source/getting-started/mac-os-x.rst b/user-guide/source/getting-started/mac-os-x.rst new file mode 100644 index 0000000..795a380 --- /dev/null +++ b/user-guide/source/getting-started/mac-os-x.rst @@ -0,0 +1,17 @@ +.. _install-mac-os-x: + +Mac OS X +======== +Installation of OpenLP on Mac OS X is just like most other software packages +on OS X, where you simply have to drag and drop OpenLP into your Applications +directory to install it.. + +Visit the `download page `_ on the +`OpenLP website `_ to download the OpenLP disk image. + +Before the setup wizard starts, you are asked to select a langage. This is not +the language you will be using OpenLP in, it is simply the language you will +be using to install OpenLP. + +.. image:: ../screenshots/install/macosx/1-copy-to-applications.png + :width: 547px diff --git a/user-guide/source/getting-started/ubuntu.rst b/user-guide/source/getting-started/ubuntu.rst new file mode 100644 index 0000000..14fc9b3 --- /dev/null +++ b/user-guide/source/getting-started/ubuntu.rst @@ -0,0 +1,60 @@ +.. _ubuntu: + +Ubuntu +====== +The latest versions of Ubuntu already have OpenLP, you simply need to open +the Software Center, search for OpenLP and click to install it. + +Open up *Software Center* by clicking on the :guilabel:`Software Center` icon +in the Launcher if you are using the *Unity* desktop, or if you are using an +older version of Ubuntu or the *Classic* desktop go to +:menuselection:`Applications` and select the *Software Center* from the bottom +of the menu. You will need to be the administrator of the system to install +OpenLP and may be asked for the administrator password several times through +this process. + +When you have the Software Center running simply search for OpenLP and click +:guilabel:`Install`. + +.. image:: ../screenshots/install/ubuntu/1-search-openlp.png + :width: 892px + +You will see the install progress as OpenLP and the dependencies required for +it to run are downloaded. + +.. image:: ../screenshots/install/ubuntu/2-install-progress.png + :width: 892px + +After installation you should see that OpenLP is installed. + +.. image:: ../screenshots/install/ubuntu/3-install-complete.png + :width: 892px + +You can now run OpenLP by either searching for it in the *Dash*, or clicking on +the category *Media Apps* in Unity. If you are running the Classic Desktop you +will have OpenLP available by clicking +:menuselection:`Applications --> Sound and Video --> OpenLP` + +Ubuntu 12.04 +------------ +If you're using Ubuntu 12.04, you may need to enable the *Backports* +repository in order to find OpenLP. The *Backports* repository is a collection +of newer versions of software already available in Ubuntu. + +With *Software Center* openlp, go to :menuselection:`Edit --> Software Sources` + +.. image:: ../screenshots/install/ubuntu/4-software-sources.png + :width: 892px + +Then click on the :guilabel:`Updates` tab and make sure the checkbox next to +:guilabel:`Backports` is checked. Click OK and then close and open *Software +Center* to refresh the software list. + +.. image:: ../screenshots/install/ubuntu/5-updates-backports.png + :width: 588px + +Other Ubuntu Releases +--------------------- +For information on how to install OpenLP in older Ubuntu releases, and in +Ubuntu derivatives like Kubuntu and Xubuntu, please see the relevaant section +in the `Reference Manual `_. diff --git a/user-guide/source/getting-started/windows.rst b/user-guide/source/getting-started/windows.rst new file mode 100644 index 0000000..0044d3e --- /dev/null +++ b/user-guide/source/getting-started/windows.rst @@ -0,0 +1,73 @@ +.. _install-windows: + +Windows +======= +Installation of OpenLP on Windows is much like most other software packages on +Windows, where a setup wizard guides you through the process. + +Visit the `download page `_ on the +`OpenLP website `_ to download OpenLP. When you download +OpenLP on Windows, Windows will ask you if you are sure you want to download +it. Be assured that our installer is safe, and has been tested by multiple +independent vendors who have certified our installer to be free of viruses and +malware. + +.. image:: ../screenshots/install/windows/1-download.png + :width: 434px + +Before the setup wizard starts, you are asked to select a langage. This is not +the language you will be using OpenLP in, it is simply the language you will +be using to install OpenLP. + +.. image:: ../screenshots/install/windows/2-select-language.png + :width: 333px + +After selecting your language, the welcome screen appears. + +.. image:: ../screenshots/install/windows/3-welcome.png + :width: 533px + +Next you be asked to accept the license. This license is the reason why OpenLP +is free. To find out more about the license, please see the +`quick guide to the GPL `_ +on the `Free Software Foundation `_'s site. + +.. image:: ../screenshots/install/windows/4-license.png + :width: 533px + +Once you've agreed to the license, you can choose where to install OpenLP to. +This usually defaults to the best place, and it is recommended you leave it +as it is. + +.. image:: ../screenshots/install/windows/5-install-location.png + :width: 533px + +In the next step you can select the name of the folder in your start menu +where OpenLP will put its links. + +.. image:: ../screenshots/install/windows/6-start-menu.png + :width: 533px + +If you want the installer to put an icon on your desktop, you can do that by +checking the checkbox on the "Additional tasks" screen of the installer. + +.. image:: ../screenshots/install/windows/7-additional-tasks.png + :width: 533px + +When the installer is ready to install OpenLP, it will show you a summary of +all the options you have selected. Click the Next button to install OpenLP. + +.. image:: ../screenshots/install/windows/8-summary.png + :width: 533px + +The installer usually takes about a minute to install OpenLP. While it does so +it will show you the progress. + +.. image:: ../screenshots/install/windows/9-progress.png + :width: 533px + +Lastly, once the installation is complete, you can check the "Launch OpenLP" +checkbox to run OpenLP once the installer has exited. + +.. image:: ../screenshots/install/windows/10-complete.png + :width: 533px diff --git a/user-guide/source/index.rst b/user-guide/source/index.rst new file mode 100644 index 0000000..0f76e9b --- /dev/null +++ b/user-guide/source/index.rst @@ -0,0 +1,24 @@ +.. OpenLP User Guide documentation master file, created by + sphinx-quickstart on Wed Jul 4 23:35:21 2012. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to the OpenLP 2.0 User Guide +==================================== + +Contents: + +.. toctree:: + getting-started/getting-started + adding-content + getting-more + :maxdepth: 2 + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/user-guide/source/screenshots/install/fedora/1-software-management.png b/user-guide/source/screenshots/install/fedora/1-software-management.png new file mode 100644 index 0000000..79d697c Binary files /dev/null and b/user-guide/source/screenshots/install/fedora/1-software-management.png differ diff --git a/user-guide/source/screenshots/install/fedora/2-search-results.png b/user-guide/source/screenshots/install/fedora/2-search-results.png new file mode 100644 index 0000000..9717adb Binary files /dev/null and b/user-guide/source/screenshots/install/fedora/2-search-results.png differ diff --git a/user-guide/source/screenshots/install/fedora/3-additional-software.png b/user-guide/source/screenshots/install/fedora/3-additional-software.png new file mode 100644 index 0000000..ab19ba8 Binary files /dev/null and b/user-guide/source/screenshots/install/fedora/3-additional-software.png differ diff --git a/user-guide/source/screenshots/install/fedora/4-installation-complete.png b/user-guide/source/screenshots/install/fedora/4-installation-complete.png new file mode 100644 index 0000000..ee2d476 Binary files /dev/null and b/user-guide/source/screenshots/install/fedora/4-installation-complete.png differ diff --git a/user-guide/source/screenshots/install/macosx/1-copy-to-applications.png b/user-guide/source/screenshots/install/macosx/1-copy-to-applications.png new file mode 100644 index 0000000..ea460b3 Binary files /dev/null and b/user-guide/source/screenshots/install/macosx/1-copy-to-applications.png differ diff --git a/user-guide/source/screenshots/install/ubuntu/1-search-openlp.png b/user-guide/source/screenshots/install/ubuntu/1-search-openlp.png new file mode 100644 index 0000000..61798d8 Binary files /dev/null and b/user-guide/source/screenshots/install/ubuntu/1-search-openlp.png differ diff --git a/user-guide/source/screenshots/install/ubuntu/2-install-progress.png b/user-guide/source/screenshots/install/ubuntu/2-install-progress.png new file mode 100644 index 0000000..6fd0dcb Binary files /dev/null and b/user-guide/source/screenshots/install/ubuntu/2-install-progress.png differ diff --git a/user-guide/source/screenshots/install/ubuntu/3-install-complete.png b/user-guide/source/screenshots/install/ubuntu/3-install-complete.png new file mode 100644 index 0000000..ad442e5 Binary files /dev/null and b/user-guide/source/screenshots/install/ubuntu/3-install-complete.png differ diff --git a/user-guide/source/screenshots/install/ubuntu/4-software-sources.png b/user-guide/source/screenshots/install/ubuntu/4-software-sources.png new file mode 100644 index 0000000..26f5c47 Binary files /dev/null and b/user-guide/source/screenshots/install/ubuntu/4-software-sources.png differ diff --git a/user-guide/source/screenshots/install/ubuntu/5-updates-backports.png b/user-guide/source/screenshots/install/ubuntu/5-updates-backports.png new file mode 100644 index 0000000..139cfb1 Binary files /dev/null and b/user-guide/source/screenshots/install/ubuntu/5-updates-backports.png differ diff --git a/user-guide/source/screenshots/install/windows/.directory b/user-guide/source/screenshots/install/windows/.directory new file mode 100644 index 0000000..e054dfd --- /dev/null +++ b/user-guide/source/screenshots/install/windows/.directory @@ -0,0 +1,3 @@ +[Dolphin] +PreviewsShown=true +Timestamp=2012,7,7,20,13,37 diff --git a/user-guide/source/screenshots/install/windows/1-download.png b/user-guide/source/screenshots/install/windows/1-download.png new file mode 100644 index 0000000..4e95c38 Binary files /dev/null and b/user-guide/source/screenshots/install/windows/1-download.png differ diff --git a/user-guide/source/screenshots/install/windows/10-complete.png b/user-guide/source/screenshots/install/windows/10-complete.png new file mode 100644 index 0000000..86d27b3 Binary files /dev/null and b/user-guide/source/screenshots/install/windows/10-complete.png differ diff --git a/user-guide/source/screenshots/install/windows/2-select-language.png b/user-guide/source/screenshots/install/windows/2-select-language.png new file mode 100644 index 0000000..e9014eb Binary files /dev/null and b/user-guide/source/screenshots/install/windows/2-select-language.png differ diff --git a/user-guide/source/screenshots/install/windows/3-welcome.png b/user-guide/source/screenshots/install/windows/3-welcome.png new file mode 100644 index 0000000..15a6506 Binary files /dev/null and b/user-guide/source/screenshots/install/windows/3-welcome.png differ diff --git a/user-guide/source/screenshots/install/windows/4-license.png b/user-guide/source/screenshots/install/windows/4-license.png new file mode 100644 index 0000000..e99d938 Binary files /dev/null and b/user-guide/source/screenshots/install/windows/4-license.png differ diff --git a/user-guide/source/screenshots/install/windows/5-install-location.png b/user-guide/source/screenshots/install/windows/5-install-location.png new file mode 100644 index 0000000..6630715 Binary files /dev/null and b/user-guide/source/screenshots/install/windows/5-install-location.png differ diff --git a/user-guide/source/screenshots/install/windows/6-start-menu.png b/user-guide/source/screenshots/install/windows/6-start-menu.png new file mode 100644 index 0000000..ff7bc4d Binary files /dev/null and b/user-guide/source/screenshots/install/windows/6-start-menu.png differ diff --git a/user-guide/source/screenshots/install/windows/7-additional-tasks.png b/user-guide/source/screenshots/install/windows/7-additional-tasks.png new file mode 100644 index 0000000..885fc9d Binary files /dev/null and b/user-guide/source/screenshots/install/windows/7-additional-tasks.png differ diff --git a/user-guide/source/screenshots/install/windows/8-summary.png b/user-guide/source/screenshots/install/windows/8-summary.png new file mode 100644 index 0000000..6dad9f0 Binary files /dev/null and b/user-guide/source/screenshots/install/windows/8-summary.png differ diff --git a/user-guide/source/screenshots/install/windows/9-progress.png b/user-guide/source/screenshots/install/windows/9-progress.png new file mode 100644 index 0000000..777bf37 Binary files /dev/null and b/user-guide/source/screenshots/install/windows/9-progress.png differ