diff --git a/Documentation/Datei-importieren.md b/Documentation/Datei-importieren.md index 400ec56..2d15d17 100644 --- a/Documentation/Datei-importieren.md +++ b/Documentation/Datei-importieren.md @@ -49,7 +49,7 @@ python manage.py import-document Documentation/import\ formats/r009.txt \ ### Dry-Run Modus -Der Dry-Run Modus ist besonders nützlich zum Testen: +Der Dry-Run Modus ist zum Testen gedacht: ```bash python manage.py import-document r009.txt \ @@ -73,7 +73,7 @@ python manage.py import-document r009.txt \ --purge ``` -Nutzen Sie `--dry-run --purge` zuerst, um zu sehen, was gelöscht würde. +Mit `--dry-run --purge` kann zuerst geprüft werden, was gelöscht würde. ## Dateiformat @@ -257,7 +257,7 @@ Abschliessender Text nach der Liste. >>>Vorgabe [Thema] ``` -Das Thema muss in der Datenbank bereits als `Thema`-Objekt existieren. Übliche Themen: +Das Thema muss in der Datenbank bereits als `Thema`-Objekt existieren. Die bestehenden Themen sind - wie in den bestehenden Standards - aus dem IT-Grundschutz übernommen: - Organisation - Technik - Informationen @@ -275,11 +275,7 @@ Das Thema muss in der Datenbank bereits als `Thema`-Objekt existieren. Übliche oder inline: -``` ->>>Nummer: 1 -``` - -Die Nummer wird als Integer gespeichert. Sie ist eindeutig innerhalb eines Dokuments und Themas. +Die Nummer wird als Integer gespeichert. Sie ist nicht eindeutig innerhalb eines Dokuments und Themas. Wenn mehrere Vorgaben im selben Thema mit der selben Nummer vorkommen, darf sich der Geltungszeitraum der Vorgaben nicht überschneiden (wird beim Import geprüft). #### Titel (Pflicht) @@ -322,14 +318,6 @@ Komma-getrennte Liste: Firewall, Netzwerk, Sicherheit ``` -oder als Block: - -``` ->>>Stichworte ->>>Text -Firewall, Netzwerk, Sicherheit -``` - **Hinweis:** Stichworte werden automatisch in der Datenbank angelegt, falls sie noch nicht existieren. #### Checkliste (Optional) @@ -347,7 +335,7 @@ Jede Zeile wird als separate Checklistenfrage gespeichert. ### 1. Dry-Run vor Import -Führen Sie immer zuerst einen Dry-Run durch: +Immer zuerst einen Dry-Run durchführen: ```bash python manage.py import-document datei.txt \ @@ -359,7 +347,7 @@ python manage.py import-document datei.txt \ ### 2. Themen vorab erstellen -Stellen Sie sicher, dass alle verwendeten Themen in der Datenbank existieren: +Sicherstellen, dass alle verwendeten Themen in der Datenbank existieren: ```python python manage.py shell @@ -391,11 +379,11 @@ Folgende Abschnitttypen müssen in der Datenbank existieren: - `code` - `diagramm` -Prüfen Sie diese in der Autorenumgebung unter "Abschnitttypen". +Prüfen in der Autorenumgebung unter "Abschnitttypen". ### 5. UTF-8 Kodierung -Stellen Sie sicher, dass Ihre Importdatei UTF-8 kodiert ist, besonders bei Umlauten (ä, ö, ü) und Sonderzeichen. +Sicherstellen, dass die Importdatei UTF-8 kodiert ist, besonders bei Umlauten (ä, ö, ü) und Sonderzeichen. ### 6. Versionierung mit Purge @@ -436,37 +424,37 @@ Leerzeilen innerhalb eines Abschnitts werden beibehalten. Eine Leerzeile nach ei Der angegebene Dokumententyp existiert nicht in der Datenbank. -**Lösung:** Erstellen Sie den Dokumententyp in der Autorenumgebung oder per Shell. +**Lösung:** Dokumententyp aus dem IT-Grundschutz verwenden, nötigenfalls hinzufügen in der Autorenumgebung oder per Shell. ### "Thema not found, skipping Vorgabe" Das in der Vorgabe verwendete Thema existiert nicht. -**Lösung:** Erstellen Sie das Thema in der Autorenumgebung oder passen Sie die Importdatei an. +**Lösung:** Thema in der Autorenumgebung erstellen oder Importdatei anpassen. ### "AbschnittTyp not found" Ein verwendeter Abschnitttyp existiert nicht. **Lösung:** -- Prüfen Sie die Schreibweise (Gross-/Kleinschreibung wird normalisiert) -- Erstellen Sie den Abschnitttyp in der Autorenumgebung -- Standardtypen: `text`, `liste geordnet`, `liste ungeordnet` +- Schreibweise prüfen (Gross-/Kleinschreibung und "-"/" " wird normalisiert) +- Wenn nötig Abschnitttyp in der Autorenumgebung erstellen (Achtung! Ausgabeformat muss im Code definiert werden) +- Standardtypen: `text`, `liste geordnet`, `liste ungeordnet`, `tabelle`, `code` ### Vorgabe wird nicht importiert -Prüfen Sie: +Prüfen: - Ist `>>>Nummer` gesetzt? - Ist `>>>Titel` gesetzt? - Existiert das Thema? -Verwenden Sie `--dry-run --verbose` für detaillierte Informationen. +`--dry-run --verbose` für detaillierte Informationen. ## Weitere Informationen ### Beispieldateien -Beispieldateien finden Sie in: +Beispieldateien: - `Documentation/import formats/r009.txt` - `Documentation/import formats/r0126.txt` @@ -485,7 +473,3 @@ Oder über die Web-Oberfläche: `/dokumente/R0066/?format=json` - `export_json` - Exportiert Dokumente als JSON - `sanity_check_vorgaben` - Prüft Vorgaben auf Konflikte - `clear_diagram_cache` - Löscht Diagramm-Cache - -## Kontakt - -Bei Fragen oder Problemen wenden Sie sich an das Information Security Management BIT.