Allgemeines

Die Dokumente werden bevorzugt in dem Format "reStructured Text" verfasst. Es gibt eine sehr gute Dokumentation in englisch unter reStructured. In diesem Dokument wird hauptsächtlich dieses Format beschrieben.

Der Grund, warum hier mit einem reStructered Format gearbeitet wird und nicht mit einem von den vielen schönen Tools die es im Internet gibt, liegt einfach daran, dass hier keine Hilfsmittel oder spezielle Browser vorrausgesetzt werden. Nicht jeder hat die Möglichkeit einen modernen Browser mit Java Unterstützung o.ä. zu nutzen.

Die Esperantozeichen können mit Hilfe des X-Modus eingegeben werden. Hierbei ist zu beachten, dass dies auch in deutschen Texten gültig ist. Durch Eingabe von doppeltem "x" wird diese Funktion unterdrückt. Wenn man also "cx" schreiben möchte, muss dies als "cxx" geschrieben werden, denn sonst wird daraus "ĉ".

Ähnlich wie die Esperantozeichen, können auch die deutschen Umlaute mit : (Doppelpunkt) geschrieben werden (z.B. aus "A:" wird "Ä") und der Doppelpunkt muss verdoppelt werden, um nach einer Umlautbuchstabe zu erscheinen.

Formatmöglichkeiten

Es stehen folgende Formate für Dokumente zur Verfügung:

Structured Text

Dies ist der Vorgänger von reStructured und sollte nach Möglichkeit nicht verwendet werden.

reStructured Text

Der Hauptformat des Portals. Dieser Format ermöglicht einfache Erstellung von Dokumenten und die automatische Konvertierung in andere Formate, wie z.B. in HTML. Detaillierte Information in Englisch ist unter reStructured nachzuschlagen, bzw. die gesammte Referenz unter reStructuredRef. Wichtigste Punkte dieses Formates siehe weiter unten.

HTML

Eine gute Dokumentation zu diesem Format ist unter SelfHTML nachzuschlagen.

Plain Text

Hierbei handelt es sich um reinen Text ohne Formatiermöglichkeiten. Gut geignet um bestehende Texte ohne Nachbearbeitung einzufügen.

Auf diesem Portal werden die Texte in reStructured Format verfasst und von dem System automatisch in HTML Konvertiert. Dies vereinfacht nicht nur das Erstellen der Dokumente, sondern ermöglicht Nutzern, die über keine oder nur wenige HTML Kenntnisse verfügen, die Dokumente ohne zusätzlichen Hilfsmittel pflegen und weiter bearbeiten können.

Aktuell ist es dennoch möglich HTML Dokumente zu erstellen, sollte allerdings nur in Notfällen verwendet werden, da HTML ein unüberwindbares Hinderniss für Nutzer ohne HTML Kenntnisse darstellen kann.

Mehrsprachige Dokumente

Jedes Objekt auf dem Portal kann entweder in Esperanto oder in Deutsch verfasst werden. Falls erwünscht, kann anschliessend der Text in jeweils die andere Sprache über das Menu "Übersetzungen verwalten" übersetzt werden. Es ist dabei zu beachten dass das Originaldokument und das übersetzte Dokument zwar zusammenhängend sind, aber zwei getrennte Inhalte darstellen. Müssen also z.B. getrennt zur Veröffentlichung eingereicht werden, allerdings wenn einer der beiden eingereicht ist, darf der andere nicht mehr verändert werden.

reStructured Format

Dieses Format ist so entwickelt worden, dass die Texte möglichst intuitiv als Texte verfasst werden und vom einem Programm in ein beliebiges andere Format konvertiert werden können. Dabei ist grosser Wert darauf gelegt worden, dass die Texte auch im Originalzustand möglichst gut lesbar sind und ohne zusätzlichen Hilfsmittel bearbeitet werden können. Hier werden die wichtigsten Elemente dieses Formats dargestellt, vollständige Beschreibung ist auf der Seite reStructured nachzuschlagen.

*dieser Text ist kursiv*

**dieser Text ist fettgedruckt**

http://docutils.sf.net

=============
Hauptkapitel
=============

Unterkapitel
=============

Unterunterkapitel
------------------

Unterunterunterkapitel
'''''''''''''''''''''''

Ein Absatz.

Nächster Absatz.

- Erstes Element
- Zweites Element

1. Erstes Element
2. Zweites Element
#. Automatisch nummeriertes Element

:Autoren:
    Tony J. (Tibs) Ibbs,
    David Goodger

:Version: 1.0 of 2001/08/98
:Widmung: Meiner Familie.

::
    
    **Dieser** Text ist nicht formatiert
    
    Dieser auch nicht

Aber **dieser** ist formatiert

**Dieser** Text ist nicht formatiert

Dieser auch nicht

.. parsed-literal::
    
    **Dieser** Text ist nicht formatiert
    
    Dieser auch nicht

Aber **dieser** ist formatiert

Dieser Text ist nicht formatiert

Dieser auch nicht

Ein Link_ wird mit einem Unterstrich gekennzeichnet.
Am Ende des Artikels wird die URL des Links angegeben.
Besteht der verlinkte Begriff aus `mehreren Wörtern`_,
so wird er zwischen umgekehrte einfache Anführungszeichen gesetzt.

.. _Link: www.esperanto-nuernberg.de
.. _mehreren Wörtern: www.esperanto-nuernberg.de

+--------------------------+-----------------+
| Die erste Spalte         | Die zweite      |
+==========================+=================+
| Jetzt keine Ueberschrift | Hier auch keine |
+--------------------------+-----------------+
| Hier die zweite Zeile    | Zweite Zeile    |
+--------------------------+-----------------+

.. list-table:: Überschrift
    :header-rows: 1
    
    * - Zeile 1 Spalte 1
      - Zeile 1 Spalte 2
      - Zeile 1 Spalte 3
    * - Zeile 2 Spalte 1
      - Zeile 2 Spalte 2
      - Zeile 2 Spalte 3
    * - Zeile 3 Spalte 1

        Diese Zelle ist mehrzeilig

      - Zeile 3 Spalte 2

        Diese Zelle ist auch mehrzeilig

      - Zeile 3 Spalte 3

.. list-table:: Überschrift
    
    * - Zeile 1 Spalte 1
      - Zeile 1 Spalte 2
      - Zeile 1 Spalte 3
    * - .. list-table::
          
          * - Dies ist eine
            - Untertabelle
          * - Mit zwei spalten
            - Und zwei Zeilen

      - +------------------+-----------------+
        | Dies ist eine    | Untertabelle    |
        +------------------+-----------------+
        | Mit zwei Spalten | und zwei Zeilen |
        +------------------+-----------------+

      - Zeile 2 Spalte 3
    * - Zeile 3 Spalte 1

        Diese Zelle ist mehrzeilig

      - Zeile 3 Spalte 2

        Diese Zelle ist auch mehrzeilig

      - Zeile 3 Spalte 3