dispohelp - download.alexander-regier.dedownload.alexander-regier.de/.../dokumentation/omsi...these...

15
DispoHelp Manual table of contents 1. Foreword 1.1 Foreword 2. Programmanual 2.1 General use 2.2 export of some tours 2.3 Import timetables from OMSI 2.4 import formatted timetables 3. developmenttools 3.1 Overview of formatted timetable datas 3.2 template for exports of tours 4. finishing instructions 4.1 get help 4.2 copyright 1. Foreword 1.1 Foreword Thank you for downloading DispoHelp, an easy Tool to show timetables from OMSI – the Omnibussimulator fast. In this short manual, there will be declared the features. There is also an information for developers.

Upload: others

Post on 08-Nov-2020

1 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: DispoHelp - download.alexander-regier.dedownload.alexander-regier.de/.../dokumentation/omsi...These schedules are listed, how they are listed in the OMSI-Editor. You can’t see a

DispoHelpManual

table of contents

1. Foreword

1.1 Foreword

2. Programmanual

2.1 General use

2.2 export of some tours

2.3 Import timetables from OMSI

2.4 import formatted timetables

3. developmenttools

3.1 Overview of formatted timetable datas

3.2 template for exports of tours

4. finishing instructions

4.1 get help

4.2 copyright

1. Foreword

1.1 Foreword

Thank you for downloading DispoHelp, an easy Tool to show timetables from OMSI – the Omnibussimulator fast.

In this short manual, there will be declared the features. There is also an information for developers.

Page 2: DispoHelp - download.alexander-regier.dedownload.alexander-regier.de/.../dokumentation/omsi...These schedules are listed, how they are listed in the OMSI-Editor. You can’t see a

Don’t be scared, if you see how many pages you can read. This manual has a lot ofpictures to demonstrate the features.

Additionally there are a few pages to explain, how the program use the TTData of OMSI.

Please note, that many graphics were used from Version 1.0. That is the reason, why maybe these graphics are a little bit older and not 100 percent the same of your version.

I hope you’ll enjoy this program.

2. Programmanual

2.1 General use

If you open the program, you’ll see the main window.

This is the window, which you see often. Therefore you get the explanation of the structure.

Page 3: DispoHelp - download.alexander-regier.dedownload.alexander-regier.de/.../dokumentation/omsi...These schedules are listed, how they are listed in the OMSI-Editor. You can’t see a

In this program, you work from up to down.

At first you choose an option of the upper list, which you can do with a mouseclick at „Map“ 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.

Here you can see all the maps, you import into DispoHelp until today. (look 2.3 and 2.4).

After choosing a map, you can switch to the Box „Line“. You decide here, of which line you want to see the timetables. You can only see the lines, you can drive at OMSI.

Below this box you see another box, where you can choose the tour. You now see all departure times of this tour.

Page 4: DispoHelp - download.alexander-regier.dedownload.alexander-regier.de/.../dokumentation/omsi...These schedules are listed, how they are listed in the OMSI-Editor. You can’t see a

On the right side you select the day. The box below is for holidays. If you search for holiday tours, click the button.

If you finished, DispoHelp will show you all timetables, you have selected.

Page 5: DispoHelp - download.alexander-regier.dedownload.alexander-regier.de/.../dokumentation/omsi...These schedules are listed, how they are listed in the OMSI-Editor. You can’t see a

These schedules are listed, how they are listed in the OMSI-Editor. You can’t see a tour with no stop. (example: Not in service)

2.2 Export of some tours

DispoHelp gives you the possibility to save trips of a tour as Data on your computer.

This saving proceed with a guideline for structure of this exportdata.

In part 3.2 you’ll lern, how you generate such a guideline.

Is there existing such a data you want to use, you can start to export the trip.

You have to click twice on the trip, you choosed in 2.1

Page 6: DispoHelp - download.alexander-regier.dedownload.alexander-regier.de/.../dokumentation/omsi...These schedules are listed, how they are listed in the OMSI-Editor. You can’t see a

There is opening a new window now. There you can select the guideline, which youwant to use for your created exportdata.

After you acknowledge your choice with a click on export, there will open a new window. You can now decide, where you want to save your data.

If you have used an user-defined data-ending, you can save your exportdata as „txt“ or your defined ending. If you don't have, you have only the choice to save as „txt“.

Page 7: DispoHelp - download.alexander-regier.dedownload.alexander-regier.de/.../dokumentation/omsi...These schedules are listed, how they are listed in the OMSI-Editor. You can’t see a

2.3 Import timetables from OMSI

In DispoHelp is an import-assistant, which is helping you to load timetables from OMSI directy into DispoHelp. You need this assistant, because DispoHelp uses other datas than OMSI.

In this part, I present you this assistant. You can find information over the structure of DispoHelp in Part 3.1

To start the import-assistant, please click on „Import from OMSI“ in the upper right corner.

In the following window you click on the right Mapfolder of your chosen OMSI-map.You can find these folder under C:\m-r software\OMSI\maps\Berlin-Spandau in this example. If you want a timetable from another map, you have to select the right map in the map-folder. Please click “OK” if you are ready.

If you haven’t done a fault and the map is containing ridable lines, the assistant shows you, which lines are ready for import.

Page 8: DispoHelp - download.alexander-regier.dedownload.alexander-regier.de/.../dokumentation/omsi...These schedules are listed, how they are listed in the OMSI-Editor. You can’t see a

Please tip in the name of the map in the lower box. This name will be shown in the main window at „Map“.

Click on “start import” to start. You’ll have to wait a few seconds.

If there was a success, you get an information, which you can acknowledge with „OK“.

Page 9: DispoHelp - download.alexander-regier.dedownload.alexander-regier.de/.../dokumentation/omsi...These schedules are listed, how they are listed in the OMSI-Editor. You can’t see a

If you close the import-assistant now, you can already see the timetables of your imported map.

Page 10: DispoHelp - download.alexander-regier.dedownload.alexander-regier.de/.../dokumentation/omsi...These schedules are listed, how they are listed in the OMSI-Editor. You can’t see a

2.4 import formatted timetables

If you want to import timetables, which you can’t import by yourself, other users of DispoHelp can send you their datas, which they imported by themselves. All files from other users are saved at „data“ and „mapdata“. The fileending of the timetable-information-files is „dph_map“. You find the structure at point 3.1

Other users can send and insert the files, shown in the upper screen. You can see these files in your DispoHelp after insert them, too.

3. developmenttools

3.1 overview of formatted timetable datas

If you want to know more about timetable-information-files, you should read the following instructions.

You can find all those files in your install-folder by clicking “data” and “mapdata“. The ending ist “dph_map”.

Page 11: DispoHelp - download.alexander-regier.dedownload.alexander-regier.de/.../dokumentation/omsi...These schedules are listed, how they are listed in the OMSI-Editor. You can’t see a

If you want to open them, use your editor or notepad on windows.

The file is reduced and there are a few empty lines for this tutorial to make it easier for you.

Page 12: DispoHelp - download.alexander-regier.dedownload.alexander-regier.de/.../dokumentation/omsi...These schedules are listed, how they are listed in the OMSI-Editor. You can’t see a

A timetable-information-file in DispoHelp is constructed very easy. It works with key words, like OMSI. You can take a look at the software development kit manual of OMSI(SDK) to look, how these files are operating.

You will only find driveable lines.

To create a new line, use the keyword „[newline]“, followed by the number of this line in the following row.

After it you insert the tours.

Page 13: DispoHelp - download.alexander-regier.dedownload.alexander-regier.de/.../dokumentation/omsi...These schedules are listed, how they are listed in the OMSI-Editor. You can’t see a

To create a new tour write the keyword „[newtour]“ in the next row, than press enter and write your tour number in the next row. There also must be inserted the code of the day in OMSI. This code will be drained by DispoHelp.

To add a service to your tour fill in the keyword „[newtour_trip]“ in the next row, followed by:

- the name of your first stop

- the name of your last stop

- the departure time at the first stop

- the journey time

…but only like this, and for a new point you have to take a new row.

important: The departure time at the first stop has to be between 00:00 and 23:59.

If you create new timetables in OMSI, it could be that 01:06 is 25:06. If you write a time over 23:59, DispoHelp won‘t work. The import-assistnat will change the time back to 01:06, so be careful, if you want to edit this filetyp manually.

important: The journey time must be declared in ninutes and seconds. You have tofill in a doublepoint(:)and two numbers after comma.

If you have registered all trips, you use the keyword „[newtour_end]“.

You can create a new tour, but be careful with your keywords.

If you have registeres all tours, use keyword „[newline_end]“

You can create a new line, but be careful to choose the right keywords.

3.2 template for exports of tours

In part 2.2 you learned, how you can export some trips. In this part you will learn, how you generate your own templates.

The export-data looks like the template-data, if you have finished. You can write, whatever you want. (f.e. other keywords for other programs) The template dara is a text data (.txt) with a different ending. During the export, the program will copy the template file and will only change the variables.

Here is a list with variables of DispoHelp:

Page 14: DispoHelp - download.alexander-regier.dedownload.alexander-regier.de/.../dokumentation/omsi...These schedules are listed, how they are listed in the OMSI-Editor. You can’t see a

$mapname$ name of the chosen map

$linenum$ the linenumber

$reallinenum$ the linenumber that is shown on the Matrix of the bus (only available in “advanced view” (->Settings))

$tournum$ the tournumber

$starttime$ the departure time at the first stop

$endtime$ the arrival time at the last stop

$firststop$ name of first stop

$laststop$ name of last stop

If the variables have been written, the template tool changes the data of your file.

Additionaly to the called variables, there is a new Keyword for the ending of the file. The standard ending is txt, like in part 2.2. If you use a new ending, DispoHelp will show you both possibilities.

The keyword for the new ending isFür „[dispohelp_output-filetype]“ In the next row, you write your ending, you want to use. You can’t see these rows in the export data.

While the rows with the keywords mustn’t have other signs, you can write in the rows with the variables other imformation like this:

map=$mapname$.

Later in your export file it looks like this:

map=Berlin Spandau '89.

All asked variables will be shown, how you have defined it in the Importer.

You can now save it in the folders „data“ and „exportstyle“, in the following model:

Name of template:dph_exs

The name of template will be shown in your export window, without ending.

4. Abschluss

4.1 get help

If you have a problem with DispoHelp, read this document again or click on the “Help”-Text the main window.

Page 15: DispoHelp - download.alexander-regier.dedownload.alexander-regier.de/.../dokumentation/omsi...These schedules are listed, how they are listed in the OMSI-Editor. You can’t see a

On the following website you can find lots of information about this program.

4.2 copyright

The whole program DispoHelp with all extras was developed by Alexander Regier.

Modifying of this program or of a part of this program is not permitted. You have to expect a criminal complaint, too.

All own produced files can be uploaded, but only under free licence and non-commercial.

The program DispoHelp, included all components are protected by german copyright. Upload the program on other servers is not allowed with no exceptions.

The Software, included all components can be uploaded, with your extra components. But only with agreement by Alexander Regier.

Copyright © Alexander Regier 2013 - www.alexander-regier.de

Translation by Nils (Nahverkehrpro at offiz. OMSI-Forum) – Thanks!

Übersetzung von Nils (Nahverkehrpro im offiz. OMSI-Forum) – Danke!