DITAVAL

Einrichten von DITA-Topics zur Verwendung von DITAVAL

Erfahren Sie, wie Sie DITA-Topics zum Verwenden von DITAVAL einrichten und bedingte Attribute auf Elemente anwenden können.

Sie können Elemente in einem DITA-Dokument zu bedingten Elementen machen, indem Sie Bedingungselemente auf die Attribute anwenden. Danach definieren Sie basierend auf den Bedingungsattributen, in einer DITAVAL-Datei, die Elemente, die in der Ausgabe enthalten oder nicht enthalten sein sollen.

Bevor Sie Dokumente mit bedingten Inhalten erstellen, müssen Sie zunächst die Kriterien für die Ausgabe planen. Beispiel: Angenommen, ein Dokument enthält Inhalte, die sich per Bedingung einerseits an Administratoren und andererseits an Endbenutzer richten. Im Dokument wenden Sie Bedingungsattribute basierend auf der Zielgruppe für die Inhalte an (siehe Bedingungsattribute auf Elemente anwenden). Danach erstellen Sie eine DITAVAL-Datei, in der Sie die Elemente festlegen, die basierend auf dem im Dokument definierten Attributwert ein- bzw. auszuschließen sind. Weitere Informationen finden Sie unter DITAVAL-Datei zum Erstellen einer bedingten Ausgabe erstellen.

Bedingungsattribute auf Elemente anwenden

Damit FrameMaker Elemente in einem DITA-Dokument bedingt verarbeiten kann, müssen Sie die Elemente angeben, die für die Ausgabe enthalten bzw. nicht enthalten sein sollen. Im Dokument wenden Sie eines oder mehrere der folgenden Bedingungsattribute auf die Elemente an, die bedingt verarbeitet werden müssen:

audience:

Beispiel: Administratoren, Autoren oder Endbenutzer.

platform:

Beispiel: Windows, Mac oder Linux

product:

Beispiel: FrameMaker, RoboHelp oder Captivate.

otherprops:

Verwenden Sie dieses Attribut zum Definieren jeder anderen Eigenschaft, die Sie für die bedingte Verarbeitung des Dokuments benötigen. Beispiele:

delivery: Beispiel: Druck, PDF oder Web
model: Hecktürmodell oder Limousine

Sie können auf ein Element mehrere Attribute anwenden. Sie können beispielsweise @audience=„administrator“ und @platform=„windows“ auf ein Element anwenden. Sie können einem einzelnen Attribut auch mehrere Werte (jeweils getrennt durch ein Leerzeichen) hinzufügen. Für Inhalte, die sich sowohl an Windows- als auch an Linux-Benutzer richten, können Sie beispielsweise @platform=„windows linux“ festlegen.

Important: Die Verwendung der oben aufgelisteten Attribute wird für das Arbeiten mit DITAVAL zu Inhalt mit einer Quelle empfohlen. Sie sind jedoch nicht auf die Verwendung nur dieser Attribute eingeschränkt. Sie können jedes Attribut verwenden, das für das ausgewählte Element in einem Dokument definiert wurde.

Anwenden von Bedingungsattributen auf ein Element

Wählen Sie ein Element in der Strukturansicht des Dokuments aus.
Öffnen Sie das Fenster Attribute (Elemente > Attribute bearbeiten).

Aktualisieren Sie eines oder mehrere der folgenden Attribute:
- audience
- platform
- product
- otherprops
Legen Sie die oben genannte Bedingung für jedes dieser Element im bedingt zu verarbeitenden Dokument fest.

Nachdem Sie die Attribute auf die spezifischen Elemente im Dokument angewendet haben, geben Sie den Inhalt in Ihrem Dokument in Abhängigkeit davon, wie Sie Ihre DITAVAL-Datei eingerichtet haben, bedingt aus.

DITAVAL-Datei zum Erstellen einer bedingten Ausgabe erstellen

Nachdem Sie Ihre Inhalte mithilfe von Bedingungsattributen eingerichtet haben („audience“, „platform“, „product“ und „otherprops“), um die Elemente zu definieren, die FrameMaker für die Ausgabe bedingt verarbeitet, müssen Sie eine DITAVAL-Datei erstellen. In einer DITAVAL-Datei definieren Sie basierend auf einem Attributname> - <Wert>Paar die bedingte Verarbeitung Ihres Dokuments. Beispielsweise können Sie angeben, dass auf Administratoren ausgerichtete Inhalte von der Ausgabe für Endbenutzer oder Autoren ausgeschlossen werden.

Erstellen einer DITAVAL-Datei:

Öffnen Sie das Dialogfeld Neue XML-Datei (Datei > Neue > XML-Datei).
Wählen Sie im Abschnitt Strukturierte Anwendungen „DITA_<version>_DITAVAL“ und klicken Sie auf OK.

Das Element der höchsten Ebene einer DITAVAL-Datei ist das <val>-Element.

Zum Definieren von Bedingungen müssen Sie <prop>-Elemente erstellen.
Fügen Sie mindestens ein <prop>-Element hinzu:

Doppelklicken Sie auf das <prop>-Element im Fenster „Elemente“ (Ansicht > Fenster > Elementkatalog).

Oder drücken Sie Strg + 1, um den Smart-Katalog anzuzeigen, wählen Sie prop, und drücken Sie die Eingabetaste.

Das Dialogfeld Attribute für neues Element wird angezeigt.
Dialogfeld „Attribute für neues Element“
Legen Sie im Dialogfeld Attribute für neues Element folgende Attribute fest:

@action

Wählen Sie, ob das angegebene Attribut in die Ausgabe ein- oder davon ausgeschlossen werden soll (@att, siehe unten).

@att

Der Name des auf das Element in Ihrem Dokument angewendeten Bedingungsattributs.

Geben Sie den Attributnamen exakt wie im Dokumentelement definiert ein.

@val

Der Wert des Bedingungsattributs (@att) wie im Element definiert.

Geben Sie den Wert exakt wie von Ihnen für das Attribut im Element angegeben ein.

Beispiel: Angenommen, Sie wenden das @audience-Attribut auf ein Element für die bedingte Ausgabe an und legen als Wert admin fest. Sie müssen für das <prop>-Element in der DITAVAL-Datei audience in das Feld @attr eingeben. Außerdem müssen Sie admin in das Feld @val eingeben. Um das Element auszuschließen, für welches das Attribut „audience“ auf admin festgelegt ist, legen Sie @action als exclude fest.
Klicken Sie auf „Element einfügen“ und speichern Sie die DITAVAL-Datei.
Speichern Sie das Dokument mit der Erweiterung .ditaval.

Bedingte Ausgabe generieren

Erfahren Sie, wie Sie in FrameMaker bedingte Ausgaben für DITA-Topics generieren können.

Dieser Abschnitt behandelt mithilfe eines einfachen Anwendungsfalls die Schritte zum Generieren einer PDF-Ausgabe mit bedingten Inhalten.

Hinweis: Das in diesem Abschnitt verwendete Beispiel umfasst nur Inhalte in Absatz-Tags (p). Sie können jedoch von jedem DITA-Element in einem Dokument aus eine bedingte Ausgabe erstellen.

Erstellen Sie ein DITA-Topic mit vier Absatzelementen (<p>):
1. Inhalt NUR für Administratoren
  
  Legen Sie das Attribut @audience auf admin fest.
2. Inhalt NUR für Autoren
  
  Legen Sie das Attribut @audience auf author fest.
3. Inhalte für Administratoren und Autoren
  
  Legen Sie das Attribut @audience auf admin author fest.
4. Inhalt für Endbenutzer und Autoren
  
  Legen Sie das Attribut @audience auf end_user author fest.
Speichern Sie das Dokument.
Erstellen Sie eine DITAVAL-Datei mit vier <prop>-Elementen:
1. @attr: audience
  
  @val: admin
  
  @action: include
2. @attr:audience
  
  @val:author
  
  @action: exclude
3. @attr:audience
  
  @val:end_user
  
  @action: exclude
Die DITAVAL-Datei oben gibt alle an Administratoren gerichteten Inhalte aus.
Erstellen Sie eine DITA Map, schließen Sie das oben genannte Dokument ein und speichern Sie die DITA Map als PDF-Datei (Datei > Als PDF speichern).
Aktivieren Sie im Dialogfeld „Dokument speichern“ die Option Aufforderung für DitaVal-Datei und klicken Sie auf Speichern.

Das Dialogfeld DitaVal-Datei auswählen wird geöffnet.
Wählen Sie die in Schritt 4 erstellte DITAVAL-Datei aus und klicken Sie auf Auswählen.

Die Option Als Bedingung anwenden gibt die gesamten Inhalte aus. Inhalte, die jedoch als aus der DITAVAL-Datei ausgeschlossen gekennzeichnet sind, werden durchgestrichen ausgegeben. Sie wählen diese Option für die Dokumentabstimmung. Verwenden Sie diese Option beispielsweise, um einen Reviewer auf die Inhalte hinzuweisen, die als „Ausgeschlossen“ gekennzeichnet sind.
Klicken Sie im Dialogfeld „PDF-Einstellungen“ auf Festlegen.

Die Ausgabe-PDF-Datei schließt Inhalte basierend auf den im Dokument und der entsprechenden DITAVAL-Datei eingerichteten Attributen ein bzw. aus.