data2check-Dokumentation – Ein Word-Dokument prüfen

1. Eine Prüfkonfiguration erstellen

Unter dem Menüpunkt »Konfiguration« können Sie Prüfkonfigurationen erstellen (siehe Abb. 1).

Unter »Konfiguration« eine Prüfkonfiguration erstellen

Abbildung 1: Unter »Konfiguration« eine Prüfkonfiguration erstellen

Damit Sie ein Dokument nach Ihren Kriterien prüfen können, müssen Sie zuallererst eine Konfiguration erstellen. Dafür benötigen Sie eine Vorlage-Datei, in der alle für Ihr Projekt erforderlichen Formatvorlagen (Microsoft Word) mindestens einmal verwendet wurden. Dieses Dokument dient als Grundlage für die Prüfkonfiguration.

Sie laden diese Vorlage-Datei hier hoch und erstellen anschließend eine entsprechende Konfiguration.

Mit Klick auf den Button »Datei auswählen« (siehe Abb. 2) gelangen Sie in Ihren Dateimanager, wo Sie eine Vorlage-Datei auswählen (siehe Abb. 3). Diese Datei dient als Basis für die Konfiguration, die neu erstellt werden soll.

ACHTUNG: Alle Formate der hochzuladenden Dateien müssen unbedingt XML-kompatibel sein, das heißt bitte nur Dateien mit der Endung .docx für Microsoft Word hochladen!

Upload einer Vorlage-Datei - »Datei auswählen« klicken, um Dateimanager zu öffnen

Abbildung 2: Upload einer Vorlage-Datei - Schritt 1: »Datei auswählen« klicken, um den Dateimanager zu öffnen

Upload einer Vorlage-Datei - Eine .docx-Datei auswählen

Abbildung 3: Upload einer Vorlage-Datei - Schritt 2: .docx-Datei auswählen

Nach Auswahl der Datei per Doppelklick erscheint der Name der ausgewählten Datei im Feld daneben (vorher war hier »Keine Datei ausgewählt.« zu lesen). Klicken Sie nun auf die grüne Schaltfläche »Beispieldatei hochladen« (siehe Abb. 4).

Upload einer Vorlage-Datei - Ausgewählte Datei hochladen

Abbildung 4: Upload einer Vorlage-Datei - Schritt 3: Ausgewählte Datei hochladen

Während des Hochladens sehen Sie einen grünen Balken, der den Fortschritt des Uploads anzeigt (siehe Abb. 5). Dieser Prozess kann einige Sekunden dauern.

Grüner Balken beim Datei-Upload

Abbildung 5: Grüner Balken beim Datei-Upload

Nach erfolgreichem Hochladen der Vorlage-Datei gelangen Sie in die "Konfigurations-Verwaltung" (rechte Spalte), wo Sie Ihre Konfiguration(en) bearbeiten können (siehe Abb. 6). Dazu mehr unter 2. Eine Prüfkonfiguration bearbeiten.

Die Konfigurations-Verwaltung

Abbildung 6: Die Konfigurations-Verwaltung

Unter »Verfügbare Prüfkonfigurationen:« (linke Spalte) werden die verfügbaren Konfigurationen angezeigt. In unserem Beispiel-Fall gibt es erstmal nur eine: DOCX - Neue Prüfung für 010101pos.docx (siehe Abb. 7).

Verfügbare Konfiguration nach Upload der Beispiel-Vorlage-Datei

Abbildung 7: Die verfügbare Konfiguration nach Upload der Beispiel-Vorlage-Datei

Falls Sie bereits mehrere Konfigurationen erstellt haben, werden Ihnen in dieser Dropdown-Liste alle angezeigt; die jeweils gerade aktuelle mit einem Häkchen (siehe Abb. 8).

Aktuelle Konfiguration mit Häkchen

Abbildung 8: Die aktuelle Konfiguration erkennt man an dem Häkchen

Die ausgewählte Vorlage-Datei wurde erfolgreich analysiert. Nun kann die neu angelegte Prüfkonfiguration bearbeitet werden.

Auf die Bestandteile und Möglichkeiten der Konfigurations-Bearbeitung wird im folgenden Abschnitt genauer eingegangen.

2. Eine Prüfkonfiguration bearbeiten

Unter dem Menüpunkt »Konfiguration« kann eine vorher erstellte Prüfkonfiguration auch bearbeitet werden. Dies geschieht in der bereits erwähnten "Konfigurations-Verwaltung" (siehe Abb. 6).

Die Konfigurations-Verwaltung besteht aus den folgenden Reitern:

  • Konfigurations-Info
  • Regeln für den Dokumentaufbau
  • Suche-/Ersetze-Regeln
  • Komponenten
  • XML-Transformation

Bevor Sie die Konfiguration nach Ihren Wünschen anpassen können, müssen Sie in der Dropdown-Liste unter »Verfügbare Prüfkonfigurationen:« (linke Spalte) eine zu bearbeitende Prüfkonfiguration auswählen (siehe auch Abb. 8).

2.1 Die Konfigurations-Info

Im Reiter Konfigurations-Info unter dem Menüpunkt »Konfiguration« können allgemeine Einstellungen für eine Prüfkonfiguration vorgenommen werden (siehe Abb. 9).

Einstellungen im Reiter »Konfigurations-Info«

Abbildung 9: Mögliche Einstellungen im Reiter »Konfigurations-Info«

Hier kann die erstellte Prüfkonfiguration umbenannt (Eingabefeld »Name der Konfiguration«) und genauer beschrieben werden (Eingabefeld »Beschreibung«). Zum einen können Sie so die Konfiguration besser einem Projekt zuordnen und zum anderen kann die Konfiguration später besser wiedergefunden werden, falls Sie mehrere Prüfkonfigurationen erstellen wollen.

ANMERKUNG: Der Default-Name einer neu angelegten Prüfkonfiguration besteht aus den Worten "Neue Prüfung für" plus den Namen der hochgeladenen Datei (inklusive des Datei-Formats). Im Eingabefeld »Beschreibung« steht defaultmäßig der Satz "Dieser Workflow basiert auf der Datei [Name der Vorlage-Datei].". Sie können die Default-Texte in beiden Eingabe-Feldern hinauslöschen und andere eintragen (siehe Abb. 10).

Änderung des Konfigurationsnamens zu Test-Konfiguration1.docx

Abbildung 10: Änderung des Konfigurationsnamens zu "Test-Konfiguration1.docx"

TIPP: Falls Sie auch Prüfkonfigurationen für Adobe InDesign erstellen, belassen Sie die Datei-Endung .docx im Namen der Word-Konfigurationen und andersherum, damit es bei eventuell gleichen Dokumentnamen nicht zu Verwechslungen kommt.

Des Weiteren können vom "Gruppen-Verwalter" mehrere Nutzer und Verwalter angelegt und auch wieder gelöscht werden. Während Nutzer die Konfiguration nur zur Dokumentprüfung verwenden dürfen, können Verwalter auch Änderungen in der Konfiguration vornehmen oder diese löschen. Weitere Informationen zum "Gruppen"-Konzept bei data2check erhalten Sie unter Allgemeiner Teil: 2. Registrierung.

ACHTUNG: Nach dem Festlegen der allgemeinen Einstellungen das Speichern der Konfiguration nicht vergessen!

2.2 Eine Konfiguration speichern und löschen

Die vorgenommenen Einstellungen sollten am Seitenende mit Klick auf den Button »Konfiguration speichern« gesichert werden.

ACHTUNG: Speichern Sie Ihre Konfiguration immer, bevor Sie ein Dokument prüfen oder eine andere Konfiguration erstellen bzw. bearbeiten wollen!

Eine bereits erstellte Konfiguration können Sie mit Klick auf den Button »Konfiguration löschen« wieder löschen (siehe Abb. 11).

ACHTUNG: Die Konfiguration ist somit mitsamt allen Einstellungen endgültig gelöscht und muss danach erneut erstellt und eventuell neu bearbeitet werden, um sie in der alten Form wieder verwenden zu können!

Konfiguration speichern oder löschen

Abbildung 11: Eine Konfiguration speichern oder löschen

2.3 Regeln für den Dokumentaufbau

Im Reiter Regeln für den Dokumentaufbau unter dem Menüpunkt »Konfiguration« werden alle Formatvorlagen, die in der Word-Vorlage-Datei benutzt wurden, aufgelistet. Hier können Regeln für den Umgang mit diesen Formatvorlagen im Prüfdokument definiert werden.

Für jede Absatz-Formatvorlage lassen sich bestimmte Regeln definieren und bestimmte Beziehungen zwischen den Formatvorlagen erlauben oder verbieten. Beispielsweise lässt sich hier festlegen, ob eine Absatz-Formatvorlage den Rang einer Überschrift hat, welche Formatvorlagen als vorheriger Absatz erlaubt bzw. verboten und welche Zeichen-Formatvorlagen für eine Absatz-Formatvorlage erlaubt bzw. verboten sind.

2.3.1 Einstellungen für den ersten Absatz

Zuerst kann definiert werden, welche Formatvorlage der erste Absatz des zu prüfenden Dokuments haben soll (siehe Abb. 12). ACHTUNG: In diesem Zusammenhang ist nicht unbedingt der erste Absatz im Fließtext gemeint, sondern sozusagen das erste Auftreten von Text im Dokument überhaupt, was zum Beispiel auch der Text auf der Titelseite sein kann.

Formatvorlagen für ersten Absatz des Dokuments bestimmen

Abbildung 12: Formatvorlagen für den ersten Absatz des Dokuments bestimmen

Wenn Sie in die Dropdown-Liste klicken, werden Ihnen alle drei möglichen Optionen für diese Einstellung angezeigt. Wählen Sie eine davon aus:

  1. Keine Einschränkung: Für den ersten Absatz im zu prüfenden Dokument darf jede der vorhandenen Absatz-Formatvorlagen verwendet werden.
  2. darf nicht sein: Mit dieser Option können Sie in der folgenden Dropdown-Liste die Absatz-Formatvorlagen auswählen, die auf keinen Fall für den ersten Absatz im zu prüfenden Dokument verwendet werden sollen.
  3. muss aus dieser Liste sein: Mit dieser Option können Sie in der folgenden Dropdown-Liste die Absatz-Formatvorlagen auswählen, die für den ersten Absatz im zu prüfenden Dokument verwendet werden dürfen.

Unter Option 2 und 3 bereits ausgewählte Absatz-Formatvorlagen können mit dem Button »aus Liste entfernen« auch wieder aus der Auswahl gelöscht werden (siehe Abb. 13).

Ausgewählte Formatvorlage aus Liste entfernen

Abbildung 13: Ausgewählte Formatvorlage aus einer Liste entfernen

Außerdem können Sie in das Feld »Kommentar zu Beschränkungen des ersten Absatzes« einen individuellen Fehlerkommentar eintragen. Nach erfolgreicher Dokument-Prüfung, erscheint der hier festgelegte Kommentar am ersten Absatz im Word-Ausgabe-Dokument, falls das geprüfte Dokument gegen diese Regel verstößt (siehe Abb. 14).

Kommentar zum ersten Absatz im Word-Ausgabe-Dokument

Abbildung 14: Kommentar zum ersten Absatz im Word-Ausgabe-Dokument

2.3.2 Einstellungen für die Absatz-Formatvorlagen

Als nächstes wird jede einzelne in der Vorlage-Datei verwendete Absatz-Formatvorlage mit ihren Einstellungsmöglichkeiten einzeln aufgeführt (siehe Abb. 15 und die folgende Tabelle). Dabei ist der Name der jeweiligen Absatz-Formatvorlage fett hervorgehoben, z. B. "Absatz-Formatvorlage _liste1".

Absatz-Formatvorlagen mit den möglichen Einstellungen

Abbildung 15: Absatz-Formatvorlagen bei einer Word-Konfiguration mit den möglichen Einstellungen (beispielhafte Darstellung)

Tabelle: Die Absatz-Formatvorlagen mit ihren Einstellungsmöglichkeiten

Bestandteil Beschreibung/Optionen Beispiel
Absatz-Formatvorlage Name der betreffenden Absatz-Formatvorlage Heading 1
Funktion
  • Standard: Es handelt sich um einen normalen Absatz ohne Gliederungsfunktion (p).
  • Überschrift Ebene 1: Es handelt sich um eine Überschrift mit Gliederungsfunktion (h1).
    ACHTUNG: Die Nummerierung der Überschriften-Ebene wächst immer weiter mit, je nachdem, welche Ebene vorher für eine andere Absatz-Formatvorlage ausgewählt wurde! (Beispiel: für Absatz-Formatvorlage A wurde »Überschrift Ebene 2« zugewiesen, dann kann für Absatz-Formatvorlage B neben Überschrift Ebene 1 bis 2 auch Ebene 3 zugewiesen werden usw.)
Heading 1 hat die Überschriften-Ebene 1, ist also eine Überschrift 1. Ordnung.
Vorhergehender Absatz Hier können Sie auswählen, welche Absatz-Formatvorlagen für den jeweils vorherigen Absatz verwendet bzw. nicht verwendet werden dürfen. Dabei sind dieselben drei Optionen wie unter 2.3.1 Einstellungen für den ersten Absatz (Keine Einschränkung, darf nicht sein, muss aus dieser Liste sein) auswählbar. Der vorhergehende Absatz von Heading 1 darf nicht sein: para und Heading 2.
Kommentar zu Beschränkungen der vorhergehenden Absätze Die Einstellung hinsichtlich des vorhergehenden Absatzes kann hier kommentiert werden. Nach erfolgreicher Dokument-Prüfung, erscheint der hier festgelegte Kommentar am betreffenden Absatz im Word-Ausgabe-Dokument, falls das geprüfte Dokument gegen diese Regel verstößt (das Prinzip ist ähnlich wie bei Abb. 14). Vor Heading 1 dürfen para und Heading 2 nicht vorkommen!
Zeichen-Formatvorlagen Hier können Sie auswählen, welche Zeichen-Formatvorlagen (inzeilige Formate, zum Beispiel "kursiv" oder "fett") in der jeweiligen Absatz-Formatvorlage vorkommen dürfen und welche nicht. Dabei sind dieselben drei Optionen wie unter 2.3.1 Einstellungen für den ersten Absatz (Keine Einschränkung, darf nicht sein, muss aus dieser Liste sein) auswählbar. Eine erlaubte Zeichen-Formatvorlage muss aus dieser Liste sein: inzeilig1 und fette_hervorhebung.
Kommentar zu Beschränkungen der Zeichen-Formatvorlagen Die Einstellung hinsichtlich der erlaubten Zeichen-Formatvorlagen kann hier kommentiert werden. Nach erfolgreicher Dokument-Prüfung, erscheint der hier festgelegte Kommentar am betreffenden Absatz im Word-Ausgabe-Dokument, falls das geprüfte Dokument gegen diese Regel verstößt (das Prinzip ist ähnlich wie bei Abb. 14). In para dürfen nur inzeilig1 und fette_hervorhebung als inzeilige Formate vorkommen!

Nach den Absatz-Formatvorlagen werden der Vollständigkeit halber am Ende der Seite alle in der Vorlage-Datei benutzten Zeichen-Formatvorlagen aufgelistet (siehe Abb. 16).

In Vorlage-Datei verwendeten Zeichen-Formatvorlagen

Abbildung 16: Die in der Vorlage-Datei verwendeten Zeichen-Formatvorlagen (beispielhafte Darstellung)

ACHTUNG: Nach dem Definieren der Regeln für die Formatvorlagen das Speichern der Konfiguration nicht vergessen!

2.4 Suche-/Ersetze-Regeln

Im Reiter Suche-/Ersetze-Regeln unter dem Menüpunkt »Konfiguration« kann bezüglich der Mikrotypografie nach bestimmten im Prüfdokument vorkommenden Zeichenkombinationen gesucht werden, die dann entweder automatisch ersetzt und/oder als Kommentar im Word-Ausgabe-Dokument markiert werden. Bei der Suche kann zwischen regulären Ausdrücken und normaler String-Suche unterschieden werden. Beim Ersetzen kann optional die Änderungsnachverfolgung im Word-Ausgabe-Dokument eingeschaltet werden.

Sie können beliebig viele Suche-/Ersetze-Regeln für das zu prüfende Dokument anlegen. Klicken Sie für jede neue Regel auf den Button »Neue Regel hinzufügen« (siehe Abb. 17).

Eine neue Suche-/Ersetze-Regel erstellen

Abbildung 17: Eine neue Suche-/Ersetze-Regel erstellen

Nun erscheint eine Eingabemaske. Geben Sie Ihren Suchbegriff in das Feld »Suche nach« ein (siehe Abb. 18).

Suchbegriff eingeben

Abbildung 18: Einen Suchbegriff eingeben (Achtung: nur gültige Zeichen verwenden!)

TIPP: Sie können nach einzelnen Wörtern, (mehreren) Leerzeichen, Buchstabenkombinationen (zum Beispiel EUR), Abkürzungen (zum Beispiel d.h.), Wortgruppen und auch nach ganzen Sätzen suchen. Umbrüche können jedoch nur in Form von regulären Ausdrücken bei der Suche erfasst werden.

ACHTUNG: Das Feld »Suche nach« darf auf keinem Fall leer bleiden, da die Prüfkonfiguration sonst ungültig ist und nicht gespeichert werden kann! Falls Sie doch keine Suche-/Ersetze-Regel für die Konfiguration erstellen möchten, klicken Sie auf das kleine x auf der rechten Seite der Maske, um die Regel wieder zu löschen (siehe Abb. 19).

Eine Suche-/Ersetze-Regel löschen

Abbildung 19: Eine Suche-/Ersetze-Regel wieder löschen

Optional können Sie das Kontrollkästchen »Regulärer Ausdruck« aktivieren, falls Sie wünschen, dass der Suchstring als regulärer Ausdruck interpretiert wird (siehe Abb. 20).

Suchbegriff als regulären Ausdruck behandeln

Abbildung 20: Suchbegriff als regulären Ausdruck behandeln

Wenn Sie das Kontrollkästchen »Ersetzung durchführen« aktivieren, erscheint das Feld »Ersetze durch«, in das Sie Ihren Ersetzungs-String eingeben können (siehe Abb. 21).

Suchbegriff ersetzen

Abbildung 21: Den Suchbegriff ersetzen

TIPP: Sie können als Ersetzungs-String einzelne Wörter, (mehrere) Leerzeichen, Buchstabenkombinationen (zum Beispiel EUR), Abkürzungen (zum Beispiel d.h.), Wortgruppen und auch ganze Sätze eingeben. Umbrüche können jedoch nur in Form von regulären Ausdrücken bei der Suche erfasst werden. Außerdem darf dieses Feld auch leer bleiben. In diesem Fall würde der gesuchte String im Word-Ausgabe-Dokument gelöscht sein.

Wenn Sie eine Ersetzung durchführen wollen, haben Sie hier auch die Möglichkeit, diese in Ihrem Word-Ausgabe-Dokument besonders kenntlich zu machen. Zum einen können Sie das Kontrollkästchen »als Änderung markieren« aktivieren (siehe Abb. 22a), falls Sie wünschen, dass die Änderungen per Änderungsnachverfolgung im Ausgabe-Dokument markiert werden sollen (siehe Abb. 22).

Aktiviertes Kontrollkästchen »als Änderung markieren«

Abbildung 22a: Aktiviertes Kontrollkästchen »als Änderung markieren«

Änderungsnachverfolgung im Word-Ausgabe-Dokument zeigt Ersetzung an

Abbildung 22: Änderungsnachverfolgung im Word-Ausgabe-Dokument zeigt die Ersetzung an

Zum anderen können Sie das Kontrollkästchen »mit Kommentar« aktivieren, falls Sie wünschen, dass im Ausgabe-Dokument an jeder Fundstelle des Suchstrings eine selbst verfasste Meldung in Form eines Kommentars eingefügt wird (siehe Abb. 24). Dazu geben Sie in das rechte Feld »Kommentar bei Regelanwendung« Ihren Kommentar ein (siehe Abb. 23).

Kommentar für die Suche-/Ersetze-Regel eingeben

Abbildung 23: Einen individuellen Kommentar für die Suche-/Ersetze-Regel eingeben

Kommentar zur Suche-/Ersetze-Regel im Word-Ausgabe-Dokument

Abbildung 24: Kommentar zur Suche-/Ersetze-Regel im Word-Ausgabe-Dokument

ACHTUNG: Nach dem Anlegen einer neuen Suche-/Ersetze-Regel das Speichern der Konfiguration nicht vergessen!

2.5 Komponenten

Im Reiter Komponenten unter dem Menüpunkt »Konfiguration« kann festgelegt werden, welche Word-spezifischen Komponenten und Objekte, wie zum Beispiel Bilder, Kommentare und Diagramme, im Prüfdokument erlaubt sind und welche nicht. Dabei wird zwischen den Kategorien »Bilder«, »Bearbeitung« und »Objekte« unterschieden (siehe Abb. 25).

Komponenten in Word-Dokumenten erlauben oder verbieten

Abbildung 25: Bestimmte Komponenten in Word-Dokumenten erlauben oder verbieten

Im Word-Ausgabe-Dokument wird auf "verbotene Komponenten" in Form von Kommentaren hingewiesen (siehe Abb. 26).

Kommentar im Ausgabe-Dokument zu einem nicht erlaubten Bildformat

Abbildung 26: Kommentar im Ausgabe-Dokument zu einem nicht erlaubten Bildformat. Für das Prüfdokument wurde nur das TIFF-Format erlaubt, es wurde jedoch ein JPEG-Bild verwendet.

2.5.1 Kategorie »Bilder«

In der Kategorie »Bilder« können Sie Regeln bezüglich des Formats und der Positionierung für im Prüfdokument eingefügte Bilder aufstellen (siehe Abb. 27).

Vier mögliche Einstellungen für Bildformate

Abbildung 27: Vier mögliche Einstellungen für Bildformate

Die folgenden vier Optionen sind möglich:

  1. Bilder sind nicht erlaubt: Im Prüfdokument sind gar keine Bilder erlaubt. Kommt ein Bild (egal welches Format) vor, erscheint an der entsprechenden Stelle ein Fehlerkommentar im Word-Ausgabe-Dokument.
  2. Alle Bildformate sind erlaubt: Es erfolgt keine Prüfung auf Bilder. Im Prüfdokument sind alle von Word unterstützten Bildformate erlaubt.
  3. Nur TIFF-Bilder sind erlaubt: Im Prüfdokument sind nur TIFF-Bilder erlaubt. Kommt ein anderes Bildformat vor, erscheint an der entsprechenden Stelle ein Fehlerkommentar im Word-Ausgabe-Dokument.
  4. Nur JPEG-Bilder sind erlaubt: Im Prüfdokumment sind nur JPEG-Bilder erlaubt. Kommt ein anderes Bildformat vor, erscheint an der entsprechenden Stelle ein Fehlerkommentar im Word-Ausgabe-Dokument.

Wenn Sie eine der Optionen 2 bis 4 gewählt haben, erscheinen zwei Kontrollkästchen, mit denen Sie die Positionierung Ihrer Bilder definieren können (siehe Abb. 28).

Verlinkte oder absolut positionierte Bilder erlauben

Abbildung 28: Verlinkte oder absolut positionierte Bilder erlauben

Bei Aktivierung des Kontrollkästchens »Verlinkte Bilder sind nicht erlaubt.« erscheint die Angabe »Verlinkte Bilder sind erlaubt.«. So können Sie auch Bilder im Prüfdokument erlauben, die nicht eingebettet sind, sondern per Verknüpfung mit einer anderen Datei eingefügt wurden (siehe Abb. 29).

Einfügen eines Bildes in Word per Verknüpfung mit einer Datei

Abbildung 29: Einfügen eines Bildes in Word per Verknüpfung mit einer Datei

Bei Aktivierung des Kontrollkästchens »Absolut positionierte Bilder sind nicht erlaubt.«, erscheint die Angabe »Absolut positionierte Bilder sind erlaubt.«. So können Sie auch Bilder im Prüfdokument erlauben, die außerhalb des Fließtextes positioniert wurden, das heißt das Bild wurde mit der Word-Layoutoption »Mit Textumbruch« verankert (siehe Abb. 30). Standardmäßig sind nur Bilder erlaubt, die innerhalb des Fließtextes positioniert sind, also Layoutoption »Mit Text in Zeile«.

Positionierung eines Bildes in Word; Layoutoption »Mit Textumbruch«

Abbildung 30: Positionierung eines Bildes in Word; Layoutoption »Mit Textumbruch«

2.5.2 Kategorie »Bearbeitung«

In der Kategorie »Bearbeitung« können Regeln bezüglich der Zulässigkeit von "Korrektur-Eintragungen" im Prüfdokument aufgestellt werden. Darunter fallen Kommentare und die Änderungsnachverfolgung (siehe Abb. 31).

Änderungsnachverfolgung und Kommentare im Prüfdokument erlauben

Abbildung 31: Änderungsnachverfolgung und Kommentare im Prüfdokument erlauben

Bei Aktivierung des Kontrollkästchens »Änderungsnachverfolgung ist nicht erlaubt.«, erscheint die Angabe »Änderungsnachverfolgung ist erlaubt.«. So können Sie eventuell nicht angenommene Änderungen im Prüfdokument erlauben. Dies kann jedoch bei einer späteren Weiterverarbeitung des Dokuments zu Problemen führen!

Bei Aktivierung des Kontrollkästchens »Kommentare im Dokument sind nicht erlaubt.«, erscheint die Angabe »Kommentare im Dokument sind erlaubt.«. So können Sie Kommentare im Prüfdokument erlauben. Dies kann jedoch bei einer späteren Weiterverarbeitung des Dokuments zu Problemen führen!

2.5.3 Kategorie »Objekte«

In der Kategorie »Objekte« können im Prüfdokument eingefügte Objekte, wie zum Beispiel Textfelder, Excel-Tabellen und Diagramme, erlaubt bzw. verboten werden (siehe Abb. 32).

Bestimmte Word-Objekte erlauben

Abbildung 32: Bestimmte Word-Objekte erlauben

Bei Aktivierung des Kontrollkästchens »Textboxen/Textfelder sind nicht erlaubt. Wenn das Dokument Textboxen enthält, so werden diese als fehlerhaft markiert.«, erscheint die Angabe »Textboxen/Textfelder sind erlaubt.«. Somit erlauben Sie diese Word-Objekt-Art in Ihrem Prüfdokument.

Bei Aktivierung des Kontrollkästches »Formen (Einfügen -> Illustrationen -> Formen) sind nicht erlaubt. Wenn das Dokument Formen enthält, so werden diese als fehlerhaft markiert.«, erscheint die Angabe »Formen sind erlaubt.«. Somit erlauben Sie diese Word-Objekt-Art in Ihrem Prüfdokument.

Bei Aktivierung des Kontrollkästchens »Diagramme (Einfügen -> Ilustrationen -> Diagramme) sind nicht erlaubt. Wenn das Dokument Diagramme enthält, so werden diese als fehlerhaft markiert.«, erscheint die Angabe »Diagramme sind erlaubt.«. Somit erlauben Sie diese Word-Objekt-Art in Ihrem Prüfdokument.

Bei Aktivierung des Kontrollkästchens »Eine Vielzahl von Objekten, die für die Weiterverarbeitung problematisch sein könnten, werden geprüft und als fehlerhaft markiert. Darunter zählen u.a. eingebundene Excel-Tabellen oder Datei-Objekte aus Nicht-Word-Programmen (z. B. PDF, ZIP-Ordner und Adobe Photoshop).«, erscheint die Angabe »Sonstige Objekte sind erlaubt, z. B. eingebundene Excel-Tabellen oder Datei-Objekte.«. Somit erlauben Sie diese Objekt-Arten in Ihrem Prüfdokument.

ACHTUNG: Nach dem Erlauben von Word-Komponenten das Speichern der Konfiguration nicht vergessen!

2.6 XML-Transformation

Im Reiter XML-Transformation unter dem Menüpunkt »Konfiguration« kann die Struktur des automatisch erzeugten XML-Dokuments angepasst werden. Dieses XML-Dokument wird während der Dokumentprüfung generiert und erscheint unter den Prüfergebnissen (XML-Version des Dokuments, siehe Abb. 33).

Auflistung der Prüfergebnisse nach der Dokumentprüfung

Abbildung 33: Auflistung der Prüfergebnisse nach der data2check-Dokumentprüfung

Alle in der Vorlage-Datei benutzten Formatvorlagen sowie das Wurzelelement werden als XML-Element umgesetzt und können hier umbenannt sowie zum Teil gelöscht und ausgepackt werden. Dadurch entsteht ein "Roh-XML", das als Grundlage für die Weiterverarbeitung in andere Ausgabe-Formate, wie zum Beispiel HTML und EPUB, dienen kann.

2.6.1 Das Wurzelelement

Das Wurzelelement wird automatisch generiert und erscheint als erstes in der Element-Liste. Mit Klick auf die Dropdown-Liste können Sie die Aktion »Wandeln in« auswählen und somit das Element umbenennen. Dadurch wird ein Eingabefeld angezeigt, in das Sie den neuen Elementnamen eingeben können.

ACHTUNG: Das Feld »Neuer Elementname« darf nicht leer sein. Der Eintrag muss mit einem Buchstaben oder einem Unterstrich beginnen, sonst ist er ungültig und die Konfiguration kann nicht gespeichert werden (siehe Abb. 34).

Ein ungültiger Elementname

Abbildung 34: Ein ungültiger Elementname

Wählen Sie »Keine Aktion« aus, wenn das Wurzelelement im XML-Dokument nicht umbenannt werden soll.

2.6.2 Die Formatvorlagen

Nach dem Wurzelelement werden die Namen der in der Vorlage-Datei benutzten Absatz- und Zeichen-Formatvorlagen alphabetisch aufgelistet. Jede Formatvorlage entspricht einem gleichnamigen Element in der automatisch erzeugten XML-Ausgabe-Datei. Folgende Aktionen sind verfügbar (siehe Abb. 35):

Ein Element umbenennen, auspacken oder löschen

Abbildung 35: Ein Element umbenennen, auspacken oder löschen

  • Keine Aktion: Das Element wird im XML-Dokument nicht geändert.
  • Wandeln in: Das Element wird im XML-Dokument umbenannt.
  • Auspacken: Das Element wird im XML-Dokument aufgelöst, der textliche Inhalt wird aber beibehalten.
  • Löschen: Das Element wird samt Inhalt im XML-Dokument gelöscht.

ACHTUNG: Für das Umbenennen der Formatvorlagen gelten dieselben Regeln wie für das Umbenennen des Wurzelelements (siehe Abb. 34)!

2.6.3 Ein Elternelement erzeugen

Für die Strukturierung des automatisch generierten XML-Dokuments steht Ihnen eine weitere Funktion zur Verfügung, mit der Sie zum Beispiel Kapitel-Strukturen generieren können; und zwar die Generierung eines sogenannten "Container-Elements". Dazu müssen Sie folgende Schritte beachten und durchführen:

  1. Im Reiter Regeln für den Dokumentaufbau unter dem Menüpunkt »Konfiguration« (siehe unter 2.3.2 Einstellungen für die Absatz-Formatvorlagen) weisen Sie einer Absatz-Formatvorlage eine Überschriften-Ebene zu (Funktion -> Überschrift Ebene 1 usw.) oder haben dies bereits getan.
  2. Anschließend können Sie im Reiter XML-Transformation bei gewählter Aktion »Wandeln in« für diese Absatz-Formatvorlage ein Elternelement generieren. Bei der entsprechenden Absatz-Formatvorlage erscheint dann unter dem Eingabefeld »Neuer Elementname« das Kontrollkästchen »Abschnitt mit Container-Element umgeben«.
  3. Bei Aktivierung dieses Kontrollkästchens erscheint ein Eingabefeld »Umgebendes Element«, in das Sie den Namen des neuen Elements eintragen können (siehe Abb. 36).

ACHTUNG: Für das Benennen des Container-Elements gelten dieselben Regeln wie für das Umbenennen des Wurzelelements (siehe Abb. 34)!

Für ein Element mit Wertigkeit einer Überschrift kann ein Elternelement generiert                         werden

Abbildung 36: Für ein Element mit Wertigkeit einer Überschrift kann ein Elternelement generiert werden

ACHTUNG: Nach der Umgestaltung der Elemente für die XML-Transformation das Speichern der Konfiguration nicht vergessen!

Nachdem Sie nun Ihre Konfiguration bearbeitet haben, können Sie unter dem Menüpunkt »Dokumente« Ihre Word-Dokumente hochladen und anhand Ihrer Konfiguration prüfen. Auf die Dokumentprüfung wird im folgenden Abschnitt genauer eingegangen.

3. Ein Dokument prüfen

Im Menüpunkt »Dokumente« können Sie die Prüfung eines Word-Dokuments anhand einer vorher erstellten Konfiguration (siehe unter 1. Eine Prüfkonfiguration erstellen und 2. Eine Prüfkonfiguration bearbeiten) durchführen. Nach Abschluss der Prüfung werden verschiedene Dokumente ausgegeben, die eingesehen und weiter verarbeitet werden können. Darunter gehören eine kommentierte Version des geprüften Dokuments, ein automatisch generiertes XML-Dokument sowie ein HTML-Prüfbericht (weitere Informationen dazu siehe unter 3.2 Die Ausgabe-Dokumente).

3.1 Der Prüfprozess

Mit Klick auf den Button »Datei auswählen« (siehe Abb. 37) gelangen Sie in Ihren Dateimanager, wo Sie ein Prüfdokument auswählen können (siehe Abb. 38).

ACHTUNG: Alle Formate der hochzuladenden Dateien müssen unbedingt XML-kompatibel sein, das heißt bitte nur Dateien mit der Endung .docx für Microsoft Word hochladen!

Upload eines Prüfdokuments - »Datei auswählen« klicken, um den Dateimanager zu öffnen

Abbildung 37: Upload eines Prüfdokuments - Schritt 1: »Datei auswählen« klicken, um den Dateimanager zu öffnen

Upload eines Prüfdokuments - .docx-Datei auswählen

Abbildung 38: Upload eines Prüfdokuments - Schritt 2: .docx-Datei auswählen

Nach Auswahl des Dokuments per Doppelklick werden in der Dropdown-Liste neben »Prüfkonfigurationen« alle bereits erstellten Prüfkonfigurationen für Word angezeigt. Die zuletzt erstellte Konfiguration erscheint immer ganz unten in der Liste. Wählen Sie die Konfiguration aus, auf deren Grundlage das vorher ausgewählte Dokument geprüft werden soll (siehe Abb. 39).

Verfügbare Prüfkonfigurationen nach Auswahl einer Word-Datei

Abbildung 39: Verfügbare Prüfkonfigurationen nach Auswahl einer Word-Datei (beispielhafte Darstellung)

Nach Auswahl des Prüfdokuments und der gewünschten Konfiguration, klicken Sie nun auf die grüne Schaltfläche »Datei hochladen und Prüfung starten«, damit der Prüfprozess ausgelöst wird. Anhand der "Uhr" sehen Sie, dass die Prüfung des ausgewählten Dokuments im Gange ist. Dieser Prozess kann einige Sekunden dauern (siehe Abb. 40).

Prüfung des Dokuments ist im Gange

Abbildung 40: Die Prüfung des Dokuments ist im Gange

Das von Ihnen ausgewählte Dokument wurde erfolgreich geprüft. Nach Beendigung der Prüfung werden in der rechten Spalte die Ausgabe-Dokumente angezeigt (siehe Abb. 33).

Näheres zu den einzelnen Ausgabe-Dokumenten erfahren Sie im folgenden Abschnitt.

3.2 Die Ausgabe-Dokumente

Unabhängig davon, ob eine Prüfung "erfolgreich" (es wurden keine Fehler gefunden) oder "nicht erfolgreich" (es wurden Fehler gefunden) war, werden immer vier Ausgabe-Dokumente in Form von Verlinkungen angezeigt:

  • Kommentierte Version des Dokuments: Wenn Sie diesen Link öffnen, wird ein Word-Ausgabe-Dokument heruntergeladen. Es handelt sich dabei um eine exakte Kopie Ihres hochgeladenen Prüfdokuments, angereichert mit Word-Kommentaren zu den gefundenen Fehlern im betreffenden Absatz (siehe Abb. 41). Mit Hilfe dieser kommentierten Version können Sie die Formatierungsfehler direkt im Word-Dokument nachvollziehen, bei Wunsch berichtigen und das Dokument anschließend gegebenenfalls erneut zur Prüfung hochladen.

    Die Kommentierte Version des Prüfdokuments

    Abbildung 41: Die Kommentierte Version des Prüfdokuments

  • XML-Version des Dokuments: Wenn Sie diesen Link öffnen, wird ein automatisch generiertes XML-Dokument heruntergeladen. Es handelt sich dabei um eine XML-Version Ihres Prüfdokuments, das heißt alle Formatvorlagen wurden hier in XML-Elemente umgewandelt (siehe Abb. 42). Diese Elemente konnten Sie im Vorfeld im Reiter XML-Transformation unter dem Menüpunkt »Konfiguration« bearbeiten (siehe unter 2.6 XML-Transformation). Dieses "Roh-XML" dient als Grundlage zur Weiterverarbeitung in andere Ausgabe-Formate, wie HTML, EPUB usw.

    Die XML-Version des Prüfdokuments

    Abbildung 42: Die XML-Version des Prüfdokuments (Auszug)

  • formatierter Prüfbericht: Wenn Sie diesen Link öffnen, wird eine Zusammenfassung der bei der Dokumentprüfung entdeckten Fehler und Meldungen als HTML heruntergeladen (siehe Abb. 43). Dadurch erhalten Sie einen ersten Überblick über Umfang und Schwere der Fehler im Word-Dokument.

    Der formatierte Prüfbericht in HTML

    Abbildung 43: Der formatierte Prüfbericht in HTML

    Außerdem können Sie sich die gefundenen Fehler direkt in einer Preview im Browser ansehen. Mit Klick in die Spalte »Details« werden alle Fehler aufgelistet, die Sie mit Klick auf den Link [Preview] am Ende jedes Punktes direkt in der HTML-Version Ihres Dokuments nachvollziehen können (siehe Abb. 44).

    Preview-Funktion im formatierten Prüfbericht

    Abbildung 44: Die Preview-Funktion im formatierten Prüfbericht

  • Prüfbericht im XML-Format: Wenn Sie diesen Link öffnen, wird ein Prüfbericht in SVRL (Schematron Validation Report Language) heruntergeladen (siehe Abb. 45). Diesen können Sie zur weiteren Verarbeitung mit XSLT oder XPath nutzen.

    Der SVRL-Prüfbericht

    Abbildung 45: Der SVRL-Prüfbericht (Auszug)

4. Die Prüfungshistorie

In der Prüfungshistorie unter dem Menüpunkt »Dokumente« (linke Spalte) finden Sie alle bereits durchgeführten Prüfungen chronologisch sortiert wieder und können auf die jeweiligen Prüfergebnisse zugreifen. Somit stellt die Prüfungshistorie Ihre individuelle Datenbank dar.

Es werden alle vorangegangenen Prüfungen mit Angabe des Zeitpunkts der Prüfung (»Geprüft am«), des Namens des Prüfdokuments (»Testdatei«), des Ergebnisses der Prüfung (grünes Häkchen (Häkchen-Icon) für "erfolgreiche Prüfung und keine Fehler gefunden", orangene Pinn-Nadel (Pinn-Nadel-Icon) für "erfolgreiche Prüfung, aber Fehler gefunden" und roter Blitz (Blitz-Icon) für "Prüfung ist fehlgeschlagen z. B. wegen eines Systemfehlers") sowie der für die Prüfung verwendeten Prüfkonfiguration aufgelistet (siehe Abb. 46).

Die Prüfungshistorie

Abbildung 46: Die Prüfungshistorie

Mit Klick auf eines der unter »Testdatei« verlinkten Prüfdokumente, werden die entsprechenden Ausgabe-Dokumente in der rechten Spalte angezeigt und können, wie unter 3.2 Die Ausgabe-Dokumente beschrieben, eingesehen werden (siehe Abb. 47).

Auflistung der Ausgabe-Dokumente

Abbildung 47: Auflistung der Ausgabe-Dokumente auf der rechten Seite

Ihre Prüfungshistorie findet sich außerdem auf der data2check-Startseite unter dem Menüpunkt »Home« wieder (siehe unter 4.1 Home im Allgemeinen Teil dieser Dokumentation).

Copyright © 2017 data2check, all rights reserved

AGBs | Impressum | Datenschutzerklärung