3.1   Überschriften

Die Überschriften sind so geordnet:

=========
Ganz oben
=========


Erste Ebene   (das gibt 1.)
===========

Zweite Ebene  (das gibt 1.1)
------------

Dritte Ebene  (das gibt 1.1.1)
````````````

Vierte Ebene  (das gibt 1.1.1.1)
............

Wichtig ist, dass die Länge der Unterstreichung mindestens so lang ist wie der Unterschriftentext. So eine Überschrift führt also sofort zu einer Warnung:

Dritte Ebene
`````````

In diesem Abschnitt habe ich eine dritte und vierte Ebene angelegt zum Test.

3.2   Textstile

Die wichtigsten Textstile sind kursiv, fett und verbatim. Man schreibt sie *kursiv*, **fett** und ``verbatim``.

3.3   Kommentare

Einen Kommentar macht man so:

.. Das ist nun ein Kommentar,
   den man in der Ausgabedatei
   nicht sieht.

3.4   Aufzählungspunkte

Eine Liste von "Items" macht man so:

• Punkt 1
• Punkt 2
• Punkt 3

Eine Aufzählung

1. Äpfel
2. Birnen
3. Orangen

Der Rohtext lautet:

1. Äpfel
2. Birnen
3. Orangen

oder kurz

1. Äpfel
2. Birnen
3. Orangen

Der Rohtext lautet:

1. Äpfel
#. Birnen
#. Orangen

Wichtig ist bei den Aufzählungen die richtige Einrücktiefe. So klappt es z.B. nicht:

1. Lorem ipsum dolor sit amet, consectetur adipisici elit, sed eiusmod tempor
incidunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis
nostrud exercitation ullamco laboris nisi ut aliquid ex ea commodi
consequat...

#. Lorem ipsum dolor sit amet, consectetur adipisici elit, sed eiusmod tempor
incidunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis
nostrud exercitation ullamco laboris nisi ut aliquid ex ea commodi
consequat...

Es muss statt dessen so geschrieben werden:

1. Lorem ipsum dolor sit amet, consectetur adipisici elit, sed eiusmod tempor
   incidunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis
   nostrud exercitation ullamco laboris nisi ut aliquid ex ea commodi
   consequat...

#. Lorem ipsum dolor sit amet, consectetur adipisici elit, sed eiusmod tempor
   incidunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis
   nostrud exercitation ullamco laboris nisi ut aliquid ex ea commodi
   consequat...

Wenn man bei einem Item-Punkt weitere Item-Unterpunkte anführen möchte, muss man schreiben:

1. Äpfel

   - Gelbe Äpfel
   - Rote Äpfel
   - Grüne Äpfel

#. Birnen
#. Orangen

Wichtig ist auch, dass man vor den Item-Punkten eine Leerzeile einfügt. Wenn man das nicht macht, dann sieht die Ausgabe so aus:

1. Äpfel - Gelbe Äpfel - Rote Äpfel - Grüne Äpfel

Die Eingabe dazu war:

1. Äpfel
   - Gelbe Äpfel
   - Rote Äpfel
   - Grüne Äpfel

3.5   Verbatim-Text

Häufig müssen Sie in der Informatik Textabschnitte 1:1 ohne Formatierung wiedergeben, man nennt diese Abschnitte auch verbatim text bzw. literal text. Im einfachsten Fall schreiben Sie das in reST so (die Leerzeile nach :: ist wichtig!):

::

  Zeile 1
  Zeile 2
  Zeile 3

Die Ausgabe ist:

Zeile 1
Zeile 2
Zeile 3

Falls der Verbatim-Block in einer bestimmten Programmiersprache verfasst ist, wählen Sie folgende Formatierung:

.. code:: c

   int main()
   {
       printf("Hallo Leute!\n");
       return 0;
   }

Die Ausgabe ist:

int main()
{
    printf("Hallo Leute!\n");
    return 0;
}

Statt dem kleinen c (Sprache C) können Sie viele weitere Sprachen wählen, z.B. python, asm, shell und java, eine Liste ist hier: http://pygments.org/languages/.

Python:

import matplotlib.pyplot as plt
import matplotlib as mpl
import numpy as np

x = np.linspace(0, 40, 100)
plt.plot(x, np.sin(x))
plt.show()

GNU Assembler (gas):

 5 add_one:           # Funktion add_one
 6    pushl   %ebp
 7    movl    %esp, %ebp
 8    subl    $4, %esp
 9    movl    8(%ebp), %eax
10    addl    $1, %eax
11    movl    %eax, -4(%ebp)
12    movl    %ebp, %esp
13    popl    %ebp
14    ret

Shell:

# if running bash
if [ -n "$BASH_VERSION" ]; then
  # include .bashrc if it exists
  if [ -f "$HOME/.bashrc" ]; then
      . "$HOME/.bashrc"
  fi
fi

export PATH=$PATH:/opt/Python-3.7.0/bin/
export PATH=/opt/gcc-arm-none-eabi-7-2018-q2-update/bin:$PATH
export PATH=/snap/bin:$PATH

Konsole:

rst2html.py --generator --source-link --language=de  uebungen-mit-rst.rst uebungen-mit-rst.html

Bilder kann man auch einfach einbinden. Die Formatierung lautet

.. figure:: hsa-logo.jpg
   :scale: 30%
   :target: http://www.hs-augsburg.de
   :align: center

   Das HS-A Logo. Durch Klicken auf das Bild gelangt
   man zur Website.

Die Ausgabe ist:

Das HS-A Logo. Durch Klicken auf das Bild gelangt man zur Website.

Man kann auch zwei Bilder nebeneinander setzen:

Das kann man mit folgendem Rohtext erzielen:

.. class:: center

   |f1| |f1|

 .. |f1| image:: frog.jpg

Powered by (man kann auf das Logo klicken). Die nötigen Definitionen dazu sind hier:

.. |Python| image:: python-snake.png
   :alt: Python Logo
   :align: middle
   :class: borderless
   :width: 193
   :height: 32

.. _Python: http://www.python.org

3.6   Fussnoten

Fussnoten [1] kann man auch schreiben.

3.7   Tabellen

Die folgenden Beispiele habe ich aus den "reStructuredText Directives" entnommen:

http://docutils.sourceforge.net/docs/ref/rst/directives.html

Das erste Beispiel ist eine "CSV Tabelle":

Der Rohtext sieht so aus:

.. csv-table:: Frozen Delights!
   :header: "Treat", "Quantity", "Description"
   :widths: 15, 10, 30

   "Albatross", 2.99, "On a stick!"
   "Crunchy Frog", 1.49, "If we took the bones out, it wouldn't be
   crunchy, now would it?"
   "Gannet Ripple", 1.99, "On a stick!"

Das zweite Beispiel ist eine "List-Table", sie sieht im Ergebnis genau so aus wie die erste Tabelle, besteht jedoch aus verschachtelten Aufzählungspunkten:

Der Rohtext dazu sieht so aus:

.. list-table:: Frozen Delights!
   :widths: 15 10 30
   :header-rows: 1

   * - Treat
     - Quantity
     - Description
   * - Albatross
     - 2.99
     - On a stick!
   * - Crunchy Frog
     - 1.49
     - If we took the bones out, it wouldn't be
       crunchy, now would it?
   * - Gannet Ripple
     - 1.99
     - On a stick!

3.8   Inhaltsverzeichnis

Möchte man ein Inhaltsverzeichnis haben (wie in dieser Datei am Anfang), verwendet man die beiden Zeilen

.. contents:: Inhalt
.. sectnum::

3.9   Boxen

Es gibt eine Reihe von gerahmten Ausgaben, die im Englischen als admonitions bezeichnet werden. Folgende Typen werden unterschieden: "attention", "caution", "danger", "error", "hint", "important", "note", "tip", "warning", "admonition".

Wenn man die --language=de Option bei rst2html gibt, werden die Typen ins Deutsche übersetzt.

Aus dem Rohtext ...

.. hint::
   Dieser Text dient als "Schnellstarter" zum Schreiben von Lösungen für
   die Übungsaufgaben in meinen Fächern.

   Viele Grüsse,

   Hubert Högl (<Hubert.Hoegl@hs-augsburg.de>)

... wird dann diese Ausgabe:

3.10   Formeln

Formeln schreibt man wie in Latex:

.. math::

    A \Longrightarrow B

    E = m \cdot c^{2}

    \frac{2 \pm \sqrt{7}}{3}

    α_t(i) = P(O_1, O_2, … O_t, q_t = S_i λ)

Hier ist die Ausgabe:

Es funktioniert auch innerhalb einer Zeile: ψ(r) = exp( − 2r), √(x² − 1), (1)/(2), ⎛⎝(1)/(2)⎞⎠ⁿ