2021 September Release

Xtech-Dokumente erstellenPermanenter Link zu dieser Überschrift

Ein Xtech-Dokument beschreibt die Struktur eines Dokuments und besteht aus einzelnen Kapiteln. Die referenzierte Formatvorlage definiert das XML-Schema und Aussehen des Dokuments.

Xtech-Dokumente erzeugenPermanenter Link zu dieser Überschrift

Um ein Xtech-Dokument zu erzeugen, gehen Sie folgendermaßen vor:

  1. Navigieren Sie in Ihr Xtechwriter-Dashboard.
  2. Klicken Sie auf die Aktion „Xtech-Dokument erzeugen“.
  3. Legen Sie folgende Metadaten fest:
    • Name
      Definiert den Namen des Xtech-Dokuments.
    • Ablage
      Definiert die Ablage, der das Xtech-Dokument zugewiesen wird.
    • Formatvorlage
      Die Formatvorlage definiert das XML-Schema und das Aussehen des Dokuments.
    • Kategorie
      Definiert die Kategorie des Dokuments. Kann zum Beispiel als Bedingung für die Sichtbarkeit von Kapiteln und Textbausteinen verwendet werden.
    • Autor
      Definiert den Benutzer, der die Publikationen zur Freigabe weiterleiten soll (wird als Workflow-Teilnehmer im mitgelieferten Freigabeprozess verwendet).
    • Reviewer
      Definiert den Benutzer, der die Publikationen freigeben soll (wird als Workflow-Teilnehmer im mitgelieferten Freigabeprozess verwendet).
  4. Klicken Sie auf „Weiter“.

Xtech-Dokumente bearbeitenPermanenter Link zu dieser Überschrift

Die Inhalte eines Xtech-Dokuments werden vorwiegend im Xeditor erstellt und gewartet. Die Dokumentstruktur kann auf Kapitelebene jedoch auch in der Baumansicht festgelegt werden. Insbesondere können bestehende Kapitel wiederverwendet und zu einem Xtech-Dokument hinzugefügt werden.

Den Xeditor verwendenPermanenter Link zu dieser Überschrift

Der Xeditor dient zum Erfassen der Inhalte des Dokuments. Es kann entweder das gesamte Xtech-Dokument bearbeitet werden oder nur einzelne Kapitel.

Um ein Xtech-Dokument mit dem Xeditor zu bearbeiten, gehen Sie folgendermaßen vor:

  1. Navigieren Sie in das gewünschte Xtech-Dokument.
  2. Klicken Sie auf die Aktion „Bearbeiten“.
  3. Erfassen Sie den gewünschten Inhalt.
    Hinweis: Nähere Informationen zur Verwendung des Xeditors finden Sie im nächsten Abschnitt.
  4. Klicken Sie auf „Speichern“ (Diskettensymbol; Tastenkombination: Strg + S) und schließen Sie das geöffnete Xeditor-Fenster.

Xeditor

Der Xeditor bietet folgende Möglichkeiten.

Arbeitsbereiche

  • Im Hauptbereich wird das Dokument entsprechend der festgelegten Formatvorlage angezeigt und kann bearbeitet werden.
  • Im rechten Bereich werden unter „Inhaltsverzeichnis“ die Kapitel des Dokuments als Baum dargestellt. Alternativ können unter „Eigenschaften“ die Eigenschaften des aktuell ausgewählten Elements angezeigt werden und gegebenenfalls Attribute, die in der Formatvorlage definiert sind, hinzugefügt werden.

Werkzeugleiste

  • Allgemein
    Standardmäßig werden die Schaltflächen „Speichern“, „Kopieren“, „Ausschneiden“, „Rückgängig“, „Wiederherstellen“ und „Suchen/Ersetzen“ angezeigt.
  • Start
    Ermöglicht Formatierungen anzubringen und Elemente einzufügen (z. B. Kapitel).
  • Tabelle
    Ermöglicht Tabellen einzufügen bzw. anzupassen.
  • Überprüfen
    Ermöglicht Kommentare hinzuzufügen und die Änderungsverfolgung zu aktivieren.
  • Ansicht
    Ermöglicht die Dokumentenansicht anzupassen (z. B. Tags oder Textplatzhalter anzeigen).
  • Fabasoft Cloud
    Ermöglicht das Einfügen von Textbausteinen und Feldern.
  • Fußleiste
  • XML-Pfad
    Zeigt den Pfad zum ausgewählten XML-Element. Über das Drop-down-Menü bei den entsprechenden Pfadelementen können Aktionen wie „Element hinzufügen“ oder „Löschen“ ausgeführt werden.
  • Benachrichtigungen
    Über das Glocken-Symbol können Benachrichtigungen zum Beispiel über eine fehlerhafte XML-Struktur angezeigt werden.

Die verfügbaren XML-Elemente werden durch das XML-Schema der verwendeten Formatvorlage festgelegt. Aktuell wird das XML-Schema „Xeditor-Schema Lightweight DITA“ unterstützt.

Wenn Sie ein neues Dokument erzeugen, starten Sie mit einem Topic-Element, das das Dokument repräsentiert. Sie können diesem Topic-Element weitere Topic-Elemente unterordnen, die die Kapitel des Dokuments repräsentieren. Ein Topic-Element enthält im Allgemeinen ein Title-Element, ein Body-Element (das wiederum die Paragraf-Elemente enthält) und gegebenenfalls weitere Topic-Elemente als Unterkapitel.

Beispiel

Um ein Dokument mit den Kapiteln „1. Einleitung“, 2 „Vorbereitung“ und 2.1 „Bedienung“ zu erstellen, gehen Sie folgendermaßen vor:

  1. Bearbeiten Sie das Xtech-Dokument.
  2. Klicken Sie in der Symbolleiste auf die Schaltfläche „Topic“.
    Hinweis: Öffnen Sie alternativ in der Fußzeile das Drop-down-Menü des ersten Topic-Elements und klicken Sie auf „Element hinzufügen“ > „Topic“.
  3. Geben Sie als Titel „Einleitung“ ein. Durch Drücken der Enter-Taste wird ein Platzhalter-Paragraf eingefügt. Sie können somit den ersten Paragrafen des Kapitels erfassen.
  4. Öffnen Sie in der Fußzeile das Drop-down-Menü des ersten Topic-Elements und klicken Sie auf „Element hinzufügen“ > „Topic“.
  5. Geben Sie als Titel „Vorbereitung“ ein. Durch Drücken der Enter-Taste wird ein Platzhalter-Paragraf eingefügt.
  6. Klicken Sie in der Symbolleiste auf die Schaltfläche „Topic“.
    Hinweis: Öffnen Sie alternativ in der Fußzeile das Drop-down-Menü des zweiten Topic-Elements und klicken Sie auf „Element hinzufügen“ > „Topic“. Bei dem zweiten Topic-Element des aktuell ausgewählten XML-Pfads handelt es sich um das Kapitel „Vorbereitung“. Das entsprechende Element wird im Editor grau hinterlegt. Somit können Sie einfach erkennen, dass Sie sich im richtigen XML-Pfad befinden.
  7. Geben Sie als Titel „Bedienung“ ein. Durch Drücken der Enter-Taste wird ein Platzhalter-Paragraf eingefügt.

Hinweis: Alternativ können Sie die Befehle auch über das Kontextmenü der jeweiligen Elemente ausführen.

Kapitel zusammenstellenPermanenter Link zu dieser Überschrift

Die Struktur eines Xtech-Dokuments kann auch über die Baumansicht festgelegt werden. Somit ist insbesondere die Wiederverwendung von Kapiteln möglich.

Um die Struktur eines Xtech-Dokuments zu ändern, gehen Sie folgendermaßen vor:

  1. Navigieren Sie in das gewünschte Xtech-Dokument oder Kapitel.
  2. Führen Sie die gewünschte „Inhalt einfügen“-Aktion aus:
    • Kapitel erzeugen
      Erzeugt ein neues Kapitel mit dem eingegebenen Namen.
    • Duplikat einfügen
      Fügt ein Duplikat eines sich in der Zwischenablage befindlichen Kapitels ein.
    • Verknüpfung einfügen
      Fügt eine Verknüpfung auf das sich in der Zwischenablage befindlichen Kapitels ein.
    • Textbaustein einfügen
      Ermöglicht die Auswahl eines vordefinierten Textbausteins und fügt diesen ein.

Hinweis: In den Eigenschaften eines Kapitels steht auf der Registerkarte „Kapitel“ das Feld Ausdruck für die Einschränkung der Verwendbarkeit zur Verfügung (siehe Kapitel „Verwendbarkeit“). Das Kapitel wird in der Publikation nur angezeigt, wenn der definierte Ausdruck true ergibt. Somit lassen sich Varianten von Dokumenten realisieren.

TextbausteinePermanenter Link zu dieser Überschrift

Textbausteine ermöglichen die Wiederverwendung von Inhalten in verschiedenen Dokumenten. Der Inhalt der referenzierten Textbausteine wird erst beim Auflösen der Textbausteine in das Dokument übernommen. Somit bleibt das Dokument immer am aktuellen Stand. Zusätzlich können Bedingungen definiert werden, ob ein Textbaustein angezeigt werden soll. Dadurch können sehr einfach verschiedene Varianten eines Dokuments publiziert werden.

Es gibt zwei Arten von Textbausteinen:

  • Statischer Textbaustein (Xeditor-Absatz)
    Ermöglicht Inhalte eines Kapitels zu erfassen, jedoch keine Kapitel an sich.
  • Statischer Textbaustein (Xeditor-Kapitel)
    Ermöglicht ein Kapitel inklusive Unterkapitel zu erfassen.

Textbausteine können von Xtechwriter-Administratoren in der Xtechwriter-Konfiguration (Bereich „Textbausteine“) verwaltet werden. Diese Textbausteine stehen in allen Ablagen zur Verfügung. Xtechwriter-Benutzer können Textbausteine in den jeweiligen Ablagen verwalten (Aktion „Vorlagen und Voreinstellungen“ > Bereich „Textbausteine“).

Textbausteine erzeugenPermanenter Link zu dieser Überschrift

Um einen Textbaustein zu erzeugen, gehen Sie folgendermaßen vor:

Navigieren Sie in der Xtechwriter-Konfiguration bzw. in der gewünschten Ablage in den Bereich Textbausteine.

  1. Klicken Sie auf die Aktion „Textbaustein erzeugen“.
  2. Klicken Sie auf den Eintrag „Statischer Textbaustein (Xeditor-Absatz)“ bzw. „Statischer Textbaustein (Xeditor-Kapitel)“.
  3. Legen Sie die Metadaten des Textbausteins fest (siehe nächster Abschnitt).
  4. Klicken Sie auf „Weiter“.
  5. Klicken Sie im Kontextmenü des Textbausteins auf „Bearbeiten“.
  6. Legen Sie den Inhalt fest, klicken Sie in der Symbolleiste auf „Speichern“ und schließen Sie das Xeditor-Fenster.

Hinweis: Textbausteine, die in der Xtechwriter-Konfiguration erzeugt wurden, müssen über den Kontextmenübefehl „Zur Verwendung freigeben“ freigegeben werden, bevor Sie verwendet werden können. Änderungen müssen über den Kontextmenübefehl „Erneut freigeben“ freigegeben werden.

Metadaten

Folgende Metadaten können definiert werden:

Registerkarte „Statischer Textbaustein“

  • Name
    Die Bezeichnung des Textbausteins.
  • Formatvorlage
    Definiert die Formatvorlage des Textbausteins.
  • Textbausteinkategorien
    Der Textbaustein wird beim Einfügen in ein Xtech-Dokument unter den angegebenen Kategorien angeboten.
    Hinweis: Textbausteinkategorien können im Kontext der Xtechwriter-Konfiguration direkt im Feld erzeugt werden. Alternativ steht in der Xtechwriter-Konfiguration die Aktion „Textbausteinkategorien festlegen“ zur Verfügung.
  • Textbausteinsprache
    Legt die Sprache des Textbausteins fest. Beim Einfügen von Textbausteinen in Xtech-Dokumenten kann anhand der Sprache gefiltert werden.

Registerkarte „Verwendbarkeit“

  • Kapitel
    Legt die Objektklassen und Kategorien von Kapiteln fest, in denen der Textbaustein verwendet werden kann.
    Hinweis: Wird eine Basisformular-Kategorie eingetragen, steht der Textbaustein auch bei Kapiteln zur Verfügung, denen eine übergeordnete Formular-Kategorie zugewiesen wurde.
  • Xtech-Dokument
    Legt die Objektklassen und Kategorien von Xtech-Dokumenten fest, in denen der Textbaustein verwendet werden kann.
  • Verfügbare Felder (Kapitel)
    Zeigt die Felder, die aufgrund der Definition im Feld Kapitel im Textbaustein zur Verfügung stehen.
  • Verfügbare Felder (Xtech-Dokument)
    Zeigt die Felder, die aufgrund der Definition im Feld Xtech-Dokument im Textbaustein zur Verfügung stehen.
  • Ausdruck für die Einschränkung der Verwendbarkeit
    Der Textbaustein wird in der Publikation nur angezeigt, wenn der definierte Ausdruck true ergibt (siehe Kapitel „Verwendbarkeit“). Somit lassen sich Varianten von Dokumenten realisieren.

Textbausteine verwendenPermanenter Link zu dieser Überschrift

Textbausteine können entweder in der Strukturansicht mithilfe der Aktion „Inhalt einfügen“ > „Textbaustein einfügen“ oder im Xeditor über die Werkzeugleiste „Fabasoft Cloud“ > „Textbaustein einfügen“ eingefügt werden. Die verfügbaren Textbausteine werden abhängig vom jeweiligen Kontext berechnet (z. B. in welchem Kapitel sich der Cursor befindet).

FelderPermanenter Link zu dieser Überschrift

Im Xeditor können Sie über die Werkzeugleiste „Fabasoft Cloud“ > „Feld einfügen“ ausgewählte Metadaten (z. B. Gültig ab) in das Dokument einfügen.

PublikationenPermanenter Link zu dieser Überschrift

Xtech-Dokumente können als PDF-Dokumente publiziert werden. Dabei werden die Stammdaten berücksichtigt und die Bedingungen der Kapitel und Textbausteine. Für die Freigabe der Publikation steht ein mitgelieferter Prozess zur Verfügung, der gegebenenfalls durch einen eigenen Prozess ersetzt werden kann.

Xtech-Dokumente publizierenPermanenter Link zu dieser Überschrift

Um ein Xtech-Dokument zu publizieren, gehen Sie folgendermaßen vor:

  1. Navigieren Sie in das gewünschte Xtech-Dokument.
  2. Wenn Sie den mitgelieferten Prozess verwenden bzw. im benutzerdefinierten Prozess der Reviewer des Xtech-Dokuments als Workflow-Teilnehmer definiert wurde, stellen Sie sicher, dass das Feld Reviewer des Xtech-Dokuments den gewünschten Wert enthält.
  3. Klicken Sie auf die Aktion „Publikationen“ > „Publizieren“.

Es wird eine Publikation erstellt und zusätzlich wird der Freigabeprozess auf der Publikation gestartet.

Die erstellte Publikation wird im Dashboard-Bereich „Publikationen“ und in den Eigenschaften des Xtech-Dokuments auf der Registerkarte „Publikationen“ abgelegt. Zusätzlich sind die Publikationen über die Aktion „Publikationen“ des Xtech-Dokuments erreichbar.

Publikationen freigebenPermanenter Link zu dieser Überschrift

Für die Freigabe der Publikation steht ein vom Produkt mitgelieferter Standardprozess zur Verfügung, der gegebenenfalls durch einen eigenen Standardprozess ersetzt werden kann (siehe Kapitel „Standardprozesse definieren“). Beim Publizieren wird der Standardprozess für die Freigabe implizit gestartet.

Der vom Produkt mitgelieferte Standardprozess besteht aus folgenden Aktivitäten:

  • Publikation zur Freigabe weiterleiten
    Im mitgelieferten Prozess wird diese Aktivität dem im Feld Autor hinterlegten Benutzer zugeteilt.
    • Öffnen
    • Eigenschaften öffnen
    • Kommentieren
      In der Publikation können Kommentare eingefügt werden.
    • Zur Freigabe weiterleiten
      Die Publikation wird dem beim Xtech-Dokument eingetragenen Reviewer zur Freigabe weitergeleitet.
    • Verwerfen
  • Publikation freigeben
    Im mitgelieferten Prozess wird diese Aktivität dem im Feld Reviewer hinterlegten Benutzer zugeteilt.
    • Öffnen
    • Eigenschaften öffnen
    • Kommentieren
    • Freigeben
    • Freigabe ablehnen

In benutzerdefinierten Prozessen können noch folgende publikationsspezifische Aktivitäten verwendet werden:

  • Publikation ablegen
    • Öffnen
    • Eigenschaften öffnen
    • PDF-Kopie ablegen
    • Nicht ablegen
  • Publikation registrieren
    • Öffnen
    • Eigenschaften öffnen
    • PDF-Kopie registrieren
    • Nicht registrieren

PublikationsstatusPermanenter Link zu dieser Überschrift

Eine Publikation kann folgende Status aufweisen:

  • In Ablauf
    Sobald eine Publikation erzeugt wird, erhält sie diesen Status.
  • Verworfen
    Die Publikation wurde verworfen (z. B. Arbeitsschritt „Verwerfen“).
  • Freigegeben
    Die Publikation wurde freigegeben (z. B. Arbeitsschritt „Freigeben“).
  • Nicht freigegeben
    Die Publikation wurde nicht freigegeben (z. B. Arbeitsschritt „Freigabe ablehnen“).

StammdatenPermanenter Link zu dieser Überschrift

Bei Xtech-Dokumenten können Stammdaten im JSON-Format hinterlegt werden, die für die Publikation berücksichtigt werden können.

Um Stammdaten hochzuladen, gehen Sie folgendermaßen vor:

  1. Navigieren Sie in das gewünschte Dokument.
  2. Klicken Sie auf die Aktion „Stammdaten importieren“.
  3. Wählen Sie eine Datei aus, die die Daten im JSON-Format enthält und klicken Sie auf „Hochladen“.

Die aktuellen Stammdaten finden Sie in den Eigenschaften des Xtech-Dokuments auf der Registerkarte „Stammdaten“.

Beispiel

JSON-Datei:

{
  "company": "Acme Ltd.",
  "formed": 2016,
  "active": true
}

Auswertung in einem Textbaustein im Feld Ausdruck für weitere Einschränkungen der Verwendbarkeit:

::document.xtdmasterdata.company == "Acme Ltd.";

VerwendbarkeitPermanenter Link zu dieser Überschrift

Für Kapitel und Textbausteine kann die Verwendbarkeit festgelegt werden. Durch Angabe von app.ducx-Ausdrücken können sehr einfach verschiedene Varianten eines Dokuments publiziert werden.

Im globalen Scope stehen folgende Variablen zur Verfügung:

  • ::document
    Das Dokument, das publiziert wird.
  • ::topic
    Das übergeordnete Kapitel.
  • ::hierarchy
    Die Hierarchie vom Dokument bis zum gerade berechneten Objekt.

Beispiel

// Kategorie des Dokuments muss der benutzerdefinierten Kategorie mit der
// Fabasoft Cloud ID "COO.1.506.2.4710"
entsprechen
::document.objcategory == COO.1.506.2.4710;

// Beim übergeordneten Kapitel muss das benutzerdefinierte Formularfeld
// "formstr1" den Wert "Wert 1" aufweisen

::topic.[#formstr1] == "Wert 1";

// Beim übergeordneten Kapitel (-1 entspricht dem letzten Kapitel in der
// Hierarchie) muss der Betreff den Wert "Wert 1" aufweisen

::hierarchy[HasClass(#XtechTopic)][-1].objsubject == "Wert 1";

// Beim aktuellen Kapitel muss das benutzerdefinierte Formularfeld
// "formstr1" den Wert "Wert 1" aufweisen

::cooobj.[#formstr1] == "Wert 1";