Fixed typos. Changed doc style of html and latex output.

- HTML: Changed to twittter bootstrap theme.
- PDF: Improved latex pdf.
- Added doc authors to Impressum section.
- Added required sphinx packages to requirements.txt
This commit is contained in:
Emanuel Schuetze 2013-06-03 13:05:23 +02:00 committed by Norman Jäckel
parent 2928995dd8
commit 34bca4b695
19 changed files with 64 additions and 72 deletions

8
THANKS
View File

@ -28,3 +28,11 @@ OpenSlides uses parts of the following projects:
* Ubuntu TrueType Font * Ubuntu TrueType Font
<http://font.ubuntu.com/> <http://font.ubuntu.com/>
* Sphinx
<http://sphinx-doc.org/>
License: BSD
* Sphinx Bootstrap Theme
<http://ryan-roemer.github.io/sphinx-bootstrap-theme/>
License: MIT

BIN
docs/_static/logo.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.4 KiB

BIN
docs/_static/openslides-logo_wide.pdf vendored Normal file

Binary file not shown.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.3 KiB

View File

@ -1,6 +0,0 @@
@import url('sphinxdoc.css');
/* Specific stylesheet for OpenSlides Documentation */
.screenshot {
width:50%;}

View File

@ -1,24 +0,0 @@
{% extends "!layout.html" %}
{% block extrahead %}
{{ super() }}
{%- if not embedded %}
<style type="text/css">
table.right { float: right; margin-left: 20px; }
table.right td { border: 1px solid #ccc; }
</style>
{%- endif %}
{% endblock %}
{% block header %}
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
<a href="{{ pathto('index') }}">
<img src="{{ pathto("_static/openslides-logo_wide75.png", 1) }}" alt="OpenSlides logo" />
</a>
</div>
{% endblock %}
{% block rootrellink %}
<li><a href="http://www.openslides.org">OpenSlides Website</a>&nbsp;|&nbsp;</li>
<li><a href="{{ pathto('index') }}">Inhaltsverzeichnis</a></li>
{% endblock %}

View File

@ -12,7 +12,7 @@
# serve to show the default. # serve to show the default.
import sys, os import sys, os
import sphinx_bootstrap_theme
# If extensions (or modules to document with autodoc) are in another directory, # 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 # 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. # documentation root, use os.path.abspath to make it absolute, like shown here.
@ -28,7 +28,7 @@ import sys, os
extensions = [] extensions = []
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] # templates_path = ['_templates']
# The suffix of source filenames. # The suffix of source filenames.
source_suffix = '.rst' source_suffix = '.rst'
@ -40,7 +40,7 @@ source_suffix = '.rst'
master_doc = 'index' master_doc = 'index'
# General information about the project. # General information about the project.
project = u'OpenSlides' project = u'OpenSlides Handbuch'
copyright = u'20122013, OpenSlides Team' copyright = u'20122013, OpenSlides Team'
# The version info for the project you're documenting, acts as replacement for # The version info for the project you're documenting, acts as replacement for
@ -48,9 +48,9 @@ copyright = u'20122013, OpenSlides Team'
# built documents. # built documents.
# #
# The short X.Y version. # The short X.Y version.
version = '1.4' version = 'v1.4'
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.
release = '1.4' release = 'v1.4'
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.
@ -91,14 +91,19 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # a list of builtin themes.
html_theme = 'sphinxdoc' html_theme = 'bootstrap'
# Adeption for OpenSlides # html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
html_style = 'openslidesdoc.css' # html_style = 'style.css'
# Theme options are theme-specific and customize the look and feel of a theme # 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 # further. For a list of options available for each theme, see the
# documentation. # documentation.
#html_theme_options = {} html_theme_options = {
'navbar_site_name': "Inhalt",
'globaltoc_depth': 2,
'navbar_class': "navbar navbar-inverse",
'source_link_position': "",
}
# Add any paths that contain custom themes here, relative to this directory. # Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = [] #html_theme_path = []
@ -112,7 +117,7 @@ html_title = "OpenSlides Handbuch"
# The name of an image file (relative to this directory) to place at the top # The name of an image file (relative to this directory) to place at the top
# of the sidebar. # of the sidebar.
#html_logo = None html_logo = '_static/logo.png'
# The name of an image file (within the static path) to use as favicon of the # 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 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
@ -172,12 +177,11 @@ htmlhelp_basename = 'OpenSlidesdoc'
# -- Options for LaTeX output -------------------------------------------------- # -- Options for LaTeX output --------------------------------------------------
latex_elements = { latex_elements = {
# The paper size ('letterpaper' or 'a4paper'). 'papersize': 'a4paper,oneside',
#'papersize': 'a4', 'pointsize': '12pt',
'babel': '\\usepackage[ngerman]{babel}',
# The font size ('10pt', '11pt' or '12pt'). 'fontpkg': '\\usepackage{lmodern}',
#'pointsize': '10pt', 'fncychap' : '\\usepackage[Sonny]{fncychap}',
# Additional stuff for the LaTeX preamble. # Additional stuff for the LaTeX preamble.
#'preamble': '', #'preamble': '',
} }
@ -185,13 +189,13 @@ latex_elements = {
# Grouping the document tree into LaTeX files. List of tuples # Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]). # (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [ latex_documents = [
('index', 'OpenSlides.tex', u'OpenSlides Handbuch', ('index', 'OpenSlides-Handbuch.tex', u'OpenSlides Handbuch',
u'OpenSlides Team', 'manual'), u'OpenSlides Team', 'manual'),
] ]
# The name of an image file (relative to this directory) to place at the top of # The name of an image file (relative to this directory) to place at the top of
# the title page. # the title page.
#latex_logo = None latex_logo = '_static/openslides-logo_wide.pdf'
# For "manual" documents, if this is true, then toplevel headings are parts, # For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters. # not chapters.

View File

@ -1,6 +1,12 @@
Impressum Impressum
========= =========
Copyright 20122013, OpenSlides Team Copyright 20122013
OpenSlides-Autorenteam:
- Norman Jäckel
- Anja Hitziger
- Emanuel Schütze
Das OpenSlides-Handbuch ist unter der `Creative Commons CC BY-SA 3.0 <http://creativecommons.org/licenses/by-sa/3.0/>`_ lizensiert. Das OpenSlides-Handbuch ist unter der `Creative Commons CC BY-SA 3.0 <http://creativecommons.org/licenses/by-sa/3.0/>`_ lizensiert.

View File

@ -26,7 +26,7 @@ einberechnet, ist für die Benutzer auf der Tagesordnung aber nicht sichtbar.
Bei der Projektion der gesamten Tagesordnung oder einzelner Unterpunkte Bei der Projektion der gesamten Tagesordnung oder einzelner Unterpunkte
erscheint ein organisatorischer Eintrag ebenfalls nicht. erscheint ein organisatorischer Eintrag ebenfalls nicht.
Zusätzlich haben Sie die Möglichkeit unter dem „Titel“ einen „Text“ Zusätzlich haben Sie die Möglichkeit, unter dem „Titel“ einen „Text“
einzufügen, der auf dem Projektor erscheinen soll. Einträge im Feld einzufügen, der auf dem Projektor erscheinen soll. Einträge im Feld
„Kommentar“ sind nur für die Versammlungsleitung sichtbar. „Kommentar“ sind nur für die Versammlungsleitung sichtbar.
@ -117,11 +117,11 @@ Folie dargestellt.
.. |bell| image:: ../_images/bell.png .. |bell| image:: ../_images/bell.png
Zusätzlich zu allen bereits genannten Anzeigemöglichkeiten, kann auf dem Zusätzlich zu allen bereits genannten Anzeigemöglichkeiten kann auf dem
Dashboard eine Einblendung der Rednerliste eingestellt werden. Aktivieren Dashboard eine Einblendung der Rednerliste eingestellt werden. Aktivieren
Sie diese, wenn Sie auf den Kästchen-Button |checkbox| klicken. Die in einem Sie diese, wenn Sie auf den Kästchen-Button |checkbox| klicken. Die in einem
grauen Rahmen, rechts unten auf der Folie, angezeigte Rednerliste grauen Rahmen, rechts unten auf der Folie angezeigte Rednerliste,
visualisiert die letzten, hervorgehoben den aktuellen und die nächsten fünf visualisiert die letzten, den aktuellen (hervorgehoben) und die nächsten (fünf)
Redner. Die Einblendung erscheint nur auf Folien von Tagesordnungspunkten. Redner. Die Einblendung erscheint nur auf Folien von Tagesordnungspunkten.
.. |checkbox| image:: ../_images/checkbox.png .. |checkbox| image:: ../_images/checkbox.png

View File

@ -40,7 +40,10 @@ Start des Servers und Öffnen des Browsers
Verwendung der Windows-Version (Portable Version mit openslides.exe) Verwendung der Windows-Version (Portable Version mit openslides.exe)
-------------------------------------------------------------------- --------------------------------------------------------------------
Wenn Sie die Windows-Version (Portable Version mit openslides.exe) verwenden, brauchen Sie nur die Datei ``openslides.exe`` ausführen. Mit dieser wird der Server gestartet und ihr Browser mit der richtigen URL geöffnet. Wenn Sie die Windows-Version (Portable Version mit openslides.exe)
verwenden, brauchen Sie nur die Datei ``openslides.exe`` auszuführen.
Mit dieser wird der Server gestartet und ihr Browser mit der richtigen
URL geöffnet.
OpenSlides kann jederzeit im schwarzen Fenster der Kommandozeile mit der Tastenkombination ``Strg`` + ``Pause`` beendet werden. Alle eingegebenen Daten bleiben in der Datenbank gespeichert. OpenSlides kann jederzeit im schwarzen Fenster der Kommandozeile mit der Tastenkombination ``Strg`` + ``Pause`` beendet werden. Alle eingegebenen Daten bleiben in der Datenbank gespeichert.
@ -52,7 +55,7 @@ Starten Sie den Server, indem Sie in der Kommandozeile eingeben::
$ openslides $ openslides
Wenn Sie eine virtuellen Arbeitsumgebung (virtualenv) verwenden, müssen Sie diese zuvor aktivieren:: Wenn Sie eine virtuelle Arbeitsumgebung (virtualenv) verwenden, müssen Sie diese zuvor aktivieren::
$ source .venv/bin/activate $ source .venv/bin/activate
@ -88,7 +91,7 @@ Im Webinterface von OpenSlides können Sie über die verschiedenen Menüpunkte a
.. image:: ../_images/Platzhalter.png .. image:: ../_images/Platzhalter.png
:class: screenshot :class: screenshot
Im Menüunkt „Dashboard“ steuern Sie, welche Folien auf dem Beamer angezeigt werden. Dazu klicken Sie einfach auf das jeweilige Projektorsymbol. Im Menüpunkt „Tagesordnung“ können Sie die Tagesordnung der Veranstaltung im Vorfeld anlegen, entsprechende Folien vorbereiten und die Rednerliste verwalten. In den Menüpunkten „Anträge“ und „Wahlen“ verwalten Sie die gestellten Anträge und die Wahlämter mit den Kandidaten sowie die dazugehörigen Abstimmungen und Wahlen. Der Menüpunkt „Teilnehmer/innen“ ermöglicht einen Zugriff auf die Personenprofile. Unter dem Punkt „Medien“ können Sie eigene Dateien auf den Server laden und zum Download anbieten. Im Menüpunkt „Konfiguration“ können einige Einstellungen vorgenommen werden. Im Menüpunkt „Dashboard“ steuern Sie, welche Folien auf dem Beamer angezeigt werden. Dazu klicken Sie einfach auf das jeweilige Projektorsymbol. Im Menüpunkt „Tagesordnung“ können Sie die Tagesordnung der Veranstaltung im Vorfeld anlegen, entsprechende Folien vorbereiten und die Rednerliste verwalten. In den Menüpunkten „Anträge“ und „Wahlen“ verwalten Sie die gestellten Anträge und die Wahlämter mit den Kandidaten sowie die dazugehörigen Abstimmungen und Wahlen. Der Menüpunkt „Teilnehmer/innen“ ermöglicht einen Zugriff auf die Personenprofile. Unter dem Punkt „Medien“ können Sie eigene Dateien auf den Server laden und zum Download anbieten. Im Menüpunkt „Konfiguration“ können einige Einstellungen vorgenommen werden.
Das Beamerbild ist unter der URL ``/projector/`` zu finden. Sie können auch auf dem Dashboard auf die Projektor-Live-Ansicht klicken. Loggen Sie sich an dem Computer, an dem der Beamer angeschlossen ist, in OpenSlides ein und rufen Sie den Link oder die URL auf. Legen Sie die Anzeige in einem eigenen Browserfenster auf den Beamer und projizieren Sie sie so auf die Leinwand. In vielen Browsern kann mit der Taste ``F11`` in den Vollbildmodus gewechselt werden. Im *Präsentationsmodus Single* müssen Sie die Bildschirmanzeige auf Erweiterung/erweiterter Desktop stellen und das Browserfenster mit dem Beamerbild auf den Beamer schieben. Das Beamerbild ist unter der URL ``/projector/`` zu finden. Sie können auch auf dem Dashboard auf die Projektor-Live-Ansicht klicken. Loggen Sie sich an dem Computer, an dem der Beamer angeschlossen ist, in OpenSlides ein und rufen Sie den Link oder die URL auf. Legen Sie die Anzeige in einem eigenen Browserfenster auf den Beamer und projizieren Sie sie so auf die Leinwand. In vielen Browsern kann mit der Taste ``F11`` in den Vollbildmodus gewechselt werden. Im *Präsentationsmodus Single* müssen Sie die Bildschirmanzeige auf Erweiterung/erweiterter Desktop stellen und das Browserfenster mit dem Beamerbild auf den Beamer schieben.

View File

@ -10,7 +10,7 @@ Beim ersten Aufruf von OpenSlides erscheint die Login-Seite. Der erste Benutzern
Eigene Benutzereinstellungen (insbesondere Benutzername oder Passwort) ändern Eigene Benutzereinstellungen (insbesondere Benutzername oder Passwort) ändern
----------------------------------------------------------------------------- -----------------------------------------------------------------------------
Die eigenen Benutzereinstellungen wie Benutzername und Passwort können und über den Link ``Benutzereinstellungen`` oben rechts geändert werden. Klicken Sie auf den Link, wählen Sie im oberen rechten Menü aus, ob Sie Ihre persönlichen Einstellungen oder Ihr Passwort ändern möchten, und ändern Sie die jeweiligen Einstellungen. Klicken Sie abschließend auf ``Speichern``. Die eigenen Benutzereinstellungen wie Benutzername und Passwort können über den Link ``Benutzereinstellungen`` oben rechts geändert werden. Klicken Sie auf den Link, wählen Sie im oberen rechten Menü aus, ob Sie Ihre persönlichen Einstellungen oder Ihr Passwort ändern möchten, und ändern Sie die jeweiligen Einstellungen. Klicken Sie abschließend auf ``Speichern``.
Fremde Benutzereinstellungen (insbesondere Benutzername oder Passwort) ändern Fremde Benutzereinstellungen (insbesondere Benutzername oder Passwort) ändern

View File

@ -48,7 +48,7 @@ werden:
zur Verfügung, bei denen zum Teil die `automatische Versionierung`__ zur Verfügung, bei denen zum Teil die `automatische Versionierung`__
aktiviert ist. aktiviert ist.
* Um die Anträge im Vorfeld zu strukturieren besteht die Möglichkeit, sie * Um die Anträge im Vorfeld zu strukturieren, besteht die Möglichkeit, sie
pro Sachgebiet zu nummerieren, sie fortlaufend, das heißt über die pro Sachgebiet zu nummerieren, sie fortlaufend, das heißt über die
Sachgebiete hinweg, zu nummerieren oder manuell die Nummerierung für den Sachgebiete hinweg, zu nummerieren oder manuell die Nummerierung für den
Bezeichner zu setzen. Bezeichner zu setzen.
@ -184,7 +184,7 @@ Dialog mit „Ja“ bestätigen.
Wenn Sie (bei entsprechender Voreinstellung__) einen Antrag Wenn Sie (bei entsprechender Voreinstellung__) einen Antrag
bearbeiten, haben Sie mit dem Haken „Keine neue Version erzeugen“ die bearbeiten, haben Sie mit dem Haken „Keine neue Version erzeugen“ die
Möglichkeit die ansonsten erfolgende Versionierung im Einzelfall Möglichkeit, die ansonsten erfolgende Versionierung im Einzelfall
ausnahmsweise zu umgehen. Dies kann sinnvoll sein, wenn Sie einen Antrag ausnahmsweise zu umgehen. Dies kann sinnvoll sein, wenn Sie einen Antrag
nur redaktionell (trivial) ändern wollen. nur redaktionell (trivial) ändern wollen.
@ -222,7 +222,7 @@ Sie diese mit dem Button „Neue Abstimmung“ auf der betreffenden
Antragsseite (im Kasten rechts) in OpenSlides aufnehmen. Tragen Sie die Antragsseite (im Kasten rechts) in OpenSlides aufnehmen. Tragen Sie die
entsprechenden Abstimmungsergebnisse in die Tabelle ein. Wenn Sie ``-1`` entsprechenden Abstimmungsergebnisse in die Tabelle ein. Wenn Sie ``-1``
eintragen, wird das Wort „Mehrheit“ ausgegeben. ``-2`` steht für „Nicht eintragen, wird das Wort „Mehrheit“ ausgegeben. ``-2`` steht für „Nicht
erfasst“. Sollten Sie bei Abgegebene Stimmen einen Wert eintragen, erfasst“. Sollten Sie bei abgegebene Stimmen einen Wert eintragen,
berechnet OpenSlides automatisch die prozentualen Anteile der übrigen berechnet OpenSlides automatisch die prozentualen Anteile der übrigen
Stimmzahlen. Klicken Sie am Ende auf ``Speichern`` oder ``Übernehmen``. Stimmzahlen. Klicken Sie am Ende auf ``Speichern`` oder ``Übernehmen``.

View File

@ -121,7 +121,7 @@ Auswahl der Beamerfolien
Testen Sie, ob auf dem Beamer die gewünschten Folien zu sehen sind, wenn Testen Sie, ob auf dem Beamer die gewünschten Folien zu sehen sind, wenn
Sie bei OpenSlides im Menüpunkt „Dashboard“ verschiedene Folien auswählen. Sie bei OpenSlides im Menüpunkt „Dashboard“ verschiedene Folien auswählen.
Sie können eine bestimmte Folien anwählen, indem Sie auf das jeweilige Sie können eine bestimmte Folie anwählen, indem Sie auf das jeweilige
Projektorsymbol |projector| klicken. Die jeweils aktive Folie zeigt ein Projektorsymbol |projector| klicken. Die jeweils aktive Folie zeigt ein
blaues Projektorsymbol. blaues Projektorsymbol.

View File

@ -9,8 +9,7 @@ Konfiguration der Tagesordnung
------------------------------ ------------------------------
Gehen Sie zunächst im Menüpunkt „Konfiguration“ links oben zum Unterpunkt Gehen Sie zunächst im Menüpunkt „Konfiguration“ links oben zum Unterpunkt
„Tagesordnung“. Hier können stellen Sie als genauen Beginn der „Tagesordnung“. Hier können Sie den genauen Beginn der Veranstaltung einstellen:
Veranstaltung ein:
02.03.2013 10:00 02.03.2013 10:00
@ -104,7 +103,7 @@ Organisationseinträgen und den Rednerlisten finden Sie hier__.
Auswahl der Beamerfolien Auswahl der Beamerfolien
------------------------ ------------------------
Wenn Sie in den Menüpunkt „Dashboard“ wechseln Wenn Sie in den Menüpunkt „Dashboard“ wechseln,
.. image:: ../_images/Platzhalter.png .. image:: ../_images/Platzhalter.png
:class: screenshot :class: screenshot

View File

@ -29,7 +29,7 @@ Die übrigen Einstellungen können Sie erst einmal so belassen.
:class: screenshot :class: screenshot
*Bei Anträgen und Wahlen kann es unter Umständen vorkommen, dass *Bei Anträgen und Wahlen kann es unter Umständen vorkommen, dass
verschieden viele Stimmzettel benötigt werden, weshalb hierfür jeweils unterschiedlich viele Stimmzettel benötigt werden, weshalb hierfür jeweils
eigene Einstellungen vorzunehmen sind.* eigene Einstellungen vorzunehmen sind.*
@ -96,7 +96,7 @@ Die Antragsansicht sieht dann wie folgt aus:
.. image:: ../_images/Platzhalter.png .. image:: ../_images/Platzhalter.png
:class: screenshot :class: screenshot
Nach Abschluss der Diskussion ruft der Vorsitzende zur Abstimmung. Klicken Nach Abschluss der Diskussion ruft der Vorsitzende zur Abstimmung auf. Klicken
Sie rechts auf „Neue Abstimmung“ und tragen Sie das Abstimmungsergebnis wie Sie rechts auf „Neue Abstimmung“ und tragen Sie das Abstimmungsergebnis wie
folgt in das Formular ein: folgt in das Formular ein:

View File

@ -22,7 +22,7 @@ Benutzerdefinierte Anzahl von Stimmzetteln:
:class: screenshot :class: screenshot
*Bei Anträgen und Wahlen kann es unter Umständen vorkommen, dass *Bei Anträgen und Wahlen kann es unter Umständen vorkommen, dass
verschieden viele Stimmzettel benötigt werden, weshalb hierfür jeweils unterschiedlich viele Stimmzettel benötigt werden, weshalb hierfür jeweils
eigene Einstellungen vorzunehmen sind.* eigene Einstellungen vorzunehmen sind.*

View File

@ -36,10 +36,10 @@ benutzerdefinierten Folien auf dem Dashboard an. Wechseln Sie zum Menüpunkt
.. image:: ../_images/Platzhalter.png .. image:: ../_images/Platzhalter.png
:class: screenshot :class: screenshot
Gegen Sie Titel und Text wie folgt ein: Geben Sie Titel und Text wie folgt ein:
Titel: Titel:
Schönster Garten des Anlage Schönster Garten der Anlage
Text: Text:
<img src="/media/file/bild.jpg" /> <img src="/media/file/bild.jpg" />

View File

@ -3,11 +3,9 @@
You can adapt this file completely to your liking, but it should at least You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. contain the root `toctree` directive.
OpenSlides |version| Handbuch OpenSlides Handbuch |version|
============================= =============================
Inhalt:
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2

View File

@ -7,5 +7,9 @@ coverage==3.6
django-discover-runner==0.3 django-discover-runner==0.3
pep8==1.4.5 pep8==1.4.5
# Requirements for OpenSlides handbook/documentation
Sphinx==1.2b1
sphinx-bootstrap-theme==0.2.3
# For Python 2.6 support # For Python 2.6 support
argparse==1.2.1 argparse==1.2.1