User Tools

Site Tools


rocgui-menu-en

Differences

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

Link to this comparison view

Next revision
Previous revision
rocgui-menu-en [2018/11/12 08:56] – external edit 127.0.0.1rocgui-menu-en [2024/04/22 16:38] (current) – [Track plan color] rjversluis
Line 8: Line 8:
  
  \\  \\
-**Menus of Rocview:** ((Click menu name to follow link))\\ +**Menus of Rocview:** ((Click menu name to follow link)) 
-| [[#file|File]] - [[#edit|Edit]] - [[#automatic|Automatic]] - [[#track_plan|Track Plan]] - [[#tables|Tables]] - [[#control|Control]] - [[#programming|Programming]] - [[#bookmarks|Bookmarks]] - [[#view|View]] - [[#help|Help]] |+**[[#file|File]] - [[#edit|Edit]] - [[#track_plan|Track plan]] - [[#tables|Tables]] - [[#automatic|Automatic]] - [[#control|Control]] - [[#programming|Programming]] - [[#bookmarks|Bookmarks]] - [[#view|View]] - [[#help|Help]]** |
  
- \\+* **Note:** The menus in Rocview have been supplemented with a "Show menu help" link to this wiki page.
  
 + \\
 +<html><a name="file"/></html>
 ===== File ===== ===== File =====
 {{:rocview:rocview-file-menu-en.png}}\\ {{:rocview:rocview-file-menu-en.png}}\\
Line 19: Line 21:
 If the Rocview is not connected to a server or it should be connected to a different one it can be setup with **[[gui-connectto-en|this dialog]]**.\\ If the Rocview is not connected to a server or it should be connected to a different one it can be setup with **[[gui-connectto-en|this dialog]]**.\\
  
 +<html><a name="go_offline"/></html>
 ==== Go offline ==== ==== Go offline ====
 Disconnect from the Rocrail server to be able to edit locally offline.\\ Disconnect from the Rocrail server to be able to edit locally offline.\\
Line 28: Line 31:
 ==== Rocrail properties... ==== ==== Rocrail properties... ====
 Most settings are explained in chapter **[[:english#rocrail|Rocrail configuration]]**.\\ Most settings are explained in chapter **[[:english#rocrail|Rocrail configuration]]**.\\
-> **Note:** This option is only available if Rocview is currently connected to a Rocrail server.+> **Note:** This option is only available if Rocview is currently connected to a Rocrail server and the [[#auto_mode|Auto mode]] mode is off.
  
 ==== Rocrail Trace ==== ==== Rocrail Trace ====
 Opens a Sub menu to chose the __**[[rocrailini-trace-en#user_trace_level|User Trace level]]**__ of the Rocrail server.\\ Opens a Sub menu to chose the __**[[rocrailini-trace-en#user_trace_level|User Trace level]]**__ of the Rocrail server.\\
  
-==== Track plan title... ==== +==== Plan properties... ==== 
-Changes the track plan title for the current layout.\\+ 
 +  * Definition of scale (default 87 for H0) 
 +  * Definition of length units (default mm, optional cm) 
 +  * Changes the track __**[[:planprops-en|Plan title and notes]]**__ for the current layout.\\
  
 ==== Demo Workspace ==== ==== Demo Workspace ====
Line 50: Line 56:
 Export the current active Workspace with all its sub-directories.\\ Export the current active Workspace with all its sub-directories.\\
 The backup directory is excluded.\\ The backup directory is excluded.\\
 +A file selection dialog opens in which the target directory must be selected and, if necessary, newly created.
 +> **Note:** The directory of the new workspace has to exist.
  
 ===Import...=== ===Import...===
 Import a Workspace and open it.\\ Import a Workspace and open it.\\
 +A file selection dialog opens in which the directory of the to be imported workspace can be selected.
  
  \\  \\
Line 73: Line 82:
  
 ==== Save level as... ==== ==== Save level as... ====
 +  * **Attention:** Saving of a plan level works only in the __**[[:rocgui-gen-en#plan_view|"notebook" view]]**__ of Rocview!
 The level active / visible in the track plan can be saved as an XML file (level name.xml). The level active / visible in the track plan can be saved as an XML file (level name.xml).
 A file dialog opens in which the suggested name and the location can be changed. A file dialog opens in which the suggested name and the location can be changed.
Line 78: Line 88:
  
 ==== Import level... ==== ==== Import level... ====
 +  * **Attention:** Import of a plan level works only in the __**[[:rocgui-gen-en#plan_view|"notebook" view]]**__ of Rocview!
 A file dialog opens for selecting an XML Plan file to import a level.\\ A file dialog opens for selecting an XML Plan file to import a level.\\
  
-> **Note:** In order to prevent multiple layers from being mixed in the target plan, import files must not contain a complete track plan, but only __one level__. \\ For the import of multiple layers, they must be stored individually in separate files. \\ ** Steps: ** \\ 1. Open the track plan containing the desired level(s) in Rocrail. \\ 2. Select the required level by clicking the corresponding tab. \\ 3. Save level as XML with __ ** [[# save_level_as | save level as ...]] ** __. (E.g., level name.xml)+> **Note:** In order to prevent multiple layers from being mixed in the target plan, import files must not contain a complete track plan, but only __one level__. \\ For the import of multiple layers, they must be stored individually in separate files. \\ ** Steps: ** \\ 1. Open the track plan containing the desired level(s) in Rocrail. \\ 2. Select the required level by clicking the corresponding tab. \\ 3. Save level as XML with __**[[#save_level_as| Save level as ...]] ** __. (E.g., level name.xml) \\ 4. Create a new level for each level to be imported in the target plan. See: __ ** [[rocgui-menu-en #add_track_panel|Add track panel]]**__ \\ 5. Select a (still free) destination level and then insert the desired level file with __**[[#import_level|Import level...]]**__ in it. 
  
  
Line 86: Line 97:
 | //Please consider the environment before printing.// | | //Please consider the environment before printing.// |
 Print the selected level or __**[[:modules:modules-en|Modular Plan]]**__.\\ Print the selected level or __**[[:modules:modules-en|Modular Plan]]**__.\\
- +Starting with 2.1.1714 Landscape orientation is pre-selected.
-====Analyse==== +
-**[[:analyzer-en|Analyses]]** the current track plan\\+
  
 ==== Upload... ==== ==== Upload... ====
Line 99: Line 108:
 > This option is only available if Rocview is currently connected to a Rocrail server. > This option is only available if Rocview is currently connected to a Rocrail server.
  
 +<html><a name="report"/></html>
 +==== Report... ====
 +Opens a submenu for selecting report dialogs for "Mobile" or "Accessory decoders" which decoders and addresses are used.\\
 +In the reports, the properties dialog of the object can be opened for a selected entry using the **Properties...** button (alternatively by double-clicking on the entry).\\
 +In the Mobile decoder report, a selected object can be opened with the **RocPro...** button in the RocPro dialog.\\
 +The content of the reports can be saved as a CSV file of the objects using the **Export** button after selecting the desired folder and file name in the file manager.\\
 +The files can be opened with the standard CSV application. (LibreOffice, MS Office, Numbers, ...)\\
 +The lists generated are not sorted; This can then be done with the standard CSV application.\\
 ==== Shutdown Rocrail and exit ==== ==== Shutdown Rocrail and exit ====
 Exits Rocview and subsequently the Rocrail server. Exits Rocview and subsequently the Rocrail server.
Line 106: Line 123:
 ==== Exit ==== ==== Exit ====
 Disconnect from server, if connected, and exit Rocview.\\ Disconnect from server, if connected, and exit Rocview.\\
- 
  \\  \\
 +<html><a name="edit"/></html>
 ===== Edit ===== ===== Edit =====
 {{:rocview:rocview-edit-menu-en.png}} \\ {{:rocview:rocview-edit-menu-en.png}} \\
Line 120: Line 137:
  
  \\  \\
 +<html><a name="trackplan"/></html>
 +===== Track plan =====
 +{{:rocview:rocview-trackplan-menu-en.png}} \\
  
 +==== Operate ====
 +This is the default mode enabling to operate objects of the plan like switches, signals and so on.\\
 +In this mode, the track plan cannot be modified. \\ 
 +
 +==== Edit Panel ====
 +The edit mode enables editing the current track plan. \\
 +This will also activate the __**[[#add_item|Add item]]**__ dialog.\\
 +| //In this mode some mouse and keyboard actions are differently mapped as in Operate mode to be able to edit the plan. \\ Also some context menus are different in this mode.// |\\
 +
 +==== Edit Module Plan ====
 +Mode for editing **[[:english#modular_layouts|modular layouts]]**. \\
 +Only available if the **[[:rocrailini-gen-en#track_plan_type|Plan Type]]** is set to **Module plan**.
 +
 +<html><a name="additem"/></html>
 +==== Add item ====
 +Opens the "Add item" dialog for adding new symbols to the track plan by __**[[http://en.wikipedia.org/wiki/Drag%26drop|Drag&Drop]]**__.\\
 +{{:rocview:additem-dnd-en.png}}\\
 +  * With the left column a category can be selected.
 +  * The symbols are scaled to the used plan panel scale.
 +  * The symbols look&feel are dependent of the selected __**[[:symbols-theme-props-en|Theme(s)]]**__.
 +  * The Accessory category includes default only the symbols for output, text and railroad crossing. \\ The __**[[:symbols-themes-accessories-en|Accessory Theme]]**__  must be added on the __**[[:symbols-en|Rocview SVG Tab]]**__ to get also the Building symbols.
 +  * For the Road category the __**[[:symbols-themes-road-en|Roads Theme]]**__ must be added on the __**[[:symbols-en|Rocview SVG Tab]]**__.
 +
 +==== Add track panel ====
 +Adds a new track panel with a title and the wanted level. \\
 +
 +==== Delete track diagram ====
 +This function is only provided in the **[[track-diagram-en#delete_track_diagram|context menu]]** of the track plan.\\
 +Only the current showed __track plan level__ will removed after a validation.\\
 +
 +==== Panel properties ====
 +Displays the properties (name and track plan level) of the current track plan.\\
 +
 +====Router...====
 +Opens a dialog for selecting options and starting the functions of the router. For details see: __**[[rocrailini-router-en|Router options]]**__.\\
 +|  {{:rocview:rocview-menue-router-en.png?300}}  |  {{:rocview:rocview-menue-router-cleaning-en.png?300}}  |
 +|  Router dialog "Routing"  |  Router dialog "Cleanup"  |
 +
 +After selecting the options and clicking on the desired function, the __**[[:router-en|Router]]**__ starts processing the loaded track plan.\\
 +
 +  * **Note:** The screenshots show the default setting of the options, which can be changed for the current session.
 +
 +
 +====Checker...====
 +Opens a dialog for selecting the options and starting the functions of the checker. For details see: __**[[rocrailini-router-en|Checker options]]**__.\\
 +
 +|  {{:rocview:rocview-menue-checker-en.png?250}}  |  {{:rocview:rocview-menue-checker-cleaning-en.png?250}}  |
 +|  Checker dialog "Extended plan check"  |  Checker dialog "Extended plan clean"  |
 +
 +The Standard plan check **"Check plan health..."** needs no selecting of options.
 +
 +After selecting the options and clicking on the desired function, the __**[[:router-en|Checker]]**__ starts processing the loaded track plan.\\
 +
 +  * **Note:** The screenshots show the default setting of the options, which can be changed for the current session.
 +
 +==== Plan tree ====
 +Open the __**[[:plantree-en|Plan tree]]**__ dialog.\\
 + 
 +<html><a name="tables"/></html>
 +===== Tables =====
 +All object tables are listed and accessable in this sub menu.\\
 +{{:rocview:rocview-tables-menu-en.png}}
 + \\
 +
 + \\
 +<html><a name="automatic"/></html>
 ===== Automatic ===== ===== Automatic =====
 {{:rocview:rocview-automatic-menu-en.png}}\\ {{:rocview:rocview-automatic-menu-en.png}}\\
Line 132: Line 218:
  
 ==== Start all locs ==== ==== Start all locs ====
-Start all locomotives available, or depending of the __**[[:startallfilter-en|Start all filter]]**__, in the table.\\ +Start all locomotives available, or depending on the selection in the __**[[:startallfilter-en|Start all filter]]**__.\\ 
-In auto mode available.\\+Locomotives in half-auto mode will remain in this mode, and will wait for speed commands.\\ 
 + 
  
 ==== Resume all locs ==== ==== Resume all locs ====
Line 163: Line 250:
 All active objects will get a (hard) reset signal; **block reservations will be reset too!**\\ All active objects will get a (hard) reset signal; **block reservations will be reset too!**\\
 In auto mode available.\\ In auto mode available.\\
- 
- 
  
  \\  \\
- +<html><a name="control"/></html>
-===== Track Plan ===== +
-{{:rocview:rocview-trackplan-menu-en.png}} \\ +
- +
-==== Operate ==== +
-This is the default mode enabling to operate objects of the plan like switches, signals and so on.\\ +
-In this mode, the track plan cannot be modified. \\  +
- +
-==== Edit Panel ==== +
-The edit mode enables editing the current track plan. \\ +
-This will also activate the __**[[#add_item|Add item]]**__ dialog.\\ +
-| //In this mode some mouse and keyboard actions are differently mapped as in Operate mode to be able to edit the plan. \\ Also some context menus are different in this mode.// |\\ +
- +
-==== Edit Module Plan ==== +
-Mode for editing **[[:english#modular_layouts|modular layouts]]**. \\ +
-Only available if the **[[:rocrailini-gen-en#track_plan_type|Plan Type]]** is set to **Module plan**. +
- +
-<html><a name="additem"/></html> +
-==== Add item ==== +
-Opens the "Add item" dialog for adding new symbols to the track plan by __**[[http://en.wikipedia.org/wiki/Drag%26drop|Drag&Drop]]**__.\\ +
-{{:rocview:additem-dnd-en.png}}\\ +
-  * With the left column a category can be selected. +
-  * The symbols are scaled to the used plan panel scale. +
-  * The symbols look&feel are dependent of the selected __**[[:symbols-theme-props-en|Theme(s)]]**__. +
-  * The Accessory category includes default only the symbols for output, text and railroad crossing. \\ The __**[[:symbols-en|Accessory]]**__ Theme must be added on the __**[[:symbols-en|Rocview SVG Tab]]**__ to get also the __**[[:buildings:buildings-en|Building symbols]]**__. +
-  * For the Road category the __**[[:symbols-en|Roads Theme]]**__ must be added on the __**[[:symbols-en|Rocview SVG Tab]]**__. +
- +
-==== Add track panel ==== +
-Adds a new track panel with a title and the wanted level. \\ +
- +
-==== Delete track diagram ==== +
-This function is only provided in the **[[track-diagram-en#delete_track_diagram|context menu]]** of the track plan.\\ +
-Only the current showed __track plan level__ will removed after a validation.\\ +
- +
-==== Panel properties ==== +
-Displays the properties (name and track plan level) of the current track plan.\\ +
- +
-==== Plan tree ==== +
-Open the __**[[:plantree-en|Plan tree]]**__ dialog.\\ +
- +
- +
-  +
- +
-===== Tables ===== +
-All object tables are listed and accessable in this sub menu.\\ +
-{{:rocview:rocview-tables-menu-en.png}} +
- \\ +
 ===== Control ===== ===== Control =====
 {{:rocview:rocview-control-menu-en.png}}\\ {{:rocview:rocview-control-menu-en.png}}\\
Line 226: Line 264:
   * virtual (Info line only; No impact on functionality.)   * virtual (Info line only; No impact on functionality.)
   * xpressnet   * xpressnet
 +  * BiDiB
  
 ==== Emergency break==== ==== Emergency break====
Line 233: Line 272:
  
  
-==== Start of Day (SoD)-> Init field ====+==== Start of Day (SoD) > ==== 
 +This submenu appears:\\ 
 +{{:rocview:rocview-control-menu2-en.png}} 
 + 
 +=== Init field ====
 To make sure all switches and signals have the right position this command flips them all twice.\\ To make sure all switches and signals have the right position this command flips them all twice.\\
 All defined signals will be sent a command with the last known state, or 'RED' If no state is available.\\ All defined signals will be sent a command with the last known state, or 'RED' If no state is available.\\
 See also: [[rocrail-cmdln-en#init_field|Command Line Options]] and [[rocrail-server-console-en|Console Mode]]\\ See also: [[rocrail-cmdln-en#init_field|Command Line Options]] and [[rocrail-server-console-en|Console Mode]]\\
-=== Sensor counters === + 
-At init field the following counters are reset:+With "init fieldthe following counters are reset:
   * wheel counter   * wheel counter
   * sensor counter   * sensor counter
  
-==== Start of Day (SoD)-> Query Sensors ====+=== Query sensors ===
 Request the status of all sensors.\\ Request the status of all sensors.\\
 Supported Command Stations: Supported Command Stations:
Line 249: Line 292:
   * Xpressnet   * Xpressnet
   * BiDiB   * BiDiB
 +
 +=== Query decoders ===
 +//Description is coming ...//
 +
 +=== Set reserved routes ===
 +In cases of accidents or if while the execution the track voltage was switched off, it may be possible that not all of the commands for reserving routes are complete executed. \\
 +If necessary - e.g. after restoration of operability - the commands of already reserved routes can be repeated with this function.
 +
 +==== Save switch position ====
 +Set all unlocked switches in its save position.\\
 +Normally this is done in the automode, but the manual methode can be used as final position before shutdown the system.\\
 +This command can also be used to check if all save positions are correct.\\
  
  
Line 254: Line 309:
 For fully automatically shutdown and power off the complete system.\\ For fully automatically shutdown and power off the complete system.\\
 After selecting this menu item a password is asked for powering of the system which only sudoers and administrators are allowed to do.\\ After selecting this menu item a password is asked for powering of the system which only sudoers and administrators are allowed to do.\\
-If no password is provided the power off is skipped.\\+If __no password__ is provided the power off is skipped, and the clients are __not__ informed.\\
 After the Rocrail server got this EoD command the following steps will be taken: After the Rocrail server got this EoD command the following steps will be taken:
   - Switch off the automatic mode.   - Switch off the automatic mode.
   - Wait until all locos are in idle state. The default __**[[:rocrailini-automode-en#end_of_day_timeout|EoD Timeout]]**__ is 60 seconds.   - Wait until all locos are in idle state. The default __**[[:rocrailini-automode-en#end_of_day_timeout|EoD Timeout]]**__ is 60 seconds.
-  - The clients will receive a shutdown event and will automatically close.+  - The clients will receive a shutdown event and will automatically close. (If a password was provided.)
   - All connected Command Stations become a halt command with optionally a shutdown request.   - All connected Command Stations become a halt command with optionally a shutdown request.
   - If a password is provided a system power off will be initiated. If successful the PC will shutdown and power off.   - If a password is provided a system power off will be initiated. If successful the PC will shutdown and power off.
Line 265: Line 320:
 Some Command Stations accept __**[[loc-gen-en#use_short_id|Short IDs]]**__ for use with throttles.\\ Some Command Stations accept __**[[loc-gen-en#use_short_id|Short IDs]]**__ for use with throttles.\\
  
 +==== Discover ====
 +With MBUS and the ECoS all the locomotive information is downloaded from the command station to Rocrail. Select the option again and the Discover session is terminated.
 ==== Fast Clock ==== ==== Fast Clock ====
 Shows a resizable __**[[:clock-adjust-en|Fast Clock]]**__.\\ Shows a resizable __**[[:clock-adjust-en|Fast Clock]]**__.\\
Line 278: Line 335:
 ==== Routes Control ==== ==== Routes Control ====
 **[[:route-ctrldlg-en|Test Routes]]** \\ **[[:route-ctrldlg-en|Test Routes]]** \\
- 
- 
  
  \\  \\
 +<html><a name="programming"/></html>
 ===== Programming ===== ===== Programming =====
 {{:rocview:programming-menu-en.png}}\\ {{:rocview:programming-menu-en.png}}\\
Line 293: Line 348:
 The first menu item opens the dialog ** [[editbookmarks-en#bookmark_read|edit bookmarks]] **. \\ The first menu item opens the dialog ** [[editbookmarks-en#bookmark_read|edit bookmarks]] **. \\
  
 +<html><a name="view"/></html>
 ===== View ===== ===== View =====
 {{:rocview:view-menu-en.png}}\\ {{:rocview:view-menu-en.png}}\\
Line 305: Line 361:
 <html><a name="zoom"/></html> <html><a name="zoom"/></html>
 ==== Zoom ==== ==== Zoom ====
-Sets the displayed size of the track plan objects.\\ +Opens the Sub menu:\\ 
-With the Zoom Dialog it will be on the fly at moving the slider thumb or after selecting a value from the ComboBox:\\ +{{:rocview:zoom-sub-en.png}}\\ 
-{{:rocview:zoom-en.png}}\\ +The displayed size of the track plan objects can be set. \\ 
-If the slider has the input focus the mouse wheel and the cursor keys can also be used. (Windows & Linux)\\+=== Fit === 
 +The zoom value is set automatically for all objects of the choosen Track plan level. \\ 
 + 
 +=== Zoom... ===  
 +Opens the Zoom dialog:\\ 
 +{{:rocview:zoom.png}}\\ 
 +A slider movement or the buttons [50], [75], [100] act directly or after entry in the Combo box. \\ 
 +If the slider has the input focusthe mouse wheel or cursor keys can also be used. (Windows & Linux) \\
  
  
Line 360: Line 423:
 ==== Tooltip ==== ==== Tooltip ====
  
 +====Toolbar configuration...====
 +Opens the dialog __**[[:rocview:toolbar-en#configure|Toolbar configuration]]**__ to choose the symbols in the toolbar.
 + 
 ==== Full screen ==== ==== Full screen ====
 Activates full screen mode.\\ Activates full screen mode.\\
Line 365: Line 431:
  
 ==== Track plan color ==== ==== Track plan color ====
-To change the background color of the track plan __temporarily__. After a reboot, the original color is restored+This sets the default background color for panels which do not have its own background color setThe own panel background colors will be temporary replaced with this one.\\ 
-> **Tip:** To permanently change the color of the track plan the **[[:track-diagram-en#individual_background_color|context menu]]** of the track plan panel can be used.+After a rocview restart the own panel background color will be used if setotherwise the default background color is used.\\ 
 +To permanently change the color of a panel the **[[:track-diagram-en#individual_background_color|context menu]]** of the track plan panel can be used.
  
 ==== Cascade ==== ==== Cascade ====
 Only available in case of __**[[:rocgui-gen-en#multi_window_view|Multi Window view]]**__ and operating system Windows.\\ Only available in case of __**[[:rocgui-gen-en#multi_window_view|Multi Window view]]**__ and operating system Windows.\\
 +====Perspectives====
 +The folllowing menu items are only available with __**[[:rocview:aui-en|Docking (AUI) view]]**__.
 +=== Save perspective...===
 +Zoom and rotation can be saved for the track plan levels. \\
 +An Input dialog for the name of the perspective opens.
 +=== Perspectives > ===
 +Saved perspectives are offered for selection in the submenu. \\
 +//default// = The perspective used while closing the previous Rocview session; is automatically loaded at Rocview startup.
 +=== Export perspective... / Import perspective... ===
 +Export or Import of perspectives in or from external xml files.
 +=== Show caption ===
 +This option is default activated.\\
 +Deactivating hides the title bar of the track-plan windows, e.g. To arrange modules vertically seamlessly. \\
 +// :!: The feature is not supported by all OS.//
  
- \\ 
  
 + \\
 +<html><a name="help"/></html>
 ===== Help ===== ===== Help =====
 {{:rocview:rocview-help-menu-en.png}} \\ {{:rocview:rocview-help-menu-en.png}} \\
Line 385: Line 467:
 Launches the standard browser and opens a website containing Rocrail's translations. Requires an active internet connection and a separate subscription. Launches the standard browser and opens a website containing Rocrail's translations. Requires an active internet connection and a separate subscription.
  
-==== Support... ==== +==== SupportKey... ==== 
-Opens the __ ** [[rocgui-donate-en|Support dialog]] ** __, which also shows the validity period of the support key.\\+Opens the __ ** [[rocgui-supportkey-en|SupportKey Dialog]] ** __, which also shows the validity period of the SupportKey.\\
  
 ==== Issue... ==== ==== Issue... ====
Line 394: Line 476:
 See: __**[[:tracefilter-en|Trace-Filter]]**__ See: __**[[:tracefilter-en|Trace-Filter]]**__
  
 +====Add note...====
 +See: [[:servernote-en|Server Notes]]\\
 +====Show notes...====
 +List up all notes in the @Box dialog.\\
 ==== @Box... ==== ==== @Box... ====
 See: __**[[:abox:archivebox-en|@Box]]**__\\ See: __**[[:abox:archivebox-en|@Box]]**__\\
rocgui-menu-en.1542009373.txt.gz · Last modified: 2018/11/12 08:56 by 127.0.0.1