Regelwerke und Hinweise für offizielle Konstrukteure

Dokumentation schreiben und 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.

Die Dokumentation ist oft der erste Eindruck, den der Anwender vom gerade erworbenen Modell gewinnt. Da die Dokumentation auch schon vor dem Kauf im Shop präsentiert wird, gehört sie so auch zur Visitenkarte des Modells überhaupt. Schreiben Sie daher die Dokumentation möglichst in einer Textverarbeitung mit Rechtschreibhilfe. Zudem: Nicht jedem ist flüssiges Formulieren in die Wiege gelegt. Hier helfen – nicht anders als bei technischen Fragen beim Arbeiten mit dem Home-Nostruktor – im schriftlichen Ausdruck erfahrene Kollegen gerne weiter.

Schließlich wird der Text als PDF exportiert (das ermöglichen praktisch alle Office- bzw. Textverarbeitungsprogramme). Als Qualitätsstufe reicht die Mittlere; der Anwender wird die Dokumentation in aller Regel am Bildschirm lesen. Das hält die Datei schlank.

Der Dateiname der Dokumentation kann, muss aber nicht dem des Modells entsprechen. Die Dokumentation zum Modell BR_01_150_DB_ZZ1.3dm kann BR_01_150_DB_ZZ1.pdf oder z.B. Lok_01_150_Wittebleche.pdf heißen. Es gelten die üblichen Konventionen für Dateinamen.

PDF-Dokumentation in der externen *.ini-Datei eintragen

Das Modell kann in der externen *.ini-Datei mit insgesamt vier PDF-Dokumenten in den Sprachen Englisch, Deutsch, Französisch und Polnisch verlinkt werden. Dies ermöglicht dem Anwender, die Dokumentation direkt aus der Modell-Auswahlliste aufzurufen. Auf diese Weise findet der Anwender die Dokumentation am schnellsten, zumal die Dateinamen im Ablage-Ordner der PDF-Dokumente nicht immer auf Anhieb verständlich sind.

Mausklick rechts auf die Modellbezeichnung öffnet ein Kontextmenü Hier kann die Dokumentation, soweit vorhanden, ausgewählt werden.

Damit die Verlinkung gelingt, wird sie in der externen *.ini-Datei so eingetragen:

PdfDoc_ENG = "Doku_zum_Modell_XYZ_ENG.pdf"<br>
PdfDoc_GER = "Doku_zum_Modell_XYZ_DEU.pdf"<br>
PdfDoc_FRA = "Doku_zum_Modell_XYZ_FRA.pdf"<br>
PdfDoc_POL = "Doku_zum_Modell_XYZ_POL.pdf"<br>

Bis auf den vollständigen Dateinamen mit der Endung *.pdf sind keine weiteren Pfadangaben notwendig, es sei denn, die Datei befindet sich im Unterordner des Zielordners \Doc\. Liegt die Dokumentation in nur einer Sprachversion vor (was die Regel sein dürfte), soll auf leere Werte, etwa: PdfDoc_POL = "" , verzichtet werden.

PDF-Dokumentation in der Installationsdatei eintragen

Im Gegensatz zum Eintrag in der *.ini-Datei wird im Installationsskript der Pfad ab dem Ordner Resourcen aufgeführt. Wenn die Dokumentation im Ordner Resourcen\Doc liegen soll, sieht die Installationsdatei z.B. so aus:

File001 = []
...
File015  = "V80NHW10019.pdf","Resourcen\Doc\V80NHW10019.pdf"

Das setzt voraus, dass sich die PDF-Datei im Installationspaket befindet. Siehe hierzu auch das Beispiel einer externen Ini-Datei.

Modell zum Signieren hochladen

Ihre fertigen Modelle, die den Prozess der Modellinstallation durchlaufen haben, übergeben Sie an das Tester-Gremium des Trend Verlags. Dies gilt für Shop- wie für Free-Modelle. Nach eventuellen Nachbesserungen, zu denen Sie das Tester-Gremium auffordern wird, wird das Modell vom Trend Verlag signiert und demnächst in den Shop eingestellt.

Flight Check

Sie ersparen sich und den Testern Zeit und Kraft, wenn Sie vor der Bereitstellung des Modells diese Liste durchgehen:

• Backface Culling (ToDo)?
• ToDo
• Beträgt die Länge der Dateinamen einschließlich Punkt und Endung maximal 31 Zeichen?
• Enthalten die Dateinamen nur die erlaubten Zeichen?
• Läuft eine Probe-Installation auf ihrem eigenen Rechner ohne Fehlermeldungen?
• Starten Sie die DEV-Version von EEP. Legen Sie eine leere Anlage an. Platzieren Sie das soeben installierte Modell. Sehen Sie das Modell komplett und fehlerfrei?
• Haben Sie das Modell mit einer Dokumentation versehen, sie in der externen *.ini-Datei verlinkt und beigepackt?

Vortest

Wenn Sie Ihrem Modell grünes Licht geben können, übergeben Sie es nach Möglichkeit zu einem inoffiziellen Vortest an einen befreundeten Konstrukteurskollegen oder anderen Fachmann. So lassen sich niederschwellig Fehler korrigieren und verschiedene Einschätzungen zum Modell diskutieren.

Modell an Tester-Gremium hochladen

Spätere Updates

Sound in Immobilien

Es empfiehlt sich, dem Anwender die Sound-Steuerung über Kontaktpunkte zu dokumentieren, damit er nicht in die Falle tappt und im Planfenster fälschlich Kontaktpunkte für Sound auswählt.

Zurück zum Kapitel Sound in Immobilien.

Modellinstallation mit dem Home-Nostruktor 13.0 vorbereiten

Die Vorteile einer Installationsroutine

Als offizieller Konstrukteur möchten Sie Ihre Modelle auch anderen EEP-Anwendern zur Verfügung stellen. Dazu muss eine Installationsroutine vorbereitet werden. Sie gewährleistet, dass alle zum Modell gehörenden Dateien sowie eventuelle zusätzliche Begleitdateien wie Sprühtexturen, Tauschtextur-Vorlagen, Dokumentation, Sound-Dateien, Demonstrationsanlagen usw. beim späteren Anwender in die vorgesehenen Verzeichnisse kopiert werden. Ein weiterer Vorteil der Installationsroutine für den EEP-Anwender besteht darin, dass die automatisch installierten Modelle zunächst in der Kategorie Neue Modelle → Zuletzt installiert erscheinen und auch ohne Modellscan in EEP sofort platziert werden können. Die vorläufige ‒ weil lediglich bis zum nächsten Scanvorgang andauernde ‒ Anzeige der zuletzt installierten Modelle in der Kategorie Neue Modelle ist sogleich der beste Zeitpunkt, um diese in die womöglich vorhandenen selbst erstellten Kategorien einzusortieren.

Die Installationsroutine und ihre Voraussetzungen

Der Home-Nostruktor 13.0 bietet eine komfortable und zuverlässige Möglichkeit zur automatischen Erzeugung von Installationsskripten für Einzelmodelle und umfangreiche Modellpakete. Das Funktionsprinzip basiert auf der Aufzeichnung einer vorhandenen Konstellation, die auf anderen Computern (beliebig oft) reproduziert werden kann. Die Voraussetzung hierfür ist, dass die Modelle und alle Begleitdateien, die Sie für die Erzeugung der Installationsroutine vorgesehenen haben, sich bereits im Ressourcen-Ordner von EEP (auf Ihrem lokalen Computer) befinden und diese zuvor auf Funktionsweise und korrekte Darstellung überprüft wurden. Zu beachten und zu kontrollieren sind dabei auch die gültigen Installationspfade.

Wenn Sie die folgenden Hinweise Schritt für Schritt am eigenen PC nachvollziehen möchten, laden Sie sich zunächst das kostenlose Modell $$$ aus der von Trend bereitgestellten offiziellen Plattform Mein EEP-Forum herunter und installieren Sie es als Anwender.

Die eigentliche Vorbereitung einer Installationsroutine erfolgt in zwei Arbeitsschritten:

• Erzeugung eines Installationsskripts (install.ini-Datei)
  
• Erzeugung einer Artikelinstallation (*.eep-Datei)
  

Die Gliederung in zwei Etappen ermöglicht die nachträgliche Zusammenfassung mehrerer Einzelartikel zu einem umfangreichen Modellpaket (z.B. einem Sparset). Die Anfertigung der *.eep-Skriptdatei ist jedoch auch bei einem einzigen Modell erforderlich, da nur sie den Start des Installationsprogramms aus EEP heraus veranlasst.

Es empfiehlt sich, die beiden Installationsskripte (install.ini und installation.eep) mit dem Home-Nostruktor zu erzeugen, auch wenn diese Dateien mit einem Texteditor geschrieben bzw. nachträglich bearbeitet werden können. Dies schließt Fehler aus, die beim Notieren der Pfadangaben oder der Nummerierung der Installationsanweisungen passieren könnten.

Ein Installationsskript (eine install.ini-Datei) erzeugen

ToDo: an passender Stelle einbauen: Sprühtexturen in das Skript aufnehmen

Im ersten Arbeitsschritt werden innerhalb des Ressourcen-Ordners von EEP alle Modelldaten und Begleitdateien ausgewählt, die Sie für die Installation vorgesehen haben. Der Home-Nostruktor protokolliert dabei die Installationspfade, kopiert alle benötigten Daten in einen Zwischenordner ihrer Wahl und erzeugt darin eine Datei namens install.ini, die alle Installationsanweisungen in einer durchnummerierten Liste beinhaltet:

Wählen Sie im Menü Datei → Erzeuge Installationsscript (ini-Datei). Ein Dialogfenster, in dem Sie alle Einstellungen vornehmen, wird geöffnet.

Im oberen Eingabefeld des Dialogfensters können Sie die Vorgabe durch einen eigenen Ordnernamen ersetzen. In diesem Beispiel heißt der Ordner EEP_Wiki_Install\Bahnwaerterhaus. Mit Klick auf die Schaltfläche Pfad ändern können Sie das Laufwerk wechseln, die Verzeichnisstruktur durchsuchen, einen existierenden Ordner auswählen bzw. einen neuen anlegen. In diesem Ordner werden anschließend alle Daten der Installation für die spätere Verwendung zwischengespeichert. Klicken Sie nun auf die Schaltfläche "*.3dm hinzufügen", um die Modelldatei auszuwählen, die installiert werden soll. In diesem Beispiel wird die Datei Bahnwaerterhaus_HW1.3dm im Ordner \EEP13\Resourcen\Immobilien\Verkehr\Betriebswerke\ ausgewählt.

Ist die Wahl des Modells (der *.3dm-Datei) getroffen, wird das Feld Inhalt der Installation... mit der ersten Installationsanweisung gefüllt. Dabei gilt:

• Möchten Sie mehrere Modelle installieren, die sich im gleichen Ordner befinden, so gelten die Windows-üblichen Regeln für die Mehrfachauswahl ([Strg]+Mausklick).

• Sobald eine *.3dm-Datei eines Modells ausgewählt wurde, braucht die zugehörige *.ini-Datei des Modells nicht zusätzlich aufgenommen zu werden. Sowohl der Home-Nostruktor als auch das in EEP eingebettete Installationsprogramm gehen davon aus, dass zu jeder *.3dm-Datei eine gleichnamige *.ini-Datei existiert und kopieren diese Ini-Datei automatisch.

• Falsch ausgewählte Dateien werden per Doppelklick auf den Listeneintrag im Feld Inhalt der Installation... entfernt (das Modell selbst in den EEP-Ressourcen wird nicht gelöscht).

Wenn ‒ wie in diesem Beispiel ‒ weitere Begleitdateien installiert werden sollen, wie z.B. eine Sound-Datei im *.wav-Format, eine PDF-Anleitung, eine Demonstrationsanlage, abgespeicherte Blöcke, Tauschtextur-Vorlagen etc., werden sie ebenfalls durch Klick auf die Schaltfläche "*.3dm hinzufügen" ausgewählt. Dabei ist Windows-üblich die Datei-Endung in der unteren Dateityp-Auswahl auf *.* umzuschalten, womit alle Dateitypen angezeigt werden.

Analog zur Auswahl einer *.3dm-Modelldatei rufen Sie innerhalb des Resourcen-Ordners von EEP die gewünschten Begleitdateien auf. In diesem Beispiel ist es die zum Modellset gehörende Sound-Datei aus dem Ordner \Resourcen\Sounds\EEXP\. Die bereits ausgewählten Dateien werden im Feld Inhalt der Installation... in separaten Zeilen erfasst.

Bevor die Install.ini-Datei erzeugt werden kann, muss noch die Kompatibilität des Modellpaketes zu einer EEP-Version bestimmt werden, die als Mindestvoraussetzung für die Installation gelten wird.

Hinweis: Trend hat im Sommer 2017 den Konstrukteuren empfohlen, als Minimale EEP-Version EEP 11 einzutragen und auch so im Shop zu dokumentieren, unabhängig von der Kompatibilität des Modells zu früheren EEP-Versionen. Die Empfehlung gibt den Modellen mit Hinblick auf die Vermarktung ein aktuelles Erscheinungsbild.

Im Feld Plug-Ins legen Sie optional fest, welche Plug-ins für die korrekte Funktionsweise des Modells anwenderseitig benötigt werden. Sie werden beim Anwender noch vor der Installation auf deren Vorhandensein abgefragt. Ein hier gesetzter Haken teilt der Modellinstallation diese Eigenschaft mit. Werden die deklarierten Mindestvoraussetzungen nicht erfüllt, wird das interne Installationsprogramm von EEP die Installation mit einer entsprechender Fehlermeldung abbrechen.

Die Schaltfläche Erzeugen generiert im zuvor bestimmten Ordner eine Datei install.ini. Sie enthält die Auflistung der im Skript gesammelten Dateipfade und kopiert die dazugehörigen Dateien ins gleiche Verzeichnis.

Inhalt der install.ini

[EEPInstall]
EEPVersion	 = 11
File001	 = "Bahnwaerterhaus_HW1.3dm","Resourcen\Immobilien\Verkehr\Betriebswerke\Bahnwaerterhaus_HW1.3dm"
File002	 = "Laeutewerk_HW1.wav","Resourcen\Sounds\EEXP\Laeutewerk_HW1.wav"
File003	 = "V11_Bahnwaerterhaus_HW1.pdf","Resourcen\Doc\V11_Bahnwaerterhaus_HW1.pdf"

Wird ein Plug-in vorgesetzt, vermerkt dies der Home-Nostruktor in der Zeile EEP-Version:

...
EEPVersion	 = 11,3
...

Hinweis: Es gehört zu den Eigenheiten des Home-Nostruktors, dass ein einmal erzeugtes Installationsskript nicht erneut aufgerufen werden kann. Bei nachträglichen Änderungen müssen alle bisherigen Schritte erneut durchlaufen werden. Es ist allerdings möglich, die Datei in einem externen Editor zu bearbeiten. Es empfiehlt sich eine anschließende Kontrolle auf eventuelle Konvertierungsfehler bei Sonderzeichen.

Eine Artikelinstallation (*.eep-Datei) erzeugen

Im zweiten Arbeitsschritt wird eine *.eep-Datei erzeugt, die vom der in EEP eingebetteten Installationsroutine aufgerufen wird.

Rufen Sie den Befehl Datei → Erzeuge Artikelinstallation (eep-Datei) auf.

Mit Klick auf Install.ini wird das zuvor abgelegte Installationspaket (*.ini) geöffnet. Hinweis: Es wird nicht die ini-Datei des Modells, sondern die im gleichen Verzeichnis liegende Datei install.ini ausgewählt.

Von diesem Bearbeitungszustand an sind die übrigen Eingabefelder im Dialogfenster aktiviert. Jetzt kann entschieden werden, ob es sich um eine sofortige Installation oder eine gegliederte Teilinstallation mit Auswahlmenü handeln soll.

Schnelle Einzelinstallation ohne Auswahlmenü

Tragen Sie in die beiden Eingabefelder Titel der Installation in der ausgewählten Landessprache und Beschreibung in der ausgewählten Landessprache nichts ein (auch kein Leerzeichen). Dies veranlasst die in EEP eingebettete Installationsroutine, sofort zum Kopieren der Daten übergehen.

Im Feld Name des Installationsordners wird der Dateiname des Installationspaketes eingetragen. Er kann noch später vor dem Hochladen des Modellpaketes auf der Trend-Server geändert werden.

Im Ordner C:\EEP_INSTALL liegt jetzt das fertige Installationsskript. Dabei hat der Home-Nostruktor dem Dateinamen als Präfix die zuvor angegebenen Mindestvoraussetzungen hinzugefügt:

Mausklick auf *.eep-Datei erzeugen schafft einen Ordner mit allen zuvor gesammelten dateien und zusätzlich die Datei Installation.eep. Er sieht in den beiden Hierarchie-Ebenen so aus:

Gegliederte Installation mit einem Auswahlmenü

EEP erlaubt die Installation mehrerer separater Modellsets Menü-gesteuert in einem einzigen Installationsprozess. Dies ist dann sinnvoll, wenn der Konstrukteur davon ausgehen kann, dass nicht alle Anwender alle Bestandteile aus dem Lieferumfang installieren werden.

Eine gesteuerte Installation erfordert mehrere voneinander unabhängige Artikel-Installationspakete. Es werden also zuvor mindestens zwei (bis maximal 99) Installationsskripte angelegt, die ‒ wie oben beschrieben ‒ zunächst unterschiedliche Installationspakete erzeugen.

Im Dialog Erzeuge eine *.eep-Datei für den 3DM-Installer (richtig müsste es heißen: "...für die Installationsroutine in EEP") wurden im Beispiel der einfachen Artikelinstallation die beiden Felder Titel der Installation in der ausgewählten Landessprache und Beschreibung in der ausgewählten Landessprache leer gelassen. Bei der gegliederten Installation werden diese Felder mit passendem Text gefüllt.

Dabei verwandelt die anschließende Kompilation die Einträge im Feld Titel der Installation... in vom Anwender wählbare Menüeinträge.

Sie können passende Einträge für die vier in EEP vorgesehenen Landessprachen vornehmen, müssen es aber nicht. Im zweiten Fall füllt die Software die Felder mit den deutschen Texten aus, so dass ein Anwender unabhängig von seiner Sprachversion die Installation (wenn auch nicht in der erwarteten Sprache) vernehmen kann.

• Rufen Sie den Befehl Datei → Erzeuge Artikelinstallation (eep-Datei) auf, um das bereits vertraute Dialogfenster anzuzeigen.

• Wie zuvor klicken Sie auf die Schaltfläche Install.ini hinzufügen und wählen im nachfolgendem Auswahlfenster die Install.ini-Datei aus dem Quellordner aus.

• Vergeben Sie im Feld Titel der Installation in der ausgewählten Landessprache einen passenden Namen für die Teilinstallation.

• Im Eingabefeld darunter Beschreibung in der jeweiligen Landessprache können kurze Hinweise zum Modell oder den Lieferumfang der Teilinstallation notiert werden.

• Klicken Sie erneut auf die Schaltfläche Install.ini hinzufügen und wählen im nachfolgenden Auswahlfenster eine andere Install.ini-Datei, diejenige, die dem zweiten Modellpaket entstammt, das installiert werden soll.

• Vergeben Sie auch hier Titel und Kurbeschreibung.

Mit Klick auf Datei → Erzeuge Artikelinstallation (eep-Datei) entsteht ein Installationsmenü. In diesem Beispiel enthält es zwei Einträge.

Sie können den Inhalt der *.eep-Datei in einem Texteditor betrachten (und bei Bedarf bearbeiten).

[Install_00]
Name_GER	 = "KSW-Straßenbahnen"
Name_ENG	 = "KSW-Tram"
Name_FRA	 = "KSW-Tramway"
Name_POL	 = "KSW-Tramwaj"
Desc_GER	 = "KSW Straßenbahntriebwagen und Beiwagen in der Woltersdorfer Ausführung. [e] Dazu ein Schleifwagen auf KSW-Basis.[e]"
Desc_ENG	 = "KSW Straßenbahntriebwagen und Beiwagen in der Woltersdorfer Ausführung. [e] Dazu ein Schleifwagen auf KSW-Basis.[e]"
Desc_FRA	 = "KSW Straßenbahntriebwagen und Beiwagen in der Woltersdorfer Ausführung. [e] Dazu ein Schleifwagen auf KSW-Basis.[e]"
Desc_POL	 = "KSW Straßenbahntriebwagen und Beiwagen in der Woltersdorfer Ausführung. [e] Dazu ein Schleifwagen auf KSW-Basis.[e]"
Script	 = "Install_00\Install.ini"

[Install_01]
Name_GER	 = "Tauschtexturen"
Name_ENG	 = "Textures"
Name_FRA	 = "Textures"
Name_POL	 = "Textura"
Desc_GER	 = "Drei Tauschtextur-Sätze mit insgesamt 13 Texturdateien für:[e] Darmstadt neu, Darmstadt alt und Wien. Schleifwagen in kommunal-orange.[e]"
Desc_ENG	 = "Drei Tauschtextur-Sätze mit insgesamt 13 Texturdateien für:[e] Darmstadt neu, Darmstadt alt und Wien. Schleifwagen in kommunal-orange.[e]"
Desc_FRA	 = "Drei Tauschtextur-Sätze mit insgesamt 13 Texturdateien für:[e] Darmstadt neu, Darmstadt alt und Wien. Schleifwagen in kommunal-orange.[e]"
Desc_POL	 = "Drei Tauschtextur-Sätze mit insgesamt 13 Texturdateien für:[e] Darmstadt neu, Darmstadt alt und Wien. Schleifwagen in kommunal-orange.[e]"
Script	 = "Install_01\Install.ini"

Hinweis: Die Mechanik der Installationsskripte für den Home-Nostruktor sieht vor, dass alle später vom Anwender zu installierenden Dateien beim Konstrukteur bereits als Quelldateien an gleicher Stelle liegen. Das erfordert eine Kontrolle, ob die Dateien bei der Probeinstallation wirklich kopiert worden sind.