Update documentation

This commit is contained in:
Norman Jäckel 2013-11-19 18:48:25 +01:00 committed by Emanuel Schuetze
parent 0e82ffc888
commit 096af30835
7 changed files with 106 additions and 41 deletions

View File

@ -28,10 +28,6 @@ Zusätzlich haben Sie die Möglichkeit, unter dem „Titel“ einen „Text“
einzufügen, der auf dem Projektor erscheinen soll. Einträge im Feld
„Kommentar“ sind nur für die Versammlungsleitung sichtbar.
*Sie können im Textfeld auch HTML-Elemente verwenden. Innerhalb solcher
sollten jedoch keine Zeilenumbrüche eingegeben werden, da letztere automatisch
in <br>-Elemente umgewandelt werden.*
Im Feld „Dauer“ können Sie die geplante Zeit des Tagesordnungspunktes im
Format „hh:mm“ (Stunden:Minuten) angeben. Auf der Übersichtsseite der
Tagesordnung werden alle eingegebenen Zeiten summiert und visualisiert.
@ -163,8 +159,6 @@ Ist der Redebeitrag zu Ende, können Sie dies mit dem Button „Rede beenden“
|microphone| bestätigen oder direkt den nächsten Redner mit dem Button „Rede
beginnen“ |microphone| aufrufen.
.. |microphone| image:: ../_images/microphone.png
Auf dem Dashboard finden Sie im Widget „Rednerliste“ zwei weitere Buttons,
um den obersten Redner des aktuell ausgewählten Tagesordnungseintrags
aufzurufen beziehungsweise den aktuellen Redebeitrag dieses Punktes zu
@ -176,6 +170,13 @@ Sie im Menüpunkt „Konfiguration“ in der oberen Leiste unter „Tagesordnung
.. image:: ../_images/Agenda_06.png
:class: screenshot
Schließlich können Sie in diesem Menüpunkt einstellen, dass die Rednerliste
mit dem Countdown gekoppelt wird. Wenn Sie auf „Rede beginnen“ |microphone|
oder Rede beenden“ |microphone| klicken, wird der Countdown automatisch
gestartet beziehungsweise gestoppt und beim nächsten Redner zurückgesetzt.
.. |microphone| image:: ../_images/microphone.png
CSV-Export der Rednerlisten
---------------------------

View File

@ -1,7 +1,9 @@
Einzelne Funktionen
===================
Im Folgenden werden die einzelnen Funktionen von OpenSlides erläutert. Die Funktionen sind mit wenigen Ausnahmen alle über die Menüpunkte des Webinterfaces zu erreichen.
Im Folgenden werden die einzelnen Funktionen von OpenSlides erläutert. Die
Funktionen sind mit wenigen Ausnahmen alle über die Menüpunkte des
Webinterfaces zu erreichen.
.. toctree::
:maxdepth: 2

View File

@ -7,9 +7,12 @@ In diesem Kapitel werden die ersten Schritte bei OpenSlides erklärt.
Installation
++++++++++++
OpenSlides muss nur auf einem Computer installiert werden. Dieser fungiert im Netzwerk als Server. Im Präsentationsmodus Single gibt es kein Netzwerk. OpenSlides muss dann auf dem einen verwendeten Computer installiert werden.
OpenSlides muss nur auf einem Computer installiert werden. Dieser fungiert
im Netzwerk als Server. Im Präsentationsmodus Single gibt es kein Netzwerk.
OpenSlides muss dann auf dem einen verwendeten Computer installiert werden.
Die aktuelle Version von OpenSlides, für die dieses Handbuch gültig ist, ist Version |version|.
Die aktuelle Version von OpenSlides, für die dieses Handbuch gültig ist,
ist Version |version|.
Verwendung der Windows-Version (Portable Version mit openslides.exe)
@ -25,13 +28,26 @@ Programmelemente sind in dem Ordner enthalten.
Verwendung der Linux/MacOS-Version
----------------------------------
Laden Sie die aktuelle OpenSlides Version für Linux/MacOS von http://openslides.org oder über den Python Package Index (PyPI) (``$ pip install openslides``) herunter. Die Installationsanleitung für diese Version finden Sie in der beiliegenden INSTALL.txt oder in der passenden Version unter http://files.openslides.org/. Folgen Sie den Anweisungen der Anleitung.
Laden Sie die aktuelle OpenSlides Version für Linux/MacOS von
http://openslides.org oder über den Python Package Index (PyPI) (``$ pip
install openslides``) herunter. Die Installationsanleitung für diese
Version finden Sie in der beiliegenden README.rst. Folgen Sie den
Anweisungen der Anleitung.
Konfiguration
+++++++++++++
Nach der Installation ist OpenSlides bereits vorkonfiguriert. Die beim ersten Start erzeugte (leere) Datenbank enthält einige Voreinstellungen. Die Konfiguration kann im laufenden Programm unter dem Tab „Konfiguration“ vorgenommen werden. Weitere Einstellungsmöglichkeiten für erfahrene Benutzer sind in der Datei ``settings.py`` möglich. Diese Datei liegt nicht im extrahierten OpenSlides Verzeichnis, sondern in einem Benutzerverzeichnis, das abhängig von Ihrem Betriebssystem ist. Unter Windows (außer bei der Portable Version) ist es standardmäßig ``$HOME\AppData\Local\openslides``, unter Linux/MacOS ist es standardmäßig ``~/.config/openslides``.
Nach der Installation ist OpenSlides bereits vorkonfiguriert. Die beim
ersten Start erzeugte (leere) Datenbank enthält einige Voreinstellungen.
Die Konfiguration kann im laufenden Programm unter dem Tab „Konfiguration“
vorgenommen werden. Weitere Einstellungsmöglichkeiten für erfahrene
Benutzer sind in der Datei ``settings.py`` möglich. Diese Datei liegt nicht
im extrahierten OpenSlides Verzeichnis, sondern in einem
Benutzerverzeichnis, das abhängig von Ihrem Betriebssystem ist. Unter
Windows (außer bei der Portable Version) ist es standardmäßig
``$HOME\AppData\Local\openslides``, unter Linux/MacOS ist es standardmäßig
``~/.config/openslides``.
Start des Servers und Öffnen des Browsers
@ -41,9 +57,9 @@ 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`` auszuführen.
Mit dieser wird der Server gestartet und ihr Browser mit der richtigen
URL geöffnet.
verwenden, brauchen Sie nur die Datei ``openslides.exe`` auszuführen. Mit
dieser wird der eine grafische Oberfläche gestartet, mit der Sie den
OpenSlides-Server konfigurieren, starten und jederzeit beenden können.
.. TODO: GUI-Funktionen beschreiben + Screenshot
@ -55,13 +71,16 @@ Starten Sie den Server, indem Sie in der Kommandozeile eingeben::
$ openslides
Wenn Sie eine virtuelle 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
Damit wird der Server gestartet und ihr Browser mit der richtigen URL geöffnet.
OpenSlides kann jederzeit im Fenster der Kommandozeile mit der Tastenkombination ``Strg`` + ``C`` beendet werden. Alle eingegebenen Daten bleiben in der Datenbank gespeichert.
OpenSlides kann jederzeit im Fenster der Kommandozeile mit der
Tastenkombination ``Strg`` + ``C`` beendet werden. Alle eingegebenen Daten
bleiben in der Datenbank gespeichert.
Weitere Startoptionen können Sie mit folgender Eingabe sehen::
@ -71,28 +90,64 @@ Weitere Startoptionen können Sie mit folgender Eingabe sehen::
Öffnen des Browsers
-------------------
Bei Start des Servers wird automatisch der Browser mit der richtigen URL geöffnet.
Bei Start des Servers wird automatisch der Browser mit der richtigen URL
geöffnet.
Falls dies wegen Ihrer Browsereinstellungen nicht gelingt, rufen Sie das OpenSlides-Webinterface auf, indem Sie in die Adresszeile die IP-Adresse des Servers eintragen. Sie hat oft die Form ``http://192.168.x.y/``, wobei x und y für eine bestimmte Zahl mit ein bis drei Ziffern stehen. Am Computer, auf dem OpenSlides gestartet wurde, kann OpenSlides auch über ``http://localhost/`` aufgerufen werden. Sollten die angegebenen Adressen nicht funktionieren, versuchen Sie die Adresse, die in der Kommandozeile angegeben ist. Möglicherweise muss ``:8000`` angefügt werden.
Falls dies wegen Ihrer Browsereinstellungen nicht gelingt, rufen Sie das
OpenSlides-Webinterface auf, indem Sie in die Adresszeile die IP-Adresse
des Servers eintragen. Sie hat oft die Form ``http://192.168.x.y/``, wobei
x und y für eine bestimmte Zahl mit ein bis drei Ziffern stehen. Am
Computer, auf dem OpenSlides gestartet wurde, kann OpenSlides auch über
``http://localhost/`` aufgerufen werden. Sollten die angegebenen Adressen
nicht funktionieren, versuchen Sie die Adresse, die in der Kommandozeile
angegeben ist. Möglicherweise muss der Port ``:8000`` angefügt werden.
Erster Login
------------
Der erste Login als Administrator ist mit dem Benutzernamen ``admin`` und dem Passwort ``admin`` möglich. Sie sollten das Passwort nach dem ersten Start ändern__, um Unbefugten keinen Zugriff auf Ihre Daten zu gewähren.
Der erste Login als Administrator ist mit dem Benutzernamen ``admin`` und
dem Passwort ``admin`` möglich. Sie sollten das Passwort nach dem ersten
Start ändern__, um Unbefugten keinen Zugriff auf Ihre Daten zu gewähren.
.. __: LoginLogout.html#
Arbeiten mit OpenSlides
+++++++++++++++++++++++
Im Webinterface von OpenSlides können Sie über die verschiedenen Menüpunkte alle Inhalte in OpenSlides eingeben und verwalten.
Im Webinterface von OpenSlides können Sie über die verschiedenen Menüpunkte
alle Inhalte in OpenSlides eingeben und verwalten.
.. image:: ../_images/FirstSteps_01.png
:class: screenshot
Im Menüpunkt „Dashboard“ steuern Sie, welche Folien auf dem Projektor 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 „Dateien“ 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 Projektor
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 „Dateien“ können Sie eigene Dateien auf den Server laden und zum
Download anbieten. PDF-Dateien können auch auf dem Projektor angezeigt
werden. Im Menüpunkt „Konfiguration“ können einige Einstellungen
vorgenommen werden.
Das Projektorbild 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 Projektor angeschlossen ist, in OpenSlides ein und rufen Sie den Link oder die URL auf. Legen Sie die Anzeige in einem eigenen Browserfenster auf den Projektor 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 Projektorbild auf den Projektor schieben.
Das Projektorbild 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 Projektor angeschlossen ist, in OpenSlides
ein und rufen Sie den Link oder die URL auf. Legen Sie die Anzeige in einem
eigenen Browserfenster auf den Projektor 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 Projektorbild auf den Projektor schieben.
Das Projektorbild aktualisiert sich vollkommen automatisch. Sollte die Aktualisierung auf Grund eines Fehlers, zum Beispiel einer Unterbrechung der Verbindung zum Server, aussetzen, sehen Sie auf den Folien unter der Uhrzeit eine rote Linie. Regelmäßig kann das Projektorbild an dem Computer, an dem der Projektor angeschlossen ist, mit der Taste ``F5`` zurückgesetzt werden.
Das Projektorbild aktualisiert sich vollkommen automatisch. Sollte die
Aktualisierung auf Grund eines Fehlers, zum Beispiel einer Unterbrechung
der Verbindung zum Server, aussetzen, kann das Projektorbild an dem
Computer, an dem der Projektor angeschlossen ist, regelmäßig mit der Taste
``F5`` zurückgesetzt werden. Um dem Kopf des Projektorfensters nach einer
Änderung in der Konfiguration zu aktualisieren, muss ebenfalls das
Browserfenster zurückgesetzt werden.

View File

@ -11,7 +11,7 @@ einen aus dem Vor- und Nachnamen zusammengesetzten Benutzernamen, wobei
Groß- und Kleinschreibung zu beachten ist und zwischen den Namen ein
Leerzeichen liegt. Beispiel: Ein mit dem Vornamen ``Max`` und dem Nachnamen
``Mustermann`` angelegter Teilnehmer hat den Benutzernamen ``Max
Mustermann``. Das Erstpasswort kann über die Teilnehmerverwaltung
Mustermann``. Das voreingestellte Passwort kann über die Teilnehmerverwaltung
eingesehen werden. Zum Einloggen geben Sie einfach Ihren Benutzernamen und
Ihr Passwort ein und klicken Sie auf ``Anmelden``.
@ -20,30 +20,31 @@ Eigene Benutzereinstellungen (insbesondere Benutzername oder Passwort) ändern
-----------------------------------------------------------------------------
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``.
den Button oben rechts geändert werden. Klicken Sie auf den Button, 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
-----------------------------------------------------------------------------
Beim Anlegen eines Teilnehmers wird automatisch ein zufälliges
Erst-Passwort gesetzt. Sie können das Erst-Passwort aus einer PDF-Datei
ablesen, die Sie durch Klick auf den Link „Erst-Passwörter als PDF“ im
Erst-Passwort gesetzt. Sie können das voreingestellte Passwort aus einer
PDF-Datei ablesen, die Sie durch Klick auf den Link „Zugangsdatenliste“ im
rechten oberen Menü erreichen.
Benutzer mit den entsprechenden Rechten wie Mitarbeiter können alle Benutzer
über den Menüpunkt „Teilnehmer/innen“ verwalten und dort auch den
Benutzernamen ändern und das Passwort auf ein bestimmtes Erst-Passwort
zurücksetzen.
Benutzernamen ändern und das Passwort auf ein bestimmtes voreingestelltes
Passwort zurücksetzen.
Klicken Sie beim jeweiligen Teilnehmer auf das Bearbeiten-Symbol |edit| und
tragen Sie unter „Erst-Passwort“ ein neues, selbstgewähltes Passwort ein.
Anschließend klicken Sie auf ``Übernehmen``. In einem zweiten Schritt
müssen Sie auf den Link „Auf Erst-Passwort zurücksetzen“ klicken, um das im
System gespeicherte Passwort mit Ihrem neu eingegebenen zu ersetzen.
Bestätigen Sie den oben auf der Seite erscheinenden Dialog mit ``Ja``.
tragen Sie unter „Voreingestelltes Passwort“ ein neues, selbstgewähltes
Passwort ein. Anschließend klicken Sie auf ``Übernehmen``. In einem zweiten
Schritt müssen Sie auf den Link „Auf Erst-Passwort zurücksetzen“ klicken,
um das im System gespeicherte Passwort mit Ihrem neu eingegebenen zu
ersetzen. Bestätigen Sie den oben auf der Seite erscheinenden Dialog mit
``Ja``.
.. |edit| image:: ../_images/pencil.png

View File

@ -36,6 +36,9 @@ werden:
* Sie können einen eigenen Titel und einen Einleitungstext für das
PDF-Dokument formulieren.
* Sie können einstellen, ob in den PDF-Dokumenten die Absätze der
Antragstexte nummeriert sein sollen.
* Es kann die Möglichkeit eingestellt werden, beim späteren Ändern von
Anträgen die automatische Versionierung im Einzelfall ausnahmsweise zu
deaktivieren. Dies kann sinnvoll sein, wenn Anträge nur redaktionell
@ -243,7 +246,8 @@ Zu jedem Antrag können Sie über einen Link („Neuer Tagesordnungseintrag“)
in der oberen Leiste des betreffenden Antrags („Mehr Aktionen“) auch einen
eigenen Eintrag in der Tagesordnung erstellen, der direkt mit der
Antragsfolie verknüpft ist. Dies empfiehlt sich, wenn ein einzelner Antrag
an einer bestimmten Stelle der Tagesordnung behandelt werden soll.
an einer bestimmten Stelle der Tagesordnung behandelt werden und dazu eine
Rednerliste verwendet soll.
Abstimmungen

View File

@ -1,6 +1,8 @@
Tutorial Präsentationsmodus
=============================
Dieses Tutorial ist auf dem Stand von OpenSlides 1.4.x.
In diesem Tutorial sehen Sie am Beispiel der Mitgliederversammlung eines
Kleingartenvereins, wie Sie OpenSlides im Präsentationsmodus bedienen.

View File

@ -3,7 +3,7 @@ Web-Links
Die Dokumentation von Django finden Sie unter:
* https://docs.djangoproject.com/en/1.5/
* https://docs.djangoproject.com/en/1.6/
Entwickler können sich unter folgendem Link über alles weitere informieren: