From 0373c2fb0fe9a898d90a8ebfc04090319da43bf9 Mon Sep 17 00:00:00 2001 From: Chris Jakeman Date: Tue, 11 Mar 2025 16:50:45 +0000 Subject: [PATCH 1/6] adds Learn > Documents webpage --- Gemfile.lock | 58 ++++++++++++++++++++------------------ _data/menu.yaml | 2 ++ learn/docs-list/index.html | 38 +++++++++++++++++++++++++ 3 files changed, 71 insertions(+), 27 deletions(-) create mode 100644 learn/docs-list/index.html diff --git a/Gemfile.lock b/Gemfile.lock index 2f2808b2..941111d6 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,52 +1,54 @@ GEM remote: https://rubygems.org/ specs: - addressable (2.8.5) - public_suffix (>= 2.0.2, < 6.0) + addressable (2.8.7) + public_suffix (>= 2.0.2, < 7.0) colorator (1.1.0) - concurrent-ruby (1.2.2) + concurrent-ruby (1.3.5) em-websocket (0.5.3) eventmachine (>= 0.12.9) http_parser.rb (~> 0) eventmachine (1.2.7) - ffi (1.16.2) + ffi (1.17.1) forwardable-extended (2.6.0) + google-protobuf (3.25.6) http_parser.rb (0.8.0) - i18n (1.14.1) + i18n (1.14.7) concurrent-ruby (~> 1.0) - jekyll (4.1.1) + jekyll (4.3.4) addressable (~> 2.4) colorator (~> 1.0) em-websocket (~> 0.5) i18n (~> 1.0) - jekyll-sass-converter (~> 2.0) + jekyll-sass-converter (>= 2.0, < 4.0) jekyll-watch (~> 2.0) - kramdown (~> 2.1) + kramdown (~> 2.3, >= 2.3.1) kramdown-parser-gfm (~> 1.0) liquid (~> 4.0) - mercenary (~> 0.4.0) + mercenary (>= 0.3.6, < 0.5) pathutil (~> 0.9) - rouge (~> 3.0) + rouge (>= 3.0, < 5.0) safe_yaml (~> 1.0) - terminal-table (~> 1.8) + terminal-table (>= 1.8, < 4.0) + webrick (~> 1.7) jekyll-feed (0.17.0) jekyll (>= 3.7, < 5.0) jekyll-prettier (0.0.0) jekyll (>= 3.8) jekyll-redirect-from (0.16.0) jekyll (>= 3.3, < 5.0) - jekyll-sass-converter (2.2.0) - sassc (> 2.0.1, < 3.0) + jekyll-sass-converter (3.0.0) + sass-embedded (~> 1.54) jekyll-seo-tag (2.8.0) jekyll (>= 3.8, < 5.0) jekyll-watch (2.2.1) listen (~> 3.0) - kramdown (2.4.0) - rexml + kramdown (2.5.1) + rexml (>= 3.3.9) kramdown-parser-gfm (1.1.0) kramdown (~> 2.0) liquid (4.0.4) - listen (3.8.0) + listen (3.9.0) rb-fsevent (~> 0.10, >= 0.10.3) rb-inotify (~> 0.9, >= 0.9.10) mercenary (0.4.0) @@ -56,25 +58,27 @@ GEM jekyll-seo-tag (~> 2.1) pathutil (0.16.2) forwardable-extended (~> 2.6) - public_suffix (5.0.3) + public_suffix (5.1.1) + rake (13.2.1) rb-fsevent (0.11.2) - rb-inotify (0.10.1) + rb-inotify (0.11.1) ffi (~> 1.0) - rexml (3.2.6) - rouge (3.30.0) + rexml (3.4.1) + rouge (4.5.1) safe_yaml (1.0.5) - sassc (2.4.0) - ffi (~> 1.9) - terminal-table (1.8.0) - unicode-display_width (~> 1.1, >= 1.1.1) - unicode-display_width (1.8.0) + sass-embedded (1.63.6) + google-protobuf (~> 3.23) + rake (>= 13.0.0) + terminal-table (3.0.2) + unicode-display_width (>= 1.1.1, < 3) + unicode-display_width (2.6.0) webrick (1.8.1) PLATFORMS ruby DEPENDENCIES - jekyll (~> 4.1.1) + jekyll (~> 4.3.3) jekyll-feed (~> 0.12) jekyll-prettier jekyll-redirect-from @@ -85,4 +89,4 @@ DEPENDENCIES webrick (~> 1.8) BUNDLED WITH - 2.2.32 + 2.3.11 diff --git a/_data/menu.yaml b/_data/menu.yaml index 40f49f6e..6d7da4ad 100644 --- a/_data/menu.yaml +++ b/_data/menu.yaml @@ -45,6 +45,8 @@ toc: url: /learn/physics/ - page: Activities url: /learn/activities/ + - page: Documents + url: /learn/docs-list/ - title: Share subfolderitems: - page: Community diff --git a/learn/docs-list/index.html b/learn/docs-list/index.html new file mode 100644 index 00000000..dabb9396 --- /dev/null +++ b/learn/docs-list/index.html @@ -0,0 +1,38 @@ +--- +layout: default +section: Learn +title: Documents +--- +
+
 
+
+

Administration Documents

+ +

Program Architecture Documents

+ +

Simulation Documents

+ +

Using Core Open Rails

+ +

Using Non-Core (Contributed) Open Rails Programs)

+ +
+
From c3363f438bb0e9a3e95f09630b4aedf3b8e3b8d6 Mon Sep 17 00:00:00 2001 From: Chris Jakeman Date: Mon, 17 Mar 2025 16:47:29 +0000 Subject: [PATCH 2/6] Manual links moved Also Learn menu rationalised --- _data/menu.yaml | 14 +++--- learn/docs-list/index.html | 33 ++++++------ learn/manual-and-tutorials/index.html | 72 --------------------------- learn/tutorials/index.html | 42 ++++++++++++++++ 4 files changed, 67 insertions(+), 94 deletions(-) delete mode 100644 learn/manual-and-tutorials/index.html create mode 100644 learn/tutorials/index.html diff --git a/_data/menu.yaml b/_data/menu.yaml index 6d7da4ad..4f482f78 100644 --- a/_data/menu.yaml +++ b/_data/menu.yaml @@ -35,18 +35,18 @@ toc: url: /download/explore-content/ - title: Learn subfolderitems: + - page: Manual & Documents + url: /learn/docs-list/ - page: FAQ url: /learn/faq/ - - page: Manual and Tutorials - url: /learn/manual-and-tutorials/ - - page: Build Your Own Route + - page: Tutorials + url: /learn/tutorials/ + - page: Tutorial - Build Your Own Route url: /learn/build-route/ + - page: Tutorial - Activities + url: /learn/activities/ - page: OR Physics url: /learn/physics/ - - page: Activities - url: /learn/activities/ - - page: Documents - url: /learn/docs-list/ - title: Share subfolderitems: - page: Community diff --git a/learn/docs-list/index.html b/learn/docs-list/index.html index dabb9396..a5ff14d9 100644 --- a/learn/docs-list/index.html +++ b/learn/docs-list/index.html @@ -1,19 +1,26 @@ --- layout: default section: Learn -title: Documents +title: Manual & Documents ---
 
-

Administration Documents

+

Using Core Open Rails

-

Program Architecture Documents

+

Using Non-Core (Contributed) Programs

Simulation Documents

-

Using Core Open Rails

+

Program Architecture Documents

-

Using Non-Core (Contributed) Open Rails Programs)

+

Administration Documents

diff --git a/learn/manual-and-tutorials/index.html b/learn/manual-and-tutorials/index.html deleted file mode 100644 index cafde9a9..00000000 --- a/learn/manual-and-tutorials/index.html +++ /dev/null @@ -1,72 +0,0 @@ ---- -layout: default -section: Learn -title: Manual and Tutorials ---- - -
-
 
-
-

Manual

-

- Each download includes a copy of the Operating Manual. - For convenience, you can also directly download the manual (PDF) ({% include file_meta.html file="testing_manual" %}) - or view it on-line. -

-

Test Environment for Models

-

-One of our aims for Open Rails is that train performance should be as realistic as possible. -To help achieve this, -Peter Newell has developed an environment for testing -the performance of locos and rolling stock. Do they perform as we expect? -

-It may be the model that is not configured correctly or, as Open Rails develops, it may be that the simulator is lacking -in realism. -

-In either case, a neutral, repeatable test environment helps to pin down the issue and get it fixed. -

-
-
 
-
-

Tutorials

-

- The comprehensive "Build your own route" tutorial is introduced here. -

-

- We need tutorials for all aspects of Open Rails on: -

-
    -
  • Driving Trains
    • -
  • Building Activities and Timetables
    • -
  • Creating Rolling Stock and Static Objects
    • -
-

- such as the tutorials on Eric Conrad's blog. -

- If you are interested in helping with tutorials, please contact us. -

-

Some other support materials are available:

- -
-
diff --git a/learn/tutorials/index.html b/learn/tutorials/index.html new file mode 100644 index 00000000..875451ad --- /dev/null +++ b/learn/tutorials/index.html @@ -0,0 +1,42 @@ +--- +layout: default +section: Learn +title: Tutorials +--- + +
+
 
+
+

Tutorials

+

+ The comprehensive "Build your own route" tutorial is introduced here. +

+

+ We need tutorials for all aspects of Open Rails on: +

+
    +
  • Driving Trains
    • +
  • Building Activities and Timetables
    • +
  • Creating Rolling Stock and Static Objects
    • +
+

+ such as the tutorials on Eric Conrad's blog. +

+ If you are interested in helping with tutorials, please contact us. +

+
+
+

Test Environment for Models

+

+ One of our aims for Open Rails is that train performance should be as realistic as possible. + To help achieve this, + Peter Newell has developed an environment for testing + the performance of locos and rolling stock. Do they perform as we expect? +

+ It may be the model that is not configured correctly or, as Open Rails develops, it may be that the simulator is lacking + in realism. +

+ In either case, a neutral, repeatable test environment helps to pin down the issue and get it fixed. +

+
+
From dfe564d7dcff1d31124913771139c4fe313d9f8e Mon Sep 17 00:00:00 2001 From: Chris Jakeman Date: Sun, 23 Mar 2025 13:40:20 +0000 Subject: [PATCH 3/6] adds link to Include Files --- learn/docs-list/index.html | 1 + 1 file changed, 1 insertion(+) diff --git a/learn/docs-list/index.html b/learn/docs-list/index.html index a5ff14d9..9a346360 100644 --- a/learn/docs-list/index.html +++ b/learn/docs-list/index.html @@ -27,6 +27,7 @@

Simulation Documents

  • How to Provide Track Profiles for Dynamic Track
  • Signalling
  • Steam Model
    • +
  • Include Files for Rolling Stock

    • Program Architecture Documents

      From 24c8b0aa811f7c426b58b9d5927e78ae7204cbad Mon Sep 17 00:00:00 2001 From: Chris Jakeman Date: Sun, 23 Mar 2025 13:59:47 +0000 Subject: [PATCH 4/6] rename folder to documents --- _data/menu.yaml | 2 +- learn/{docs-list => documents}/index.html | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename learn/{docs-list => documents}/index.html (100%) diff --git a/_data/menu.yaml b/_data/menu.yaml index 4f482f78..f44c0688 100644 --- a/_data/menu.yaml +++ b/_data/menu.yaml @@ -36,7 +36,7 @@ toc: - title: Learn subfolderitems: - page: Manual & Documents - url: /learn/docs-list/ + url: /learn/documents/ - page: FAQ url: /learn/faq/ - page: Tutorials diff --git a/learn/docs-list/index.html b/learn/documents/index.html similarity index 100% rename from learn/docs-list/index.html rename to learn/documents/index.html From 15a83e5e0ad49d3618675ee61423fbae60537af8 Mon Sep 17 00:00:00 2001 From: Chris Jakeman Date: Sun, 6 Apr 2025 15:48:08 +0100 Subject: [PATCH 5/6] Adds prefix for items from Documentation\Online folder --- learn/documents/index.html | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/learn/documents/index.html b/learn/documents/index.html index 9a346360..1e6d03cc 100644 --- a/learn/documents/index.html +++ b/learn/documents/index.html @@ -11,7 +11,7 @@

      Using Core Open Rails

    • User Manual (Testing Version)
      • Each stable and testing version includes a copy of the Operating Manual.
      Also you can Download a PDF edition -
    • Installation Guide
      • +
    • Installation Guide
    • Keyboard and Camera Controls v4
    • Keyboard Layout (DE) V1.3.1e
    @@ -24,19 +24,19 @@

    Using Non-Core (Contributed) Programs

    Simulation Documents

    Program Architecture Documents

    Administration Documents

    From c5953073966343eec0d8cbbaa27f0d835589c811 Mon Sep 17 00:00:00 2001 From: Chris Jakeman Date: Sat, 12 Apr 2025 10:56:47 +0100 Subject: [PATCH 6/6] Repair links to Non-Core documents --- learn/documents/index.html | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/learn/documents/index.html b/learn/documents/index.html index 1e6d03cc..0935526f 100644 --- a/learn/documents/index.html +++ b/learn/documents/index.html @@ -17,10 +17,10 @@

    Using Core Open Rails

    Using Non-Core (Contributed) Programs

    Simulation Documents