Wichtig

Übersetzen ist eine Gemeinschaftsarbeit Sie können mitmachen 1. Diese Seite befindet sich derzeit im |Übersetzungsfortschritt|.

19. Anhang: Mitwirken an diesem Handbuch

Um Materialien zu diesem Kurs hinzuzufügen, müssen Sie die Richtlinien in diesem Anhang befolgen. Es ist Ihnen nicht gestattet, die Bedingungen in diesem Anhang, außer zur Klarstellung, zu ändern. Damit soll sichergestellt werden, dass die Qualität und Konsistenz dieses Handbuchs aufrechterhalten werden können.

19.1. Ressourcen herunterladen

Die Quelle dieses Dokuments ist auf GitHub <https://github.com/qgis/QGIS-Documentation>`_ verfügbar. Unter GitHub.com <https://github.com/>`_ finden Sie Anweisungen zur Verwendung des Git-Versionskontrollsystems.

19.2. Handbuch-Format

Dieses Handbuch wurde mit Sphinx <https://www.sphinx-doc.org/en/master/>`_ geschrieben. Ein Python-Dokumentgenerator, der die Auszeichnungssprache reStructuredText verwendet. Anweisungen zur Verwendung dieser Tools finden Sie auf den jeweiligen Websites.

19.3. Hinzufügen eines Moduls

Um ein neues Modul hinzuzufügen:

  1. Legen Sie zunächst ein neues Verzeichnis (direkt unter der obersten Ebene des qgis-training-manual -Verzeichnisses) mit dem Namen des neuen Moduls an.

  2. Erstellen Sie in diesem neuen Verzeichnis eine Datei mit dem Namen index.rst. Lassen Sie diese Datei vorerst leer.

  3. Öffnen Sie die index.rst-Datei im Verzeichnis der obersten Ebene. Die ersten Zeilen lauten:

    .. toctree::
   :maxdepth: 2

   foreword/index
   introduction/index

Sie werden feststellen, dass es sich hierbei um eine Liste von Verzeichnisnamen handelt, gefolgt vom Namen index. Dadurch wird die Indexdatei der obersten Ebene an die Indexdateien in den einzelnen Verzeichnissen weitergeleitet. Die Reihenfolge, in der sie aufgelistet werden, bestimmt die Reihenfolge, in der sie im Dokument angezeigt werden.

  1. Fügen Sie den Namen Ihres neuen Moduls hinzu (d. h. den Namen, den Sie dem neuen Verzeichnis gegeben haben), gefolgt von ``/index` an der Stelle hinzu`, an der Ihr Modul angezeigt werden soll.

  2. Denken Sie daran, die Reihenfolge der Module logisch zu halten, damit spätere Module auf dem Wissen aufgebaut werden können, das in früheren Modulen vermittelt wurde.

  3. Öffnen Sie die eigene Indexdatei (module_name/index.rst) Ihres neuen Moduls.

  4. Erstellen Sie oben auf der Seite die Modulüberschrift:

    1. Schreiben Sie eine erste Zeile mit Sternchen (*).

    2. Es folgt eine Zeile, die die Auszeichnungsphrase Module:, gefolgt vom Namen Ihres Moduls enthält.

    3. Zum Schluß eine weitere Zeile mit der gleichen Anzahl von Sternchen (*).

    Bemerkung

    Die Unterstreichung und die Überstreichung sollten nicht kürzer sein als die Zeile mit dem Modultitel.

  5. Lassen Sie darunter eine Zeile leer.

  6. Schreiben Sie einen kurzen Absatz, in dem Sie den Zweck und den Inhalt des Moduls erläutern.

  7. Lassen Sie darunter wieder eine Zeile leer. Danach fügen Sie folgenden Text hinzu:

    .. toctree::
   :maxdepth: 2

   lesson1
   lesson2

    … wobei lesson1, lesson2, usw. die Namen Ihrer geplanten Lektionen sind.

Die Indexdatei auf Modulebene sieht dann folgendermaßen aus:

*******************************************************************************
Module: Module Name
*******************************************************************************

Short paragraph describing the module.

.. toctree::
   :maxdepth: 2

   lesson1
   lesson2

19.4. Hinzufügen einer Lektion

So fügen Sie eine Lektion zu einem neuen oder vorhandenen Modul hinzu:

  1. Öffnen Sie das Modulverzeichnis.

  2. Öffnen Sie die index.rst-Datei (die oben bei neuen Modulen erstellt wurde).

  3. Stellen Sie sicher, dass der Name der geplanten Lektion unter der Anweisung toctree aufgeführt ist, wie oben gezeigt.

  4. Erstellen Sie eine neue Datei unter dem Modulverzeichnis.

  5. Benennen Sie diese Datei mit exakt dem Namen, den Sie in der Datei des Moduls angegeben haben, und fügen Sie die Erweiterung :file:`.rst hinzu.

Bemerkung

Beim Bearben funktioniert eine .rst-Datei genau wie eine normale Datei Textdatei (.txt).

  1. Um mit dem Schreiben der Lektion zu beginnen, schreiben Sie die Markup-Phrase Lesson, gefolgt vom Namen der Lektion.

  2. Schreibe in die nächste Zeile eine Linie mit Gleichheitszeichen (=), die nicht kürzer als der Titel der Lektion ist.

  3. Lassen Sie danach eine Zeile leer.

  4. Schreiben Sie eine kurze Beschreibung des Inhalts der Lektion.

  5. Fügen Sie eine allgemeine Einführung in das Thema hinzu. Beispiele finden Sie in den vorhandenen Lektionen in diesem Handbuch.

  6. Beginnen Sie darunter einen neuen Absatz, der mit diesem Satz beginnt:

    **The goal for this lesson:**

  7. Erläutern Sie kurz das beabsichtigte Ergebnis dieser Lektion.

  8. Wenn Sie das Ziel der Lektion nicht in ein oder zwei Sätzen beschreiben können, erwägen SIe, den Stoff in mehrere Lektionen aufzuteilen.

Jede Lektion wird in mehrere Abschnitte unterteilt, die im Folgenden behandelt werden.

19.5. Hinzufügen eines Abschnitts

Es gibt zwei Arten von Abschnitten: „Mach mit“ und „Selbst ausprobieren“.

  • Ein „Mach mit“-Abschnitt ist eine detaillierte Reihe von Anweisungen, die dem Leser zeigt, wie man einen bestimmten Aspekt von QGIS verwendet. Dies geschieht in der Regel durch klare Klick-für-Klick-Anweisungen, durchsetzt mit Screenshots.

  • Ein Abschnitt „Selbst ausprobieren“ gibt dem Leser eine kurze Aufgabe zum Selbst-Ausprobieren. Es ist in der Regel mit einem Eintrag im Antwortfeld darunter verbunden, der zeigt oder erklärt, wie die Aufgabe zu erledigen ist und nach Möglichkeit das erwartete Ergebnis anzeigt.

Jeder Abschnitt hat einen Schwierigkeitsgrad. Ein leichter Abschnitt wird mit ★☆☆, ein moderater durch ★★☆ und ein fortgeschrittener mit ★★★ gekennzeichnet.

19.5.1. Hinzufügen eines „Mach mit“-Abschnitts

  1. Um diesen Abschnitt zu beginnen, schreiben Sie die Markup-Phrase der beabsichtigten Schwierigkeit (wie oben gezeigt).

  2. Lassen Sie ein Leerzeichen und schreiben Sie dann Mach mit:.

  3. Lassen Sie ein weiteres Leerzeichen und schreiben Sie den Namen des Abschnitts (verwenden Sie nur einen Anfangs-Großbuchstaben sowie Großbuchstaben für Eigennamen).

  4. Schreiben Sie in der nächsten Zeile eine Linie mit Minuspunkten/Bindestrichen (-), die nicht kürzer als der Abschnittstitel ist.

  5. Schreiben Sie eine kurze Einleitung zu dem Abschnitt, in der Sie seinen Zweck erklären. Geben Sie dann eine detaillierte (Klick-für-Klick) Anleitung zu dem Verfahren, das demonstriert werden soll.

  6. Fügen Sie in jeden Abschnitt nach Bedarf interne Links, externe Links und Screenshots ein.

  7. Versuchen Sie, jeden Abschnitt mit einem kurzen Absatz zu beenden, der ihn abschließt und natürlich, wenn möglich, zum nächsten Abschnitt führt.

19.5.2. Hinzufügen eines „Selbst ausprobieren“-Abschnitts

  1. Um diesen Abschnitt zu beginnen, schreiben Sie die Markup-Phrase der beabsichtigten Schwierigkeit (wie oben gezeigt).

  2. Um diesen Abschnitt zu beginnen, schreiben Sie die Markup-Phrase der beabsichtigten Schwierigkeit (wie oben gezeigt). Lassen Sie ein Leerzeichen und schreiben Sie dann Selbst ausprobieren:.

  3. Schreiben Sie in der nächsten Zeile eine Linie mit Minuspunkten/Bindestrichen (-), die nicht kürzer als der Abschnittstitel ist.

  4. Schreiben Sie in der nächsten Zeile eine Linie mit Minuspunkten/Bindestrichen (-), die nicht kürzer als der Abschnittstitel ist. Erklären Sie die Übung, die der Leser abschließen soll. Beziehen Sie sich bei Bedarf auf vorherige Abschnitte, Lektionen oder Module.

  5. Fügen Sie Screenshots hinzu, um etwas zu verdeutlichen, wenn die Beschreibung im Text nicht ganz eindeutig ist.

In den meisten Fällen möchten Sie eine Antwort darauf geben, wie die Aufgabe in diesem Abschnitt gelöst werden kann. Dazu müssen Sie einen Antwortblock erstellen und unter den Anweisungen einfügen.

  1. Erstellen Sie zunächst das entsprechende einklappbare Widget, das die Antwort enthält:

    .. admonition:: Answer
   :class: dropdown

  2. Halten Sie eine Einrückung in Bezug auf den obigen Block aufrecht und schreiben Sie die Anweisungen darüber, wie die Aufgabe erledigt werden soll. Fügen Sie bei Bedarf Links und Bilder ein.

19.6. Fügen Sie eine Zusammenfassung hinzu

So beenden Sie eine Lektion:

  1. Schreiben Sie Zusammenfassung, gefolgt von einer neuen Zeile mit Minuspunkten/Bindestrichen (-).

  2. Schreiben Sie eine Zusammenfassung für die Lektion, in der Sie erklären, welche Konzepte in der Lektion behandelt wurden.

19.7. Einen Abschnitt mit weiterführender Literatur hinzufügen

Dieser Abschnitt ist optional.

  • Schreiben Sie Weiterführende Literatur, gefolgt von einer neuen Zeile von Minuspunkten/Bindestrichen (-).

  • Fügen Sie entsprechende Links zu externen Websites hinzu.

19.8. Füge einen Abschnitt „Was kommt als Nächstes“ hinzu

  1. Schreiben Sie den Satz Was kommt als Nächstes, gefolgt von einer neuen Zeile mit Minuspunkten/Bindestrichen (-).

  2. Erklären Sie, wie diese Lektion die Schüler auf die nächste Lektion oder das nächste Modul vorbereitet hat.

  3. Denken Sie daran, den Abschnitt „Was kommt als nächstes“ der vorherigen Lektion zu ändern, falls erforderlich. sodass es sich auf Ihre neue Lektion bezieht. Dies ist notwendig, wenn Sie eine neue Lektion unter den bestehenden Lektionen oder nach einer bestehenden Lektion eingefügt haben.

19.9. Markup verwenden

Um die Standards dieses Dokuments einzuhalten, müssen Sie den Standard Markup zu Ihrem Text hinzufügen.

19.9.1. Neue Konzepte

Wenn Sie ein neues Konzept erklären, müssen Sie den neuen Konzept-Namen in Kursivschrift schreiben, indem Sie ihn in Sternchen (*) einschließen.

This sample text shows how to introduce a *new concept*.

19.9.2. Hervorhebung

  • Um einen entscheidenden Begriff hervorzuheben, der kein neues Konzept ist, schreiben Sie den Begriff in Fett, indem Sie ihn in doppelte Sternchen (**) einschließen.

  • Gehen Sie sparsam damit um! Wenn diese Hervorhebungen zu viel verwendet werden, kann es für den Leser so aussehen, als ob Sie schreien oder herablassend sind.

This sample text shows how to use **emphasis** in a sentence. Include the
punctuation mark if it is followed by a **comma,** or at the **end of the
sentence.**

19.9.3. Bilder

  • Wenn Sie ein Bild hinzufügen, speichern Sie es in einem img -Ordner neben der Lektionsdatei.

  • Fügen Sie es wie folgt in das Dokument ein:

    .. figure:: img/image_file.extension
   :align: center

  • Denken Sie daran, eine Linie über und unter dem Bildmarkup freizulassen.

19.9.6. Verwenden von Text mit festem Zeilenabstand

  • Wenn Sie einen Text schreiben, den der Benutzer eingeben muss - ein Pfadname oder der Name eines Datenbankelements wie z. B. eines Tabellen- oder Spaltennamens - müssen Sie ihn in ``Text mit festem Zeilenabstand` schreiben. Zum Beispiel:

    Enter the following path in the text box: ``path/to/file``.

19.9.7. Beschriften von GUI-Elementen

  • Wenn Sie sich auf ein GUI-Element beziehen, z. B. eine Schaltfläche, müssen Sie dessen Namen im :guilabel:` GUI-Label-Format` eingeben. Zum Beispiel:

    To access this tool, click on the :guilabel:`Tool Name` button.

  • Dies gilt auch, wenn Sie den Namen eines Werkzeugs nennen, ohne dass Sie den Nutzer auffordern, darauf zu klicken.

19.9.9. Hinzufügen von Notizen

  • Möglicherweise müssen Sie dem Text eine Notiz hinzufügen, in der zusätzliche Details erläutert werden, die nicht leicht in den Ablauf der Lektion eingebunden werden können. Dies ist das Markup:

    [Normal paragraph.]

.. note:: Note text.
  New line within note.

  New paragraph within note.

[Unindented text resumes normal paragraph.]

19.9.10. Hinzufügen einer Sponsoring-/Autorennotiz

Wenn Sie ein neues Modul, eine neue Lektion oder einen neuen Abschnitt im Auftrag eines Sponsors schreiben, müssen diese eine kurze Sponsorennachricht deren Wahl enthalten. Diese muss den Namens des Sponsors beinhalten und muss unter der Überschrift des Moduls, der Lektion oder des Abschnitts stehen. Es soll sich jedoch nicht um eine Werbung für deren Unternehmen handeln.

Wenn Sie sich selbst freiwillig bereit erklärt haben, ein Modul, eine Lektion oder einen Abschnitt zu schreiben und nicht im Namen eines Sponsors, können Sie einen Autorenvermerk unter der Überschrift des Moduls, der Lektion oder des Abschnitts einfügen, den Sie verfasst haben. Dies muss die Form Diese(s) [Modul/Lektion/Abschnitt] beigetragen von [Autorenname]. haben. Fügen Sie keinen weiteren Text, keine Kontaktdaten usw. hinzu. Solche Einzelheiten sind in im Abschnitt „Mitwirkende“ des Vorworts, zusammen mit dem/den Namen(n) des Teil(e), die Sie hinzugefügt haben. Wenn Sie lediglich Erweiterungen, Korrekturen und/oder Ergänzungen vorgenommen haben, tragen Sie sich selbst als Editor ein.

19.10. Vielen Dank!

Vielen Dank, dass Sie zu diesem Projekt beigetragen haben! Auf diese Weise machen Sie QGIS für Benutzer zugänglicher und schaffen einen Mehrwert für das ganze QGIS-Projekt.