Handbuch Dokumentations- generator

Transcription

Innovator 11
Handbuch
Dokumentationsgenerator
www.mid.de
Handbuch Dokumentationsgenerator – Innovator 11 (Version 11.2) – Ausgabe Juli 2010
Copyright © 1986-2010 MID GmbH Nürnberg. Alle Rechte vorbehalten.
Das Copyright für die Innovator-Software und die Dokumentation liegt ausschließlich bei der MID GmbH.
Die Vervielfältigung und Veröffentlichung – auch in Auszügen – bedarf in jedem Fall der schriftlichen Genehmigung der
MID GmbH. Zuwiderhandlungen werden gemäß des Urheberschutzgesetzes strafrechtlich verfolgt.
In dieser Dokumentation werden eingetragene Warenzeichen und Handelsnamen verwendet. Auch ohne Kennzeichnung
gelten die entsprechenden Schutzbestimmungen.
Der Inhalt der Dokumentation ist nur zur Information bestimmt und kann jederzeit ohne Vorankündigung geändert
werden. Die MID GmbH geht damit keinerlei Verpflichtungen ein. Für Schäden, die aus der Benutzung der Software und
der Dokumentation entstehen, übernimmt die MID GmbH keine Haftung.
Inhaltsverzeichnis
Inhaltsverzeichnis
Modelldokumentation erzeugen ................................................................................................................1
Unterstützte Formate .......................................................................................................................................... 1
1
Dokumentationsgenerator starten ..............................................................................................................2
1.1 Dokumentationsgenerator unter Windows aufrufen ...................................................................3
1.2 Parameter des Dokumentationsgenerators unter Windows verwenden..................................3
Erzeugung der Dokumentation direkt anstoßen .................................................................................................. 3
2
Eingabedaten und Ausgabeeinstellungen bestimmen ...........................................................................8
2.1 Eingabedaten angeben...........................................................................................................................8
Modelltyp bestimmen ......................................................................................................................................... 8
Eingaberepository (Informationsdateien) wählen................................................................................................. 9
Eingabe-ASCII-Datei wählen .............................................................................................................................. 9
2.2
Ausgabeeinstellungen vornehmen ....................................................................................................10
Ausgabeverzeichnis wählen ................................................................................................................................ 10
Eingaberepository löschen ................................................................................................................................. 10
Mehrseitige Grafiken umwandeln...................................................................................................................... 11
Zeichenüberprüfung einschalten........................................................................................................................ 11
Leerkapitel unterdrücken................................................................................................................................... 12
Modellprüfung ausschalten................................................................................................................................ 12
Kapitelüberschriften in Spiegelstrichlisten wandeln ........................................................................................... 12
3
Ausgabeart wählen ........................................................................................................................................13
3.1 Dokumentation im Voranzeigefenster ausgeben .........................................................................14
Voranzeigefenster als Ausgabeart bestimmen ..................................................................................................... 14
Standarddrucker festlegen.................................................................................................................................. 14
3.2
Dokumentation im Format MS-Word für Windows ausgeben ...............................................15
Formatvorlagen zur Verfügung stellen ............................................................................................................... 15
Gliederungsnummerierung von Word für Windows nutzen.............................................................................. 16
Word für Windows als Ausgabeart bestimmen .................................................................................................. 17
Grafikformat bestimmen ................................................................................................................................... 17
Ausgabe ohne Grafikdateien .............................................................................................................................. 17
Dokumentation in Word für Windows mit Tcl-Skript verbinden ..................................................................... 18
Dokumentationsausgabe für Word für Windows steuern .................................................................................. 18
Inhaltsverzeichnis erzeugen bzw. aktualisieren ................................................................................................... 19
Grafiken darstellen und Skalierung bestimmen.................................................................................................. 19
Kopf- und Fußzeilen bearbeiten ........................................................................................................................ 20
Einbinden von Fremdobjekten .......................................................................................................................... 20
Konvertierung von Dokumenten für Word 2003 (SP 3) ................................................................................... 20
3.3
Dokumentation im Format ASCII-Text ausgeben ......................................................................21
ASCII-Format als Ausgabeart bestimmen .......................................................................................................... 21
Copyright © 2010 MID GmbH
I
Inhaltsverzeichnis
Dokumentation in ASCII-Format mit Tcl-Skript verbinden ............................................................................. 22
Dokumentation direkt in RTF-, HTML- oder FrameMaker-Format ausgeben ................................................. 23
Skalierung der Importgrafiken bestimmen......................................................................................................... 23
3.4
Dokumentation im Format XML ausgeben ..................................................................................23
XML-Format als Ausgabeart bestimmen............................................................................................................ 24
XSL-Stylesheet auswählen ................................................................................................................................. 25
XSL-Stylesheet auswerten .................................................................................................................................. 25
Dokumentation in XML-Format mit Tcl-Skript verbinden .............................................................................. 26
3.5
Dokumentation als PostScript-Dokument ausgeben .................................................................26
PostScript als Ausgabeart bestimmen................................................................................................................. 27
PostScript-Dokument mit Tcl-Skript verbinden................................................................................................ 27
II
Handbuch Dokumentationsgenerator Innovator 11
Modelldokumentation erzeugen
Voraussetzung zur Erzeugung einer Dokumentation sind die sogenannten
Informationsdateien (siehe Handbuch classiX - C Dokumentation, Kapitel
C-4, "Modelldokumentation konfigurieren"). Sie enthalten die notwendigen Daten für die Dokumentation, also Modelldaten, Grafik- und Selektionsinformationen und die Struktur der Dokumentation. Sie spiegeln den
Stand der Modellentwicklung wider, der zum Zeitpunkt ihrer Generierung
erreicht war.
Mit dem Dokumentationsgenerator inodocu.exe können Sie aus diesen
Informationsdateien Ihre Modelldokumentation erzeugen und ausgeben.
Der Dokumentationsgenerator verwendet also nicht das zentrale OnlineRepository, in dem die Änderungen im Modell fortlaufend auf dem aktuellsten Stand festgehalten werden, sondern verarbeitet eine Momentaufnahme des Repositorys. Diese Offline-Festlegung ermöglicht, Dokumentationen in verschiedenen Ausgabeformaten – PostScript, Word for Windows
etc. – zu erzeugen, die alle denselben Stand der Modellentwicklung widerspiegeln, ohne dass die Entwickler ihre Arbeit bis zum Abschluss der Dokumentationsgenerierung ruhen lassen müssen.
Um zu einem späteren Zeitpunkt einen bestimmten Stand der Modellentwicklung dokumentieren zu können, muss das Modell in diesem
Zustand versioniert werden.
Hinweis
Für die Ausgabe einer Dokumentation stehen Ihnen im Dokumentationsgenerator verschiedene Kombinationen von Dokumentarten und Grafikformaten zur Verfügung.
Für die Ausgabearten PostScript-Dokument und Voranzeigefenster werden
stets EPS- Grafiken erzeugt. Für die Ausgabearten Word-für-Windows-Dokument, ASCII-Text-Dokument und XML wählen Sie das zu erzeugende
Grafikformat:
Unterstützte Formate
•
•
•
•
EMF (Enhanced Metafile)
EPS (Encapsulated PostScript)
PNG (Portable Network Graphic)
SVG (Scalable Vector Graphic)
1
Ausgabeart
Grafikformat
EPS
1
PNG
SVG
EMF
PostScript-Dokument
9
Voranzeigefenster
9
Word-für-Windows-Dokument
9
9
9
9
ASCII-Text-Dokument
9
9
9
9
XML
9
9
9
9
Dokumentationsgenerator starten
Je nachdem, auf welcher Plattform Sie arbeiten, müssen Sie den Dokumentationsgenerator auf unterschiedliche Weise starten. Dabei können Sie Parameter setzen oder den Dokumentationsgenerator aus Skripten heraus
starten. Auf allen Plattformen können Sie zudem bestimmen, dass die Erzeugung der Dokumentation direkt nach Generierung der Informationsdateien angestoßen wird (siehe Seite 4).
Hinweis
Normalerweise wird der Dokumentationsgenerator inodocu.exe automatisch gestartet, wenn Sie für das Dokumentationskommando (eXcellence) bzw. die Dokumentationsvorlage (classiX) ein anderes Ausgabeformat als Doku-Repository eingestellt haben.
Wenn Sie Doku-Repository als Ausgabeformat gewählt haben, empfiehlt es sich, im Eingabefeld Name der Informationsdateien einen
Dateinamen anzugeben, den Sie anschließend als Eingaberepository für die
Dokumentationsgenerierung verwenden können.
Lassen Sie dieses Feld leer, wird automatisch ein Dateiname generiert, den
Sie im Infofenster Doku-Information sehen können.
Wenn Sie ein anderes Ausgabeformat verwenden und das Doku-Repository
verwenden wollen, um anschließend noch eine Dokumentation in einem
anderen Format zu generieren, müssen Sie in der Gruppe Optionen das
Auswahlfeld Eingaberepositorys bei Erfolg löschen deaktivieren.
Sie können die Einstellungen für den Dokumentationsgenerator entweder
über Parameter beim Starten des Programms in der Kommandozeile oder
über eine Dialogbox vornehmen. Die Liste der Parameter finden Sie auf
Seite 4. Wie Sie die Einstellungen in der Dialogbox vornehmen, lesen Sie
ab Seite 8.
2
1.1 Dokumentationsgenerator unter Windows aufrufen
1.1
Dokumentationsgenerator unter Windows aufrufen
Wenn Sie unter Windows arbeiten, finden Sie das Programm Dokumentationsgenerator inodocu.exe im Ordner Dokumentation der Programmgruppe Innovator.
So gehen Sie vor
Um den Dokumentationsgenerator zu starten:
» Doppelklicken Sie auf das Symbol Dokumentationsgenerator im
Ordner Dokumentation der Programmgruppe.
Die Dialogbox Dokumentationsgenerator öffnet sich, in der Sie,
wie in Kapitel 2, Seite 8, beschrieben, die erforderlichen Einstellungen
für die Ausgabe der Dokumentation vornehmen.
1.2
Parameter des Dokumentationsgenerators unter Windows verwenden
Beim Aufruf des Dokumentationsgenerators können Sie bereits in der
Kommandozeile Parameter wie etwa die Modelltyp, Ausgabeverzeichnis
und -format oder den zu verwendenden Drucker über verschiedene Parameter festlegen(siehe Seite 4). Je nachdem, welche Optionen Sie beim Aufruf angeben, wird die Dialogbox gar nicht geöffnet oder die entsprechenden Felder in der Dialogbox werden vorbesetzt.
Wenn Sie beim Aufruf des Dokumentationsgenerators inodocu.exe
keine Parameter angeben, verwendet dieser die Standardeinstellungen.
Hinweis
Wenn Sie beim Aufruf des Dokumentationsgenerators Name und ggf. Pfad
des Eingaberepositorys sowie die Dateinamenserweiterung für den zu dokumentierenden Modelltyp angeben, können Sie die Erzeugung der Dokumentation direkt anstoßen.
Erzeugung der
Dokumentation direkt
anstoßen
So gehen Sie vor
Um den Dokumentationsgenerator inodocu.exe so zu starten, dass unmittelbar nach dem Aufruf die gewünschte Dokumentation erzeugt wird:
» Geben Sie in der Kommandozeile
inodocu <Optionen> <Name des Eingaberepositorys>
ein.
Falls sich die Informationsdateien nicht im aktuellen Arbeitsverzeichnis
befinden:
» Geben Sie bei <Name des Eingaberepositorys> den Pfad an.
Um den Modelltyp zu bestimmen, den Sie dokumentieren möchten:
3
» Setzen Sie den entsprechende Parameter (siehe Seite 4) oder geben Sie
die entsprechende Dateinamenserweiterung der Datei des Eingaberepositorys an, welche die Modelldaten enthält.
Hinweis
Die Dateinamenserweiterungen für die Informationsdateien, welche
die Modelldaten enthalten, lauten:
.d1 für Innovator Function (Standard)
.d2 für Innovator Data classiX
.d3 für Innovator Object classiX
.d4 für Innovator Business
.d5 für Innovator Process (PHB)
.d6 für Innovator Object eXcellence
.d7 für Innovator Report
.d8 für Innovator Data eXcellence
Beim Aufrufen des Dokumentationsgenerators können Sie diverse Parameter festlegen. Nachfolgend finden Sie eine Liste mit den verfügbaren Optionen und ihren Wirkungen.
Hinweis
Einige Parameter können Sie auch im Abschnitt Einstellungen der
Datei inodocu1.ini einstellen.
Parameter (Windows)
Wirkung
Option in der Dialogbox
/args <Argumente>
Gruppe NachbearbeiArgumente des Nachbearbeitungstungskommando, Eingabefeld
kommandos (siehe -cmd).
Neben den angegebenen Argumenten Argumente
wird der Pfadname der erzeugten Ausgabedatei übergeben. Damit lässt sich
z. B. eine Anwendung für die generierte Ausgabedatei aufrufen.
/AT <Grafikformat>
Die Dokumentation wird als ASCIIText erzeugt.
Auswahlliste Ausgabeart,
Eintrag ASCII-Text Dokument
-av <Name>
/av <Name>
(nur eXcellence)
4
Gibt an, welche in der Modellkonfi- guration gespeicherte Prüfroutine zur
Verifikation der Modellinhalte herangezogen werden soll ("apply verification").
1.2 Parameter des Dokumentationsgenerators unter Windows verwenden
Parameter (Windows)
Wirkung
/BM
/DATA
/ERM
/REPORT
/SASD
/UML14
/UML20
/VM
Bestimmt den Dokumentationstyp
(BM - Business, DATA - Data eXcellence, ERM - Data classiX, REPORT
- Report, SASD - Function, UML14 Object classiX, UML20 - Object
eXcellence, VM - Process)
(bestimmt durch Modelltyp)
/bpf
Bei der Generierung in ASCII-Text,
XML oder für Word für Windows
werden keine Grafikdateien erzeugt.
Auswahlfeld Keine Grafikausgabedateien erstellen
/cc
Zeichenüberprüfung wird ausgeschal- Auswahlfeld Keine Zeichenüberprüfung
tet.
/chcd
Hauptkapitel, für die im Strukturbaum keine Unterkapitel festgelegt
wurden oder aufgrund der modellierten Sachverhalte in dem Ergebnisdokument keine hätten, werden in Spiegelstrichlisten umgewandelt. Für sie
wird keine Überschrift ausgegeben.
Alternativfeld Dynamisch
/chcs
Hauptkapitel, für die im Strukturbaum keine Unterkapitel festgelegt
wurden, werden in Spiegelstrichlisten
umgewandelt. Für sie wird keine
Überschrift ausgegeben.
Alternativfeld Nur Blatt-
Nachbearbeitungskommando, z. B. in
Form eines Tcl- (classiX) oder JavaSkripts (eXcellence) bei der Ausgabe
in die Formate PostScript, Word,
ASCII oder XML. Das Skript wird
zum Abschluss der Dokumentationserstellung automatisch ausgeführt.
Gruppe Nachbearbeitungskommando, Eingabefeld
/cmd <Kommando>
/cmg
knoten im Strukturbaum
Kommando
Grafiken in den Formaten EPS oder Auswahlfeld Mehrseitige
PNG, die laut Konfiguration im Dia- Grafiken in einseitige
gramm- oder Tabelleneditor mehrere umwandeln
Seiten einnehmen, werden in der Dokumentation einseitig ausgegeben.
Diese Option gilt nicht für Grafiken
in den Vektorformaten SVG und
EMF, da diese Grafiken immer auf
eine einzige Seite skaliert werden.
5
Parameter (Windows)
Wirkung
/d <Pfad>
Bestimmt den Pfad des Verzeichnisses, in das die Dokumentation generiert werden soll. Wird kein Ausgabeverzeichnis festgelegt, werden die Dateien im aktuellen Arbeitsverzeichnis
abgelegt.
Eingabefeld Ausgabeverzeichnis
/ec
Bei der Dokumentationserstellung
werden alle leeren Hauptkapitel zu
Modellbestandteilen unterdrückt.
Auswahlfeld Unterdrücken
aller leeren Kapitel
EPS
PNG
EMF
SVG
Bestimmt das Grafikformat bei den
Ausgabearten ASCII-Text-Dokument, XML und Word-für-Windows-Dokument. Bei der Eingabe
ist das Grafikformat dem Ausgabeformat nachzustellen (z. B.: /WW EPS)
Auswahlliste Grafikformat
/f
Bestimmt, dass die Daten aus einer
Eingabefeld Eingabe-ASCII-Datei
servergenerierten ASCII-Datei und
nicht aus den Informationsdateien gelesen werden.
/ihl <Ebene>
Die Kapitelnummern beginnen bei
Gliederungsebene <Ebene>.
-
Bestimmt, dass das kleinste gemeinsame Paket als Wurzel verwendet wird.
Auswahlfeld Kleinstes ge-
(nur Word für Windows)
/lcp
meinsames Paket als
Wurzel verwenden
werden keine Kapitelnummern erzeugt.
-
/oa
Bei den Ausgabearten Word-fürWindows und XML wird die Ausgabedatei automatisch geöffnet.
-
/on
Bei den Ausgabearten Word-fürWindows und XML wird die Ausgabedatei nicht geöffnet.
/oq
Bei den Ausgabearten Word-fürWindows und XML wird die Ausgabedatei nach Anfrage geöffnet.
/p <Drucker>
Ist als Ausgabeformat Voranzeige- Auswahlliste Drucker
fenster ausgewählt, bestimmt dies
den Drucker, auf dem die Dokumentation ausgegeben werden soll.
/nwhn
(nur Word für Windows)
6
1.2 Parameter des Dokumentationsgenerators unter Windows verwenden
Parameter (Windows)
Wirkung
/pmv
unterbleibt die Prüfung von Elementen des Modells.
Auswahlfeld Keine Modellverifikation
/PS
Die Dokumentation wird im PostScript-Format ausgegeben
Eintrag PostScript
/PV
Die Dokumentation wird im Voranzeigefenster ausgegeben.
Eintrag Voranzeigefenster
/rir
Die Informationsdateien werden
Auswahlfeld Eingabereponach einer erfolgreichen Dokumenta- sitorys bei Erfolg löschen
tionserstellung gelöscht.
/sp <Pfad>
Wird beim Import von Grafik- oder
Textdateien mittels der Punktkommandos .import bzw. .include
ein relativer oder absoluter Pfad für
die Datei angegeben, so wird die Datei dieser Angabe entsprechend geladen. Wird dagegen nur der Name einer Datei spezifiziert, so legt diese
Option die Verzeichnisse fest, in denen die Datei gesucht wird, falls sie
nicht im aktuellen Arbeitsverzeichnis
abgelegt ist. Mehrere Pfade sind
durch senkrechte Striche ('|') zu
trennen.
/stsh <Datei>
Gibt bei einer XML-Dokumentation
ein XSL-Stylesheet an (siehe -x).
-
Eingabefeld XSL-Stylesheet
/u
Bewirkt die Ausgabe der Aufrufsyntax
zum Programm inodocu.
-
/v
Bewirkt die Ausgabe der Versionsinformation zum Programm inodocu.
-
/w
Bewirkt, dass das Fenster zur Anzeige
des Bearbeitungsstandes bei der Dokumentationserstellung auch dann
geöffnet wird, wenn der Aufruf von
inodocu unter Angabe eines Namens für die Informationsdateien erfolgte.
-
7
Parameter (Windows)
Wirkung
/WW <Grafikformat>
Die Dokumentation wird als Datei
im MS-Word-für-Windows-Format
erzeugt.
Eintrag Word-für-Win-
/x
/XML <Grafikformat>
2
dows-Dokument
Nach Erstellung einer XML-Dokumentation wird das angegebene XSLStylesheet (siehe /stsh) ausgewertet.
Auswahlfeld XSL-Transformation durchführen
Die Dokumentation wird als Datei
im XML-Format erzeugt.
Eintrag XML
Eingabedaten und Ausgabeeinstellungen bestimmen
Der Dokumentationsgenerator nutzt die Informationsdateien eines bestimmten Modelltyps, um daraus entsprechend der durch Sie bestimmten
Ausgabeparameter und Layoutvorgaben die Modelldokumentation zu erstellen.
Für die gemeinsame Dokumentation von Modellen unterschiedlichen Typs
nutzen Sie die Edition Innovator Report.
In der Dialogbox Dokumentationsgenerator können Sie über eine
Reihe von Optionen folgendes bestimmen:
• den zu dokumentierenden Modelltyp
• das Eingaberepository, unter dessen Namen die zu verwendenden Informationsdateien abgelegt sind
• das Ausgabeverzeichnis, in das die vom Dokumentationsgenerator inodocu.exe generierten Dateien gegebenenfalls abgelegt werden sollen
• die Ausgabeart und damit verbunden gegebenenfalls Grafikformate,
Drucker und XSL-Stylesheets
• bestimmte Layoutvorgaben
• ob die Modellprüfung ein- oder ausgeschaltet sein soll
2.1
Eingabedaten angeben
Im ersten Arbeitsschritt bestimmen Sie, welcher Modelltyp dokumentiert
und welche Informationsdateien hierfür verwendet werden sollen.
Modelltyp bestimmen
8
Als Erstes wählen Sie den Modelltyp, den Sie dokumentieren möchten.
2.1 Eingabedaten angeben
So gehen Sie vor
Um den Modelltyp zu bestimmen:
» Öffnen Sie, wie auf Seite 2 beschrieben, die Dialogbox Dokumentationsgenerator.
» Wählen Sie in der Auswahlliste Dokumentationstyp den Modelltyp
aus, den Sie dokumentieren möchten.
Nun wählen Sie die Informationsdateien, die Sie, wie im Handbuch
classiX - C Dokumentation, Kapitel C-4, "Modelldokumentation konfigurieren", beschrieben, generiert haben. Dazu wählen Sie das entsprechende
Eingaberepository aus. Nur die zum Modelltyp passenden Informationsdateien werden zur Auswahl angezeigt.
Eingaberepository
(Informationsdateien)
wählen
Das Ausgaberepository, das Sie für das Dokumentationskommando
unter Eigenschaften... im Register Optionen im Eingabefeld
Name der Informationsdateien angegeben haben, dient dem Dokumentationsgenerator als Eingaberepository (siehe Handbuch
classiX - C Dokumentation, Kapitel , Abschnitt "Ausgabeformat einer
Dokumentationsvorlage ändern").
Hinweis
So gehen Sie vor
Um ein Eingaberepository auszuwählen:
» Geben Sie in der Dialogbox Dokumentationsgenerator Namen
und vollständigen Pfad einer der Informationsdateien des Repositorys
im Eingabefeld Eingaberepositorys ein (siehe Handbuch classiX C Dokumentation, Kapitel , "Informationsdateien kennen lernen", Abschnitt "Informationsdateien kennen lernen")
oder
» Klicken Sie auf [Auswählen] und wählen Sie eine Datei aus.
Name und Pfad werden in das Eingabefeld Eingaberepositorys
übernommen.
Anstelle eines Eingaberespository können Sie aber auch eine andere Art
von Eingabedatei im ASCII-Format wählen. Diese kann nur von einem
Tcl-Interpreter aus über entsprechende Kommandos erstellt werden. Eine
solche Eingabedatei enthält eine bereits mit Informationen vom Server ausgefüllte Dokumentationsstruktur.
Eingabe-ASCII-Datei
wählen
9
So gehen Sie vor
Um eine Eingabe-ASCII-Datei auszuwählen:
» Geben Sie in der Dialogbox Dokumentationsgenerator Namen
und vollständigen Pfad der Datei im Eingabefeld Eingabe-ASCIIDatei ein
oder
» Klicken Sie auf [Auswählen] und wählen Sie eine Datei aus.
Name und Pfad werden in das Eingabefeld Eingabe-ASCII-Datei
übernommen.
2.2
Ausgabeeinstellungen vornehmen
Wenn Sie die Eingabedaten angegeben haben (siehe Seite 8), legen Sie ggf.
fest, wo die erzeugten Daten abgelegt werden sollen, und nehmen weitere
Einstellungen für die Ausgabe der Dokumentation vor.
Ausgabeverzeichnis
wählen
Hinweis
Sie können ein Verzeichnis angeben, in das die Dateien abgelegt werden
sollen, die bei der Erzeugung der Dokumentation generiert werden.
Wenn Sie kein Ausgabeverzeichnis festlegen, werden die Dateien im aktuellen Arbeitsverzeichnis abgelegt.
So gehen Sie vor
Um das Ausgabeverzeichnis festzulegen:
» Geben Sie es im Eingabefeld Ausgabeverzeichnis mit vollständigem Pfad an.
Treffen Sie nun ggf. in der Gruppe Optionen weitere Einstellungen für
die Ausgabe der Dokumentation.
Eingaberepository
löschen
10
Sie können bestimmen, dass die Informationsdateien nach erfolgreicher Erstellung der Dokumentation gelöscht werden.
2.2 Ausgabeeinstellungen vornehmen
So gehen Sie vor
Damit die Informationsdateien nach Erzeugung der Dokumentation gelöscht werden:
» Aktivieren Sie in der Dialogbox Dokumentationsgenerator in der
Gruppe Optionen das Auswahlfeld Eingaberepositorys bei
Erfolg löschen.
Solange die Eingaberepositorys nicht gelöscht werden, können Sie die
Dokumentationsgenerierung beliebig oft wiederholen.
Hinweis
Im Dokumentationsgenerator können Sie bestimmen, ob Grafiken in den
Formaten EPS oder PNG, die laut Konfiguration im Diagramm- oder Tabelleneditor mehrere Seiten einnehmen, in der Dokumentation ein- oder
mehrseitig ausgegeben werden. Diese Option gilt nicht für Grafiken in den
Vektorformaten SVG und EMF, da diese Grafiken immer auf eine einzige
Seite skaliert werden.
Mehrseitige Grafiken
umwandeln
So gehen Sie vor
Um mehrseitige Grafiken in einseitige umzuwandeln:
Gruppe Optionen das Auswahlfeld Mehrseitige Grafiken in
einseitige umwandeln.
Diese Option ist für das Dokumentationskommando auch unter Eigenschaften... im Register Optionen (eXcellence) bzw. im Register Ausgabeformat (classiX) zu finden.
Hinweis
Die Zeichenüberprüfung ist bei der Erstellung neuer Dokumentationskommandos (eXcellence) bzw. Dokumentationsvorlagen (classiX) standardmäßig ausgeschaltet. Bei der Dokumentationserstellung erscheint
dann keine Warnung, wenn in einem Dokument ein Zeichen vorkommt,
das mit dem gewählten Ausgabeformat nicht umgesetzt werden kann. Sie
können diese Funktion einschalten.
Zeichenüberprüfung
einschalten
So gehen Sie vor
Um die Zeichenüberprüfung einzuschalten:
» Deaktivieren Sie in der Dialogbox Dokumentationsgenerator in
der Gruppe Optionen das Auswahlfeld Keine Zeichenüberprüfung.
11
Leerkapitel
unterdrücken
Hinweis
Standardmäßig erscheinen in der erstellten Dokumentation für leere
Hauptkapitel zu Modellbestandteilen die Überschrift und je ein Eintrag im
Inhaltsverzeichnis und im Index. Sie können bestimmen, dass diese leeren
Kapitel bzw. die Einträge für diese Kapitel in der Dokumentation unterdrückt werden.
Wenn ein leeres Kapitel in einen Spiegelstrichlisteneintrag gewandelt
wurde, wird es nicht mehr entfernt (siehe Seite 12).
So gehen Sie vor
Um die Leerkapitel zu unterdrücken:
Gruppe Optionen das Auswahlfeld Unterdrücken aller leeren
Kapitel.
Modellprüfung
ausschalten
Standardmäßig erfolgt bei der Dokumentationserstellung die Prüfung von
Elementen des Modells. Sie können diese Funktion ausschalten, z. B. um
eine erneute Prüfung zu verhindern.
So gehen Sie vor
Um die Modellprüfung auszuschalten:
Gruppe Optionen das Auswahlfeld Keine Modellverifikation.
12
Kapitelüberschriften
in Spiegelstrichlisten
wandeln
In der Gruppe Kapitelüberschriften in Spiegelstrichlisten wandeln können Sie bestimmen, bis zu welchem Grad Hauptkapi-
Hinweis
Wenn Sie leere Kapitel unterdrücken, werden deren Überschriften
nicht mehr aufgeführt (siehe Seite 12). Dann können sie nicht mehr als
Spiegelstrichlisten aufgeführt werden.
tel bei der Ausgabe der Dokumentation in Spiegelstrichlisten ausgegeben
werden sollen.
3 Ausgabeart wählen
So gehen Sie vor
Wenn Sie möchten, dass Hauptkapitel (sie enthalten eine Variable wie etwa
$(name)), für die im Strukturbaum keine Unterkapitel festgelegt wurden,
in Spiegelstrichlisten ausgegeben werden sollen:
Gruppe Kapitelüberschriften in Spiegelstrichlisten
wandeln das Alternativfeld Nur Blattknoten im Strukturbaum.
Die Kapitel werden ohne Überschriften ausgegeben.
So gehen Sie vor
Wenn Sie möchten, dass sowohl Hauptkapitel, für die im Strukturbaum
keine Unterkapitel festgelegt wurden, als auch Hauptkapitel, die zwar Unterkapitel besitzen, jedoch aufgrund der modellierten Sachverhalte im Ergebnisdokument keine hätten, als Spiegelstrichlisten ausgegeben werden:
wandeln das Alternativfeld Dynamisch.
So gehen Sie vor
Wenn Sie möchten, dass Hauptkapitel ohne Unterkapitel nicht in Spiegelstrichlisten umgewandelt werden:
wandeln das Alternativfeld Nie.
3
Ausgabeart wählen
Im zweiten Schritt bestimmen Sie, auf welche Weise die erzeugte Dokumentation ausgegeben werden soll. Hierfür stehen Ihnen folgende Auswahlmöglichkeiten zur Verfügung:
• Voranzeigefenster (Standard) (siehe Kapitel 3.1, Seite 14)
• Word-für-Windows-Dokument (siehe Kapitel 3.2, Seite 15)
• ASCII-Text-Dokument (siehe Kapitel 3.3, Seite 21)
• XML(-Datei) (siehe Kapitel 3.4, Seite 23)
• PostScript-Dokument (siehe Kapitel 3.5, Seite 26)
13
3.1
Dokumentation im Voranzeigefenster ausgeben
Wenn Sie die Dokumentation im Voranzeigefenster der Dokumentation
ausgeben, können Sie diese sichten, gegebenenfalls einige Formatierungen
ändern und von dieser Anwendung aus unter anderem direkt ausdrucken.
Nähere Informationen dazu finden Sie im Handbuch classiX C Dokumentation, Kapitel 6, "Dokumentation im Voranzeigefenster sichten (C-6)".
Hinweis
Die Voreinstellung des Layouts von Dokumentationen, die im Voranzeigefenster ausgegeben werden, können Sie durch entsprechende Einträge in den Abschnitten RG (Rastergrafik) und PV (Preview) der Datei
inodocu1.ini festlegen.
Voranzeigefenster als
Ausgabeart bestimmen
Bestimmen Sie zuerst, dass die Dokumentation im Voranzeigefenster ausgegeben werden soll.
So gehen Sie vor
Um die Dokumentation im Voranzeigefenster auszugeben:
» Wählen Sie in der Auswahlliste Ausgabeart den Eintrag Voranzeigefenster.
Standarddrucker
festlegen
Optional können Sie den Drucker bestimmen, den das Voranzeigefenster
als Standarddrucker verwenden soll.
So gehen Sie vor
Um den Drucker zu bestimmen, den das Voranzeigefenster als Standarddrucker verwenden soll:
» Bestimmen Sie in der Dialogbox Dokumentationsgenerator in der
Auswahlliste Drucker den Drucker, auf dem die Dokumentation ausgegeben werden soll.
» Um für den ausgewählten Drucker Einstellungen vorzunehmen, klicken
Sie auf die Schaltfläche [Konfigurieren].
» Klicken Sie auf [OK].
14
3.2 Dokumentation im Format MS-Word für Windows ausgeben
3.2
Dokumentation im Format MS-Word für Windows ausgeben
Sie können die Dokumentation in eine Textdatei im Format MS-Word für
Windows für die Versionen 1.1 oder 2.0 ausgeben. In welcher Version die
Dokumentation ausgegeben wird, hängt vom entsprechenden Eintrag für
die Version im Abschnitt WW der Datei inodocu1.ini ab.
Zur Gestaltung von Layout und Formatierung einer Modelldokumentation
im Format Microsoft Word für Windows dient stets die Dokumentvorlage
inodocu.dot im Verzeichnis $INODIR. Diese Datei ist Bestandteil von
Innovator, liegt standardmäßig im Format Word für Windows 2.0 vor, enthält alle Formatvorlagen für Absätze, Zeichen und Tabellen, die auch in
den erzeugten Dokumenten verwendet werden und wird automatisch mit
der Textausgabedatei verknüpft.
Formatvorlagen zur
Verfügung stellen
Im Verzeichnis $INODIR befinden sich nach der Installation neben der
Dokumentvorlage inodocu.dot:
Hinweis
• die für die Word-Version 1.1 bestimmte Datei inodocu1.dot,
• die für die Word-Versionen 2.0 bis Word 2000 bestimmte Datei
inodocu2.dot und
• die für die Word-Versionen 2003 und höher bestimmte Datei
inodocu2003.dot.
Die Datei inodocu.dot ist standardmäßig eine Kopie von
inodocu2.dot.
Zum Ändern von Zeichen- und Absatzformaten etc. müssen Sie lediglich
die betreffende Formatvorlage in inodocu.dot modifizieren, da die Textausgabedatei selber keine Formatierungsinformationen, sondern nur Verweise auf Formatvorlagen enthält.
Die Seitenränder in der Word-Vorlage müssen kleiner oder gleich den Seitenrändern im Abschnitt WW der Datei inodocu1.ini sein.
So gehen Sie vor
Um die Dokumentvorlage für die Bearbeitung der Dokumentation in
Word für Windows zur Verfügung zu stellen:
» Kopieren Sie für Microsoft Word 2003 und höher eine Kopie der Datei inodocu2003.dot in das Vorlagen-Verzeichnis von Word für
Windows und benennen Sie diese in inodocu.dot um.
» Kopieren Sie für Microsoft Word 2.0 bis Word 2000 die Datei
inodocu2.dot in das Vorlagen-Verzeichnis von Word für Windows
und benennen Sie diese in inodocu.dot um.
15
» Kopieren Sie für Microsoft Word für Windows 1.1 eine Kopie der Datei inodocu1.dot in das Vorlagen-Verzeichnis von Word für Windows und benennen Sie diese in inodocu.dot um.
Damit in einer erstellten Dokumentation eine veränderte Formatvorlage
wirksam wird:
» Verbinden Sie diese mit der Dokumentation.
Beachten Sie, dass Sie mit einer Word-Dokumentvorlage Formatvorlagen für Zeichen, Absätze, Tabellen und Listen zuweisen können, jedoch
nicht für Seitenränder, Kopf- und Fußzeilenabstände oder verschiedene
Abschnitte (z. B. Titelseite) usw.
Weitere Informationen finden Sie in der Hilfe von Microsoft Word.
Hinweis
Soll das generierte Dokument in ein Microsoft Word für Windows einer höheren Version eingelesen werden, müssen Sie den entsprechenden Filter zur Konvertierung installiert haben. Alternativ können Sie
das Format RTF wählen.
Bei der Ausgabeart Word-für-Windows-Dokument erzeugt der Dokumentationsgenerator ggf. mehrere Grafikdateien.
Hinweis
Der Name der erzeugten Textdatei setzt sich aus dem Namen der Informationsdateien und der Dateinamenserweiterung .doc zusammen.
Die Namen der Grafikdateien setzen sich aus dem nach fünf Zeichen
abgeschnittenen Namen der Informationsdateien, ihrer Nummerierung
ab 000 und der Dateinamenserweiterung zusammen, die sich aus dem
Grafikformat ergibt (beispielsweise name000.emf für eine EMF-Grafikdatei).
Gliederungsnummerierung von Word für
Windows nutzen
Der Dokumentationsgenerator kann bei der Ausgabe der Dokumentation
im Word-für-Windows-Format die automatische Gliederungsnummerierung von Word für Windows nutzen. Diese basiert dann auf den Absatzformaten für Überschriften der entsprechenden Word-für-Windows-Dokumentvorlage. Die Nummerierung durch Innovator ist in diesem Falle deaktiviert.
Die Nutzung der integrierten Word-für-Windows-Gliederungsnummerierung ermöglicht eine einheitliche und durchgängige Nummerierung des
kompletten Dokuments mit allen eingebundenen externen Objekten
(Word-für-Windows-Dokumenten) durch Word für Windows. Dazu müssen natürlich die externen Objekte ebenfalls die Word-für-Windows-Absatzformate für die Kapitelüberschriften nutzen.
Die Aktivierung der Gliederungsnummerierung durch Word für Windows
wird durch den Parameter automatische Nummerierung in der Sektion [WW] in der Datei inodocu1.ini vorgenommen.
16
Parameter
Bedeutung
0 (default)
Die separate Kapitelnummerierung durch Innovator wird
in Word für Windows als fester Text erzeugt.
1
Die separate Kapitelnummerierung durch Innovator wird
in Word für Windows als Feldfunktion erzeugt.
2
Die Gliederungsnummerierung von Word für Windows
wird genutzt, die Innovator-Kapitelnummerierung ist
deaktiviert.
Bestimmen Sie zuerst, dass die Dokumentation im Format Word für Windows ausgegeben werden soll.
Word für Windows als
So gehen Sie vor
Um die Dokumentation im Format Word für Windows auszugeben:
» Wählen Sie in der Auswahlliste Ausgabeart den Eintrag Word-fürWindows-Dokument.
Bei der Ausgabeart Word für Windows können Sie das Format der zu erzeugenden Grafikdateien bestimmen. Zur Auswahl stehen:
• EMF (Enhanced Metafile)
• EPS (Encapsulated PostScript)
• PNG (Portable Network Graphic)
• SVG (Scalable Vector Graphic)
Grafikformat
bestimmen
So gehen Sie vor
Um das Grafikformat zu bestimmen:
Auswahlliste Grafikformat das gewünschte Grafikformat.
Optional können Sie bei dieser Ausgabeart bestimmen, dass lediglich die
Textdatei, jedoch keine Grafikdateien ausgegeben werden sollen.
Ausgabe ohne
Grafikdateien
17
So gehen Sie vor
Um zu bestimmen, dass die Grafikdateien nicht erzeugt werden:
Gruppe Optionen das Auswahlfeld Keine Grafikausgabedateien erstellen.
Dokumentation in
Word für Windows
mit Tcl-Skript
verbinden
Optional können Sie zu dieser Ausgabeart ein Tcl-Skript bestimmen und
mit Aufrufargumenten versehen. Ein an dieser Stelle angegebenes Skript
wird zum Abschluss der Dokumentationserstellung über den TCL-Editor
inotcl.exe automatisch ausgeführt, dabei wird neben den angegebenen
Argumenten der Pfadname der erzeugten Ausgabedatei übergeben. Auf
diese Weise wird die generierte Ausgabedatei beispielsweise direkt nach ihrer Erzeugung in der Anwendung Word für Windows aufgerufen.
Hinweis
Kommandos und Aufrufargumente können Sie ebenfalls bei der Ausgabe als ASCII-Text-Dokument (siehe Seite 21), XML-Datei (siehe
Seite 23) und PostScript-Dokument (siehe Seite 26) bestimmen.
So gehen Sie vor
Um das Word-für-Windows-Dokument mit einem Tcl-Skript zu verbinden:
» Geben Sie in der Dialogbox Dokumentationsgenerator in der
Gruppe Nachbearbeitungskommando im Eingabefeld Kommando
ein entsprechendes Kommando ein.
» Geben Sie im Eingabefeld Argumente das gewünschte Aufrufargument
ein.
Um die Erzeugung des Word-für-Windows-Dokuments und die über
das Kommando bestimmte Anwendung zu starten:
Dokumentationsausgabe für Word für
Windows steuern
18
Normalerweise wird nach der Dokumentationsgenerierung im Word-fürWindows-Format ein Abfragedialog geöffnet, in dem der Benutzer angeben
kann, ob die generierte Dokumentation geöffnet werden soll. Wird der
Dokumentationsgenerator inodocu.exe mit der Option /on gestartet,
wird die Worddatei nicht geöffnet, bei Start mit der Option /oa wird die
Worddatei ohne Abfrage geöffnet (siehe Seite 4).
Alternativ lässt sich die Ausgabe der Ergebnisdatei über Alternativfelder in
der Dialogbox Anpassen/Dokumentationsvorlagen steuern, die Sie
im Modellbrowser aufrufen.
So gehen Sie vor
Um die Ausgabe der Ergebnisdatei zu beeinflussen:
» Wählen Sie im Modellbrowser den Menübefehl Extras>Anpassen>
Dokumentationsvorlagen...
Die gleichnamige Dialogbox erscheint.
» Aktivieren Sie im Register Nachbearbeitungsparameter in der
Gruppe Ergebnisdatei öffnen eine der Alternativen Immer, Nie
oder Nach Anfrage.
In Dokumentationen, die zum ersten Mal im Format Word für Windows
geöffnet werden, wird das Inhaltsverzeichnis ggf. nicht sofort angezeigt,
sondern muss neu erzeugt werden.
Inhaltsverzeichnis
erzeugen bzw.
aktualisieren
So gehen Sie vor
Um das Inhaltsverzeichnis neu zu erzeugen:
» Markieren Sie in MS-Word für Windows das gesamte Dokument (z. B.
mit [Strg]+[A]).
» Drücken Sie die Taste [F9] zur Feldaktualisierung.
Weitere Informationen finden Sie in Ihrem Handbuch zu MS-Word für
Windows.
In Dokumentationen, die zum ersten Mal im Format MS-Word für Windows erscheinen, werden die eingebetteten Grafiken ggf. nicht sofort angezeigt. Um die Grafiken darzustellen, müssen Sie die Verknüpfungen aktualisieren.
Grafiken darstellen
und Skalierung
bestimmen
Zum Anzeigen von EPS-Grafiken benötigen Sie ein entsprechendes
Plug-in.
Die Skalierung der zu importierenden Grafiken legen Sie mit den dafür
vorgesehenen Einträgen im Abschnitt WW der Datei inodocu1.ini
fest.
Hinweis
So gehen Sie vor
Um die Verknüpfungen zu aktualisieren:
» Markieren Sie in MS-Word für Windows das gesamte Dokument
([Strg]+[A]).
» Drücken Sie die Taste [F9] zur Feldaktualisierung.
Informationen hierzu finden Sie in Ihrer Word-für-Windows-Dokumentation.
19
Kopf- und Fußzeilen
bearbeiten
Bei Kopf- oder Fußzeilen, die aus mehr als einer Textzeile bestehen, müssen Sie die Druckformate zum Festlegen der vertikalen Position der Linie,
welche die Kopf- bzw. Fußzeile vom eigentlichen Text trennt, entsprechend
anpassen.
Einbinden von
Fremdobjekten
Zum Einbinden von Fremdobjekten (siehe Handbuch classiX C Dokumentation, Kapitel C-2.3.4, "Externe Objekte einbinden") ist es
erforderlich, die Dateinamenserweiterungen solcher Fremdobjekte zu den
Namen von Anwendungen zur Bearbeitung dieser Objekte in Bezug zu setzen. Zu diesem Zweck existiert der Eintrag Anwendungen im Abschnitt
WW der Datei inodocu1.ini.
Bei der Einbindung von Fremdobjekten in eine Dokumentation für MSWord für Windows Version 2.0 erzeugt Innovator DDE-Feldfunktionen,
da eine Verknüpfungs-Feldfunktion ohne Positionsangabe fälschlicherweise
zu einer Fehlermeldung in Word für Windows Version 2.0 führt. Wird ein
solches Dokument in ein MS-Word für Windows einer höheren Version
eingelesen, kann die Verknüpfung mittels der DDE-Feldfunktion nicht
hergestellt werden.
So gehen Sie vor
Um Verknüpfungsfeldfunktionen anstelle von DDE-Feldfunktionen zu
verwenden:
» Setzen Sie den Eintrag Verknüpfungsfeld im Abschnitt WW der Datei inodocu1.ini auf den Wert 1.
Konvertierung von
Dokumenten für
Word 2003 (SP 3)
20
Microsoft Word 2003 erlaubt ab Service Pack 3 nicht mehr das Öffnen
von Word-Dokumenten älterer Versionen, insbesondere Word 2.0. Der
Dokumentationsgenerator von Innovator generiert Dokumente in betroffenen Versionen.
Wenn das generelle Freischalten des Öffnens von Word-Dokumenten älterer Versionen (siehe http://support.microsoft.com/kb/922849/, Absatz
"Methode 2") nicht möglich ist, kann der mit Innovator gelieferte Konverter benutzt werden.
Konfigurieren Sie einen Ausnahmespeicherort für die Konvertierung, wie
in http://support.microsoft.com/kb/922849/ (Absatz "Methode 1") beschrieben. Fügen Sie in der Konfigurationsdatei inodocu1.ini (im Verzeichnis $INODIR/de_de bzw. im Verzeichnis der benutzerspezifischen
Einstellungen) im Abschnitt WW den Parameter Verzeichnis für automatische Konvertierung mit dem Wert des Ausnahmespeicherortes an.
3.3 Dokumentation im Format ASCII-Text ausgeben
3.3
Dokumentation im Format ASCII-Text ausgeben
Sie können die Dokumentation in eine Datei im ASCII-Format ausgeben.
Bei dieser Ausgabeart erzeugt der Dokumentationsgenerator inodocu.exe standardmäßig zusätzlich gegebenenfalls mehrere Grafikdateien.
Die Ausgabedatei kann mittels geeigneter Filter, z. B. Tcl-Skripten, in beliebige weitere Ausgabeformate konvertiert werden, wobei diese zumindest
eines der in Abschnitt "Grafikformat bestimmen", Seite 21 genannten Grafikformate unterstützen sollten.
Der Name der erzeugten Textdatei setzt sich aus dem Namen der Informationsdateien und der Dateinamenserweiterung .iad zusammen.
Hinweis
Grafikformat ergibt (beispielsweise name000.png für eine PNG-Grafikdatei).
Bestimmen Sie zuerst, dass die Dokumentation im ASCII-Format ausgegeben werden soll.
ASCII-Format als
So gehen Sie vor
Um die Dokumentation im ASCII-Format auszugeben:
» Wählen Sie in der Auswahlliste Ausgabeart den Eintrag ASCIIText-Dokument.
Bei der Ausgabeart ASCII-Text können Sie das Format der zu erzeugenden
Grafikdateien bestimmen.
Grafikformat
bestimmen
Bei der Wahl des Grafikformats müssen Sie darauf achten, dass dieses
von dem Ausgabeformat unterstützt wird, in das die Ausgabedatei möglicherweise konvertiert werden soll.
Hinweis
Zur Auswahl stehen:
21
So gehen Sie vor
Auswahlliste Grafikformat das gewünschte Grafikformat.
Ausgabe ohne
Grafikdateien
So gehen Sie vor
Dokumentation in
ASCII-Format mit TclSkript verbinden
Hinweis
Optional können Sie zu dieser Ausgabeart ein Tcl-Skript bestimmen und
wird zum Abschluss der Dokumentationserstellung über den TCL-Editor
Argumenten der Pfadname der erzeugten Ausgabedatei übergeben. Auf
diese Weise wird die generierte Ausgabedatei beispielsweise direkt nach ihrer Erzeugung in ein anderes Zielformat konvertiert.
Kommandos und Aufrufargrumente können Sie auch bei der Ausgabe
als Word-für-Windows-Dokument (siehe Seite 15), XML-Datei (siehe
Seite 23) und PostScript-Dokument (siehe Seite 26) bestimmen .
So gehen Sie vor
Um das ASCII-Dokument mit einem Tcl-Skript zu verbinden:
ein.
Um die Erzeugung des ASCII-Dokuments und die über das Kommando bestimmte Anwendung zu starten:
22
3.4 Dokumentation im Format XML ausgeben
Über Tcl-Skripten können Sie bestimmen, dass die erzeugte Ausgabedatei
direkt nach ihrer Erzeugung in folgende Ausgabeformate konvertiert wird:
• Rich Text Format (RTF)
• HyperText Markup Language (HTML)
• Maker Interchange Format (MIF) für Adobe FrameMaker
Dokumentation direkt
in RTF-, HTML- oder
FrameMaker-Format
ausgeben
So gehen Sie vor
Um die Ausgabedatei direkt im Format RTF auszugeben:
das Tcl-Skript asc2rtf.tcl ein.
Um die Ausgabedatei direkt im Format HTML auszugeben:
» Geben Sie in der Gruppe Nachbearbeitungskommando im Eingabefeld Kommando das Tcl-Skript asc2html.tcl ein.
Um die Ausgabedatei direkt im Format MIF auszugeben:
» Geben Sie in der Gruppe Nachbearbeitungskommando im Eingabefeld Kommando das Tcl-Skript asc2mif.tcl ein.
ein.
Um die Erzeugung der Ausgabedateien und die über das Kommando
bestimmte Konvertierung zu starten:
Die Skalierung der zu importierenden Grafiken legen Sie mit den dafür
vorgesehenen Einträgen im Abschnitt AT der Datei inodocu1.ini
fest.
3.4
Skalierung der
Importgrafiken
bestimmen
Dokumentation im Format XML ausgeben
Sie können die Dokumentation in einer Datei im XML-Format ausgeben.
Bei dieser Ausgabeart erzeugt der Dokumentationsgenerator inodocu.exe standardmäßig zusätzlich gegebenenfalls mehrere Grafikdateien.
Der Name der erzeugten Datei setzt sich aus dem Namen der Informationsdateien und der Dateinamenserweiterung .xml zusammen.
Grafikformat ergibt (beispielsweise name000.png für eine PNG-Grafikdatei).
Hinweis
23
Der Hauptzweck des XML-Ausgabeformats ist es, daraus andere Dokumente wie z. B. HTML zu generieren. Dazu ist im Lieferumfang von
Innovator ein XSL-Stylesheet (htmldocu.xsl, siehe Seite 25) und der
Stylesheetprozessor (xp, siehe Seite 25) enthalten.
Hinweis
Im Verzeichnis $INODIR befindet sich auch ein Cascading Stylesheet
docu.css. Dieses wird zur Formatierung der HTML-Dateien verwendet. Damit ist es möglich, das Erscheinungsbild der Dokumentation
(Schriftgrössen, Farben, ...) an individuelle Anforderungen anzupassen.
XML-Format als
Bestimmen Sie zuerst, dass die Dokumentation im Format XML ausgegeben werden soll.
So gehen Sie vor
Um die Dokumentation im XML-Format auszugeben:
» Wählen Sie in der Auswahlliste Ausgabeart den Eintrag XML.
Grafikformat
bestimmen
Bei der Ausgabeart XML können Sie das Format der zu erzeugenden Grafikdateien bestimmen.
Zur Auswahl stehen:
Hinweis
Bei der Wahl des Grafikformats müssen Sie darauf achten, dass dieses
von dem Ausgabeformat unterstützt wird, in das die Ausgabedatei möglicherweise konvertiert werden soll.
Das Grafikformat EMF steht nur unter MS-Windows zur Verfügung.
So gehen Sie vor
in der Auswahlliste Grafikformat das gewünschte Grafikformat.
Ausgabe ohne
Grafikdateien
24
3.4 Dokumentation im Format XML ausgeben
So gehen Sie vor
Die Ausgabedatei im XML-Format kann durch geeignete Filter wie etwa
XSL-Stylesheets in weitere Ausgabeformate (z. B. HTML) konvertiert werden, wobei diese zumindest eines der in Abschnitt "Grafikformat bestimmen", Seite 21, genannten Grafikformate unterstützen sollten.
XSL-Stylesheet
auswählen
Im Verzeichnis $INODIR befindet sich das Stylesheet htmldocu.xsl
zur Erzeugung von HTML-Dateien. Dieses Stylesheet konvertiert die
XML-Datei in mehrere kleine HTML-Dateien, die über die Datei name.html verknüpft sind.
Hinweis
So gehen Sie vor
Um ein XLS-Stylesheet auszuwählen:
» Geben Sie es in der Dialogbox Dokumentationsgenerator mit
vollständigem Pfad im Eingabefeld XSL-Stylesheet ein.
oder
» Klicken Sie auf [Auswählen].
Die Dialogbox Wähle XSL-Stylesheet erscheint.
» Wählen Sie das gewünschte XLS-Stylesheet aus und klicken Sie auf
[Öffnen].
Name und Pfad des gewählten Stylesheet werden im Eingabefeld XSLStylesheet übernommen.
Sie können bestimmen, dass nach Erstellung einer XML-Dokumentation
ein angegebenes XSL-Stylesheet ausgewertet wird. Dabei läuft ein Stylesheet-Prozessor über das Ergebnis und führt Konvertierungen durch. In der
Parameterdatei inodocu1.ini finden Sie unter dem Schlüsselwort XML
die Vorgaben zum Prozessor.
XSL-Stylesheet
auswerten
So gehen Sie vor
Damit ein XSL-Stylesheet ausgewertet wird:
Gruppe Optionen das Auswahlfeld XSL-Transformation
durchführen.
25
Dokumentation in
XML-Format mit TclSkript verbinden
Optional können Sie zu dieser Ausgabeart Tcl-Skripten bestimmen und
wird zum Abschluss der Dokumentationserstellung über das Programm
Argumenten der Pfadname der erzeugten Ausgabedatei übergeben.
Hinweis
Kommandos und Aufrufargrumente können Sie auch bei der Ausgabe
als Word-für-Windows-Dokument (siehe Seite 15), ASCII-Text-Dokument (siehe Seite 21) und PostScript-Dokument (siehe Seite 26) bestimmen.
So gehen Sie vor
Um das XML-Dokument mit einem Tcl-Skript zu verbinden:
ein.
Um die Erzeugung des XML-Dokuments und die über das Kommando
bestimmte Anwendung zu starten:
Hinweis
Bei sehr großen XML-Dateien kann es vorkommen, dass die XSLTransformation der Dokumentationsgenerierung fehlschlägt, weil der
Speicherbedarf des Java-Prozesses zu groß ist. Man kann die maximale
Heap-Größe durch einen Aufrufparameter der Java-VM setzen. Dazu
muss man in der inodocu1.ini im Abschnitt XML den Eintrag XSLStylesheet-Prozessor setzen. Die folgende Zeile setzt für die
SUN-Java-VM die maximale Heap-Größe auf 64 Megabyte:
XSL-Stylesheet-Prozessor = "java -mx64m -classpath '$(INODIR)/java/
sax.jar;$(INODIR)/java/xp.jar;$(INODIR)/java/xt.jar'
Dcom.jclark.xsl.sax.parser= com.jclark.xml.sax.CommmentDriver
com.jclark.xsl.sax.Driver"
3.5
Dokumentation als PostScript-Dokument ausgeben
Wenn Sie Ihre Dokumentation in der plattformunabhängigen Beschreibungssprache PostScript ausgeben, können Sie diese in einem späteren Arbeitsschritt ausdrucken oder in entsprechenden Anzeigeprogrammen sichten. Optional können Sie bestimmen, dass das PostScript-Dokument Ihrer
26
3.5 Dokumentation als PostScript-Dokument ausgeben
Dokumentation direkt nach seiner Erzeugung in einer Anwendung ausgegeben wird. Der Name der erzeugten PostScript-Dokumentation setzt sich
aus dem Namen der Informationsdateien und der Dateinamenserweiterung .ps zusammen.
Das Layout von Dokumentationen, die als PostScript-Dokument ausgegeben werden, können Sie durch entsprechende Einträge im Abschnitt RG der Datei inodocu1.ini festlegen.
Hinweis
Bestimmen Sie zuerst, dass Sie die Dokumentation als PostScript-Dokument ausgeben möchten.
PostScript als
So gehen Sie vor
Um die Dokumentation als PostScript-Dokument auszugeben:
» Wählen Sie in der Auswahlliste Ausgabeart den Eintrag PostScript-Dokument.
Wenn Sie die Dokumentation als PostScript-Dokument ausgeben, können
Sie optional dazu ein Tcl-Skript bestimmen und dieses mit Aufrufargumenten versehen. Ein an dieser Stelle angegebenes Skript wird zum Abschluss der Dokumentationserstellung über das Programm inotcl.exe
automatisch ausgeführt. Dabei wird neben den angegebenen Argumenten
der Pfadname der erzeugten Ausgabedatei übergeben.
PostScript-Dokument
mit Tcl-Skript
verbinden
Kommandos und Aufrufargumente können Sie auch bei der Ausgabe
als Word-für-Windows-Dokument (siehe Seite 15), ASCII-Text-Dokument (siehe Seite 21) und XML-Datei bestimmen (siehe Seite 23).
Hinweis
So gehen Sie vor
Um das PostScript-Dokument mit einem Tcl-Skript zu verbinden:
ein.
Um die Erzeugung des PostScript-Dokuments und die über das Kommando bestimmte Anwendung zu starten:
27
Alternativ können Sie in der Datei inoprint.ini folgenden Eintrag eingeben:
[printer]
PostScript=PostScript, .
PostScript to Printer = "PostScript, /tmp | lpr %1 ; rm %1"
PostScript to GV = "GV, /tmp | ghostview %1 ; rm %1"
und den gewünschten Drucker angeben oder den Dokumentationsgenerator inodocu mit folgenden Argumenten aufrufen:
inodocu -PS -p "PostScript to GV" datei.d1
28
Stichwortverzeichnis
Stichwortverzeichnis
A
ASCII-Text
-als Ausgabeart 21
-Grafik
Format bestimmen 21
Skalierung bestimmen 23
unterdrücken 22
Ausgabe
-Einstellungen 8
-Verzeichnis wählen 10
Ausgabeart Dokumentation
-ASCII-Text 21
-MS-Word für Windows 15
-PostScript Dokument 26
mit Tcl-Skript 27
-Voranzeigefenster 14
-wählen 13
-XML 23
ausschalten
-Modellprüfung 12
-Zeichenüberprüfung 11
D
Dokumentation
-ausgeben
ASCII-Text 21
MS-Word für Windows 15
PostScript-Dokument 26
Voranzeigefenster 14
XML 23
-Modellprüfung ausschalten 12
Dokumentationsgenerator
-Generierung bei Aufruf anstoßen 3
-starten 2
E
Eingabedaten 8
Eingaberepository
-löschen 10
erstellen
-Inhaltsverzeichnis (Word für
Windows) 19
Fußzeile
-bearbeiten 20
G
Gliederungsnummerierung verwenden
(Word für Windows) 16
Grafik
-darstellen
Word für Windows 19
-Format bestimmen
ASCII-Text 21
XML 24
-Skalierung bestimmen
ASCII-Text 23
in Word für Windows 19
-unterdrücken
ASCII-Text 22
XML 24
Grafikformate 1
I
Informationsdatei 1
-Dateinamenserweiterung 4
Inhaltsverzeichnis erstellen (Word für
Windows) 19
K
Kopfzeile
-bearbeiten 20
L
Leerkapitel unterdrücken 12
löschen
-Eingaberepository 10
M
Modelltyp bestimmen 8
MS-Word für Windows 15
F
Formatvorlage verwenden (Word für
Windows) 15
Fremdobjekte in Word für Windows
einbinden 20
P
PostScript Dokument
-als Ausgabeart 26, 27
-überTcl-Skript 27
T
Tcl-Skript
-mit Dokumentation verbinden
Word für Windows 18, 22
XML 26
V
Voranzeigefenster
-als Ausgabeart 14
W
Word für Windows
-als Ausgabeart 15
-Dokumentation mit Tcl-Skript
verbinden 18, 22
-Formatvorlage verwenden 15
-Fremdobjekte einbinden 20
-Gliederungsnummerierung
verwenden 16
-Grafik
darstellen 19
Format bestimmen 17
Salierung 19
unterdrücken 17
-Inhaltsverzeichnis erstellen 19
-Kopf- und Fußzeilen bearbeiten 20
X
XML
-als Ausgabeart 23
-Dokumentation mit Tcl-Skript
verbinden 26
-Grafik
Format bestimmen 24
unterdrücken 24
-XSL-Stylesheet
auswählen 25
auswerten 25
Z
Zeichenüberprüfung ausschalten 11
29
MID GmbH
Hauptsitz Nürnberg
Eibacher Hauptstraße 141
90451 Nürnberg
Tel.: +49 (0)911 96836-22
Fax: +49 (0)911 96836-10
E-Mail: [email protected]
www.mid.de
Niederlassung Köln
Ettore-Bugatti-Straße 6-14
51149 Köln
Niederlassung Stuttgart
Silberburgstraße 187
70178 Stuttgart
Niederlassung München
Keltenring 7
82041 Oberhaching
Tel.: +49 (0)2203 20271-0
Fax: +49 (0)2203 20271-10
Tel.: +49 (0)711 633859-0
Fax: +49 (0)711 633859-10
Tel.: +49 (0)89 95476831-0
Fax: +49 (0)89 95476831-9

Handbuch Dokumentations- generator

Transcription

Similar documents

CINEMA 4D

Erste Schritte mit der integrierten

Der erste Server: Der Dell PowerEdge T110 II im Vergleich mit

Einführung in Linux

www.jurijs-skripte.de.vu UML

Word-Tipp: Seriendruck mit Bildern

diplomarbeit