PDF-Dokumentation verlinken

Wenn die Installation, der Einbau auf der Anlage oder der Betrieb eines Modells erklärungsbedürftig ist, soll der Konstrukteur eine Dokumentation erstellen, die den Anwender auf möglichst kurzem Weg zum Ziel führt.

Dokumentation schreiben

Schreiben Sie nicht drauf los, sondern versuchen Sie sich in die Perspektive des Anwenders, der das Modell ohne Umstände verwenden will, zu versetzen. Was ist für ihn Voraussetzung, was eher Folklore? Erstellen Sie dann für sich eine Gliederung, die dem Anwender als logische Abfolge von Informationen und Handlungsanweisungen erscheint.

Natürlich haben Sie das Recht, auch kurze allgemeine Erklärungen zum Modell und dessen Vorbild zu verfassen. Bedenken Sie aber, dass der Anwender bei Bedarf fast alles im Netz nachrecherchieren kann, wenn es ihn überhaupt interessiert. So ist eine allgemeine Geschichte der Bahnschranke ebenso überflüssig wie detailverliebte Schilderungen einer bestimmten Dorfkirche.

Umso wichtiger ist es, dass Sie die Funktionsweise von Modellen mit komplexen Bewegungsachsen erläutern. Ebenso essenziell ist die genaue, möglichst bebilderte Erklärung der Handhabung von Gleisobjekten, wenn sie als Set mit zueinander passenden Elementen vorliegen.

Schreiben Sie die Dokumentation unbedingt in einer Textverarbeitung mit Rechtschreibhilfe. Nicht jedem ist flüssiges Formulieren in die Wiege gelegt. Hier helfen – genau wie bei technischen Fragen beim Arbeiten mit dem Home-Nostruktor – schreiberfahrene Kollegen gerne weiter.

PDF-Dokumentation zum Modell in der externen *.ini-Datei verlinken

Jedes einzelne Modell kann mit seiner externen *.ini-Datei mit insgesamt vier PDF-Dokumenten in den Sprachen: Englisch, Deutsch, Französisch und Polnisch verknüpft (verlinkt) werden. Der große Vorteil der verknüpften Dokumente für den EEP-Anwender liegt darin, dass er die Aufbauanleitung, den geschichtlichen Umriss, oder ein technisches Datenblatt etc. nicht erst umständlich aufsuchen, sondern über das Menü der [RMT] und den Eintrag "Dokumentation anzeigen" direkt aus der Modell-Auswahlliste aufrufen kann. Dies ist nicht nur für die Programm-Ergonomie vom Vorteil, vielmehr spart es auch Zeit (und unter Umständen auch Nerven), sollten sich bereits zig PDF-Dokumente angesammelt haben und die Suche nach dem Passenden zunehmend schwieriger wird. Auch wenn die Verknüpfung zu einer Anleitung bei jedem einzelnen Modell möglich ist, so bedeutet es für den Konstrukteur nicht, dass er zu jedem Modell eine gesonderte Anleitung bereitzustellen hat.

Zum Einen ist es eine Ermessensfrage, ob eine Anleitung oder ausführliche Beschreibung überhaupt notwendig ist, des Weiteren kann eine Dokumentation gleich mit mehreren Modellen verknüpft sein.

Die PDF-Dokumentation, welche grundsätzlich aus dem \Resourcen\Doc\-Ordner aufgerufen wird (EEP durchsucht diesen Ordner nach PDF-Dateien automatisch), kann in der externen *.ini-Datei wie folgt verknüpft werden:

PdfDoc_ENG = "Anleitung_zum_Modell_XYZ_ENG.pdf"
PdfDoc_GER = "Anleitung_zum_Modell_XYZ_DEU.pdf"
PdfDoc_FRA = "Anleitung_zum_Modell_XYZ_FRA.pdf"
PdfDoc_POL = "Anleitung_zum_Modell_XYZ_POL.pdf"


Bis auf den vollständigen Dateinamen mit der Endung *.pdfsind als alphanumerische Werte keine weiteren Pfadangaben notwendig, es sei denn, die Datei befindet sich im Unterordner des Zielordners \Doc\. Stehen außer einer deutschsprachigen Anleitung keine weiteren Sprachversionen zur Verfügung, soll auf leere Werte, etwa: PdfDoc_POL = "" - komplett verzichtet werden, denn; was nicht da ist, braucht auch nicht initialisiert zu werden.

Zurück zur Startseite