OKS Data Editor

OKS Data Editor

The OKS Data Editor provides an interactive Motif based GUI to graphically manipulate objects stored in the OKS database files. An OKS object can be inspected and edited visually.
The editor supports the following OKS data file changes: The editor supports OKS server including:

The editor presents instances of a class in matrix form. A matrix may be sorted by a class' attribute or relationship. For complicated search of instances there is graphical query constructor.

Contents

1. Command Line Options
  1.1 The Editor Options
2. Environment Variables
3. Appearance
    3.1. The GUI Customization


1. Command Line Options

oks_data_editor [<X Toolkit options>] [editor options] [<schema_files>] [<data_files>]
where:
NOTENote: the order of options is important and X Toolkit command line arguments (if used) must be placed before any other options, and the schema / data files must be put last.


An example of command:

oks_data_editor -bg grey -fg white --no-message-window combined/partitions/ATLAS.data.xml

1.1. The Editor Options

Options Description of options
Short format Long format
  --no-message-window do not create graphical window for messages and errors and do not redirect output (same as OKS_GUI_NO_MSG_WINDOW environment variable)
-V --oks-verbose run OKS in verbose mode to display OKS kernel messages
-v --verbose display editor debug messages
-a --allow-duplicated-objects-via-inheritance do not stop if there are duplicated object via inheritance hierarchy (usually used for debug purposes)
-I --init-dirs init-directories colon-separated list of directories containing initialization files for user graphical windows (same as OKS_GUI_PATH environment variable)
-D --init-data-files data-files colon-separated list of initialisation data files with absolute or relative to init-dirs names (same as OKS_GUI_INIT_DATA environment variable)
-P --pixmap-dirs pixmap-dirs colon-separated list of pixmap directories with absolute or relative to init-dirs names (same as OKS_GUI_XPM_DIRS environment variable)
-B --bitmap-dirs bitmap-dirs colon-separated list of bitmap directories with absolute or relative to init-dirs names (same as OKS_GUI_XBM_DIRS environment variable)
-W --icon_width width graphical window parameter: width of the icon
-H --ch-obj-dx width graphical window parameter: children objects horisontal spacing
-R --ch-obj-dy width graphical window parameter: children objects vertical spacing
-A --ch-obj-max-width width graphical window parameter: maximum width of child object (wrap relationship branch)
-O --font-dx width graphical window parameter: text horisontal spacing
-E --font-dy width graphical window parameter: text vertical spacing
-Z --obj-dx width graphical window parameter: graphical objects horisontal spacing
-T --obj-dy width graphical window parameter: graphical objects vertical spacing
-N --da-x-margin width graphical window parameter: drawing area top/bottom margins
-C --da-y-margin width graphical window parameter: drawing area left/right margins


2. Environment Variables

Set environment variable OKS_DATA_EDITOR_NO_MSG_WINDOW to any value to avoid appearance of Messages Window. By default all load time and run time errors and information messages generated by OKS kernel and Data Editor are listed in Message Window. Setting of the environment variable mentioned above will redirect them to the terminal window from which Data Editor was started.

Another environment variables can be useful as well:


3. Appearance

The OKS Data Editor Main Window appears after successful start of the application. Depending on the environment variable discussed above, the Message Log Window may appear as well. The Main Window stays on screen during an operation with Data Editor. Other windows are created dynamically when required and is deleted when is not needed. The different types of windows are listed below:

3.1. The GUI Customization

X Toolkit resource names

The applications understand all of the core X Toolkit resource names and classes as well as:

X resource database file

It is possible to customize appearance of the editor via setting user preferences about color, fonts, and so on. Then the OksEditor class should be used as base prefix. For example, put into ~/.Xdefaults file the following fonts and colours preferences of first editor version:

OksEditor*Background:             LightGrey
OksEditor*menu_bar*Background:    CornFlowerBlue
OksEditor*popup*Background:       Grey
OksEditor*menu_bar*Foreground:    White
OksEditor*XmList*Background:      Grey
OksEditor*XmTextField*Background: Grey
OksEditor*DrawingArea*Background: Grey
OksEditor*XmText*Background:      Grey
OksEditor*FontList:               -adobe-helvetica-bold-r-normal--14-140-75-75-p-82-iso8859-1
OksEditor*popup*FontList:         -adobe-helvetica-bold-r-normal--14-140-75-75-p-82-iso8859-1
OksEditor*simple*FontList:        -adobe-helvetica-medium-o-normal--14-140-75-75-p-78-iso8859-1
OksEditor*header*FontList:        -adobe-helvetica-bold-o-normal--14-140-75-75-p-82-iso8859-1

Then run:
restart the editor and see result :-)

Index

Modified 09-JUN-2009
Author Igor Soloviev