From bf87cbfd5e83bd1254dd6ed05a5e32eb40b3ed31 Mon Sep 17 00:00:00 2001
From: Mark Hall <mark.hall@work.room3b.eu>
Date: Tue, 10 Dec 2019 12:59:05 +0000
Subject: [PATCH] Updated docs
---
CHANGES.md | 2 ++
docs/processes.rst | 23 +++++++++++++++++++++++
2 files changed, 25 insertions(+)
diff --git a/CHANGES.md b/CHANGES.md
index bfb8c84..bf91410 100644
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -2,6 +2,8 @@
## Development ():
+* **Update**: Updated the documentation
+
## 0.8.12 (10.12.2019):
* **Bugfix**: Updated the TEI editor dependency
diff --git a/docs/processes.rst b/docs/processes.rst
index 524061e..949c2e3 100644
--- a/docs/processes.rst
+++ b/docs/processes.rst
@@ -7,6 +7,20 @@ Edition ermöglicht und gleichzeitig ein permanentes Backup bereitstellt. In die
Benutzer_in eine eigene Kopie aller Daten. Zusätzlich gibt es noch eine primäre Kopie, aus welcher die Webseite dann
generiert wird. Damit die Arbeit so reibungslos wie möglich ist, müssen ein paar Abläufe befolgt werden.
+Globaler Ablauf
+===============
+
+Die folgenden drei Schritte definieren den globalen Ablauf der Bearbeitung der Ausgabe:
+
+#. :ref:`Eine Session anfangen <process-begin-session>`.
+#. :ref:`Eine Datei bearbeiten <process-edit-file>`. Dieser Schritt kann wiederholt für verschiedene Dateien ausgeführt werden.
+#. :ref:`Die Session beenden <process-end-session>`.
+
+Wenn ein Block an Änderungen abgeschlossen ist, dann kann :ref:`die Integration der Änderungen beantragt <process-integrate-changes>`
+werden.
+
+.. _process-begin-session:
+
Anfang einer Session
====================
@@ -19,6 +33,8 @@ Am Anfang einer neuen Session sind folgende Schritte auszuführen:
und die_der Benutzer_in **muss** die Änderungen in die eigene Kopie übernehmen. Bevor dies nicht durchgeführt wurde
können keine Dateien bearbeitet werden.
+.. _process-edit-file:
+
Eine Datei bearbeiten
=====================
@@ -31,6 +47,11 @@ Um eine Datei zu bearbeiten, folgen sie diesen Schritten:
Details zur nutzung des Texteditors finden sie :doc:`hier <editor/index>`.
+Schritte 2 und 3 können wiederholt ausgeführt werden. Insbesondere über den "Dateien" Icon kann man immer schnell zur
+Liste der zu bearbeitenden Dateien kommen.
+
+.. _process-end-session:
+
Ende einer Session
==================
@@ -40,6 +61,8 @@ verloren gehen:
#. Zur Edition zurückkehren, in diesem Fall durch Auswählen der "Gutzow Digitale Gesamtausgabe" in der Menüzeile.
#. Ihre Änderungen werden automatisch mit dem Backup synchronisiert.
+.. _process-integrate-changes:
+
Integration in die primäre Kopie
================================
--
GitLab