Skip to content

Commit efef86c

Browse files
committed
Merge branch 'add-menu-notifications' of https://github.com/cjakeman/openrails into add-menu-notifications
2 parents 0917bdc + ecca125 commit efef86c

10 files changed

+110
-15
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: 110 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -41,21 +41,114 @@ Click on the ``Options`` button and select the ``Content`` tab. See the
4141
Updating OR
4242
===========
4343

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

60153
Further General Buttons
61154
=======================
@@ -66,6 +159,8 @@ Tools
66159
By clicking this button you get access to the ancillary tools (see :ref:`here
67160
<intro-reality>`).
68161

162+
.. _documents:
163+
69164
Documents
70165
---------
71166

0 commit comments

Comments
 (0)