Skip to content

adds Learn > Documents webpage #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Apr 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 15 additions & 19 deletions Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,19 @@ GEM
specs:
addressable (2.8.7)
public_suffix (>= 2.0.2, < 7.0)
bigdecimal (3.1.8)
colorator (1.1.0)
concurrent-ruby (1.3.3)
concurrent-ruby (1.3.5)
em-websocket (0.5.3)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0)
eventmachine (1.2.7)
ffi (1.17.0-x86_64-linux-gnu)
ffi (1.17.1)
forwardable-extended (2.6.0)
google-protobuf (4.27.1-x86_64-linux)
bigdecimal
rake (>= 13)
google-protobuf (3.25.6)
http_parser.rb (0.8.0)
i18n (1.14.5)
i18n (1.14.7)
concurrent-ruby (~> 1.0)
jekyll (4.3.3)
jekyll (4.3.4)
addressable (~> 2.4)
colorator (~> 1.0)
em-websocket (~> 0.5)
Expand Down Expand Up @@ -46,8 +43,8 @@ GEM
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)
Expand All @@ -61,21 +58,20 @@ GEM
jekyll-seo-tag (~> 2.1)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (6.0.1)
public_suffix (5.1.1)
rake (13.2.1)
rb-fsevent (0.11.2)
rb-inotify (0.11.1)
ffi (~> 1.0)
rexml (3.3.2)
strscan
rouge (4.2.1)
rexml (3.4.1)
rouge (4.5.1)
safe_yaml (1.0.5)
sass-embedded (1.77.4-x86_64-linux-gnu)
google-protobuf (>= 3.25, < 5.0)
strscan (3.1.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.5.0)
unicode-display_width (2.6.0)
webrick (1.8.1)

PLATFORMS
Expand All @@ -93,4 +89,4 @@ DEPENDENCIES
webrick (~> 1.8)

BUNDLED WITH
2.2.32
2.3.11
12 changes: 7 additions & 5 deletions _data/menu.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -35,16 +35,18 @@ toc:
url: /download/explore-content/
- title: Learn
subfolderitems:
- page: Manual & Documents
url: /learn/documents/
- 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/
- title: Share
subfolderitems:
- page: Community
Expand Down
42 changes: 42 additions & 0 deletions learn/documents/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
layout: default
section: Learn
title: Manual & Documents
---
<div class="row">
<div class="col-md-2">&nbsp;</div>
<div class="col-md-8">
<h2>Using Core Open Rails</h2>
<ul>
<li><a href="https://open-rails.readthedocs.io/en/latest/" target="_blank">User Manual (Testing Version)</a></li>
Each stable and testing version includes a copy of the Operating Manual.<br />
Also you can <a href='{% include file_url.html file="testing_manual" %}'>Download a PDF edition</a>
<li><a href="https://static.openrails.org/files/OpenRails-Testing-Installation%20Guide%20En.pdf" target="_blank">Installation Guide</a></li>
<li><a href="https://coalstonewcastle.com.au/physics/open-rails-support/" target="_blank">Keyboard and Camera Controls v4</a></li>
<li><a href="https://static.openrails.org/files/Keyboard_Layout_DE_V1.3.1e.pdf" target="_blank">Keyboard Layout (DE) V1.3.1e</a></li>
</ul>
<h2>Using Non-Core (Contributed) Programs</h2>
<ul>
<li><a href="https://static.openrails.org/files/OpenRails-Testing-Content%20checker.pdf" target="_blank">Content Checker Manual</a></li>
<li><a href="https://static.openrails.org/files/OpenRails-Testing-timetable-editor_de.pdf" target="_blank">Timetable Editor (DE)</a></li>
<li><a href="https://static.openrails.org/files/OpenRails-Testing-timetable-editor_en.pdf" target="_blank">Timetable Editor (EN)</a></li>
<li><a href="https://static.openrails.org/files/OpenRails-Testing-ORTS%20Trackviewer%20manual.pdf" target="_blank">Trackviewer Manual</a></li>
</ul>
<h2>Simulation Documents</h2>
<ul>
<li><a href="https://static.openrails.org/files/OpenRails-Testing-How%20to%20Provide%20Track%20Profiles%20for%20Open%20Rails%20Dynamic%20Track.pdf" target="_blank">How to Provide Track Profiles for Dynamic Track</a></li>
<li><a href="https://static.openrails.org/files/OpenRails-Testing-Signalling.pdf" target="_blank">Signalling</a></li>
<li><a href="https://coalstonewcastle.com.au/physics/or-steam-model/" target="_blank">Steam Model</a></li>
<li><a href="https://coalstonewcastle.com.au/physics/inc-files/" target="_blank">Include Files for Rolling Stock</a></li>
</ul>
<h2>Program Architecture Documents</h2>
<ul>
<li><a href="https://static.openrails.org/files/OpenRails-Testing-Architecture%20Diagram%20V1.pdf" target="_blank">Architecture Diagram</a></li>
<li><a href="https://static.openrails.org/files/OpenRails-Testing-Processor%20Flow%20Chart.pdf" target="_blank">Processor Flow Chart</a></li>
</ul>
<h2>Administration Documents</h2>
<ul>
<li><a href="https://static.openrails.org/files/OpenRails-Testing-Notifications.pdf" target="_blank">Notifications</a></li>
</ul>
</div>
</div>
72 changes: 0 additions & 72 deletions learn/manual-and-tutorials/index.html

This file was deleted.

42 changes: 42 additions & 0 deletions learn/tutorials/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
layout: default
section: Learn
title: Tutorials
---

<div class="row">
<div class="col-md-1">&nbsp;</div>
<div class="col-md-5">
<h2>Tutorials</h2>
<p>
The comprehensive "Build your own route" tutorial <a href="/learn/build-route">is introduced here</a>.
</p>
<p>
We need tutorials for all aspects of Open Rails on:
</p>
<ul>
<li>Driving Trains</li>
<li>Building Activities and Timetables</li>
<li>Creating Rolling Stock and Static Objects</li>
</ul>
<p>
such as the tutorials on <a href="http://msts-roundhouse.vnxglobal.com/" target="_blank">Eric Conrad's blog</a>.
</p><p>
If you are interested in helping with tutorials, please <a href='../../contact/'>contact us</a>.
</p>
</div>
<div class="col-md-5">
<h2>Test Environment for Models</h2>
<p>
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 <a href="http://www.coalstonewcastle.com.au/physics/">an environment for testing</a>
the performance of locos and rolling stock. Do they perform as we expect?
</p><p>
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.
</p><p>
In either case, a neutral, repeatable test environment helps to pin down the issue and get it fixed.
</p>
</div>
</div>