odds and ends

mstevetodd · Jan 21, 2025 · ba0a4c3 · ba0a4c3
1 parent 5cff7d9
commit ba0a4c3
Show file tree

Hide file tree

Showing 8 changed files with 72 additions and 31 deletions.
diff --git a/docs/_static/css/engine_driver_home_theme.css b/docs/_static/css/engine_driver_home_theme.css
@@ -434,7 +434,7 @@ html[data-theme='dark'] .rst-content .guilabel{
 /* *************************************** */
 
 .wy-nav-side {
-  background: #aa6d18 !important;
+  background: #724911 !important;
   /* background: #031214 !important; */
 }
 
@@ -515,7 +515,7 @@ html[data-theme='dark'] .wy-menu-vertical li.toctree-l3.current li.toctree-l4>a.
 
 .gsib_a input {
   padding: 5px !important;
-  background-color: #141414 !important;
+  background-color: #3d260c !important;
   color:white !important;
 }
 

diff --git a/docs/configuration/configuration_withrottle.rst b/docs/configuration/configuration_withrottle.rst
@@ -1,5 +1,5 @@
 *******************************************
-Configuring the WiThrottle server
+Configuring Your Server
 *******************************************
 
 .. meta::
@@ -13,6 +13,22 @@ Configuring the WiThrottle server
    .. contents:: On This Page
      :local:
 
+|ED| can connect to a number of supported |WIT| and |NATIVE| servers including:
+
+* |JMRI| 
+
+   * Using |WIT|, or
+   * Using |NATIVE|
+
+* |EX-CS|
+
+   * Using |WIT|, or
+   * Using |NATIVE|
+
+* MRC Prodigy WiFi
+* Digitrax LnWi
+* WifiTrax (for NCE)
+
 
 JMRI
 ^^^^
@@ -22,6 +38,8 @@ JMRI
 * You can also 'filter' the turnouts shown using the WiThrottle->Filter Controls option in the WiThrottle window.
 * Entering roster entries, and defining routes and turnouts on the server will all make your |ed| throttle more powerful and easier to use (though not required). 
 * |ed| will show additional info if the JMRI Web Server is started (such as roster details and icon images).
+* To use the |NATIVE| with |JMRI| you must ``Load DCC== over TCP Server`` in the 'DCC-EX' menu in |JMRI|, then connect |ED| to the additional server that is presented.
+
 
 DCC-EX WiFi
 ^^^^^^^^^^^

diff --git a/docs/configuration/index.rst b/docs/configuration/index.rst
@@ -7,15 +7,12 @@ Configuration
 
 .. include:: ../include.rst
 
-.. sidebar:: On This Page
-   :class: sidebar-on-this-page
+.. toctree::
+   :hidden:
 
-   .. toctree::
-    :includehidden:
-
-    configuration
-    configuration_withrottle
-    preferences_index
+   configuration
+   configuration_withrottle
+   preferences_index
 
 
 See:

diff --git a/docs/configuration/preferences.rst b/docs/configuration/preferences.rst
@@ -166,6 +166,16 @@ Swipe through Routes?
 
 If this preference is enabled, the |R-S| is included in the list of screens when swiping left/right between screens.
 
+Double Back Buton to Exit?
+""""""""""""""""""""""""""
+
+When this preference is enabled, pressing the Andoroid System ``Back`` button twice quickly from the |T-S| will exit the app.
+
+Hide Instructional Hints 
+""""""""""""""""""""""""
+
+When this preference is enabled, most of the less important 'Toast' message will not be shown.
+
 Throttle Screen Appearance Preferences
 --------------------------------------
 

diff --git a/docs/contributing/index.rst b/docs/contributing/index.rst
@@ -16,13 +16,13 @@ Contributing
 Contributing to the Code
 ========================
 
-|ed| is open source software written in Java. The source code is available on `github.com/JMRI/EngineDriver <https://github.com/JMRI/EngineDriver>`_.
+|ed| is open source software written in Java for Android. The source code is available on `github.com/JMRI/EngineDriver <https://github.com/JMRI/EngineDriver>`_.
 
 It is recommended that you contact M Steve Todd if you intend to contribute to the code base, before you start working.
 
 On the Android device you intend to test on
 
-* Make sure that the developer options are enabled and ``Android debugging`` is on, and ``unknown sources`` is on.  You can also use the Virtual Devices in Android Studio to test you cade.
+* Make sure that the developer options are enabled and ``Android debugging`` is on, and ``unknown sources`` is on.  You can also use the Virtual Devices in Android Studio to test you code.
 
 Here are all the steps needed for Microsoft Windows:
 
@@ -38,17 +38,17 @@ Here are all the steps needed for Microsoft Windows:
 * Open the project. 
 * Only if needed...
 
-  * Take the Run -> Run... -> Edit Configurations option
-  * In the Run/Debug Configurations window, press the "+", then Android App
+  * Take the :menuselection:`Run --> Run... --> Edit Configurations` option
+  * In the Run/Debug Configurations window, press the :guilabel:`+`, then Android App
   * Enter Name "EngineDriver", and select Module: EngineDriver
-  * Click ``Run``.
+  * Click :guilabel:`Run`.
   * You will likely get one or more error messages about missing components. Click on the link in each message and Android Studio will automatically download the missing components.
 
 To test your changes:
 
 * Connect your phone via USB
 * In the Select Deployment Target window, your attached phone should show under Connected Devices.
-* Select your device and press ``run`` or ``debug``.
+* Select your device and press :guilabel:`run` or :guilabel:`debug`.
 * EngineDriver should compile and be installed on your device.
 
 To publish your changes:
@@ -71,8 +71,8 @@ Contributing to the Documentation
 
 This documentation is open source and can be accessed on `github.com/mstevetodd/EngineDriver_Home <https://github.com/mstevetodd/EngineDriver_Home>`_
 
-All this documentation is done using **reStructuredText**, for which you can find information on the official website: `reStructuredText <https://docutils.sourceforge.io/rst.html>`_
-or the `Sphinx <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>`_ document builder tool website.
+All this documentation is done using **reStructuredText** and with Sphinx, for which you can find information on the official website: `reStructuredText <https://docutils.sourceforge.io/rst.html>`_
+and the `Sphinx <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>`_ document builder tool website.
 **reStructuredText** is a markdown type language, for typesetting documents from websites to PDF or LaTeX documents. 
 This Website is built upon this technology, so you should make yourself familiar with this by looking through the links provided.
 
@@ -91,8 +91,7 @@ The steps listed here provide guidance on how to edit and preview changes to the
 
 * Then use 'pip' to install the required packages; 'sphinx' and the theme 'sphinx_rtd_theme'.  |br|\ Open and command prompt and enter: 
 
-  * ``pip install -U sphinx``
-  * ``pip install sphinx-rtd-theme``
+  * ``pip install -r requirements.txt``
 
 * On GitHub
 
@@ -120,14 +119,14 @@ Style Guidelines
 ----------------
 
 * Use British/Australian/Canadian spelling e.g. 'colour' not 'color'.  |br|\ (Primarily because it is used in more English speaking countries)
-*	Use railroad/railway terminology that is understandable by all English-speaking people. |br|\ Where there are clear differences from US to non-US terminology use both with a slash between and use the US version first. e.g. turnouts/points, consists/multiple units, switching/shunting.  (Primarily because JMRI uses the US terminology)
+*	Use railroad/railway terminology that is understandable by all English-speaking people. |br|\ Where there are clear differences from US to non-US terminology use both with a slash between and use the US version first. e.g. turnouts/points, consists/multiple units, switching/shunting.  (Primarily because DCC and JMRI uses the US terminology)
 * In general use 'loco' instead of 'locomotive' or 'engine'
 * Avoid the term 'Checked'. Use 'Enabled' instead.  ("Checked' is more a US term.)
 * Use bolded \*\*Engine Driver\*\* or \|ed\| not 'Engine Driver app', 'EngineDriver' or 'Engine Driver Throttle' (except on the first page) - |ed|
 *	No full stop at the end of a numbered or unnumbered list
 *	Numbered lists should be avoided, unless there is a specific need
-* Use first person (you and your; not I, me, my or am) language
-*	A string of nouns should be sequenced in alphabetic order, unless it makes more sense within the context to display them in some other sequence
+* Use second person (you and your; not I, me, or my) language
+*	A string or list of nouns should be sequenced in alphabetic order, unless it makes more sense within the context to display them in some other sequence
 * Double quotes (") should only be used for quoting text from people, documents or web sites
 *	No quotes around 'Also See' type references
 *	Avoid '(above)' or '(below)' in text.  Use hypertext links instead

diff --git a/docs/downloads/index.rst b/docs/downloads/index.rst
@@ -7,21 +7,34 @@ Downloads
 
 .. include:: ../include.rst
 
+
+.. sidebar::
+   :class: sidebar-on-this-page
+
+   .. contents:: On This Page
+     :local:
+
+Production Verion
+-----------------
+
 The Published version (v2.37.187) is available in the `Google Play Store <https://play.google.com/store/apps/details?id=jmri.enginedriver>`_ or by `direct download <../_static/apk/EngineDriver.apk>`_.
 
 Installing from the Play Store is preferred as you will automatically receive updates to the app, as long as your device/phone periodically connects to the internet.
 
+Beta Versions
+-------------
+
 If you'd like to help test early versions, please join the `Beta program <https://play.google.com/apps/testing/jmri.enginedriver>`_.
 
+Older or Other Versions - Manual Install
+----------------------------------------
+
 *Notes for Manual Installs*
 
 * For manual installs of the .apk files below, turn on "Allow unknown sources" in the Android System Settings, then download desired version to your device and follow the prompts to install.
 
 * Sometimes you may need to uninstall previous versions before you can install the new version this way.
 
-Older or Other Versions
------------------------
-
 * `EngineDriver-2.38.189.apk (Beta) <../_static/apk/EngineDriver-2.38.189.apk>`_
 * `EngineDriver-2.37.187.apk <../_static/apk/EngineDriver-2.37.187.apk>`_
 * `EngineDriver-2.36.177.apk <../_static/apk/EngineDriver-2.36.177.apk>`_

diff --git a/docs/operation/interface.rst b/docs/operation/interface.rst
@@ -95,7 +95,7 @@ The Action Bar appears at the top of all screens. It will show different informa
 In the |C-S| the Action Bar only displays:
 
 * The app name (|ed|)
-
+ 
 See the `Action Bar`_ section of this page for more information.
 
 |HR-DASHED|

diff --git a/docs/videos/index.rst b/docs/videos/index.rst
@@ -4,12 +4,16 @@ Videos
 
 .. include:: ../include.rst
 
-----
+.. sidebar::
+   :class: sidebar-on-this-page
+
+   .. contents:: On This Page
+     :local:
 
 .. note:: 
-  :class: note-ed
+   :class: note-ed
 
-  Note: Many of the videos below were done on older versions of |ed|. Some of the functions, screen layouts or the names of the preferences may have changed slightly.
+  Many of the videos below were done on older versions of |ed|. Some of the functions, screen layouts or the names of the preferences may have changed slightly.
 
 Connecting
 ==============================