Bearbeiten einer Dokumenthalter(Document Holder)-XML-Datei

Anmerkung: Wir empfehlen, dass Sie Document Holder mit dem Online DH Editor bearbeiten. Siehe Bearbeiten eines Dokumenthalters online.

Eine Dokumenthalterdatei (Document Holder) ist eine XML-Datei mit einem bestimmten Format. Sie können die XML-Datei auf die folgenden Arten bearbeiten:

Mit einer Anwendung wie Notepad oder einem speziellen XML-Editor.
Mit dem Online DH Editor vom QDC eQMS. Dies wird unter Bearbeitung eines Dokumentenhalters (Document Holder) online behandelt.

Dieses Thema erklärt:

Die Offline-Bearbeitung einer XML-Datei.
Das XML-Layout, das für den DH-Typ verwendet wird.

Basis-Layout

Das QDC eQMS verfügt über eine Reihe von Regeln (oder Schemata) für die Verwendung von XML für gültige Document Holder.

Ein Document Holder besteht aus:

Einem XML-Element namens documentHolder, das ein optionales <introduction>-Element enthält.
Einem obligatorischen <sections>-Element.

Das Element <introduction> enthält Text zur Beschreibung des Dokuments und wird am oberen Rand des Document Holder angezeigt. Das <sections> Element enthält Verweise auf das Dokument.

Im obigen Beispiel besteht der Document Holder aus einem einzigen documentHolder-Element, das ein introduction-Element und ein sections-Element enthält. Der Text innerhalb des introduction-Elements ist so formatiert, dass zwei Zeilenumbrüche einen neuen Absatz einleiten. Beachten Sie, dass das Element sections leer ist – bei echten Document Holders wäre dies nicht der Fall, da das Element sections die Dokumentverweise enthält.

Beachten Sie im Beispiel, dass bei den XML-Elementen zwischen Gross- und Kleinschreibung unterschieden wird. Wenn Sie also Ihre eigenen Document Holders erstellen, müssen Sie documentHolder verwenden (und nicht „DocumentHolder“ oder „documentholder“).

Das Element sections

Das <section>-Element eines Document Holder wird verwendet, um null oder mehr <section>-Elemente zu enthalten. Jedes <section>-Element muss ein src-Attribut haben, um es mit einem Abschnitt (section) in einem anderen Document Holder zu verknüpfen (siehe unten), oder einen Titel (title), der als Überschrift für den Abschnitt in der vom QDC eQMS erstellten Webseite verwendet wird. Hier ist ein falsches und ein richtiges Beispiel, um dies zu veranschaulichen:

<section></section> [Dies ist nicht korrekt]

<section title="test"></section> [Das ist richtig]

Ein section-Element kann ein <description>-Element und ein <documents>-Element enthalten, das eine Liste von <document>-Elementen enthält. Wie das Element introduction, dient auch das Element description dazu, einen einleitenden Text an den Anfang eines jeden Abschnitts zu stellen. Sie können diesen Text verwenden, um die Arten von Dokumenten zu beschreiben, auf die in dem Abschnitt (section) verwiesen wird.

Das documents-Element enthält null oder mehr Verweise auf Dokumente selbst. Ein einfacher Dokumentverweis besteht aus einem document element mit den Attributen partnum und issue.

Der obige Beispiel-Document Holder enthält zwei Abschnitte, den ersten mit dem Titel Einleitende Dokumente (Introductory Documents) und den zweiten mit dem Titel Manuals. Der erste Abschnitt enthält eine Beschreibung, während der zweite Abschnitt keine Beschreibung enthält.

Sie sehen an dem Beispiel, dass jeder Abschnitt (section) ein Attribut title hat und jedes Dokument (document) ein Attribut partnum und issue hat.

Abschnittskennungen (Section identifiers) und Einbeziehung von Abschnitten (section inclusion)

Section-Elemente können auch ein optionales id-Attribut haben, das zur eindeutigen Identifizierung des Abschnitts innerhalb des Dokuments dient. Ein Beispiel:

<section id="software_docs" title="Software documents"></section>

Die Section-IDs müssen innerhalb des Dokuments eindeutig sein, d.h. zwei oder mehr Section-Elemente innerhalb eines Document Holder können nicht das gleiche id-Attribut verwenden.

Es ist möglich, eine Section-ID zu verwenden, um den Inhalt eines Abschnitts aus einem anderen DH-Dokument einzubinden. Um einen Abschnitt aus einem anderen Document Holder einzubinden, müssen Sie das optionale Attribut src verwenden. Um zum Beispiel einen Abschnitt mit der id software_docs in Version 3 von AA-999999-DH einzubinden, kann das folgende section-Element verwendet werden:

<section src="AA-999999-DH-3#software_docs"></section>

Wenn ein Abschnitt in einen Document Holder aufgenommen wird, werden der Titel (title), die Beschreibung (description) und die Liste der Dokumente in diesem Abschnitt aufgenommen. Sowohl der Titel (title) als auch die Beschreibung (description) können später bei Bedarf überschrieben werden.

Das Element Document

Das document-Element enthält Verweise auf eQMS-Dokumente und kann innerhalb eines Document Holder mehrfach vorkommen. Ein Basisdokumentverweis hat die Attribute partnum und issue. Da ein Basisdokumentverweis keinen Textinhalt enthält, sollte er als selbstschliessendes XML-Element geschrieben werden (d.h. ein Element mit einem schliessenden ‚/‘-Zeichen).

Standardmässig zeigt das QDC eQMS einen einfachen Dokumentverweis als Link zur Stammdatei des Dokuments im eQMS an, wobei der Titel des referenzierten Dokuments als Linktext verwendet wird. Wenn Sie etwas anderes als den Titel des Dokuments als Link verwenden möchten, verwenden Sie das Attribut title des Dokumentenelements (document element), um Ihren eigenen Titel festzulegen.

Im obigen Beispiel wird das Dokument mit dem Text My Link Text verknüpft.

Wenn ein Dokumentverweis im QDC eQMS angezeigt wird, wird er mit allen Versionsinformationen angezeigt, die mit der referenzierten Version verbunden sind. Es ist jedoch möglich, einen zusätzlichen Versionsstring in den Dokumentverweis einzufügen und diesen ebenfalls anzuzeigen. Um einen zusätzlichen Versionsstring hinzuzufügen, verwenden Sie das Attribut version des Dokumentenelements (document element).

Im obigen Beispiel würde das QDC eQMS den Link zum Dokument mit dem Titel des Dokuments, gefolgt von (My version string), anzeigen.

Um zusätzlichen Text einzufügen, nachdem der Link zum Dokument angezeigt wurde, können Sie Text in das Dokumentenelement (document element) einfügen. Dieser Text wird als Absatz direkt nach dem Link des Dokuments angezeigt.

In dem obigen Beispiel enthält der Dokumentverweis zusätzlichen Text, der nach dem Dokumentlink angezeigt wird. Beachten Sie, dass das Dokumentenelement (document element) ein schliessendes Tag hat und nicht selbst geschlossen ist.

Um auf die letzte genehmigte Version eines Dokuments zu verweisen, kann das issue-Attribut eines Dokumentenelements (document element) mit dem Wert APPROVED versehen werden.

Formatierung der Elemente Einleitung (introduction) und Beschreibung (description)

Die Elemente Elemente Einleitung (introduction) und Beschreibung (description) enthalten standardmässig reinen Text. Die einzige Formatierung, die in diesen reinen Textblöcken stattfindet, ist wie folgt:

Doppelte Zeilenumbrüche werden in Absatzumbrüche umgewandelt.
20 oder mehr ‚-‚ oder ‚_‘-Zeichen in einer Zeile, werden in eine horizontale Linie umgewandelt.

Wenn eine komplexere Formatierung in diesen Elementen erforderlich ist, kann das Attribut format verwendet werden, das den Wert textile erhält.

Textile ist ein einfaches Format zur Textformatierung, das Textstile wie fett, durchgestrichen, kursiv, hoch- und tiefgestellt bietet. Textile ermöglicht auch komplexere Textstrukturen wie Tabellen und Listen. Eine vollständige Beschreibung der Textile-Auszeichnungssyntax finden Sie unter http://www.textism.com/tools/textile/.

Wenn das obige Beispiel in eine Webseite gerendert wird, sieht das Ergebnis folgendermassen aus:

Wenn Sie die Zeichen ‚<‚ und ‚>‘ in der Textformatierung verwenden, müssen sie in XML in < bzw. > escaped werden.

Zum Beispiel die folgende Textilauszeichnung:

<code>a = b;</code>

muss im Document Holder so geschrieben werden: