Writing .his files is one of the last steps of the mapmaking process, but there are important
standards that cannot be overlooked when creating these documents. This tutorial will show you
everything you need to know to write a .his file, and clearly demonstrate the proper format
in which .his files must be submitted. Please thoroughly read this tutorial to
ensure you understand how to correctly assemble .his files.
Before we get into the details, an explanation of exactly what a .his file is and does will be
necessary. The file has two purposes:
- Provide information (accessible via the "Info" button in the Trains window) that
describes the yard to users.
- Provide detailed information about the project that is used to add the new map to the YD
network.
In the table that follows, the six sections of the .his file are described. It
is important to note that all text in red must
be included in the .his file exactly as shown here. Once completed projects are submitted
for posting to the server, Jim Hill uses a software script to extract data from the submitted .his
files and automatically update the YD system files; for the script to function properly, the
specifications described herein must be adhered to. Thusly, there are no exceptions to the
format specified below, and any incorrect submittals will be returned to the designer for revision
according to the guidelines set forth herein. For the purposes of this tutorial, we will
examine the .his file for 1214 Sheffield Interlocking.
Name: Sheffield Interlocking, MO
Map By: Matt Freix
Date Added: 07-15-04 |
The first section provides the map name, author, and completion date.
The script uses the Name: header to extract the map name from the .his
file and add it to the .ini file. There can be only one space between the colon and the
map name, and the [map name],[2-letter state ID] format must be used (be sure to include
the comma). |
Description:
The Sheffield Interlocking area is the eastern end of the Kansas
City Terminal main through downtown... |
The project description is a concisely-written representation of the depicted map.
In its most basic form, a .his file will simply describe the purpose of a map (in the case of a
simple junction, it may suffice to only describe what lines are connecting). However, designers
are encouraged to research their projects and include detailed information in the .his files;
the information for my Selkirk, NY, map is an excellent example of this
variety of description. (Note that link is to an obsolete version of the .his file format.)
Note that I will act as editor for descriptions, making modifications as required for proper
MUGS (mechanics, usage, grammar, spelling).
|
Version History:
v1: Added to server (Do not delete.) |
Just a file structure thing. Ignore it (without deleting!) and move on. |
ParentYD:
YDSymbol:
Long: -94.497
Lat: 39.113 |
With this section begins the data content of the .his file.
ParentYD: - Used to indicate which yard is the parent of a new map; enter
yard number only. (This line is only used when the map in question will be a satellite of another
map; if your project will not be a satellite, leave this blank.)
YDSymbol: - Specifies the three-letter identifier used for YD's automatic
train symbol generator. (At this time, it is undecided whom will assign the symbol.)
Long: - Longitude of yard, given to three decimal places; see
Process Appendix II for information on how to obtain this item.
Lat: - Latitude of yard, given to three decimal places; see
Process Appendix II for information on how to obtain this item. |
Conn-Dels:
1200:13:1153:1
1200:14:1153:1
(etc.) |
Connections that will be deleted from the network (if none, leave blank).
Connections are described with the following format:
[map1 number]:[exit number]:[map2 number]:[exit number]
Thus, the example at left indicates that the connection between 1200 Santa Fe Jct. exit 13 and
1153 Q Tower exit 1 is rendered obsolete by the new map and should be removed from the system.
There cannot be a blank line between Conn-Dels: and the associated
connections (i.e., the entry must appear exactly as depicted at left). You can add text separated
by a space after defining a connection, such as:
[map1 number]:[exit number]:[map2 number]:[exit number] [textstring]
The text will be ignored by the script but can be used to note the name of the map being connected to.
When submitting a group of maps that are to be posted together, all connections that
are to be deleted must be listed in the lowest-numbered .his file of the group. |
Conn-Adds:
9911:1:1200:20
9911:2:1200:20
9911:3:1200:19
9911:4:LD
(etc.) |
Connections that will be added to the network.
Connections are described with the following format:
[map1 number]:[exit number]:[map2 number]:[exit number]
Thus, the example at left indicates that the connection between 9911 Sheffied Interlocking exit 1 and
1200 Santa Fe Jct. exit 20 is to be included in the system.
There cannot be a blank line between Conn-Adds: and the associated
connections (i.e., the entry must appear exactly as depicted at left). You can add text separated
by a space after defining a connection, such as:
[map1 number]:[exit number]:[map2 number]:[exit number] [textstring]
The text will be ignored by the script but can be used to note the name of the map being connected to.
Exit lines that have no destination are assigned a "local delivery" exit by the system; such exits
are indicated in the .his file with the format:
[map1 number]:[exit number]:LD
Each .his file will include a list of only new connections relating to the associated map.
All reciprocal connections must be listed in each .his file (i.e., map1.his will have
map1:map2 connections, and map2.his will list map2:map1 connections), with
the exception that connections between new and existing maps do not require you to submit
a revised .his for the existing map. Do not submit a master list of all connections for a group
of maps. Additional connections not directly associated with any of the submitted maps (i.e., a new
connection between two existing maps) should be included in the lowest-numbered .his file of a
group. |
To ease the task of properly assembling a .his file, I'm providing a template
.his file that is ready to be filled out with the requisite information. Simply download the
file, open it in Notepad, save it with the appropriate 9xxx.his filename, and enter your data.
As a ready reference for what a completed .his file should look like, please review the
.his file for IU Tower. Spaces and line separations in your .his file
should exactly match those in the example file (the template is set up precisely
this way).
A piece of advice for designers assembling connections for groups of maps:
It is a tremendous aid to schematically diagram the connections on paper. Here's how I do it:
- Before drawing anything, consider how many maps are going to be connected (both construction
and existing) and how they relate to each other in space, so you can organize them properly
on the paper.
- Now, using a pencil, write down the number and name for each map, then draw a box around
this data.
- Write down the exit numbers on the appropriate sides of the box for each map (in other words, on
the same side of the box as they are on the image in YD).
- Use a ruler (or other straightedge) to draw lines connecting exits of one map to the connecting
exits of other maps. As always, be sure to write neatly so you or someone else can come back later
and check your work.
Now, you'll have in front of you an easy-to-comprehend, visual representation of all the connections
that need to be written for the maps you'll be submitting!
I'll get around to posting a sample image that I've done once I get my scanner unburied.
|
