Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 755ff2b

Browse files
committed
Automatic merge of T1.5.1-1188-gd2c2ab5d66 and 17 pull requests
- Pull request #959 at 2452cb0: Fix TrackViewer crash on big zoom value - Pull request #972 at e90a2aa: On Map window color changed switch or signal is not changed - Pull request #799 at dfc715e: Consolidated wind simulation - Pull request #839 at d00beb9: First phase of https://blueprints.launchpad.net/or/+spec/additional-cruise-control-parameters - Pull request #885 at 8f473ce: feat: Add notifications to Menu - Pull request #891 at 9a1d6b2: Auto save - Pull request #892 at 1f5ba4c: Signal Function OPP_SIG_ID_TRAINPATH - Pull request #952 at 8347095: Investigation - Pulsing graphics - Pull request #953 at a519452: Fix Lights Crash on Corrupt Shapes - Pull request #954 at 53e9cc6: Multiple Track Profiles & Superelevation Improvements - Pull request #962 at 46d0472: Fix pantographs on unpowered cars - Pull request #970 at 6fa5eed: feat: Remove unnecessary Windows.Forms usage - Pull request #973 at c35be87: fix: Using singular target framework to allow for different platforms across different projects - Pull request #974 at 5faea6f: Bug fix for https://bugs.launchpad.net/or/+bug/2076034 Doors remain open in AI trains - Pull request #978 at 91f3ee8: fix: adds MilepostUnitsMiles to Manual - Pull request #900 at c27f32d: DMI updates - Pull request #876 at f92de76: docs: add source for documents previously on website to source Documentation folder
19 parents 2673493 + d2c2ab5 + 2452cb0 + e90a2aa + dfc715e + d00beb9 + 8f473ce + 9a1d6b2 + 1f5ba4c + 8347095 + a519452 + 53e9cc6 + 46d0472 + 6fa5eed + c35be87 + 5faea6f + 91f3ee8 + c27f32d + f92de76 commit 755ff2b

30 files changed

+1611
-145
lines changed
10.6 KB
Loading
3.79 KB
Loading
3.2 KB
Loading
56.9 KB
Loading
73.2 KB
Loading
49.4 KB
Loading
54.3 KB
Loading
62.3 KB
Loading
45.5 KB
Loading

Source/Documentation/Manual/start.rst

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,115 @@ Click on the ``Options`` button and select the ``Content`` tab. See the
5757
Updating OR
5858
===========
5959

60+
Four update modes are provided and you can update Open Rails with a single click of a button.
61+
62+
"Stable" is the default and recommended mode.
63+
64+
"Testing" is updated more frequently than the "Stable" mode.
65+
66+
If you follow the Open Rails project on the forums, then you will hear about bug-fixes and new features.
67+
These are included in the "Unstable" version for developers and testers to try out.
68+
Once they have been checked and approved, they are published (on Fridays) as the latest "Testing" version.
69+
Any user can easily update to the current weekly "Testing" version and benefit from these improvements.
70+
71+
New versions are advertised and installed using the :ref:`Notifications <notifications>` feature.
72+
73+
You can change your current mode using Options > System > Update mode.
74+
The fourth mode is "none", which does not search for a new version.
75+
76+
77+
.. _notifications:
78+
79+
Notifications
80+
=============
81+
82+
Notifications are brief messages sent to Open Rails when you launch Open Rails.
83+
You can view these by clicking on the notifications icon and stop viewing by toggling the icon again.
84+
85+
.. image:: images/notification-icon.png
86+
87+
Old notifications persist, but when new ones are available, the icon is overlaid with a red indicator showing the number of new notifications.
88+
The icons are presented in date order with the latest one first. Step through them by clicking on the arrows:
89+
90+
.. image:: images/notification-red-indicator.png
91+
92+
Static Notifications
93+
--------------------
94+
95+
A simple notification may be shown in the same way to all users, such as:
96+
97+
.. image:: images/notification-static.png
98+
99+
Pressing the “Archive” button will launch your default browser to provide extra detail.
100+
101+
Responsive Notifications
102+
------------------------
103+
104+
Many notifications show differently depending on the user’s installation.
105+
106+
Responsive notifications are used to advise that a new version is available.
107+
If a new version is available, then the notification might be shown as:
108+
109+
.. image:: images/notification-update-available.png
110+
111+
As before, the button “What’s new” will launch your default browser to provide extra detail.
112+
The “Install” button is special and launches a seamless process to download the latest version available and use it to replace the active version.
113+
114+
Once the user has upgraded, the previous message is no longer appropriate and the notification responds to the changes by showing as:
115+
116+
.. image:: images/notification-update-installed.png
117+
118+
Privacy Note
119+
------------
120+
121+
No information is returned to the Open Rails web server.
122+
123+
Update Mode
124+
-----------
125+
126+
There are 4 update modes – Stable, Testing, Unstable and None. More details are available :ref:`here <updating-or>`.
127+
Note, however, that previously saved games may not be compatible with newer versions, as described :ref:`here <driving-saveresume>`.
128+
129+
Checking Compatibility
130+
----------------------
131+
132+
Responsive notifications are also used to check that an update is compatible with your system. For example, you might see useful warnings such as:
133+
134+
.. image:: images/notification-update-incompatible.png
135+
136+
Responding to Routes
137+
--------------------
138+
139+
These notifications can respond to the routes you have installed, so you can be advised of updates to routes you have already installed. For example, you might see:
140+
141+
.. image:: images/notification-routes.png
142+
143+
But this notification would be missing if you don’t already have the route installed.
144+
145+
Responding to Settings
146+
----------------------
147+
148+
The notifications can also respond to the settings you are using - see :ref:`Open Rails Options<options>`.
149+
150+
In this fictional example, you might see a message encouraging you to try an improved feature:
151+
152+
.. image:: images/notification-settings.png
153+
154+
However, if you have the option turned on already, then the notification is not shown.
155+
156+
Communication Error
157+
-------------------
158+
159+
If there is a problem with the Internet then the Notifications are replaced by a single prepared notification which gives a reason for the error and a chance to re-try:
160+
161+
.. image:: images/notification-error.png
162+
163+
Publishing Notifications
164+
------------------------
165+
166+
The Notifications document explains how to publish notifications and is included in the :ref:`Documents drop-down<documents>`.
167+
168+
=======
60169
When a new release of OR is available and your computer is online, a link
61170
``Update to xnnnn`` appears in the upper right corner. The string ``xnnnn`` is
62171
the release number of the newest release that matches your selected level
@@ -82,6 +191,8 @@ Tools
82191
By clicking this button you get access to the ancillary tools (see :ref:`here
83192
<intro-reality>`).
84193

194+
.. _documents:
195+
85196
Documents
86197
---------
87198

0 commit comments

Comments
 (0)