User Tools

Site Tools


gui-reports-en

Differences

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


gui-reports-en [2024/05/07 14:31] (current) – created - external edit 127.0.0.1
Line 1: Line 1:
 +======Reports======
 +
 +{{  rocrail-logo-32.png}}
 +[[english|Content]] -> [[english#rocview|Rocview]]->[[english#general|General]] 
 +  *  [[rocgui-config-en|Configuration]] | [[loc-tab-en|Locomotives Tab]] | [[gui-accel-en|Accelerators]] | [[gui-cs-status-en|Status Lights]] | [[gui-multi-en|Use multiple Gui's for viewing]] | **Reports**
 +
 + \\
 +| //Please consider the environment before printing reports.// |
 +
 + \\
 +
 +
 +**Note:** Starting with 2.1.3006 a "Save as..." dialog will popup for saving the documentation instead of the default WEB Browser because of security reasons.\\
 +
 +
 + \\
 +
 +=====Creating lists of objects defined in the plan=====
 +
 +For certain objects of the plan Rocrail provides reports. Users might access these reports on the index tab of 
 +objects by hitting the documentation button:
 +
 +{{gui_report_1_en.png}}
 +
 +The defined standard browser of the operating system will be launched to display the report. 
 +
 +{{gui_report_2_en.png}}
 +
 +The layout of the report is done by XSL formatting. The corresponding stylesheets are located OOTB in the directory 'stylesheets', but the
 +this directory can be configured in rocview.ini directly or using File -> Rocview properties:
 +
 +{{gui_report_3_en.png}}
 +
 +The name of the XSL has a postfix indicating the language of the report. The language of the report is chosen based on the used language for Rocview.\\
 +If the report is not available in a language it will be displayed in the English version. \\
 +
 +:!: Please use your own directory, if you plan to change the XSL files. Otherwise your changes will be overwritten during the next installation.\\
 +\\
 +
 +
 +
 +=====Browser settings=====
 +====Safari====
 +Safari does not allow local file URLs per default.\\
 +This can be enabled in the settings:\\
 +{{:documentation:safari-allow-fileurl.png?800}}\\
 +
 +
 +
 + \\
 +====Firefox====
 +| {{attention.png}} | Firefox 3.0.1 and later might cause problems while displaying the reports. |
 +Due to some security enhancements Firefox 3.0.1 doesn't allow OOTB to link local content (stylesheet).\\
 +If you experience this problem please change the corresponding Firefox preference:
 +
 +  * Open FireFox
 +  * Open the URL **about:config** (See screen shot below.)
 +  * Accept the nice warning (as usual)
 +  * Search for the preference **security.fileuri.strict_origin_policy**
 +  * Change it to **false** by double clicking the corresponding line
 +  * Close Firefox
 +  * Try it again 
 +
 +{{:rocview:about_config_189.jpg}}
 +
 +
 + \\
 +=====CSV Documentation=====
 +CSV can be selected in the Save Dialog and will create a Comma Separated Value list with common index columns.\\
 +The default application will be started to open the csv documentation for further processing.\\
 +
 +  * **Note:** Default are this columns will be documented: **iid,id,bus,addr,port,desc,remark**
 +
 +====User defined Columns====
 +User defined columns can be set in the Plan tree in the list node.\\
 +\\
 +// Menue -> Track plan -> Plan tree... //\\
 +\\
 +{{:rocview:plantree-csv-columns-en.png?700}}\\
 +Example for the "Carlist node".\\
 +
 +If a list node is selected in the tree, a comma-separated list of the desired columns can be edited in the **CSV columns** field.\\
 +//**Caution:** The list must not contain spaces.//\\
 +If an associated sub-node, i.e. an element of the list, is selected, the available columns can be read out in the right-hand window and, if necessary, copy/paste into the **CSV Columns** field.\\
 +Changes must be activated with the **[ = ]** button.\\
 +
 +  * **Note:** If all CSV Columns from the List node are removed, the documentation will be done with the [[#csv_documentation|default Columns]].
 + 
 +
 + \\
 +=====HTML Documentation=====
 +HTML is supported by the following objects:
 +  * Trains
 +  * Locomotives
 +  * Cars
 +  * Accessory Decoders
 +====Example====
 +{{:train:trains-en.jpg?800}}\\
 +