Doc: Prepared manual for publishing.

This commit is contained in:
Emanuel Schuetze 2012-07-25 17:12:03 +02:00
parent 5d367dd635
commit d230bf040f
7 changed files with 53 additions and 25 deletions

View File

@ -6,7 +6,7 @@ SPHINXOPTS =
SPHINXBUILD = sphinx-build SPHINXBUILD = sphinx-build
PAPER = PAPER =
BUILDDIR = _build BUILDDIR = _build
LANGUAGES = de en LANGUAGES = de
# Internal variables. # Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_a4 = -D latex_paper_size=a4

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.3 KiB

24
docs/_templates/layout.html vendored Normal file
View File

@ -0,0 +1,24 @@
{% 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/images/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

@ -54,7 +54,7 @@ release = '1.2'
# 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.
#language = None language = 'de'
# There are two options for replacing |today|: either, you set today to some # There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used: # non-false value, then it is used:
@ -105,7 +105,7 @@ html_style = 'openslidesdoc.css'
# The name for this set of Sphinx documents. If None, it defaults to # The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation". # "<project> v<release> documentation".
#html_title = None html_title = "OpenSlides Handbuch"
# A shorter title for the navigation bar. Default is the same as html_title. # A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None #html_short_title = None
@ -143,7 +143,7 @@ html_static_path = ['_static']
#html_domain_indices = True #html_domain_indices = True
# If false, no index is generated. # If false, no index is generated.
#html_use_index = True html_use_index = False
# If true, the index is split into individual pages for each letter. # If true, the index is split into individual pages for each letter.
#html_split_index = False #html_split_index = False
@ -185,7 +185,7 @@ 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 Documentation', ('index', 'OpenSlides.tex', u'OpenSlides Handbuch',
u'OpenSlides Team', 'manual'), u'OpenSlides Team', 'manual'),
] ]
@ -215,7 +215,7 @@ latex_documents = [
# One entry per manual page. List of tuples # One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section). # (source start file, name, description, authors, manual section).
man_pages = [ man_pages = [
('index', 'openslides', u'OpenSlides Documentation', ('index', 'openslides', u'OpenSlides Handbuch',
[u'OpenSlides Team'], 1) [u'OpenSlides Team'], 1)
] ]
@ -229,8 +229,8 @@ man_pages = [
# (source start file, target name, title, author, # (source start file, target name, title, author,
# dir menu entry, description, category) # dir menu entry, description, category)
texinfo_documents = [ texinfo_documents = [
('index', 'OpenSlides', u'OpenSlides Documentation', ('index', 'OpenSlides', u'OpenSlides Handbuch',
u'OpenSlides Team', 'OpenSlides', 'One line description of project.', u'OpenSlides Team', 'OpenSlides', 'Das Benutzerhandbuch von OpenSlides',
'Miscellaneous'), 'Miscellaneous'),
] ]

View File

@ -7,23 +7,26 @@ In diesem Kapitel werden die ersten Schritte bei OpenSlides erklärt.
Installation Installation
++++++++++++ ++++++++++++
OpenSlides muss auf einem Computer installiert werden. Dieser fungiert im Netzwerk als Server. Im Präsentationsmodus Single gibt es kein Netzwerk und daher auch keinen Server. OpenSlides muss dann auf dem einen verwendeten Computer installiert werden. OpenSlides muss 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 Systemvoraussetzungen finden Sie hier: **TODO**
Hinweise zur technischen Ausstattung (des Servers) finden Sie hier: **TODO** (Mindestanforderungen, empfohlene Anforderungen für Teilnehmermodus mit soundsoviel Clients)
Verwendung der Windows-Version (Portable Version mit openslides.exe) Verwendung der Windows-Version (Portable Version mit openslides.exe)
-------------------------------------------------------------------- --------------------------------------------------------------------
Laden Sie die Datei ``openslides-1.2-portable.zip`` hier (**TODO**) herunter und extrahieren Sie den Inhalt in einen beliebigen Ordner. OpenSlides muss nun nicht weiter installiert werden. Alle notwendigen Programmelemente sind in dem Ordner enthalten. Laden Sie die aktuelle OpenSlides Version für Windows von
http://www.openslides.org herunter. Extrahieren Sie das zip-Archiv
(z.B. ``openslides-1.2-portable.zip``) in einen beliebigen Ordner.
OpenSlides muss nun nicht weiter installiert werden. Alle notwendigen
Programmelemente sind in dem Ordner enthalten.
Verwendung der Linux-Version oder des Quellcodes aus dem OpenSlides-Repository Verwendung der Linux/MacOS-Version oder des Quellcodes aus dem OpenSlides-Repository
------------------------------------------------------------------------------ ------------------------------------------------------------------------------------
Die Installationsanleitung für diese Versionen finden Sie hier: **TODO** Laden Sie die aktuelle OpenSlides Version für Linux/MacOS von
http://www.openslides.org herunter. Die Installationsanleitung für
diese Version finden Sie in der beiliegenden INSTALL.txt. Folgen Sie
den Anweisungen der Anleitung.
@ -44,8 +47,8 @@ Wenn Sie die Windows-Version (Portable Version mit openslides.exe) verwenden, br
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.
Verwendung der Linux-Version oder des Quellcodes aus dem OpenSlides-Repository Verwendung der Linux/MacOS-Version oder des Quellcodes aus dem OpenSlides-Repository
------------------------------------------------------------------------------ ------------------------------------------------------------------------------------
Starten Sie den Server, indem Sie in der Kommandozeile in den Ordner wechseln, der die Datei ``start.py`` enthält, und eingeben:: Starten Sie den Server, indem Sie in der Kommandozeile in den Ordner wechseln, der die Datei ``start.py`` enthält, und eingeben::

6
docs/de/impressum.rst Normal file
View File

@ -0,0 +1,6 @@
Impressum
=========
Copyright 2012, OpenSlides Team
Das OpenSlides-Handbuch ist unter der `Creative Commons CC BY-SA 3.0 <http://creativecommons.org/licenses/by-sa/3.0/>`_ lizensiert.

View File

@ -23,9 +23,4 @@ Inhalt:
chapter7 chapter7
Anhang impressum
======
* :ref:`genindex`
* :ref:`search`