diff --git a/user-guide/make.bat b/user-guide/make.bat index bfb1a3a..c297f99 100644 --- a/user-guide/make.bat +++ b/user-guide/make.bat @@ -3,188 +3,195 @@ REM Command file for Sphinx documentation if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build + 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% + 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 + :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 + 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 + %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 + %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 + %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 + %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 + %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 ^ + %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 + 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 ^ + %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 + 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 + %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 + %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 + %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 + %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 + %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 + %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 + %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 + %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 ^ + %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 + 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 ^ + %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 + 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 100644 index 0000000..93710cb --- /dev/null +++ b/user-guide/pdf_optimise.py @@ -0,0 +1,46 @@ +#!/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 restore_files(temp_dir, restore_dir): + shutil.copytree( + shutil.rmtree(temp_dir) + +def adjust_image(match): + try: + width = int(match.group(1)) + width = int(round(width * 2.4)) + return str(width) + except: + return match.group(1) + +def process_images(filename): + contents = open(filename, 'rb').read() + contents = IMAGE_WIDTH.sub(adjust_image, contents) + fd = open(filename, 'wb') + fd.write(contents) + fd.close() + +def find_files(base_dir): + for root, dirs, files in os.walk(top, topdown=False): + 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) + return + temp_dir = mkdtemp() + shutile.copytree(here, temp_dir) + find_files(here) + +if __name__ == '__main__': + main() \ No newline at end of file diff --git a/user-guide/source/getting-started/fedora.rst b/user-guide/source/getting-started/fedora.rst new file mode 100644 index 0000000..a4f4b13 --- /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: 1995px + +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/index.rst b/user-guide/source/getting-started/index.rst index 576a8fe..db65827 100644 --- a/user-guide/source/getting-started/index.rst +++ b/user-guide/source/getting-started/index.rst @@ -5,8 +5,8 @@ Getting Started In this section we'll be taking you through the first steps to getting OpenLP up and running on your computer. -Downloading & Installing ------------------------- +Installing +---------- Follow the instructions below to download and install OpenLP on your operating system. @@ -14,13 +14,9 @@ system. windows mac-os-x ubuntu + fedora :maxdepth: 2 - -Fedora -****** -Open your package manager. Enable extras. Search for OpenLP. Click Install. - 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. diff --git a/user-guide/source/getting-started/ubuntu.rst b/user-guide/source/getting-started/ubuntu.rst index e6111fb..7143be8 100644 --- a/user-guide/source/getting-started/ubuntu.rst +++ b/user-guide/source/getting-started/ubuntu.rst @@ -46,7 +46,10 @@ 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 + 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 Reference Manual. +Ubuntu derivatives like Kubuntu and Xubuntu, please see the relevaant section +in the `Reference Manual `_. 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/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