User Tools

Site Tools


issue-en

Differences

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


issue-en [2025/01/06 11:56] (current) – created - external edit 127.0.0.1
Line 1: Line 1:
 +[[:issue-en|{{icons:uk.png|English Version}}]]  [[:issue-de|{{icons:de.png|Deutsche Version}}]] [[:issue-nl|{{icons:nl.png|Nederlandse Versie}}]] [[:issue-fr|{{icons:fr.png|Version française}}]]
  
 +====== Create an issue ======
 +[[:english#rocview|{{  :viewer.png}}]][[:english|{{  :rocrail-logo-35.png}}]]
 +[[:english|Content]] -> [[:english#rocview|Rocview ]]
 +  * **Issue**
 + \\ 
 +| Menu location | //Rocview -> Help -> Issue// |
 +| Toolbar icon    | {{:issue:issue.png}} or {{:issue:issue_c.png}} |
 +
 + \\
 +
 +===== Quick start =====
 +//If you report a problem in the __**[[http://forum.rocrail.net|Rocrail Forum]]**__ you need to provide some essential files which you can easily collect  with this function in a few steps: //
 +  - Deinstall all __extra__ Virus and other scanners; Reboot.
 +  - __**U P D A T E**__ the Rocrail installation. __**This is very essential**__ :!: __**[[https://wiki.rocrail.net/rocrail-snapshot/|Rocrail Update]]**__ 
 +  - Delete old ** *.trc** files.
 +  - Open your workspace.
 +  - __**[[:rocgui-menu-en#activate_actions|Disable actions]]**__.
 +  - Activate the required trace options: 
 +    - Don't know what to select: **Information**
 +    - Drive automatically: **Information + Automatic**
 +    - Controller problem: **Information + Monitor** 
 +  - Operate Rocrail until the problem occurs.
 +  - Open the **Help** menu in Rocview.
 +  - Select **Issue**.
 +  - Write some text in the **Subject** field (do not use special characters); For example: "Switch does not work".
 +  - Optionally write some detailed information about your issue in the **Description** text area.
 +  - Click on **OK**.
 +  - A file explorer window will open with a file named **issue.zip** which can be attached in the Forum. \\ At the bottom of the Forum entry is a "Upload Attachment" feature, select the **issue.zip** file just created.
 +  - If the zip file is not created automatically, then use a zip program to zip the "issue" subdirectory.\\
 +
 +**Notes:** 
 +  * The issue files will be found on the server computer if Rocview runs on another computer.
 +  * Modular plans cannot use this function and must be assembled manually, including all modules.
 +  * If Rocrail terminates before you can create the issue, then zip your workspace together and post it in the forum.
 +
 +\\
 +     At the bottom of the forum contribution there is a function "Upload Attachment".
 + \\
 +
 +=====Modular layouts=====
 +Creating an issue in case of a modular layout will flatten it into one plan file.\\
 +Zipping the complete directory will be the better way for this type of layouts.\\
 +
 + \\
 +
 +===== Trace levels =====
 +Activate only __**[[rocrailini-trace-en|server trace levels]]**__ which are really necessary.\\
 +  * Byte trace level makes only sense in case of communication issues.
 +  * Automatic mode trace level makes only sense in case of automatic mode issues.
 +  * And so on...
 +
 + \\
 +
 +===== Preparation =====
 +  - Switch off all unnecessary trace levels.
 +  - Prepare the environment as needed for reproduction of the issue.
 +  - Restart if needed.
 +  - __**[[:rocgui-menu-en#activate_actions|Disable actions]]**__.
 +  - Make the reproduction of the issue as short as possible.
 +  - Write in the Issue Dialog a step by step list on how to reproduce it.
 +
 +
 + \\
 +===== Location of the Issue =====
 +{{ :issue:issue-explorer-en.png}}
 +This issues folder is by default in the workspace environment but can be modified in the __**[[:rocrailini-gen-en#issues_path|general Rocrail server settings]]**__.\\
 +In the server trace window the fully qualified path will be shown.\\
 +If the server runs on the same computer a file explorer window will be opened which contains all files which can be compressed into one file for uploading in to the forum. With newer revisions an **issue.zip** file is created automatically.\\
 +Optional another path can be selected if the server runs on the same computer.\\
 +
 + \\
 +
 +===== Posting the Issue =====
 +Compress the Issue directory into a 'issue'.zip file on Mac/Windows or into a 'issue'.tar.gz on Linux.\\  
 +Attach this 'issue' archive to the Forum posting.\\ 
 +{{:attach-file-forum-en.jpg?600}}\\
 + \\
 +
 +===== Help Menu =====
 +{{:issue:issue-menu.png}}
 +
 +
 + \\
 +===== Example =====
 +==== Dialog ====
 +{{:issue:issuedlg-en.png}}
 +===Subject===
 +The subject of the issue. (Mandatory)\\
 +//Do not use special characters in the subject because it is used for building a filename, which can be platform dependent.//\\
 +===Path===
 +Optional path for storing the issue files in case the server runs on the same computer as Rocview.\\
 +===Description===
 +Short description of the issue. This is optional but highly recommended.\\
 +
 + \\
 +
 +==== Directory contents ====
 +^ issues/De_trein_vertrekt_niet./ ^^
 +| issue.txt | Content of issue dialog and statistics of server. |
 +| plan.xml | Memory dump of model which includes all separate input XML files like modules and locos. (The file name will resemble the rocrail.ini and could be different, and the preceding path will be removed.) |
 +| occ.xml | Memory dump of occupancy and placing. |
 +| rocrail.ini | Memory dump of server settings. (The preceding plan file path will be removed.) |
 +| rocrail.trc | Copy of current trace file(s). | \\
 +
 +These files are contained in an "issues" sub-directory. \\
 +
 +==== Adding a file to the forum ====
 +
 +{{:issue:forum-file-en.png?700}}
 +
 +At the bottom of the forum there is an option "Attachments". \\
 +Select the file you want to place in the forum with the "Add files" option and then press "Submit".
 +
 + \\
 +
 +==== Report ====
 +issue.txt:
 +<code>
 +Date: 20120930.112140.715
 +Rocrail 2.0.999-4021 Sunrise (linux)
 +
 +started at Sun Sep 30 11:20:31 2012
 +
 +process id         = 81373
 +working directory = /Users/rob/lp/Rocrail/unxbin/virt
 +allocation count  = 17555
 +allocated memory  = 3 MB
 +clients           = 1
 +connections       = 1
 +locos             = 2
 +
 +
 +De trein vertrekt niet.:
 +----------------------------------------
 +Ik heb al van alles geprobeerd maar zelfs met een zetje wilt de trein niet gaan rijden.
 +
 +
 +BackTrace: (last 10 exceptions and warnings)
 +----------------------------------------
 + unable to open file: netroutes.xml
 + Error open file [netroutes.xml] [rb]
 + Error open file [netroutes.xml] [rb]
 + block [03] not found
 + block [02] not found
 + block [01] not found
 + createMap: locationlist NOT found.
 + createMap: operatorlist NOT found.
 + createMap: waybilllist NOT found.
 + createMap: linklist NOT found.
 +
 +13 threads:
 +----------------------------------------
 +timedoff "timedoff"
 +clockticker "clockticker"
 +r2rreader "r2rreader"
 +V200 "Elektrolokomotive E 41 der DB"
 +infw035C98E0 "127.0.0.1"
 +broadcast "ClientCon Broadcaster"
 +tick06F00E00 "tick06F00E00"
 +checker "checker"
 +cconmngr "ClientCon Manager"
 +r2rwriter "r2rwriter"
 +vcs-1 "vcs-1"
 +E03 "Elektrolokomotive BR 103 der DB"
 +cmdr035C98E0 "127.0.0.1"
 +
 +</code>
 +\\
 +===== Setting an Entry in the Forum as solved =====
 +
 +  * Navigate to the first posting in your thread
 +  * Choose button "Edit"
 +  * Got to the very end of the subject line
 +  * For Windows: press key "Win" and ".", a table with icons appears
 +  * For Apple: press [FN], a table with icons appears. If it does not appear, set the function "Show Emoji & Symbols" in the keyboard settings at "Press [FN] key to".
 +  * Choose tickmark
 +  * Press button "Save changes"