Anwendung "Technical Information"
Technical Information – Übersicht
Sie müssen einen Dokumenttyp auf dem Arbortext Publishing Engine Server implementieren, der das von der Serviceanwendung erstellte umgewandelte XML-Dokument publizieren kann. Im Lieferumfang von Arbortext Editor and Publishing Engine ist eine DITA-Dokumenttyp-Beispielanwendung enthalten, die Sie als Ausgangspunkt verwenden oder analysieren können, um die wichtigsten Anforderungen für einen eigenen Dokumenttyp zu ermitteln.
Die Anwendung "Technical Information" weist einen spezialisierten DITA-Dokumenttyp auf. Sie organisiert und verwaltet Informationen zu Wartungsoperationen und -teilen. Die Anwendung ist auf dem Arbortext Publishing Engine Server standardmäßig in folgendem Verzeichnis installiert:
Arbortext-path\application\com.ptc.arbortext.techinfo
Beschreibung des Dokumenttyps "Technical Information"
Die Themen der Anwendung "Technical Information" können verwendet werden, um Wartungsinformationen zu entwickeln, oder als Ausgangspunkt zum Entwickeln einer eigenen spezialisierten DITA-Anwendung dienen. Die Anwendung "Technical Information" ist eine Spezialisierung der Arbortext DITA-Anwendung, ein angepasster Dokumenttyp muss jedoch nicht auf DITA basieren.
Die folgenden Thementypen sind für den Dokumenttyp "Technical Information" verfügbar:
Konzept
Stellt Hintergrundinformationen bereit, die Benutzer verstehen müssen, bevor sie mit einem Produkt oder einer Schnittstelle arbeiten oder eine Aufgabe ausführen können.
Deckblatt
Stellt die Informationen bereit, die auf dem Deckblatt einer PDF-Datei oder eines gedruckten Dokuments angezeigt werden sollen.
Diagnose
Stellt Diagnoseinformationen bereit.
Verfahren
Stellt ein Verfahren zum Durchführen einer Aufgabe bereit. In diesem Fall werden die Schritte und Grafiken zu einem einzelnen Textfluss kombiniert.
Referenz
Stellt Informationen zu den regulären Funktionen eines Service, Produkts oder Teils bereit.
Nebeneinander-Verfahren
Stellt ein Verfahren zum Durchführen einer Aufgabe bereit. In diesem Fall werden die Schritte und Grafiken nebeneinander in einem Tabellenformat dargestellt.
Aufgabe
Stellt Verfahrensablaufinformationen bereit.
Problembehandlung
Stellt Informationen zur Problembehandlung oder Diagnose bereit.
Beschreibung der Formatvorlage "Technical Information"
Der Dokumenttyp "Technical Information" beinhaltet eine Arbortext Styler Beispielvorlage zur Publizierung, die in folgendem Verzeichnis abgelegt ist:
Arbortext Pfad\application\com.ptc.arbortext.techinfo
\doctypes\techinfo\techinfo.style
Umwandlung und Formatierung überprüfen
Sie können eine Formatvorlage für die Ausgabe erzeugen. Um den Fortschritt zu überprüfen, können Sie das Stammdokument aus der Payload öffnen, Anpassungen an der Formatvorlage vornehmen und die Änderungen testen, wenn Sie die Ausgabe mit Arbortext Publishing Engine Interactive generieren. XSLT-Autoren können diesen Prozess auch verwenden, um ihre Umwandlungen zu bewerten, die die Zielzuordnung und die Zielteilelisten erzeugen.
Sie müssen eine Payload vom Arbortext Publishing Engine Server abrufen. WVS und Arbortext Publishing Engine müssen für die Publizierung eingerichtet sein. Auf dem Arbortext Publishing Engine Server muss das Transaktionsarchiv konfiguriert und aktiv sein. (Informationen zum Transaktionsarchiv finden Sie in der Configuring Arbortext Publishing Engine (Arbortext Publishing Engine konfigurieren) Dokumentation, die Teil der Dokumentation zu Arbortext Publishing Engine ist.) Sie können dann einen Publizierungsantrag aus Ihrer Publikationsstruktur, Informationsstruktur oder Teileliste in Windchill starten. Suchen Sie die Transaktion im Transaktionsarchiv, laden Sie die Datei mit dem Antragstext namens rqbody.dat herunter, und benennen Sie sie um. Verwenden Sie zur Umbenennung die Erweiterung .zip.
Öffnen Sie das Stammdokument Identifier.xml der Payload in Arbortext Publishing Engine Interactive, um die Zielzuordnung manuell zu erzeugen. Sie können entweder die Dateien zuerst aus payload.zip extrahieren und das Stammdokument Identifier.xml öffnen, oder Sie können die Datei payload.zip selbst öffnen. Bearbeiten > Transformiertes Dokument bearbeiten wird nur angezeigt, wenn Sie eine Identifier.xml-Datei aus einer Payload öffnen. (Dies bedeutet, der Dokumenttyp muss PublicationStructure lauten, damit die Menüoption verfügbar ist.) Wenn Sie Transformiertes Dokument bearbeiten wählen, führt Arbortext Publishing Engine Interactive die Umwandlung aus der Serviceanwendung für das Stammdokument und alle zugehörigen referenzierten Dokumente aus. Dann wird die resultierende Zielzuordnung (z.B. techinfomap) in einem neuen Fenster angezeigt.
Wenn Sie eine DITA-Map-Spezialisierung verwenden, können Sie Bearbeiten > Komplettdokument für Formatierung bearbeiten in Arbortext Publishing Engine Interactive verwenden, um das formatierte Ergebnis anzuzeigen. Wenn das Ziel ein anderer Dokumenttyp war, können Sie das Ergebnis zumindest anzeigen, indem Sie die Zuordnung anzeigen und publizieren.
Die folgenden Abschnitte enthalten einige Tipps zum Aufbau der Formatvorlage techinfo.style.
Handbuchtitel
In der Beispielformatvorlage wird das Attribut outputclass für das techinfomap-Map-Stammelement verwendet, um die folgenden Titel zu generieren:
outputclass-Attributwert
Titel
service
Servicehandbuch
installation
Installationshandbuch
owners
Benutzerhandbuch
parts
Illustrated Parts Catalog (IPC)
Nummerierung der Titelseite
Auf der Titelseite werden mithilfe von number und numberlist einleitende Ausdrücke für Seriennummern, Teilenummern und Modellnummern generiert.
outputclass-Attributwert
Ausdruck
serial
Seriennr.
part
Teilenr.
model
Modellnr.
Wenn der outputclass-Wert leer ist oder nicht den aufgeführten Werten entspricht, wird kein Text generiert. numberlist kann numberarrange enthalten.
Nebeneinander-Verfahren
Um ein Verfahren so darzustellen, dass der Text auf der linken und die Grafiken auf der rechten Seite angezeigt werden, müssen Sie eine spezielle Tag-Struktur anwenden. Mindestens eines der procstep-Tags muss ein procinfo-Tag enthalten. Wenn keine procinfo-Tags im Verfahren vorhanden sind, wird es nicht als Nebeneinander-Verfahren angezeigt.
Änderungen der Teilelistentabelle
Das Teilelisten-XML-Markup ist eine angepasste Tabelle. Die Arbortext Styler Formatvorlage verwendet daher einige der Tabelleneigenschaften zum Anwenden von Formatierungen. Die standardmäßige Teilelistentabelle enthält die Elementnummer, die Gliederung, die Teilenummer, den Teilenamen, die Menge, den Indikator für die Wartbarkeit, die Angabe "Nicht illustriert" sowie Anmerkungen.
Eigenschaft
Datentyp
partattribute-Name
Ausgabe
Elementnummer
Zeichenfolge
itemNumber
Ja
Elementsequenznummer
Ganzzahl
itemSequenceNumber
Nein
Gliederung
Ganzzahl (0–6)
indenture
Nein, getestet
Teilenummer
Zeichenfolge
number
Ja
Teilename
Zeichenfolge
name
Ja
Menge
Zeichenfolge
itemQuantity
Ja
Indikator "Wartbar"
Boolesch
serviceable
Nein, getestet
Nicht illustriert
Boolesch
illustrated
Nein, getestet
Siehe
FIG
ITM
ISN
referTo
Nein
Anmerkungen
Zeichenfolge
remarks
Yes
Um die Werte von serviceable und illustrated zu testen, müssen Sie die Werte von partattribute name=”serviceable” und partattribute name=”illustrated” als Attribut zu partitem hinzufügen, indem Sie die XML-Version der Formatvorlage bearbeiten, anstatt die Arbortext Styler Benutzeroberfläche zu verwenden.
Die Ausgabe der Element- und Teilenummer ist wie folgt von den Werten der Eigenschaften serviceable und illustrated abhängig:
Wartbar
Illustriert
Teilenummer anzeigen?
Elementnummer anzeigen?
Wahr
Wahr
Ja
Ja
Wahr
Falsch
Ja
Nein
Falsch
Wahr
Nein
Ja
Falsch
Falsch
Nein
Nein
Indem Sie die XML-Version der Formatvorlage ändern und SetOutputAttribute verwenden, werden die Werte als Attribute gespeichert. Diese Attribute werden anschließend mit den _sfe-Elementen getestet, die als Teil der angepassten Tabelle generiert werden.
War dies hilfreich?