DispoHelp. Handbuch. Inhaltsverzeichnis. 1. Vorwort. 2. Programmhandbuch. 3. Entwicklungstools. 4. Abschluss. 1.1 Vorwort

Transkript

1 DispoHelp Handbuch Inhaltsverzeichnis 1. Vorwort 1.1 Vorwort 2. Programmhandbuch 2.1 Allgemeine Verwendung und Bedienung 2.2 Exportieren einzelner Umlauftouren 2.3 Fahrpläne aus OMSI importieren 2.4 Formatierte Fahrpläne einfügen 3. Entwicklungstools 3.1 Formatierte Fahrplandateien im Überblick 3.2 Vorlagen für Tour- / Umlaufexporte 4. Abschluss 4.1 Hilfe erhalten 4.2 Copyright und Lizensschutz 1. Vorwort 1.1 Vorwort Vielen Dank für den Download von DispoHelp, einem einfachen Tool zum schnellen Anzeigen von Busfahrplänen aus OMSI den Omnibussimulator. In diesem kurzen Handbuch soll der Funktionsumfang besser erklärt werden und Entwicklern Hilfe geboten werden.

2 Lassen Sie sich nicht von der Anzahl der Seiten erschrecken. Das Handbuch verfügt über viele Bilder zur Veranschaulichung der beschriebenen Funktionen. Des weiteren ist im Handbuch in mehreren Seiten über den Aufbau der internen Dateien dokumentiert. Bitte beachten Sie, dass die verwendeten Grafiken noch teilweise der Version 1.0 beta entnommen worden sind, wodurch diese eventuell leicht veraltet sind und nicht mehr zu 100 % dem aktuellen Aussehen des Programms entsprechen. Ich wünsche Ihnen viel Spaß mit der Software. 2. Programmhandbuch 2.1 Allgemeine Verwendung und Bedienung Wenn Sie das Programm öffnen sehen Sie zunächst das Hauptfenster. Dies ist das Fenster, welches Sie die meiste Zeit bei der Verwendung zu Gesicht bekommen, daher wird Ihnen nun der Aufbau etwas genauer erklärt.

3 Im Programm arbeiten Sie meist von oben nach unten. Als erstes wählen Sie aus der obersten Liste, welche Sie mit einem Klick auf die Box bei Map öffnen, die gewünschte Karte aus. In ihr sehen Sie alle Karten für OMSI, welche Sie bereits in DispoHelp importiert haben (siehe 2.3 und 2.4). Nach Auswählen einer Karte können Sie in der darunter liegenden Box die Linie auswählen, für die Sie die Fahrpläne anzeigen möchten. Hierbei ist zu beachten, dass lediglich die Linien gelistet sind, die auch aktiv vom Nutzer fahrbar sind. Direkt darunter bietet Ihnen eine weitere Box die Auswahl des gewünschten Umlaufs, bzw. der gewünschten Tour, für die im folgenden Schritt dann der Fahrplan angezeigt wird.

4 Auf der rechten Seite können Sie zudem jederzeit den gewünschten Tag auswählen, für den die Fahrpläne angezeigt werden sollen. Außerdem können Sie festlegen, ob dieser Tag des anzuzeigenden Fahrplan in den Schulferien oder zu Schulzeiten liegen soll. Ist auch diese Auswahl getroffen, lädt DispoHelp automatisch die unter diesen Umständen gespeicherten Fahrpläne.

5 Diese Fahr- bzw. Dienstpläne werden in der Reihenfolge angezeigt, wie sie im OMSI-Editor zugewiesen wurden. Fahrten ohne Zwischenhalt werden nicht angezeigt. 2.2 Exportieren einzelner Umlauftouren DispoHelp bietet die Möglichkeit, einzelne Trips von Umläufen extern als Datei zu speichern. Dies geschieht nach einer vorher erstellten Vorlage für den Aufbau dieser Exportdatei. In Teil 3.2 lernen Sie, wie Sie so eine Vorlage für das Programm erstellen. Existiert bereits eine Vorlagendatei, die Ihren Wünschen entspricht können Sie nun einen Trip exportieren. Klicken Sie dazu, nachdem Sie Map, Linie und den entsprechenden Umlauf ausgewählt haben, auf den Trip doppelt, den Sie exportieren möchten. Nun öffnet sich ein neues Fenster, in dem Sie die Vorlage, die Sie zum Erstellen der Exportdatei verwenden möchten, auswählen.

6 Nachdem Sie Ihre Auswahl mit einem Klicken auf Exportieren bestätigt haben, öffnet sich ein weiteres Fenster, indem Sie festlegen, wo Sie die exportierte Datei speichern möchten. Wurde in Ihrer Exportvorlage eine benutzerdefinierte Dateiendung festgelegt, so haben Sie die Wahl des Dateityps für die Ausgabedatei für die benutzerdefinierte Dateiendung oder.txt, also eine normale Textdatei. Wurde in der Vorlage keine benutzerdefinierte Dateiendung festgelegt, können Sie nur als.txt exportieren.

7 2.3 Fahrpläne aus OMSI importieren DispoHelp bietet mithilfe des Import-Asstistent die Möglichkeit, Fahrpläne aus OMSI direkt in DispoHelp zu importieren, da DispoHelp andere Informationsdateien verwendet als OMSI. In diesem Teil soll der Import-Assistent vorgestellt werden, Informationen zum Aufbau der Informationsdatei in DispoHelp sind in Teil 3.1 zu finden. Klicken Sie zum Öffnen des Import-Assistent oben rechts im Hauptfenster auf Aus OMSI importieren. Im folgendem Fenster wählen Sie bitte den Mapordner der gewünschten OMSI- Karte aus. Diesen finden Sie, indem Sie ins OMSI-Hauptverzeichnis, dann in den Unterordner maps und den Namen Ihrer gewünschten Karte, in diesem Beispiel Berlin-Spandau, auswählen und mit OK bestätigen. Haben Sie alles richtig gemacht und die Karte enthält fahrbare Linien, zeigt Ihnen der Import-Assistent noch einmal die zum Import zur Verfügung stehenden Linien an.

8 Geben Sie nun in das Textfeld im unteren Teil des Fensters den Namen der Karte erneut ein, dieser Name wird später im Hauptfenster im Menü Map angezeigt. Klicken Sie auf Import starten, um mit dem Import zu beginnen. Dieser sollte meist nur wenige Sekunden dauern. Wenn der Import erfolgreich war, sehen Sie eine entsprechende Meldung, die Sie mit OK bestätigen können.

9 Wenn Sie nun den Import-Assistent schließen, können Sie sich schon die Fahrpläne der eben importierten Karte ansehen.

10 2.4 Formatierte Fahrpläne einfügen Möchten Sie Fahrpläne in DispoHelp einfügen, die Sie aber selber nicht importieren können, können Ihnen andere Verwender von DispoHelp ihre bereits importierte Fahrplandateien senden. Alle Dateien dieser Art finden Sie im Installationsverzeichnis von DispoHelp im Unterverzeichnis data und mapdata. Die Dateiendung dieser Fahrplaninformationsdateien für DispoHelp lautet.dph_map. Wie diese Datei aufgebaut ist erfahren Sie in Teil 3.1. Andere Benutzer von DispoHelp können Ihnen die entsprechenden Dateien aus diesem Verzeichnis zusenden und Sie können diese dann auf Ihrem Rechner in das entsprechende Verzeichnis einfügen. Diese sind dann auch bei Ihnen in DispoHelp sichtbar. 3. Entwicklungstools 3.1 Formatierte Fahrplandateien im Überblick Wenn Sie mehr über den Aufbau der Fahrplaninformationsdateien in DispoHelp wissen möchten, können Sie diesen im folgenden Teil erkunden. Alle Dateien dieser Art finden Sie im Installationsverzeichnis von DispoHelp im Unterverzeichnis data und mapdata. Die Dateiendung dieser Fahrplaninformationsdateien für DispoHelp lautet.dph_map.

11 Diese Dateien lassen sich einfach mit dem Windows Editor / Notepad öffnen. Aus Vereinfachungsgründen wurde die geöffnete Datei für dieses Tutorial gekürzt und mit weiteren Leerzeilen versehen.

12 Eine Fahrplaninformationsdatei für DispoHelp ist relativ simpel aufgebaut, sie arbeitet nach dem selben Schlüsselwort -Prinzip wie OMSI-Dateien auch. Wie diese im Detail funktionieren können Sie ausführlich im OMSI-SDK nachlesen, welches kostenlos unter zum Download zur Verfügung steht. In einer Datei werden lediglich fahrbare Linien und Touren hinterlegt.

13 Um eine Linie hinzuzufügen wird das Schlüsselwort [newline] gesetzt, gefolgt von der Liniennummer in der nächsten Zeile. Nun folgen die in dieser Linie vorhandenen Umläufe. Um einen Umlauf hinzuzufügen wird das Schlüsselwort [newtour] gesetzt, gefolgt von der Umlaufnummer und dem Fahrtagescode aus OMSI in den nächsten beiden Zeilen. Dieser Fahrtagescode wird vom OMSI-Editor generiert und kann von DispoHelp wieder encodiert (aufgelöst) werden. Um einen Dienst in dem eben festgelegten Umlauf hinzuzufügen wird das Schlüsselwort [newtour_trip] gesetzt, gefolgt von... - dem Namen der Starthaltestelle - dem Namen der Endhaltestelle - der Abfahrtszeit an der Starthaltestelle - der Fahrzeit für diesen Dienst in dieser Reihenfolge in den folgenden 4 Zeilen. Wichtig: Die Abfahrtszeit für die Starthaltestelle muss eine reelle Uhrzeit sein, also zwichen 0:00 und 23:59 liegen. Bei der Erstellung von Fahrplänen im OMSI-Editor kann es passieren, dass durch das automatische Vervollständigen eine Uhrzeit von z.b. 25:06 entsteht, mit der DispoHelp aber nichts anfangen kann und eine entsprechende Fehlermeldung erzeugen würde. Der Import-Assistent formatiert solche unreellen Uhrzeiten in reelle um, also z.b. in 1:06. Achten Sie beim manuellen Bearbeiten aber auf dieses Format! Wichtig: Die Fahrzeit des Dienstes muss in der Konfigurationsdatei für DispoHelp folgendes Format haben: Minuten:Sekunden, mit einem : (Doppelpunkt) und zwei Nachkommastellen. Der OMSI-Editor erzeugt Werte, wie z.b Der Import-Assisten formatiert diese um. Sind alle Trips für diesen Umlauf eingetragen wird dieser mit dem Schlüsselwort [newtour_end] abgeschlossen. Nun können noch weitere Umläufe mit entsprechende Trips hinzugefügt werden, achten Sie aber auf die Schlüsselworte! Sind alle Umläufe für diese Linie eingetragen wird diese mit dem Schlüsselwort [newline_end] abgeschlossen.

14 Nun können noch weitere Linien mit entsprechenden Umläufen und Trips hinzugefügt werden, achten Sie aber auf die Schlüsselworte! 3.2 Vorlagen für Tour- / Umlaufexporte In Teil 2.2 haben Sie gelernt, wie Sie einzelne Trips von Umläufen z.b. für andere Programme nach Vorlage exportieren können. In diesem Teil erfahren Sie, wie Sie selber Vorlagen erstellen. Die Exportdatei sieht später genauso aus, wie die Vorlagendatei, das heißt, Sie können in die Vorlagendatei hineinschreiben, was Sie wollen, also auch, z.b. wenn Sie die spätere Exportdatei für ein anderes Programm nutzen wollen, externe Schlüsselworte. Die Vorlagendatei ist eine Textdatei(.txt) mit anderer Endung. Beim Export legt das Programm eine exakte Kopie der Vorlagendatei an und ersetzt nur die eingetragenen Variablen durch die Werte im Programm. Es gibt folgende Variablen, die das Programm ausgibt: $mapname$ $linenum$ $reallinenum$ $tournum$ $starttime$ $endtime$ $firststop$ $laststop$ Der Name der ausgewählten Karte Die ausgewählte Liniennummer Die echte Liniennummer, die auf der Matrix steht (nur bei erweiterter Darstellung (->Einstellungen)) Die ausgewählte Umlaufnummer Abfahrtszeit Starthaltestelle Ankunftszeit Endhaltestelle Name der Starthaltestelle Name der Endhaltestelle Werden diese Variablen in der Vorlagendatei eingefügt ersetzt das Exporttool diese in der Exportdatei durch die entsprechenden Werte. Zusätzlich zu den eben genannten Variablen lässt sich mit einem weiteren Schlüsselwort eine benutzerdefinierte Dateiendung festlegen. Wie Sie in Teil 2.2 bereits gelernt haben ist standardmäßig die Dateiendung.txt festgelegt. Wenn in einer Vorlage eine eigene festgelegt wurde, stehen beide zur Auswahl. Für eine benutzerdefinierte Dateiendung fügen Sie das Schlüsselwort [dispohelp_output-filetype] ein, gefolgt von der gewünschten Dateiendung in der nächsten Zeile.

15 Diese beiden Zeilen werden in der Exportdatei nicht mehr vorhanden sein. Während in den Zeilen der Schlüsselworte keine weiteren Zeichen vorhanden sein dürfen (so natürlich auch hier bei dem für die benutzerdefinierte Dateiendung), können in Zeilen mit Variablen auch noch andere Texte stehen, da andere Programme evtl. mit anderen Formaten arbeiten. So kann in einer Vorlage zum Beispiel eine Zeile so aussehen: map=$mapname$. In der späteren Exportdatei sehe dass dann beispielsweise entsprechend so aus: map=berlin Spandau '89. Alle abzufragenden Variablen werden in dem Namen ausgegeben, wie sie im Importer festgelegt wurden. Speichern Sie nun Ihre Vorlagendatei im Installationsverzeichnis von DispoHelp, im Unterordner data und exportstyle, in folgendem Dateinamensmuster ab: Name der Vorlage.dph_exs Der Name der Vorlage wird im Exportfenster angezeigt, ohne die Dateiendung. 4. Abschluss 4.1 Hilfe erhalten Wenn Sie einmal nicht weiterwissen hilf Ihnen ein Blick in diese Dokumentation oder ein Klick unten links im Hauptfenster auf Hilfe.

16 Auf der folgenden Website finden Sie zahlreiche Informationen über das Programm. 4.2 Copyright und Lizensschutz Das komplette Programm DispoHelp wurde mitsamt aller Komponenten von Alexander Regier entwickelt. Das Ändern des Programms oder Teilendavon, außer denen hier im Handbuch vorgestellten, ist nicht gestattet und kann strafrechtlich verfolgt werden. Alle selbsterstellten Dateien dürfen öffentlich weitergegeben werden, jedoch unter freier Lizenz und unkommerziell. Das Programm DispoHelp inklusiver aller seiner Komponenten darf nicht auf anderen Servern hochgeladen oder anderweitig vertrieben werden. Weder unter kostenfreier Lizenz, noch kommerzieller. Die Software inklusiver aller seiner Komponenten darf jedoch mit vorheriger Absprache mit mir mit eigenen Komponenten mitgeliefert werden. Copyright Alexander Regier