openlp-core team mailing list archive
-
openlp-core team
-
Mailing list archive
-
Message #06134
[Merge] lp:~raoul-snyman/openlp/manual-documentation into lp:openlp
Raoul Snyman has proposed merging lp:~raoul-snyman/openlp/manual-documentation into lp:openlp.
Requested reviews:
OpenLP Core (openlp-core)
For more details, see:
https://code.launchpad.net/~raoul-snyman/openlp/manual-documentation/+merge/49188
Created a new theme for Qt Help.
Added a condition in the configuration depending on the theme.
Note: to get Qt Help, change the theme to "openlp_qthelp" and then build with "make qthelp".
--
https://code.launchpad.net/~raoul-snyman/openlp/manual-documentation/+merge/49188
Your team OpenLP Core is requested to review the proposed merge of lp:~raoul-snyman/openlp/manual-documentation into lp:openlp.
=== modified file 'documentation/api/source/core/theme.rst'
--- documentation/api/source/core/theme.rst 2010-09-14 18:18:47 +0000
+++ documentation/api/source/core/theme.rst 2011-02-10 06:51:14 +0000
@@ -1,8 +1,10 @@
.. _core-theme:
-:mod:`theme` Module
-===================
+Theme Function Library
+======================
.. automodule:: openlp.core.theme
:members:
+.. autoclass:: openlp.core.theme.theme.Theme
+ :members:
=== modified file 'documentation/api/source/plugins/bibles.rst'
--- documentation/api/source/plugins/bibles.rst 2010-10-16 19:38:23 +0000
+++ documentation/api/source/plugins/bibles.rst 2011-02-10 06:51:14 +0000
@@ -18,7 +18,7 @@
.. automodule:: openlp.plugins.bibles.forms
:members:
-.. autoclass:: openlp.plugins.bibles.forms.importwizardform.ImportWizardForm
+.. autoclass:: openlp.plugins.bibles.forms.bibleimportform.BibleImportForm
:members:
Helper Classes & Functions
=== modified file 'documentation/manual/source/conf.py'
--- documentation/manual/source/conf.py 2010-10-16 19:38:23 +0000
+++ documentation/manual/source/conf.py 2011-02-10 06:51:14 +0000
@@ -48,7 +48,7 @@
# The short X.Y version.
version = '2.0'
# The full version, including alpha/beta/rc tags.
-release = '1.9.3'
+release = '1.9.5'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@@ -92,22 +92,24 @@
# The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'.
+#html_theme = 'openlp_qthelp'
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'
-}
+if html_theme == 'default':
+ html_theme_options = {
+ 'sidebarbgcolor': '#3a60a9',
+ 'relbarbgcolor': '#203b6f',
+ 'footerbgcolor': '#26437c',
+ 'headtextcolor': '#203b6f',
+ 'linkcolor': '#26437c',
+ 'sidebarlinkcolor': '#ceceff'
+ }
# Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
+html_theme_path = [u'../themes']
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
=== modified file 'documentation/manual/source/dualmonitors.rst'
--- documentation/manual/source/dualmonitors.rst 2010-10-19 18:54:43 +0000
+++ documentation/manual/source/dualmonitors.rst 2011-02-10 06:51:14 +0000
@@ -149,15 +149,15 @@
root@linux: # nividia-settings
If you do not want to write the changes to your ``xorg.conf`` file simply run
-the nVidia Settings program (``nvidia-settings``) from your desktop's menu,
-usually in an administration or system menu, or from the terminal as a normal
-user run::
+the nVidia Settings program (:command:`nvidia-settings`) from your desktop's
+menu, usually in an administration or system menu, or from the terminal as a
+normal user run::
user@linux:~ $ nvidia-settings
-Once you have opened nVidia Settings, click on
-:guilabel:`X Server Display Configuration`. Then select the monitor you are
-wanting to use as your second monitor and click :guilabel:`Configure`.
+Once you have opened nVidia Settings, click on :guilabel:`X Server Display
+Configuration`. Then select the monitor you are wanting to use as your second
+monitor and click :guilabel:`Configure`.
.. image:: pics/nvlinux1.png
=== modified file 'documentation/manual/source/index.rst'
--- documentation/manual/source/index.rst 2010-12-01 19:55:05 +0000
+++ documentation/manual/source/index.rst 2011-02-10 06:51:14 +0000
@@ -17,10 +17,3 @@
mediamanager
songs
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
-
=== added directory 'documentation/manual/themes'
=== added directory 'documentation/manual/themes/openlp_qthelp'
=== added file 'documentation/manual/themes/openlp_qthelp/layout.html'
--- documentation/manual/themes/openlp_qthelp/layout.html 1970-01-01 00:00:00 +0000
+++ documentation/manual/themes/openlp_qthelp/layout.html 2011-02-10 06:51:14 +0000
@@ -0,0 +1,68 @@
+{#
+ openlp_qthelp/layout.html
+ ~~~~~~~~~~~~~~~~~
+
+ Sphinx layout template for the openlp_qthelp theme.
+
+ :copyright: Copyright 2004-2010 Raoul Snyman.
+ :license: GPL
+#}
+{% extends "basic/layout.html" %}
+{% set script_files = script_files + ['_static/theme_extras.js'] %}
+{% set css_files = css_files + ['_static/print.css'] %}
+
+{# do not display relbars #}
+{% block relbar1 %}{% endblock %}
+{% block relbar2 %}{% endblock %}
+
+{% macro nav() %}
+ <p>
+ {%- block openlp_qthelprel1 %}
+ {%- endblock %}
+ {%- if prev %}
+ «  <a href="{{ prev.link|e }}">{{ prev.title }}</a>
+   ::  
+ {%- endif %}
+ <a class="uplink" href="{{ pathto(master_doc) }}">{{ _('Contents') }}</a>
+ {%- if next %}
+   ::  
+ <a href="{{ next.link|e }}">{{ next.title }}</a>  Â»
+ {%- endif %}
+ {%- block openlp_qthelprel2 %}
+ {%- endblock %}
+ </p>
+{% endmacro %}
+
+{% block content %}
+ <!-- div class="header">
+ {%- block openlp_qthelpheader %}
+ {%- if theme_full_logo != "false" %}
+ <a href="{{ pathto('index') }}">
+ <img class="logo" src="{{ pathto('_static/' + logo, 1) }}" alt="Logo"/>
+ </a>
+ {%- else %}
+ {%- if logo -%}
+ <img class="rightlogo" src="{{ pathto('_static/' + logo, 1) }}" alt="Logo"/>
+ {%- endif -%}
+ <h1 class="heading"><a href="{{ pathto('index') }}">
+ <span>{{ shorttitle|e }}</span></a></h1>
+ <h2 class="heading"><span>{{ title|striptags|e }}</span></h2>
+ {%- endif %}
+ {%- endblock %}
+ </div -->
+ <div class="topnav">
+ {{ nav() }}
+ </div>
+ <div class="content">
+ {#{%- if display_toc %}
+ <div id="toc">
+ <h3>Table Of Contents</h3>
+ {{ toc }}
+ </div>
+ {%- endif %}#}
+ {% block body %}{% endblock %}
+ </div>
+ <div class="bottomnav">
+ {{ nav() }}
+ </div>
+{% endblock %}
=== added directory 'documentation/manual/themes/openlp_qthelp/static'
=== added file 'documentation/manual/themes/openlp_qthelp/static/alert_info_32.png'
Binary files documentation/manual/themes/openlp_qthelp/static/alert_info_32.png 1970-01-01 00:00:00 +0000 and documentation/manual/themes/openlp_qthelp/static/alert_info_32.png 2011-02-10 06:51:14 +0000 differ
=== added file 'documentation/manual/themes/openlp_qthelp/static/alert_warning_32.png'
Binary files documentation/manual/themes/openlp_qthelp/static/alert_warning_32.png 1970-01-01 00:00:00 +0000 and documentation/manual/themes/openlp_qthelp/static/alert_warning_32.png 2011-02-10 06:51:14 +0000 differ
=== added file 'documentation/manual/themes/openlp_qthelp/static/bg-page.png'
Binary files documentation/manual/themes/openlp_qthelp/static/bg-page.png 1970-01-01 00:00:00 +0000 and documentation/manual/themes/openlp_qthelp/static/bg-page.png 2011-02-10 06:51:14 +0000 differ
=== added file 'documentation/manual/themes/openlp_qthelp/static/bullet_orange.png'
Binary files documentation/manual/themes/openlp_qthelp/static/bullet_orange.png 1970-01-01 00:00:00 +0000 and documentation/manual/themes/openlp_qthelp/static/bullet_orange.png 2011-02-10 06:51:14 +0000 differ
=== added file 'documentation/manual/themes/openlp_qthelp/static/openlp_qthelp.css_t'
--- documentation/manual/themes/openlp_qthelp/static/openlp_qthelp.css_t 1970-01-01 00:00:00 +0000
+++ documentation/manual/themes/openlp_qthelp/static/openlp_qthelp.css_t 2011-02-10 06:51:14 +0000
@@ -0,0 +1,372 @@
+/*
+ * openlp_qthelp.css_t
+ * ~~~~~~~~~~~
+ *
+ * Sphinx stylesheet -- openlp_qthelp theme.
+ *
+ * Adapted from http://openlp_qthelp-os.org/docs/Haiku-doc.css.
+ * Original copyright message:
+ *
+ * Copyright 2008-2009, Haiku. All rights reserved.
+ * Distributed under the terms of the MIT License.
+ *
+ * Authors:
+ * Francois Revol <revol@xxxxxxx>
+ * Stephan Assmus <superstippi@xxxxxx>
+ * Braden Ewing <brewin@xxxxxxxxx>
+ * Humdinger <humdingerb@xxxxxxxxx>
+ *
+ * :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+
+@import url("basic.css");
+
+html {
+ margin: 0px;
+ padding: 0px;
+ background-color: #fff;
+ background-image: none;
+}
+
+body {
+ line-height: 1.5;
+ margin: auto;
+ padding: 0px;
+ font-family: "DejaVu Sans", Arial, Helvetica, sans-serif;
+ min-width: 59em;
+ max-width: 70em;
+ color: {{ theme_textcolor }};
+}
+
+div.footer {
+ padding: 8px;
+ font-size: 11px;
+ text-align: center;
+ letter-spacing: 0.5px;
+}
+
+/* link colors and text decoration */
+
+a:link {
+ font-weight: bold;
+ text-decoration: none;
+ color: {{ theme_linkcolor }};
+}
+
+a:visited {
+ font-weight: bold;
+ text-decoration: none;
+ color: {{ theme_visitedlinkcolor }};
+}
+
+a:hover, a:active {
+ text-decoration: underline;
+ color: {{ theme_hoverlinkcolor }};
+}
+
+/* Some headers act as anchors, don't give them a hover effect */
+
+h1 a:hover, a:active {
+ text-decoration: none;
+ color: {{ theme_headingcolor }};
+}
+
+h2 a:hover, a:active {
+ text-decoration: none;
+ color: {{ theme_headingcolor }};
+}
+
+h3 a:hover, a:active {
+ text-decoration: none;
+ color: {{ theme_headingcolor }};
+}
+
+h4 a:hover, a:active {
+ text-decoration: none;
+ color: {{ theme_headingcolor }};
+}
+
+a.headerlink {
+ color: #a7ce38;
+ padding-left: 5px;
+}
+
+a.headerlink:hover {
+ color: #a7ce38;
+}
+
+/* basic text elements */
+
+div.content {
+ margin-top: 20px;
+ margin-left: 40px;
+ margin-right: 40px;
+ margin-bottom: 50px;
+ font-size: 0.9em;
+}
+
+/* heading and navigation */
+
+div.header {
+ position: relative;
+ left: 0px;
+ top: 0px;
+ height: 85px;
+ /* background: #eeeeee; */
+ padding: 0 40px;
+}
+div.header h1 {
+ font-size: 1.6em;
+ font-weight: normal;
+ letter-spacing: 1px;
+ color: {{ theme_headingcolor }};
+ border: 0;
+ margin: 0;
+ padding-top: 15px;
+}
+div.header h1 a {
+ font-weight: normal;
+ color: {{ theme_headingcolor }};
+}
+div.header h2 {
+ font-size: 1.3em;
+ font-weight: normal;
+ letter-spacing: 1px;
+ text-transform: uppercase;
+ color: #aaa;
+ border: 0;
+ margin-top: -3px;
+ padding: 0;
+}
+
+div.header img.rightlogo {
+ float: right;
+}
+
+
+div.title {
+ font-size: 1.3em;
+ font-weight: bold;
+ color: {{ theme_headingcolor }};
+ border-bottom: dotted thin #e0e0e0;
+ margin-bottom: 25px;
+}
+div.topnav {
+ /* background: #e0e0e0; */
+}
+div.topnav p {
+ margin-top: 0;
+ margin-left: 40px;
+ margin-right: 40px;
+ margin-bottom: 0px;
+ text-align: right;
+ font-size: 0.8em;
+}
+div.bottomnav {
+ background: #eeeeee;
+}
+div.bottomnav p {
+ margin-right: 40px;
+ text-align: right;
+ font-size: 0.8em;
+}
+
+a.uplink {
+ font-weight: normal;
+}
+
+
+/* contents box */
+
+table.index {
+ margin: 0px 0px 30px 30px;
+ padding: 1px;
+ border-width: 1px;
+ border-style: dotted;
+ border-color: #e0e0e0;
+}
+table.index tr.heading {
+ background-color: #e0e0e0;
+ text-align: center;
+ font-weight: bold;
+ font-size: 1.1em;
+}
+table.index tr.index {
+ background-color: #eeeeee;
+}
+table.index td {
+ padding: 5px 20px;
+}
+
+table.index a:link, table.index a:visited {
+ font-weight: normal;
+ text-decoration: none;
+ color: {{ theme_linkcolor }};
+}
+table.index a:hover, table.index a:active {
+ text-decoration: underline;
+ color: {{ theme_hoverlinkcolor }};
+}
+
+
+/* Haiku User Guide styles and layout */
+
+/* Rounded corner boxes */
+/* Common declarations */
+div.admonition {
+ -webkit-border-radius: 10px;
+ -khtml-border-radius: 10px;
+ -moz-border-radius: 10px;
+ border-radius: 10px;
+ border-style: dotted;
+ border-width: thin;
+ border-color: #dcdcdc;
+ padding: 10px 15px 10px 15px;
+ margin-bottom: 15px;
+ margin-top: 15px;
+}
+div.note {
+ padding: 10px 15px 10px 80px;
+ background: #e4ffde url(alert_info_32.png) 15px 15px no-repeat;
+ min-height: 42px;
+}
+div.warning {
+ padding: 10px 15px 10px 80px;
+ background: #fffbc6 url(alert_warning_32.png) 15px 15px no-repeat;
+ min-height: 42px;
+}
+div.seealso {
+ background: #e4ffde;
+}
+
+/* More layout and styles */
+h1 {
+ font-size: 1.3em;
+ font-weight: bold;
+ color: {{ theme_headingcolor }};
+ border-bottom: dotted thin #e0e0e0;
+ margin-top: 30px;
+}
+
+h2 {
+ font-size: 1.2em;
+ font-weight: normal;
+ color: {{ theme_headingcolor }};
+ border-bottom: dotted thin #e0e0e0;
+ margin-top: 30px;
+}
+
+h3 {
+ font-size: 1.1em;
+ font-weight: normal;
+ color: {{ theme_headingcolor }};
+ margin-top: 30px;
+}
+
+h4 {
+ font-size: 1.0em;
+ font-weight: normal;
+ color: {{ theme_headingcolor }};
+ margin-top: 30px;
+}
+
+p {
+ text-align: justify;
+}
+
+p.last {
+ margin-bottom: 0;
+}
+
+ol {
+ padding-left: 20px;
+}
+
+ul {
+ padding-left: 5px;
+ margin-top: 3px;
+}
+
+li {
+ line-height: 1.3;
+}
+
+div.content ul > li {
+ -moz-background-clip:border;
+ -moz-background-inline-policy:continuous;
+ -moz-background-origin:padding;
+ background: transparent url(bullet_orange.png) no-repeat scroll left 0.45em;
+ list-style-image: none;
+ list-style-type: none;
+ padding: 0 0 0 1.666em;
+ margin-bottom: 3px;
+}
+
+td {
+ vertical-align: top;
+}
+
+tt {
+ background-color: #e2e2e2;
+ font-size: 1.0em;
+ font-family: monospace;
+}
+
+pre {
+ border-color: #0c3762;
+ border-style: dotted;
+ border-width: thin;
+ margin: 0 0 12px 0;
+ padding: 0.8em;
+ background-color: #f0f0f0;
+}
+
+hr {
+ border-top: 1px solid #ccc;
+ border-bottom: 0;
+ border-right: 0;
+ border-left: 0;
+ margin-bottom: 10px;
+ margin-top: 20px;
+}
+
+/* printer only pretty stuff */
+@media print {
+ .noprint {
+ display: none;
+ }
+ /* for acronyms we want their definitions inlined at print time */
+ acronym[title]:after {
+ font-size: small;
+ content: " (" attr(title) ")";
+ font-style: italic;
+ }
+ /* and not have mozilla dotted underline */
+ acronym {
+ border: none;
+ }
+ div.topnav, div.bottomnav, div.header, table.index {
+ display: none;
+ }
+ div.content {
+ margin: 0px;
+ padding: 0px;
+ }
+ html {
+ background: #FFF;
+ }
+}
+
+.viewcode-back {
+ font-family: "DejaVu Sans", Arial, Helvetica, sans-serif;
+}
+
+div.viewcode-block:target {
+ background-color: #f4debf;
+ border-top: 1px solid #ac9;
+ border-bottom: 1px solid #ac9;
+ margin: -1px -12px;
+ padding: 0 12px;
+}
=== added file 'documentation/manual/themes/openlp_qthelp/theme.conf'
--- documentation/manual/themes/openlp_qthelp/theme.conf 1970-01-01 00:00:00 +0000
+++ documentation/manual/themes/openlp_qthelp/theme.conf 2011-02-10 06:51:14 +0000
@@ -0,0 +1,12 @@
+[theme]
+inherit = basic
+stylesheet = openlp_qthelp.css
+pygments_style = autumn
+
+[options]
+full_logo = false
+textcolor = #333333
+headingcolor = #203b6f
+linkcolor = #26437c
+visitedlinkcolor = #26437c
+hoverlinkcolor = #26437c
=== modified file 'openlp/core/theme/theme.py'
--- openlp/core/theme/theme.py 2011-02-08 03:25:50 +0000
+++ openlp/core/theme/theme.py 2011-02-10 06:51:14 +0000
@@ -71,38 +71,45 @@
Theme name
``BackgroundMode``
- The behaviour of the background. Valid modes are:
- - 0 - Transparent
- - 1 - Opaque
+ The behaviour of the background. Valid modes are:
+
+ * ``0`` - Transparent
+ * ``1`` - Opaque
``BackgroundType``
- The content of the background. Valid types are:
- - 0 - solid color
- - 1 - gradient color
- - 2 - image
+ The content of the background. Valid types are:
+
+ * ``0`` - solid color
+ * ``1`` - gradient color
+ * ``2`` - image
``BackgroundParameter1``
- Extra information about the background. The contents of this attribute
+ Extra information about the background. The contents of this attribute
depend on the BackgroundType:
- - image: image filename
- - gradient: start color
- - solid: color
+
+ * ``image`` - image filename
+ * ``gradient`` - start color
+ * ``solid`` - color
``BackgroundParameter2``
Extra information about the background. The contents of this attribute
depend on the BackgroundType:
- - image: border color
- - gradient: end color
- - solid: N/A
+
+ * ``image`` - border color
+ * ``gradient`` - end color
+ * ``solid`` - N/A
``BackgroundParameter3``
Extra information about the background. The contents of this attribute
depend on the BackgroundType:
- - image: N/A
- - gradient: The direction of the gradient. Valid entries are:
- - 0 -> vertical
- - 1 -> horizontal
- - solid: N/A
+
+ * ``image`` - N/A
+ * ``gradient`` - The direction of the gradient. Valid entries are:
+
+ * ``0`` - vertical
+ * ``1`` - horizontal
+
+ * ``solid`` - N/A
``FontName``
Name of the font to use for the main font.
@@ -118,36 +125,41 @@
``Shadow``
The shadow type to apply to the main font.
- - 0 - no shadow
- - non-zero - use shadow
+
+ * ``0`` - no shadow
+ * non-zero - use shadow
``ShadowColor``
Color for the shadow
``Outline``
The outline to apply to the main font
- - 0 - no outline
- - non-zero - use outline
+
+ * ``0`` - no outline
+ * non-zero - use outline
``OutlineColor``
Color for the outline (or None if Outline is 0)
``HorizontalAlign``
The horizontal alignment to apply to text. Valid alignments are:
- - 0 - left align
- - 1 - right align
- - 2 - centre align
+
+ * ``0`` - left align
+ * ``1`` - right align
+ * ``2`` - centre align
``VerticalAlign``
The vertical alignment to apply to the text. Valid alignments are:
- - 0 - top align
- - 1 - bottom align
- - 2 - centre align
+
+ * ``0`` - top align
+ * ``1`` - bottom align
+ * ``2`` - centre align
``WrapStyle``
The wrap style to apply to the text. Valid styles are:
- - 0 - normal
- - 1 - lyrics
+
+ * ``0`` - normal
+ * ``1`` - lyrics
"""
def __init__(self, xml):
"""
=== modified file 'openlp/core/utils/__init__.py'
--- openlp/core/utils/__init__.py 2011-01-23 00:46:51 +0000
+++ openlp/core/utils/__init__.py 2011-02-10 06:51:14 +0000
@@ -24,7 +24,7 @@
# Temple Place, Suite 330, Boston, MA 02111-1307 USA #
###############################################################################
"""
-The :mod:`utils` module provides the utility libraries for OpenLP
+The :mod:`openlp.core.utils` module provides the utility libraries for OpenLP.
"""
import logging
import os
Follow ups
