Differences

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

@@ Line 1: / Line 1: @@
+====== Menu ======
+[[:english#rocview|{{  :viewer.png}}]][[:english|{{  :rocrail-logo-35.png}}]]
+[[english|Content]] -> [[english#rocview|Rocview ]] -> [[english#general|General]]
+  * **Menu** | [[rocgui-config-en|Configuration]] | [[loc-tab-en|Locomotives Tab]] | [[gui-accel-en|Accelerators]] | [[gui-cs-status-en|Command Station Status]] | [[gui-multi-en|Use multiple Gui's for viewing]] | [[gui-reports-en|Reports]]
+ \\
+See also the __**[[:rocview:toolbar-en|Rocview Toolbar]]**__.\\
+ \\
+**Menus of Rocview:** ((Click menu name to follow link))
+| **[[#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 =====
+{{:rocview:rocview-file-menu-en.png}}\\
+==== Connect to... ====
+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 ====
+Disconnect from the Rocrail server to be able to edit locally offline.\\
+==== Rocview properties... ====
+Modify Rocview settings explained in chapter **[[:rocgui-config-en|Configuration]]**.\\
+This menu item is in the Rocview menu under Mac OS X.\\
+==== Rocrail properties... ====
+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 and the [[#auto_mode|Auto mode]] mode is off.
+==== Server monitor ====
+See: **[[:servermonitor-en|Server monitor]]**\\
+==== Rocrail Trace ====
+Opens a Sub menu to chose the __**[[rocrailini-trace-en#user_trace_level|User Trace level]]**__ of the Rocrail server.\\
+==== Plan properties... ====
+  * 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 ====
+Opens the Demo Workspace, saved with the installation.\\
+====Open Workspace====
+Opens a Rocrail **[[:workspaces-en|Workspace]]**\\
+====Recent Workspaces====
+The last 10 Workspaces are listed for activation.\\
+====Export/Import a Workspace====
+Exporting and importing Workspaces can be used as a copy for a new computer, or as backup.\\
+===Export...===
+Export the current active Workspace with all its sub-directories.\\
+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 a Workspace and open it.\\
+A file selection dialog opens in which the directory of the to be imported workspace can be selected.
+ \\
+==== New, Open... ====
+To create or open a track plan, respectively. \\
+See: **[[track-diagram-en|Create / modify a Track plan]]** \\
+> **Note:** These options are only available if Rocview runs **offline**, i.e. is not connected to a Rocrail server.
+==== Save ====
+Saves the current track plan. \\
+> **Tip:** The track plan is automatically saved if Rocview and Rocrail are quit.
+==== Save as... ====
+Saves the current track plan under a different name. \\
+> **Note:** If the plan is saved under name different from the current one the path to the file has to be adjusted manually in the rocrail.ini or from the **[[:rocrailini-gen-en|Rocrail properties]]** menu and the server has to be restarted.
+==== 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).
+A file dialog opens in which the suggested name and the location can be changed.
+> **Note:** Level names should not contain characters that interfere with path names, like "/", ".", etc.
+==== 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.\\
+> **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.
+==== Print... ====
+| //Please consider the environment before printing.// |
+Print the selected level or __**[[:modules:modules-en|Modular Plan]]**__.\\
+This menu item is __not available__ in combination with **[[:rocview:aui-en|Docking view]]** and/or **[[:rocgui-gen-en#aui_view_in_case_of_multiple_monitors|AUI view in case of multiple monitors]]**.\\
+==== Upload... ====
+| :!: The current plan on the server will not be saved after an upload to make it possible to update it. |
+The Rocrail server saves the received file with the name specified in the plan file in its local work directory.\\
+The new plan will be used after it is changed in the **[[:rocrailini-gen-en#track_plan_file|General Tab]]** and the server is restarted.\\
+> This option should be used by advanced users only!
+> 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 ====
+Exits Rocview and subsequently the Rocrail server.
+> **Note:** This option is only available if Rocview is currently connected to a Rocrail server and the server does not run in **[[rocrail-server-console-en|Console Mode]]** or runs in a previously opened **[[:workspaces-en|Workspace]]**.\\
+==== Exit ====
+Disconnect from server, if connected, and exit Rocview.\\
+ \\
+<html><a name="edit"/></html>
+===== Edit =====
+{{:rocview:rocview-edit-menu-en.png}} \\
+==== Undo... ====
+The [[undo-en|Undo Dialog]] is only available if there are deleted objects in edit mode.\\
+ \\
+==== Find and replace... ====
+The [[findreplace-en|Find and replace Dialog]] is available so common attributes, dialog fields, can be changed with one click.\\
+ \\
+<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 =====
+{{:rocview:rocview-automatic-menu-en.png}}\\
+==== Auto mode ====
+Flips Auto mode on/off.\\
+==== Home Location ====
+With the home action all locomotives with a __**[[:loc-gen-en#home_location|Home location]]**__ set, and which are not already at the home location, will get a command to run to the home location.\\
+The Finder will be used to find a path to the Home location.\\
+==== Start all locs ====
+Start all locomotives available, or depending on the selection in the __**[[:startallfilter-en|Start all filter]]**__.\\
+Locomotives in half-auto mode will remain in this mode, and will wait for speed commands.\\
+==== Resume all locs ====
+Start all locomotives stopped in a previous session.\\
+In auto mode available.\\
+> **Note:** This option is only available if the locs are stopped with this function: __**[[:rocgui-menu-en#stop_all_locs|Stop all locs]]**__
+==== Simulate sensors ====
+Allow with a mouse click to flip the sensor state.\\
+This is default but can be disabled to avoid accidents by an unwanted click in automatic mode.\\
+==== Activate actions ====
+Enable or disable processing actions and XmlScript.\\
+==== Stop all locs ====
+Signal all running trains to stop in the current or next block. See also: __**[[:rocgui-menu-en#resume_all_locs|Resume all locs (from previous session)]]**__\\
+In auto mode available.\\
+This has no effect on the __**[[:stage-en#staging_automation|staging automation]]**__.\\
+==== Reset ====
+| Global Automatic Reset. |
+:!: Before using a reset command all locs should be stopped with __**[[:rocgui-menu-en#stop_all_locs|Stop all locs]]**__ command.\\
+=== Soft reset ===
+All active objects will get a (soft) reset signal, and current block reservations will be preserved.\\
+In auto mode available.\\
+=== Reset all ===
+All active objects will get a (hard) reset signal; **block reservations will be reset too!**\\
+In auto mode available.\\
+ \\
+<html><a name="control"/></html>
+===== Control =====
+{{:rocview:rocview-control-menu-en.png}}\\
+==== Enable communication====
+Enable/Disable controller communication.
+Supported libraries: (so far)
+  * cbus
+  * ecos
+  * p50x (tamsmc, opendcc)
+  * virtual (Info line only; No impact on functionality.)
+  * xpressnet
+  * BiDiB
+==== Emergency break====
+This will issue an Emergency Break command and switch auto mode off.\\
+If a Command Station does not support Emergency Break it will be translated into a Power Off command.\\
+:!: In combination with server option **[[:rocrailini-automode-en#force_unlock_at_ebreak|Force unlock at Ebreak]]** this could lead to chaos.\\
+==== 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.\\
+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]]\\
+With "init field" the following counters are reset:
+  * wheel counter
+  * sensor counter
+=== Query sensors ===
+Request the status of all sensors.\\
+Supported Command Stations:
+  * CBUS
+  * LocoNet
+  * Xpressnet
+  * 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.
+=== Reset Command Station ===
+Supported CS:
+  * Tams MC command "x@@"
+ \\
+==== 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.\\
+==== End of Day (EoD) ====
+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.\\
+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:
+  - 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.
+  - 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.
+  - If a password is provided a system power off will be initiated. If successful the PC will shutdown and power off.
+==== Transmit short IDs ====
+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 ====
+Shows a resizable __**[[:clock-adjust-en|Fast Clock]]**__.\\
+==== MIC (Mouse Control) ====
+**[[:mic-en|Mouse Control]]** \\
+==== Throttle ====
+**[[:loc-throttle-en|Locomotive Throttle]]** \\
+==== Switch Control ====
+**[[:switch-ctrldlg-en|Test Switches]]** \\
+==== Routes Control ====
+**[[:route-ctrldlg-en|Test Routes]]** \\
+ \\
+<html><a name="programming"/></html>
+===== Programming =====
+{{:rocview:programming-menu-en.png}}\\
+Special stationary and mobile programming dialogs.\\
+ \\
+===== Bookmarks =====
+The menu lists the last ten bookmarks as ID and tab name. \\
+{{: Rocview: bookmarkmenu-en.png}} \\
+The first menu item opens the dialog ** [[editbookmarks-en#bookmark_read|edit bookmarks]] **. \\
+<html><a name="view"/></html>
+===== View =====
+{{:rocview:view-menu-en.png}}\\
+ \\
+==== Clear messages ====
+Deletes all messages displayed in the areas //Server// and //Controller//.
+==== Language ====
+To select the desired language of the user interface. After reselection, a dialog prompts to restart Rocview.
+<html><a name="zoom"/></html>
+==== Zoom ====
+Opens the Sub menu:\\
+{{:rocview:zoom-sub-en.png}}\\
+The displayed size of the track plan objects can be set. \\
+=== 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 focus, the mouse wheel or cursor keys can also be used. (Windows & Linux) \\
+==== Loco panel ====
+See [[#track_plan1|Track plan]] below.
+==== Loco widgets ====
+Activates **[[:rocview:locowidgets-en|Loco Widgets]]**.
+==== Track plan ====
+Either the [[#loco_panel|Loco panel]] (see above) or the track plan can be set hidden for **[[:gui-multi-en|Multiple Rocview instances]]** purpose.
+==== Trace ====
+Shows/hides the window areas with Server and Controller messages.\\
+Disable this option to save resources.\\
+==== Sort locos by address ====
+When this option is set the sorting is based on the decoder address instead of the identifier "%%#__%%".
+==== Loco view filter ====
+Select the visible loco types.\\
+==== Select Loco Columns ====
+//(wxWidgets 3.02 or higher.)//\\
+Select the columns to be visible in the Loco Tab.\\
+{{:rocview:select-loco-columns-en.png}}\\
+Columns in the left list are disabled in the loco tab.\\
+====Block menu====
+Select the menu items in the block context menu.\\
+{{:rocview:block-menuselection-en.png}}\\
+==== Show IDs ====
+Show the object IDs in the layout.\\
+==== Show Counters ====
+The sensor counters are shown formatted as: **counter,carcount,wheelcount**\\
+| ID | Counters |
+| {{:rocview:sensor-id.png}} | {{:rocview:sensor-counters.png}} |\\
+==== Show locked switches ====
+Set switch background to light red in case it is locked.\\
+See __**[[:switch-wiring-en#background_color_in_rocview|Switch Wiring]]**__\\
+==== Show pending switches ====
+Set switch background to red in case it is pending.\\
+See __**[[:switch-wiring-en#background_color_in_rocview|Switch Wiring]]**__\\
+==== Show grid ====
+==== Tooltip ====
+====Toolbar configuration...====
+Opens the dialog __**[[:rocview:toolbar-en#configure|Toolbar configuration]]**__ to choose the symbols in the toolbar.
+==== Full screen ====
+Activates full screen mode.\\
+> **Note:** On Mac OSX the menu is no longer reachable; Use CMD+U to switch back to normal screen mode.\\
+==== Track plan color ====
+This sets the default background color for panels which do not have its own background color set. The own panel background colors will be temporary replaced with this one.\\
+After a rocview restart the own panel background color will be used if set, otherwise 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 ====
+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 =====
+{{:rocview:rocview-help-menu-en.png}} \\
+==== Guide... ====
+Launches the standard browser and opens Rocrail's online manual (this wiki). An active internet connection is required.
+==== Forum... ====
+Launches the standard browser and opens Rocrail's user forum. An active internet connection is required.
+==== Translations... ====
+Launches the standard browser and opens a website containing Rocrail's translations. Requires an active internet connection and a separate subscription.
+==== SupportKey... ====
+Opens the __ ** [[rocgui-supportkey-en|SupportKey Dialog]] ** __, which also shows the validity period of the SupportKey.\\
+==== Issue... ====
+Create all needed documents for reporting a problem. See: __**[[:issue-en|Create an Issue]]**__.\\
+==== Trace... ====
+See: __**[[:tracefilter-en|Trace-Filter]]**__
+====Add note...====
+See: [[:servernote-en|Server Notes]]\\
+====Show notes...====
+List up all notes in the @Box dialog.\\
+==== @Box... ====
+See: __**[[:abox:archivebox-en|@Box]]**__\\
+==== Info... ====
+The __**[[:rocview-info-en|Info dialog]]**__ with Revision information of Rocview and the connected server.\\
+ \\
+===== Ubuntu & Menu Icons =====
+To enable menu icons install the "dconf-tools":
+<code>
+sudo apt-get install dconf-tools
+</code>
+Call dconf with the following parameters:
+<code>
+dconf write /org/gnome/desktop/interface/menus-have-icons true
+</code>
+| Tested with Ubuntu 12.04 and 13.10. |\\