Skip to content

Commit e660df0

Browse files
authored
Merge pull request #3194 from katysaintin/master
Add documentation in rst file for AdvancedConverter Application
2 parents 867c6cf + ae35df9 commit e660df0

File tree

3 files changed

+69
-0
lines changed

3 files changed

+69
-0
lines changed

docs/source/converter.PNG

6.24 KB
Loading

docs/source/converter.rst

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
=================
2+
AdvancedConverter
3+
=================
4+
5+
OPI to BOB converter
6+
--------------------
7+
8+
9+
Table:
10+
11+
+ Description
12+
+ Command Line
13+
+ Converter application
14+
15+
Description
16+
------------
17+
18+
AdvancedConverter is a tool to convert massively and recursively CSS OPI to Phoebus BOB files. It will automatically convert the widgets and their properties from the legacy file format.
19+
20+
The converter takes folder or files and convert any OPI files into a BOB files (without delete previous OPI files).
21+
The programm keep the hierarchy, subfolders, scrypt and files inside.
22+
23+
Command Line
24+
------------
25+
To use this AdvancedConverter, you can do it via this command line invocation:
26+
27+
Usage: Usage: -main org.csstudio.display.builder.model.AdvancedConverter [-help] [-output /path/to/folder] </path/to/opi/folder>
28+
29+
Converts BOY "*".opi files to Display Builder "*".bob format
30+
31+
**-output** /path/to/folder - Folder into which converted files are written
32+
33+
<files> - One or more files to convert
34+
35+
Exemples :
36+
*Convert and copy in another folder*
37+
38+
**-main org.csstudio.display.builder.model.AdvancedConverter** *-output* **output/path/to/folder input/path/to/folder**
39+
40+
*Convert and stay in the folder*
41+
42+
**-main org.csstudio.display.builder.model.AdvancedConverter input/path/to/folder**
43+
44+
Converter application
45+
-----------------
46+
47+
Located in *Utility -> OPI converter*, it will generate a pop up window. In this pop up, you can choose a input file or folder with the Browse button in the input section. In a similar way, you can choose or not a output folder.
48+
To run the conversion you need to press the run button.
49+
.. image:: converter_path.png
50+
51+
52+
If the output is empty, the conversion will be done in the input folder.
53+
.. image:: converter.png
54+
55+
56+
57+
Right before the conversion, you might have an overriding message window. It appear when you already converted a file in the output folder.
58+
59+
If you select **YES**, it will **delete** all bob files present in the output folder and process the conversion normaly and convert evey opi files.
60+
61+
If you select **NO**, you return in the browsing section.
62+
63+
During the conversion, you can follow the conversion process with the progress bar. When the conversion is done, you return in the browsing section and can close the window with the "x" button or rerun a conversion.
64+
65+
66+
67+
68+
69+

docs/source/converter_path.png

19 KB
Loading

0 commit comments

Comments
 (0)