Added initial documentation structure. Thanks to Wolfram Stebel!

docs/conf.py

@@ -115,12 +115,12 @@ html_theme = 'sphinxdoc'
 # 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 = '_static/images/favicon.ico'
+html_favicon = '_static/favicon.ico'
 
 # 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']
+html_static_path = ['_static','de/_static/']
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.

docs/de/chapter1.rst

@@ -1,12 +1,22 @@
-Kapitel 1
-=========
+Einführung
+==========
 
-TODO
+Openslides hilft Ihnen bei der Organisation von Veranstaltungen die typischerweise über Anträge abstimmen müssen und bei denen Wahlen durchgeführt werden. Dies können Vereine, Parteien oder ähnliche Vereinigungen sein.
 
-Abschnitt A
------------
-TODO
+Sie werden von Openslides bei der Erstellung einer Tagesordnung für die Veranstaltung unterstützt und können diese während der Veranstaltung anhand des Verlaufes anpassen bzw. den Ablauf und Ergebnisse präsentieren.
+
+Hierzu ist eine Computerausrüstung notwendig, die je nach Veranstaltungsgrösse und Durchführungsart variiert. Ein Beamer sollte in jedem Fall vorhanden sein, damit alle Anwesenden den Ablauf der Veranstaltung verfolgen können und von der Organisation der Veranstaltung mit Openslides profitieren können.
+
+In Openslides wird der rote Faden für eine Veranstaltung als Tagesordnung festgelegt und für den Teilnehmer transparent präsentiert.
+
+
+.. toctree::
+ :maxdepth: 2
+
+
+ chapter1_1
+
+ chapter1_2
+
+ chapter1_3
    
-Abschnitt B
------------
-TODO

docs/de/chapter1_1.rst

@@ -0,0 +1,20 @@
+Einsatzgebiete
+--------------
+Openslides wird im allgemeinen bei Veranstaltungen von Vereinen oder politischen Parteien eingesetzt.
+
+Hierbei können Teilnehmer verwaltet, Anträge bearbeitet und Wahlen, z.B. für Ehrenämter oder Parteiposten, durchgeführt werden.
+
+Der Einsatz kann in verschiedenen Konfigurationen erfolgen:
+
+* Präsentationsmodus:
+
+  Ein oder mehrere Veranstalter (z.B. Vorstandsmitglieder eines Vereins/Partei) konfigurieren und bedienen Openslides und alle anderen können die Veranstaltung in einer Projektion verfolgen.
+
+* Mehrbenutzermodus:
+
+  Ein oder mehrere Veranstalter (z.B. Vorstandsmitglieder eines Vereins/Partei) konfigurieren und bedienen Openslides. Alle Delegierten erhalten einen Zugang zu Openslides und können dort z.B. Anträge eintragen und Wahlvorschläge machen. Wer diese Option als Delegierter wahrnehmen möchte, muss einen eigenen Computer (Notebook) mitbringen. Auch hier wird der Verlauf der Veranstaltung in einer Projektion präsentiert. Zu diesem Zweck bekommt jeder Delegierte vom Veranstalter eingeschränkte Zugriffsrechte auf den Datenbestand.
+
+Es ist offensichtlich, dass für den Mehrbenutzermodus ein Computernetzwerk verfügbar sein muss, z.B. mit mehreren LAN-Anschlüssen oder WLAN-Zugang.
+Daher erfordert ein Mehrbenutzermodus wesentlich mehr Aufwand in der Vorbereitung der Veranstaltung, z.B. auch durch die Ausgabe von Benutzerdaten.
+
+Die wichtigsten Schritte werden in den folgenden Kapiteln erläutert.

docs/de/chapter1_2.rst

@@ -0,0 +1,9 @@
+Vorraussetzungen
+----------------
+Openslides muss auf einem Rechner installiert sein (http://openslides.org/download/INSTALL-1.1.txt).
+
+Es sollte ein Beamer an den Rechner angeschlossen sein, so dass die Teilnehmer der Tagesordnung folgen können und Detailinformationen dargestellt werden können.
+
+Gegebenenfalls muss ein Netzwerk bereit gestellt werden, damit im Mehrbenutzerbetrieb die Tielnehmer auf die Daten zugreifen können.
+
+

docs/de/chapter1_3.rst

@@ -0,0 +1,13 @@
+Vorbereitungen
+--------------
+Die Veranstaltung sollte zumindest in der Konfiguration vorbereitet sein.
+
+Alle Teilnehmer sollten entweder im Vorfeld oder bei der Registrierung am Tagungsort vor der Veranstaltung erfasst werden.
+
+Jedem Delegierten muss das Einrichten des Zugangs nahe gebracht werden sofern er mit eigenem Rechner auf die Daten zugreifen können soll.
+
+Bei langen Tagungen mit vielen Tagungsordnungspunkten, grosser Anzahl von Anträgen und vielen Wahlgängen ist es auch zu empfehlen die Wahlvorgänge und Anträge vorzubereiten.
+
+Personen die definitiv teilnehmen oder kandidieren können im Datenbestand schon vorbereit werden und bereits als Wahlvorschläge eingetragen werden.
+
+Anträge können auch aus einer CSV-Datei importiert werden, siehe hierzu (TODO: link)

docs/de/chapter2.rst

@@ -1,12 +1,125 @@
-Kapitel 2
-=========
+Openslides in 30 Minuten
+========================
 
-TODO
+In dieser Kurzanleitung (Tutorial) lernen Sie die grundlegenden Eigenschaften von Openslides kennen, indem Sie eine Veranstaltung in Kurzform erstellen.
 
-Abschnitt A
------------
-TODO
 
-Abschnitt B
------------
-TODO
+An allen Stellen wo offensichtlich später z.B. der Name Ihres Vereins/Ihrer Partei etc. verwendet wird können Sie gerne sofort Ihre eigenen Daten verwenden, allerdings unterscheiden sich dann später aber Bildschirmkopien von Ihrer aktuellen Umgebung.
+
+
+Voraussetzungen
+---------------
+Es wird vorausgesetzt dass Openslides auf einem Rechner bereits lokal in Betrieb genommen wurde und Sie mit einer frischen (leeren) Datenbank starten (http://openslides.org/download/INSTALL-1.1.txt). Sie müssen wissen für welchen Port (TODO: Indexeintrag) Openslides bei der Installation konfiguriert wurde, um das Programm starten zu können.
+
+Wir gehen zunächst davon aus, dass Sie der Installationsanleitung gefolgt sind und der Port "8000" ist. Als weitere Grundlage gehen wir davon aus, dass ein Benutzer "benutzer" mit dem Passwort "openslides" und Mail "benutzer@mail.de" beim Erstellen der Datenbank angelegt wurde. Überall wo diese Daten eingegeben werden müssen, sollten Sie den evtl. den von Ihnen anders benannten Benutzer bzw. Passwort verwenden.
+
+
+Desweiteren sollten Sie einen Web-Browser (Firefox, Safari, Internet Explorer o.ä.) zum Zugriff auf Webseiten zur Verfügung haben.
+
+
+Zusammenstellen der Veranstaltung
+---------------------------------
+
+Starten Sie mit der Eingabe "http://localhost:8000" im Web-Browser und bestätigen Sie mit "Enter".
+
+Es wird automatisch die Seite "http://localhost:8000/login/" angezeigt:
+
+.. image:: _static/images/login.png
+
+Geben Sie "benutzer" als Nutzername und "openslides" als Passwort ein (bzw. Ihre anders gewählten Daten) und klicken Sie "Anmelden".
+
+Sie sehen nun den Startbildschirm. Oben rechts wird der angemeldete Benutzer angezeigt.
+
+.. image:: _static/images/init_start.png
+
+
+Klicken Sie auf die obere Lasche "Konfiguration"
+
+.. image:: _static/images/config_tab.png
+
+und geben Sie die Daten wie angezeigt ein:
+
+.. image:: _static/images/config_tab_common.png
+
+danach klicken Sie "Speichern".
+
+.. image:: _static/images/config_tab_common_saved.png
+
+Solche Bestätigungen werden häufiger im Browser eingeblendet! Die gespeicherten Daten werden in der Überschrift angezeigt.
+
+Klicken Sie nun auf die linke Lasche "Wahl" (oben ist noch "Konfiguration" gewählt).
+
+.. image:: _static/images/config_tab_election.png
+
+Schreiben Sie den Einleitungstext in das vorgesehene Feld und klicken Sie "Speichern".
+
+.. image:: _static/images/config_tab_election_introduction.png
+
+Auch hier erhalten Sie eine Bestätigung des Vorgangs.
+
+Wählen Sie nun "Antrag":
+
+.. image:: _static/images/config_tab_application.png
+
+und geben Sie "Mindestanzahl..."  0 ein sowie den Einleitungstext:
+
+.. image:: _static/images/config_tab_application_introduction.png
+
+Hiermit ist die Konfiguration zunächst abgeschlossen.
+
+Klicken Sie nun auf "Tagesordnung" um diese anzuzeigen. Die Liste ist zunächst leer und wir legen mit "Neuer Eintrag" einen neuen Tagesordnungspunkt an: (TODO: Bild falsch)
+
+.. image:: _static/images/top_new.png
+
+Klicken Sie "Speichern" und schauen Sie bitte auf die nun erscheinende List:
+
+.. image:: _static/images/top_initial_top.png
+
+Geben Sie einen weitere Tagesordnungspunkt "Bericht des Vorstands" ein:
+
+.. image:: _static/images/top_second_top_list.png
+
+Klicken Sie nun auf die Lasche "Teilnehmer/innen"
+
+.. image:: _static/images/participants_tab.png
+
+Um Anträge anlegen und Wahlen veranstalten zu können werden Sie nun Teilnehmer anlegen. Hierzu wählen Sie "Neue/r Teilnehmer/in" aus, so dass das Eingabefomular für Teilnehmer erscheint. Erfassen Sie nun 3 Teilnehmer. Zunächst Rudolf Ratlos wie dargestellt, die Einstellung für die Gruppen können Sie wie im Erläuterungstext beschrieben mehrfach markieren.
+
+.. image:: _static/images/participant_new.png
+
+und klicken Sie "Speichern". In der Liste sehen Sie nun einen Eintrag für Rudolf Ratlos.
+
+.. image:: _static/images/participant_added.png
+
+Klicken Sie auf das "Bearbeiten" Symbol am Ende der Zeile (Papier mit Stift). Sie sehen, dass dem Teilnehmer ein weiteres Feld "Benutzername" mit dem automatisch generierten Benutzernamen zugefügt wurde und im Feld "Erst-Passwort" (unten) etwas kryptisches eingetragen wurde.
+(TODO: Benutzernamen und passwort ändern???). Klicken Se einfach erneut "Speichern".
+
+Legen Sie nun Thea Tatendrang und Werner Wichtig genauso an wie eben, nur dass als Gruppe lediglich "Delegierte", das korrekte Geschlecht und kein Amt eingetragen wird. Die Liste sieht dann wie folgt aus:
+
+.. image:: _static/images/participant_all_added_list.png
+
+
+
+
+Durchführen der Veranstaltung
+-----------------------------
+Alle notwendigen Daten wurden im vorigen Abschnitt erfasst. In dieser Kurzanleitung wird die Veranstaltung als eine Art "Präsentation" durchgeführt, d.h. es gibt einen Rechner im Raum, ein Anwesender bedient diesen und alle anderen Anwesenden können den Ablauf auf einer Leinwand (Beamer erforderlich) verfolgen.
+
+Es wird davon ausgegangen, dass der Erstbenutzer "benutzer" mit dem Passwort "openslides" angemeldet ist und die Ansicht zeigt die Tagesordnung.
+
+Starten Sie ein weiteres Browser-Fenster und geben Sie dort ebenfalls "http://localhost:8000" ein. Sie landen ebenfalls auf der Tagesordnung. Dort wählen Sie nun links "Beamer-Ansicht". (Platzieren Sie dieses Browser-Fenster so, dass es vom Beamer dargestellt wird. Das zweite Fenster mit der Tagesordnung verbleibt auf dem "alternativen" Bildschirm und stellt das Arbeitsfenster dar. Eventuell muss am Computer oder am Beamer etwas eingestellt werden, damit 2 verschiedene Bildschirme verwaltet werden können. Dies zu beschreiben geht über den Horizont der Kurzanleitung hinaus.)
+
+Im Beamer-Fenster ist folgendes sichtbar (Ausschnitt):
+
+.. image:: _static/images/beamer_view_top_part.png
+
+
+Die Beamer-Ansicht wird über die Tagesordnung gesteuert und aktualisiert sich innerhalb kurzer Zeit nach einer Änderung. Ohne Ihr Zutun wird die vollständige Tagesordnung dargestellt.
+
+Klicken Sie nun in der Tagesordnung auf den Haken links neben "Begrüssung" und beachten Sie das Beamer-Fenster. Dort wird jetzt fett "Begrüssung" angezeigt und die Anwesenden können den Fortschritt der Sitzung verfolgen.
+
+
+Bereinigung der Daten
+---------------------
+
+Nachdem Sie diese Kurzanleitung mit Testdaten durchgespielt haben sollten Sie die Datenbank neu erstellen/löschen. (TODO: löschen???)

docs/de/chapter3.rst

@@ -0,0 +1,14 @@
+Veranstaltung vorbereiten
+=========================
+
+TODO
+
+
+.. toctree::
+ :maxdepth: 2
+
+ chapter3_1
+
+ chapter3_2
+
+ chapter3_3

docs/de/chapter3_1.rst

@@ -0,0 +1,3 @@
+Präsentationsmodus
+------------------
+TODO

docs/de/chapter3_2.rst

@@ -0,0 +1,3 @@
+Mehrbenutzermodus
+-----------------
+TODO

docs/de/chapter3_3.rst

@@ -0,0 +1,3 @@
+Tipps
+-----
+TODO

docs/de/chapter4.rst

@@ -0,0 +1,13 @@
+Veranstaltung durchführen
+=========================
+
+TODO
+
+.. toctree::
+ :maxdepth: 2
+
+ chapter4_1
+
+ chapter4_2
+
+ chapter4_3

docs/de/chapter4_1.rst

@@ -0,0 +1,3 @@
+Präsentationsmodus
+------------------
+TODO

docs/de/chapter4_2.rst

@@ -0,0 +1,3 @@
+Mehrbenutzermodus
+-----------------
+TODO

docs/de/chapter4_3.rst

@@ -0,0 +1,3 @@
+Tipps
+-----
+TODO

docs/de/chapter5.rst

@@ -0,0 +1,29 @@
+Anleitung
+=========
+
+TODO
+
+.. toctree::
+ :maxdepth: 2
+
+ chapter5_1
+
+ chapter5_2
+
+ chapter5_3
+  
+ chapter5_4
+    
+ chapter5_5
+      
+ chapter5_6
+        
+ chapter5_7
+          
+ chapter5_8
+  
+ chapter5_9
+          
+ chapter5_10
+  
+ chapter5_11

docs/de/chapter5_1.rst

@@ -0,0 +1,4 @@
+Erste Einrichtung
+-----------------
+
+TODO:

docs/de/chapter5_10.rst

@@ -0,0 +1,4 @@
+Countdown
+---------
+
+TODO:

docs/de/chapter5_11.rst

@@ -0,0 +1,2 @@
+Wiederverwendung einer Veranstaltung
+------------------------------------

docs/de/chapter5_2.rst

@@ -0,0 +1,4 @@
+An-/Abmelden
+------------
+
+TODO:

docs/de/chapter5_3.rst

@@ -0,0 +1,4 @@
+Einstellungen
+-------------
+
+TODO:

docs/de/chapter5_4.rst

@@ -0,0 +1,4 @@
+Konfiguration
+-------------
+
+TODO:

docs/de/chapter5_5.rst

@@ -0,0 +1,4 @@
+Teilnehmer
+----------
+
+TODO:

docs/de/chapter5_6.rst

@@ -0,0 +1,4 @@
+Tagesordnung
+------------
+
+TODO:

docs/de/chapter5_7.rst

@@ -0,0 +1,4 @@
+Anträge
+-------
+
+TODO:

docs/de/chapter5_8.rst

@@ -0,0 +1,4 @@
+Wahlen
+------
+
+TODO:

docs/de/chapter5_9.rst

@@ -0,0 +1,4 @@
+Beamer-Ansicht
+--------------
+
+TODO:

docs/de/chapter6.rst

@@ -0,0 +1,15 @@
+Anhänge
+=======
+
+TODO
+
+.. toctree::
+ :maxdepth: 2
+
+ chapter6_1
+
+ chapter6_2
+
+ chapter6_3
+
+ chapter6_4

docs/de/chapter6_1.rst

@@ -0,0 +1,4 @@
+Netwerktechnik für Openslides Dummies
+-------------------------------------
+
+TODO:

docs/de/chapter6_2.rst

@@ -0,0 +1,4 @@
+Datenschutz
+-----------
+
+TODO:

docs/de/chapter6_3.rst

@@ -0,0 +1,17 @@
+Das Aussehen ändern
+-------------------
+
+Das Aussehen von Openslides wird durch die folgenden Dateien beeinflusst:
+
+* base.css
+* tabledrag.css
+* agenda.css
+* beamer.css
+
+Die Dateien liegen im Unterverzeichnis "/static/styles/" des Installationsverzeichnisses.
+
+Es handelt sich dabei um sogenannte "Cascaded Style Sheets" (CSS).
+
+Wenn Sie die Darstellung verändern wollen, müssen Sie diese Dateien verändern. Legen Sie sicherheitshalber eine Kopie der urspünglichen Datei an, um sich bei fehlerhaften Veränderungen am Original orientieren zu können.
+
+TODO: Werkezeuge für CSS?

docs/de/chapter6_4.rst

@@ -0,0 +1,11 @@
+Web-Links
+---------
+
+Weitere Dokumentation finden Sie unter:
+
+* http://openslides.org
+* http://openslides.org/download/INSTALL-1.1.txt
+
+Entwickler können sich hier über alles weitere informieren:
+
+* http://dev.openslides.org/

docs/de/index.rst

@@ -16,6 +16,14 @@ Inhalt:
  
  chapter2
 
+ chapter3
+
+ chapter4
+
+ chapter5
+
+ chapter6
+
 
 Anhang
 ======