Merge remote-tracking branch 'upstream/master' into webserver-time

Author: Chris Jakeman

.gitignore

@@ -16,6 +16,20 @@
 /Source/Help
 /Source/Locales/**/*.bak
 
+## Ignore Visual Studio Code configuration files.
+##
+## Get latest from https://github.com/github/gitignore/blob/master/Global/VisualStudioCode.gitignore
+
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+*.code-workspace
+
+# Local History for Visual Studio Code
+.history/
+
 ## Ignore Visual Studio temporary files, build results, and
 ## files generated by popular Visual Studio add-ons.
 ##

Source/Documentation/Manual/cabs.rst

@@ -266,15 +266,18 @@ Further OR cab controls
 -----------------------
 
 OR supports the cabview control to open/close the left doors, the right doors 
-and the mirrors.
+and the mirrors. Moreover it supports the controls for the battery state and for 
+the key state; these two controls have no effect on the state of the locomotive.
 
 .. index::
    single: ORTS_LEFTDOOR
    single: ORTS_RIGHTDOOR
    single: ORTS_MIRRORS
+   single: ORTS_BATTERY
+   single: ORTS_POWERKEY
 
 The control blocks are like the one shown for the cab light. The Type strings 
-are ORTS_LEFTDOOR, ORTS_RIGHTDOOR and ORTS_MIRRORS.
+are ORTS_LEFTDOOR, ORTS_RIGHTDOOR, ORTS_MIRRORS, ORTS_BATTERY and ORTS_POWERKEY.
 
 
 High-resolution Cab Backgrounds and Controls
@@ -411,28 +414,38 @@ Note that you cannot use the MS Cabview editor on the .cvf file after having
 inserted these optional lines, because the editor will delete these added 
 lines when the file is saved.
 
-Rotation of Digital controls
-----------------------------
+Rotation of Gauges and Digital controls
+---------------------------------------
 
 .. index::
    single: ORTSAngle
 
 One of the drawbacks of rendering a cabview in 2D is that some parts of it 
-are not shown with a frontal, horizontal, view. Displaying a horizontal digital 
-control on it generates an unrealistc effect. This is the rationale of following 
-entry, to be added within a Digital cabview control block in the .cvf file::
+are not shown with a frontal, precisely vertical or horizontal, view. 
+Displaying a vertical gauge or a horizontal digital control on it generates an
+unrealistic effect. This is the rationale of following entry, to be added
+within a Gauge or Digital cabview control block in the .cvf file::
 
   ORTSAngle ( 5 )
 
 The number in parenthesis is the angle in degrees with respect to the horizontal 
-(positive for counterclockwise rotation).
+(or to the vertical for vertical gauges). Positive values produce
+counterclockwise rotation.
+
+At the left of the picture an example of a white vertical gauge that has been rotated 
+by 12 degrees
+
+.. image:: images/cabs-gauges-rotation.png
 
 Here an example of a red max speed indication that has been rotated by 5 degrees
 
 .. image:: images/cabs-digitals-rotation.png
 
+Gauges may have Style POINTER or SOLID.
+
 Rotation may be applied, with the same syntax, also to DigitalClock cab controls.
 
+
 3D cabs
 =======
 

Source/Documentation/Manual/features-rollingstock.rst

@@ -265,8 +265,6 @@ the trainset is at the pickup/unloader location.
 Static OR Freightanims
 ''''''''''''''''''''''
 
-Only the two general parameters shown below are used for static OR freightanims::
-
 .. index::
    single: MSTSFreightAnimEnabled
    single: WagonEmptyWeight
@@ -278,6 +276,8 @@ Only the two general parameters shown below are used for static OR freightanims:
    single: Flip
    single: Visibility
 
+Only the two general parameters shown below are used for static OR freightanims::
+
     MSTSFreightAnimEnabled (0)
     WagonEmptyWeight(22t)
 

Source/Documentation/Manual/images/cabs-gauges-rotation.png

@@ -59,10 +59,10 @@ others. The software is published so that the user community can
 understand how the software functions to facilitate feedback and to 
 improve the capabilities of Open Rails software.
 
-Open Rails is published under the GPL license which is "copyleft"[1]  to ensure 
+Open Rails is published under the GPL license which is "copyleft"[1]_ to ensure 
 that the source code always remains publicly available.
 
-.. [1] http://www.gnu.org/copyleft//
+.. [1] https://gnu.org/copyleft
 
 .. _intro-MSTSneeded:
 

Source/Documentation/Manual/images/web-page-both.png

@@ -1015,7 +1015,7 @@ how to modify these two files is contained in the Word document
 edited with a Unicode text editor.
 
 Additionally, a C# scripting interface is available to complement
-the ``sigscr.dat```file for more complex systems.
+the ``sigscr.dat``` file for more complex systems.
 
 SignalNumClearAhead
 -------------------

Source/Documentation/Manual/images/web-page-hud.png

@@ -172,42 +172,27 @@ Enable web server
 -----------------
 
 This option enables an internal web server that can be used to display game and
-train status information in a browser, intended for use on secondary screens.
-When activated, the server can be accessed (on the local machine only) at
+train status information in a web browser, intended for use on secondary screens.
+
+When activated, the server can be accessed from a browser on the local machine at
 ``http://localhost:<port>``, where ``<port>`` is the specified port number.
 
-.. admonition:: For core developers
-
-    The web server serves content out of the ``Content\Web`` subfolder of the OR
-    program folder; it features a simple API to obtain data from the simulator.
-    Responses are OR data structures
-    `serialized <https://www.newtonsoft.com/json/help/html/T_Newtonsoft_Json_JsonConvert.htm>`_
-    in JSON format. API call paths are case-sensitive.
-
-    .. list-table::
-       :widths: 15 15 35 35
-       :header-rows: 1
-
-       * - Method
-         - API call
-         - Description
-         - Response type
-       * - GET
-         - ``/API/HUD/<n>``
-         - | Retrieves the information rendered on the ``<F5>`` HUD, row by row,
-           | page by page, where ``<n>`` is the desired HUD page number.
-         - Orts.Viewer3D.WebServices.WebServer.ORTSApiController.HudApiArray
-       * - GET
-         - | ``/API/TRAINMONITOR``
-           | or ``/API/TRAININFO``
-         - | Retrieves information rendered on the Track Monitor, such as speed,
-           | acceleration, grade, and upcoming hazards.
-         - Orts.Simulation.Physics.Train.TrainInfo
-       * - GET
-         - ``/API/APISAMPLE``
-         - | A test object that demonstrates the JSON serialization of various
-           | data types.
-         - Orts.Viewer3D.WebServices.WebServer.ORTSApiController.ApiSampleData
+If you `open
+<https://www.howtogeek.com/394735/how-do-i-open-a-port-on-windows-firewall/>`_
+the web server port (just granting RunActivity.exe an exemption is not
+sufficient) in Windows Firewall, the server can also be accessed from a device
+on the local network, such as a smartphone, tablet or another PC, using your
+system's `IP address
+<https://support.microsoft.com/en-us/windows/find-your-ip-address-f21a9bbc-c582-55cd-35e0-73431160a1b9>`_.
+E.g.: If your Open Rails PC is at IP address 192.168.0.99, browse to
+``http://192.168.0.99:<port>``, where ``<port>`` is the specified port number.
+
+:ref:`Sample web pages <sample-web-pages>` are included in the Open Rails
+installation and the browser will show a menu of sample pages.
+
+As well as a web browser, data from the web server can also be fetched by any
+program which can make a web request, such as C# or Python, using the
+:ref:`Application Programming Interface <web-server-api>` (API).
 
 Overspeed Monitor
 -----------------
@@ -382,6 +367,17 @@ Ambient daylight brightness
 
 With this slider you can set the daylight brightness.
 
+Anti-aliasing
+-------------
+
+Controls the anti-aliasing method used by Open Rails. Anti-aliasing is a
+computer graphics technique that smooths any harsh edges, otherwise known as
+"jaggies," present in the video image. Currently, Open Rails only supports the
+multisample anti-aliasing (MSAA) method. Higher applications of anti-aliasing
+will require exponentially more graphics computing power.
+
+The default setting is MSAA with 2x sampling.
+
 .. _options-simulation:
 
 Simulation Options