[gpz]

An efficient workflow to propose modifications to the manual would be creating a PR for them on GitHub. Only the git client (like TortoiseGit or GitHub desktop) is needed for creating such a PR and a text editor (Notepad, Notepad++, etc.). What's more, it is even possible to create such a PR by only clicketing on the github.com web page, with editing also done online. Fork, create a new branch, make the edits, create a PR. :)

[Weter]

I've only looked for some polite way to ask not to split Manual enhancement thread - for easier to follow it for the rest of us.
Here on ET there are more of such useful discussions. Not everyone is able to use that. I'm not successful with it.

[QJ-6811]

Some time ago (1.5 / 2 years?) things changed regarding Start/Stop Diesel engine procedure in OR.

In addition to the operation of sound triggers being changed, the display status of "ORTS_PLAYER_DIESEL_ENGINE_STATE" was also changed.
At the time it was indeed as described in the Manual: "frames 0, 1, 2, 3 for the player locomotive engine states Stopped, Starting, Running and Stopping."

The current status is "frames 0, 1, 2, 3 for the player locomotive engine states Stopped, Stopping, Starting and Running"

I think it is better to change this line in the Manual now? :)

[Weter]

I've came across, that analog clock's code sample is likely absent in Manual, only a chapter, about making scenery objects with animated clocks, where possibility to add clock in cabs is just have been mentioned.
Here is the sample:

                DialClock (
                        Hours (
                                Position ( 190 285 1 22 )
                                Pivot ( 3 )
                                Graphic ( "hour.ace" )
                        )
                        Minutes (
                                Position ( 190 285 1 30 )
                                Pivot ( 3 )
                                Graphic ( "minute.ace" )
                        )
                        Seconds (
                                Position ( 190 285 1 30 )
                                Pivot ( 3 )
                                Graphic ( "second.ace" )
                        )
                )

[Weter]

Hello.
Timetable's part 12 again.
Part 12.4.4 does not contain information about HHpMM timing format, which currently does nothing for program, but only shows (as a comment) the PASSING time of given station for given train.

---

I suppose, the latter two phrases of this post are worth to be added to paragraph 12.4.6 of the official Manual.

---

I'd report about #briefing row description at Chapter 12.4.6:

Manual said:

The #briefing row is optional and contains text which describes the train operation for the user. This text appears in the Open Rails main window along with description of the route and the loco.

The user can also see it in-game in the Briefing tab of the Help Window (F1).

A similar entry in the #comment column provides text which describes the entire timetable.

The timetable-or file does not allow the fields to contain line-breaks but if HTML breaks “<br>” are inserted into the #briefing field, these will be converted to line-breaks.

text, entered at intersection of #briefing row and first #comment column will describe the whole timetable, but my work have shown, that for text to be actually visible in Main Menu's window, it has to be placed to next column after the first (while #Comment is third one from the left)

---

Quote

12.4.7.4. Station Commands
... They are inserted directly after the station name in the first column.

But what may be a bit more nice-to insert them at next (second) blank column.

$nohold is actually Train command, canceling $hold for given train.
But at 12.4.7.5. Timing Commands nothing said about that, exept all three commands are similar to respective station commands.
Hence, $nohold is currently not explained ata ll.
Here is similar form, as missing:

Quote

$waitsignal
Can be used to override and negate a $nowaitsignal station command for the current train.

Quote

$nowaitsignal
Normally, if a train is stopped at a station and the next signal ahead is still at danger, the train will not depart. But, there are situations where this should be overruled.

Should be added something like: "(next signal)that belongs to the same node as current stop's platform marker"

---

12.4.7.5 "timing command" paragraph have swallowed shunting commands.
Between $noclaim
And
$detach
It's desirable to insert "12.4.7.6 shunting commands" headline.
So, next paragraph (Start commands) is expected to be not 12.4.7.6, but 12.4.7.7 already.

[Weter]

12.5.2. Processing of #dispose Command For Player Train
When the player train terminates and a #dispose command is set for that train to form another train (either $form, $trigger or $stable), the train will indeed form the next train as detailed, and that next train will now be the new player train. So the player can continue with that train, for instance on a return journey.

12.4.7.10 said:

$triggers also defines which new train is to be formed out of this train when the train terminates.

However, when this command is used, the new train will be formed using the consist definition of the new train and the existing consist is removed.

12.4.6 said:

However, if the train is run as an AI train and it is ‘formed’ out of another train (see below), the consist information is ignored and the train uses the consist of the train out of which it was formed.

For the player train, the consist is always used even if the train is formed out of another train.

Does that mean, if first train was controlled by player, it's consist will be retained and $trigger command will be ineffective/replaced by $form?
Then, should exception for player-controlled train be mentioned?

12.5.8. Known Problems said:

If the /binary qualifier is set for #path, but the OpenRails subdirectory in the Paths directory does not exist, the program will not be able to load any paths.

Is it obsolete now?

[Genma Saotome]

There still is no comprehensive list of acceptable values for ESD_Alternative_Texture().

[Weter]

Hello.
Nowadays, we have testing version 1.5.1
But manual still has a chapter, named "version 1.3 known issues" or so.

[Weter]

Hello.
Dispatcher window of two tabs
https://open-rails.r...html#map-window
is obsolete feature now (new map window has only one tab).

[engmod]

Hi Team,

Was trying to find above in the manual dated 16 August 2024.

Can't find it, it appears in a number of routes.

[cjakeman]

Hi Derek,

Good catch.

If you can suggest some text/images, then I can get them added to the Manual.

[engmod]

MilePostUnitsMiles or MilePostUnitsKilometers can be used in a .trk file to nominate miles or KiloMeters to be used as the measure of distance when running within a route.

[Laci1959]

engmod, on 16 August 2024 - 08:14 PM, said:

Hi Team,

Was trying to find above in the manual dated 16 August 2024.

Can't find it, it appears in a number of routes.

Hello.

I think the reason you can't find it in the manual is because it's a 20-year-old MSTS feature.
But it would be good to pick it up because all jokes are new to a newborn. Those who are just starting, or who started a few years ago, may not know what it is all about.

Sincerely, Laci1959

[cjakeman]

engmod, on 17 August 2024 - 12:48 AM, said:

MilePostUnitsMiles or MilePostUnitsKilometers can be used in a .trk file to nominate miles or KiloMeters to be used as the measure of distance when running within a route.

Please note, the Manual does not have a section just on Route Features, although there is one on OR-specific Route Features.

I'm proposing to add Mileposts to the Manual section for Open Rails Options as follows:



Is that OK?

[engmod]

Good for me Chris.