Differences

This shows you the differences between two versions of the page.

--- stepbystep-en [2020/10/31 13:49] – [1.0 Basics] smitt48
+++ stepbystep-en [2023/09/01 11:23] (current) – rjversluis
@@ Line 33: / Line 33: @@
 ===== Further Tutorials =====
   * Language Versions (click on flags to access pages):
-    * This tutorial is also available in German [[stepbystep-de|{{:icons:de.png|Deutsche Version}}]], Italian [[stepbystep-it|{{icons:it.png|Versione Italiana}}]] and French [[:stepbystep-fr|{{icons:fr.png|Version Français}}]]
+    * This tutorial is also available in German [[stepbystep-de|{{:icons:de.png|Deutsche Version}}]], Italian [[stepbystep-it|{{icons:it.png|Versione Italiana}}]], French [[:stepbystep-fr|{{icons:fr.png|Version Français}}]] Dutch [[stepbystep-nl|{{:icons:nl.png|Nederlandse Versie}}]]
-    * The Dutch tutorial [[stepbystep-nl|{{:icons:nl.png|Nederlandse Versie}}]]
-    * The Russian version of the StepByStep: [[https://launchpad.net/rocrail/sunrise/2.0/+download/Rocrail-Step-RU.pdf|{{:icons:ru.png}}]]
  \\
-| :!: Please note: This tutorial is based on an unaltered first-time installation of Rocrail. \\ If changes of settings were made prior to reading this instruction success is not guaranteed! \\ __A simple de-installation / re-installation of Rocrail will not help in this case!__ See footnote((To bring back the initial settings of Rocrail first the application has to be de-installed if offered by the operating system. Afterwards the Rocail folder (My files/Rocrail, Documents/Rocrail, home/Rocrail, depending on the operating system) has to be deleted manually. Backup your files before doing so! Afterwards Rocrail can be installed again.)) |
+| :!: Please note: This tutorial is based on an unaltered first-time installation of Rocrail. \\ If changes of settings were made prior to reading this instruction success is not guaranteed! \\ __A simple de-installation / re-installation of Rocrail will not help in this case!__ See footnote((To bring back the initial settings of Rocrail first the application has to be de-installed if offered by the operating system. Afterwards the Rocrail folder (My files/Rocrail, Documents/Rocrail, home/Rocrail, depending on the operating system) has to be deleted manually. Backup your files before doing so! Afterwards Rocrail can be installed again.)) |
  \\
@@ Line 80: / Line 78: @@
 Here is some basic information:
-- Rocrail is not "installed", but is a simple zip which is extracted to any ** arbitrary ** storage location. \\
+  - Rocrail is not "installed", but is a simple zip which is extracted to any ** arbitrary ** storage location. \\
-- The zip contains the correct shortcut for starting ROCVIEW (there is no server to start!) \\
+  - The zip contains the correct shortcut for starting ROCVIEW (there is no server to start!) \\
-- As a rule, there are no individual (plan) files in Rocrail, but WORK AREAS (called workspace) to be opened (created and saved). The main reason for this is that a Rocrail working environment not only consists of the plan, but also the rocrail.ini with the essential definitions for controllers, automatic operation, locomotive occupancy, etc.\\
+  - As a rule, there are no individual (plan) files in Rocrail, but WORK AREAS (called workspace) to be opened (created and saved). The main reason for this is that a Rocrail working environment not only consists of the plan, but also the rocrail.ini with the essential definitions for controllers, automatic operation, locomotive occupancy, etc.\\
-This concept enables the users to exchange the respective working areas with each other, to test each other's plan virtually without affecting our own installation in any way. An excellent support concept. \\
+This concept enables the users to exchange the respective workspaces with each other, to test each other's plans virtually without affecting their own installation in any way. An excellent support concept. \\
 So: \\
-- Start Rocview \\
+  - Start Rocview \\
-- Open a (new) workspace. The workspace starts the server with the correct parameters and definitions i.e. rocrail.ini \\
+  - Open a (new) workspace. The workspace starts the server with the correct parameters and definitions i.e. rocrail.ini \\
-- Create a plan (it can still be called "plan") \\
+  - Create a plan (it can still be called "plan") \\
-- Make the settings for the controllers and automatic system etc. \\
+  - Make the settings for the controllers and automatic system etc. \\
-- Save the work area [the work area may be ** anywhere ** (you should remember where) - when you open it again, Rocrail follows the (Windows) paths]. \\
+  - Save the workspace [this workspace may be ** anywhere ** (you should remember where) - when you open it again, Rocrail follows the (Windows) paths]. \\
 ==== 1.1 Download ====
 Rocrail can be downloaded from the **[[:download-int|download portal]]** (all operating systems).
@@ Line 98: / Line 96: @@
 ==== 1.2 Installation ====
-| :!:  If the installer offers the option, **Wiki plan** (__not__ Demo plan) should be selected to be installed. |
+As already mentioned above, Rocrail is not installed "classically". Instead, a ZIP file specific to the operating system is unpacked into a folder or directory previously created for this purpose.
  \\
 OS-dependent information is found here (return to this page after the software was installed and proceed with section 1.3):
@@ Line 109: / Line 109: @@
 ==== 1.3 The First Start ====
-__Rocview__ (not Rocrail!) is started from the start menu or the place where the OS holds the program links.
+Start __Rocview__. To do this, double-click on the corresponding icon on the desktop.
-If Rocrail was installed using the ZIP installer (**[[:rocrailonastick-en|Rocrail ZIP]]**), the folder where the unzipped files are located has to be opened instead. Then with double-click on the file desktoplink.cmd((depending on operating system settings, the extension .cmd may not be displayed)) a link on the desktop is created((a window that opens and closes briefly is of no importance)). The icon is called ''Rocview''. Double click on this link / icon to start Rocview.
+If no desktop link has been created yet, first open the folder in which the previously unpacked files are located. Then with double-click on the file desktoplink.cmd((depending on operating system settings, the extension .cmd may not be displayed)) a link on the desktop is created((a window that opens and closes briefly is of no importance)). The icon is called ''Rocview''. Double click on this icon to start Rocview.
-> **Note:** It is important to always start Rocview using the automatically created icon in the start menu or the desktop shortcut created according to the above procedure, otherwise dependencies will not be resolved correctly.
+> **Note:** It is important to always start Rocview using this desktop icon, otherwise dependencies may not be resolved correctly and malfunctions may occur.
-Rocview opens and two pop-up dialogues shows up:
+Rocview opens and two pop-up dialogues show up:
-| {{:sbs:sbs-copyright-en.png}} | {{:sbs:sbs-donation-en.png|Donation Dialogue}} |
+| {{:sbs:sbs-copyright-en.png}} | {{:sbs:sbs-donation-en.png|SupportKey Dialoge}} |
-| Info dialogue. Copyright and disclaimer | Donation dialogue |
+| Info dialogue. Copyright and disclaimer | SupportKey dialogue |
  \\
 The one shown on the left is the Info dialogue. It appears only at the very first start of Rocrail. The terms and conditions have to be accepted and confirmed in order to use the program.
-The dialogue on the right is the **[[rocgui-donate-en|Donation Dialogue]]**. It will appear every time Rocview is started as long as no donation key was loaded. The window is closed by pressing **OK**.
+The dialogue on the right is the **[[rocgui-supportkey-en|SupportKey Dialoge]]**. It will appear every time Rocview is started as long as no SupportKey was loaded. The window is closed by pressing **OK**.
-> **Note:** Rocrail is developed and maintained entirely on volunteer labour. However, some money is needed to run the project, e.g. for purchasing hardware for testing purposes and to cover other expenses like domain and server hosting. \\ It is thus left to the user to make a small contribution as a donation if the program should be liked and be used in the long term. \\ The pages **[[rocgui-donate-en|Donation Dialogue]]** and **[[donate-en|Donating]]** inform about how to make a donation.
+> **Note:** Money is needed to keep the Rocrail project alive.\\ It is thus left to the user to make a small contribution as a support if the program should be liked and be used in the long term. \\ The pages **[[rocgui-supportkey-en|SupportKey Dialogu]]** and **[[supportkey-en|Supporting]]** inform about how to make a financial support.
  \\
-After closing the Donation Dialogue, Rocview is displayed in the language specified by the operating system.
+After closing the SupportKey Dialogue, Rocview is displayed in the language specified by the operating system.
 <html>
@@ Line 170: / Line 170: @@
  \\
-To get an impression of what Rocview looks like with a loaded plan, one of the two demo plans can now be opened: \\
+To get an impression of what Rocview looks like with a loaded plan, the wiki demo plan is now opened:
-   * 1. From the menu // file // select the item // Demo workspace //. \\
+  * In the //File// menu, select //Open Workspace//, then open the ''wikidemo'' folder in the dialogue that opens. \\
-   * 2. From the menu // File // select // Open Workspace // and then open the folder “wikidemo” in the dialog box that opens. \\
 By opening a workspace Rocrail (the server) and Rocview (the client / graphical user interface) start with a common connection to control the model railway layout.
 |< >|
-| {{:sbs:sbs-open-demo-workspace-menu-en.png|}} | {{:sbs:sbs-open-workspace-menu-en.png|}} |
+| {{:sbs:sbs-open-workspace-menu-en.png|}} |
-| The Demo workspace is opened by \\ clicking on // Demo Workspace // or by //Select open workspace (see point 2 above)...// ||
+| The wiki demo workspace is opened by \\ selecting "Open Workspace..." |
  \\
@@ Line 262: / Line 261: @@
 The window title now reads ''Rocrail: New plan''. The title can be changed as needed using menu //File -> Plan properties...//. For instance ''My Layout'' could be used. The window title changes to the new name, e.g. ''Rocrail: My Layout''.
-> **Tip:** To facilitate the opening of the workspace in future //Roc__view__ properties...// can be selected from the //File// menu, then the default workspace is selected on tab //Path// of the dialogue. \\ It is __not__ recommended to check the //Use workspace at startup// option for the time being as the beginner may want to experiment with different plans in different workspaces.
+**Notes:**
+  * :!: A new Workspace should __not__ be created in the Rocrail installation directory tree.
+  * To facilitate the opening of the workspace in future //Roc__view__ properties...// can be selected from the //File// menu, then the default workspace is selected on tab //Path// of the dialogue.
+  * It is __not__ recommended to check the //"Use workspace at startup"// option for the time being as the beginner may want to experiment with different plans in different workspaces.
  \\
@@ Line 339: / Line 341: @@
 > **Note:** The loco ID is used as an unique identifier within Rocrail and is thus very important. Two or more locos must not share the same ID. \\ Some CS (e. g. ECoS) require exactly the same ID in both Rocrail and the CS. See the wiki page on the relevant CS, if applicable.
-> **Note:** IDs should not contain white spaces (blanks). Even though possible, blanks may interfere with Rocrail's advanced features like, e.g., XML scripting. Instead of a blank an underscore can be used: ''BR_298''.
+> **General note on IDs:** All IDs (e.g. of locomotives, wagons, switches, signals, etc.) should not contain spaces/blanks or special characters. This is possible, but can lead to problems in connection with advanced operations (e.g. in XML scripts). For example, the underscore character can be used instead of the space character: **''BR_298''**. \\ It is strongly recommended to use only combinations of the following characters with a max. length of 32:
+**''0 1 2 3 4 5 6 7 8 9'' \\ ''a b c d e f g h i j k l m n o p q r s t u v w x y z'', or Capital letters \\ ''_ . - + [ ]''**
 All other fields are optional and do not need any change for the time being. See **[[:loc-gen-en|Locomotives: General]]** for an explanation.
@@ Line 925: / Line 929: @@
 The preferred method of creating routes is very easy by using the **[[:router-en|Router]]**. It will find any possible route and create it automatically. This chapter describes how the Router is used, the next chapter will briefly describe how routes can be created by hand.
-//Router -> Routing// is selected from the //File//-menu to run the Router. In the server message window the creation of four routes will be confirmed. \\
+//Router -> Routing// is selected from the //Track plan//-menu to choose options and run the Router. In a server popup message window the creation of four routes will be confirmed. \\
-| {{:sbs:sbs-analyze-menu-en.png|}} | {{:sbs:sbs-analyzer-routes-en.png|}} |
+| {{:sbs:sbs-analyze-menu-en.png|}} | {{:sbs:sbs-analyze-menu-2-en.png?300|}} \\ \\ {{:sbs:sbs-analyzer-routes-en.png?300|}} |
-| Running the Router and Result ||
+| Running the Router and Result | |
  \\
-Rocrail has to be closed and restarted after running the Router.
 Four routes have been generated because (only) these four routes are possible if the plan is used in running direction (clockwise as indicated by the direction tracks): Block 01 (minus side) to block 03 (minus side), block 02 (-) to block 03 (-), 03 (+) to 01 (+) and 03 (+) to 02 (+). \\
@@ Line 957: / Line 960: @@
  \\
 === 7.3.2 Creating Routes Manually ===
-This section describes how routes are created by hand. In most cases the Router can be used to create routes but sometimes it is good to know how to do this manually. This section can be skipped if not of interest (continue [[#configuring_routes|7.3.3]] below).
+This section describes how routes are created manually. In most cases the Router can be used to create routes but sometimes it is good to know how to do this manually. This section can be skipped if not of interest (continue [[#configuring_routes|7.3.3]] below).
 An existing route created be the Router will be used to explain the course of action.
-First, //Tables -> Routes// is selected from the menu. The //Index// tab is shown. The first route in the list (''autogen-[01-]-[03-]'') is highlighted (instead, if a new route was to be created, the **NEW** button had to be clicked). Now tab //General// is selected.
+First, //Tables -> Routes// is selected from the menu. The //Index// tab is shown. The first route in the list (''[01-]-[03-]'') is highlighted (instead, if a new route was to be created, the **NEW** button had to be clicked). Now tab //General// is selected.
 | {{:sbs:sbs-routes-man-gen-en.png}} |
@@ Line 967: / Line 970: @@
  \\
-For a newly created route first of all the ID had to entered. Here, the ID was created by the Router which is indicated by the ''autogen-'' prefix.
+For a newly created route first of all the ID had to entered. Here, the ID was created by the Router which is indicated by the description ''*Generated by the router''.
-> **Note:** Do not use ''autogen-'' as a prefix for manually created routes.
+> **Note:** It is recommended to provide a description (e. g. "manual") for manually created routes.
 For a manually created route the ID could be simply ''[01-]-[03-]'' or ''01-_to_03-'' or something else which is found to be self explaining.
@@ Line 1057: / Line 1060: @@
 After all settings are done **Apply** is pressed and the dialogue is closed by pressing **OK**. \\
-> **Tip:** The Router in many cases can configure routes automatically. Prior to this in the dialogue available from menu //File// -> //Rocrail properties...// -> tab //Router// option **Assign feedbacks to blocks** has to be selected and Rocrail has to be closed and restarted.
+> **Tip:** The Router in many cases can configure routes automatically. Prior to this in the dialogue available from menu //Track plan// -> //Router// -> tab //Routing// option **Assign feedbacks to blocks** has to be selected.
 Rocrail is now ready to run trains in automatic mode. \\