Name/Version Reviewed: xtme (X Toolkit Metadata Editor) version 2.3.2

Reviewer / Date: Hugh Phillips / April 1999

Version and date of last known release: 2.7.9, 2004

Function: CSDGM (1998) metadata entry tool

Background Information

Metadata

Get binaries and source code here

Platform: UNIX, with XR5 (MS-Windows users should look at xtme's sibling, tkme)

Principal Contact: Peter N. Schweitzer, USGS, pschweitzer@usgs.gov

Status:

Functional, general release, updates and changes may be coupled with changes to mp

Metadata Storage Structure: Discrete

Brief Description:

xtme is a metadata entry tool which operates in the X-Windows environment. The main user interface consists of a three paned window. The upper window shows the hierarchically arranged metadata element tree of the current metadata file and has a pull down menu bar for file, editing, and help operations. The middle window is used for entry and editing of metadata text which may follow the currently selected (in the upper window) metadata element. The bottom one-line window is used to display the precedence (mandatory, optional, repeatable etc.) of elements available on the Add menu and a short description of the function of the picks available on other menus.

The `depth' of the tree view can be selected. Entire sections of the metadata tree can be cut and pasted within xtme and brought in from other `X' windows, including another xtme session. xtme is smart enough to only allow a tree to be pasted in where it is allowed. It is possible to blank all the text entered into a selected part of the metadata tree without losing the element tree itself. A 'prune' function, which removes empty elements (empty data entry elements or compound elements with empty children) below the currently (in the editor) selected element, has recently been added. This may be unleashed at the highest (Metadata) element to clean up a document produced by other metadata tools which pass empty elements on through to the output report.

Choices available on the Help menu spawn a a new window whose contents are dictated by the choice made from the Help menu. 'Version' provides information on the version number and release date for xtme as well as some hints for using the tool. 'Element' provides the CSDGM definition for the element selected in the metadata tree window. 'Output' creates a scrollable display of the entire metadata document. Additional controls and menus on this window provide several means to efficiently navigate through the metadata document and synchronize the edit element of the main window with the currently selected position in the output window. For example, mp's error report may have noted an error on line 153. Type the number 153 into the small window next to the 'Go to Line' button, then mash the button. This will center the output window on line 153 and place a caret on that line. If 'Edit' is selected from the Output window title bar, the element containing that line will be selected in the metadata tree window, and the contents of the element will be visible in the middle pane of the main window. Mouse clicking anywhere else in the Output window will move the position of the caret to the clicked position, and again, selecting 'Edit' from the Output window will synchronize the main edit window with the caret position in the Output window. The xx menu of the Output window has a Search choice that allows strings to be located in the Out window. This feature is particularly handy for navigating metadata documents with many enumerated attribute items.

Cost: none

Notable Plus:

Like mp, xtme will support local extensions if they are defined in a user supplied extension file. These extensions become a temporary part of the `Add' menu within the tool. Help is available for each element and is identical in content to the 1998 CSDGM. The help file can be edited and enhanced to include local extensions and examples.

Notable Minus: -

Metadata Exchange

xtme can import a metadata file which will pass mp, i.e. an ASCII text metadata file with hierarchy indicated with spaces or tabs. xtme exports an ASCII metadata file with hierarchical two space indents which is acceptable to mp. xtme does not prevent you from breaking the production rules for the CSDGM. For example, it will not prevent you from creating multiple instances of an element which may only occur once, or from failing to include mandatory elements.

Useability

Although the user interface appears simple it is very powerful in its ability of to prune and graft parts of the metadata tree. Menu lists allow the user to select from appropriate elements to add at any particular point, or alternatively, entire parts of the metadata tree can be grafted in by X-selection from other X-Windows. xtme is designed for discrete metadata documents and has no database capabilities behind it. Any value for a metadata element can be pasted in from other X-Windows. Metadata documents produced by xtme are fully editable and can be updated at any stage. xtme has extensive documentation (even its own metadata). It has on-line help initially limited to just the definitions of the elements in the CSDGM, but because the help file is an ASCII document it may be enhanced to include examples, FAQs, or other helpful information. xtme has no spell checking capabilities and does not maintain a history of metadata changes.

Administrative

Binaries are available for a variety of UNIX platforms (DG/UX, HP/UX, Linux, SunOS, Solaris, AIX) and the source code is available to be compiled on any other. The tool takes about 350 Kb of disk space, including its associated documentation. Installation merely requires a decompress/dearchive, or at worst a modification of an existing Makefile to compile the tool on your platform.

The tool requires at least X-Windows R5 which is not provided. The tool is publicly available, free, and has active maintenance by its author.

Through a configuration file, the input xtme will accept or output it produces may be modified. An administrator may add new menu items (to the extent of metadata extension elements). Because the author is so actively involved with standards activity the reviewer is confident that if the CSDGM should change, the tool author will quickly incorporate these changes into the tool. The source code is provided.

Tool Reliability

xtme has one well documented 'feature.' It will eliminate (pasted) parts of a free text section beginning with a line which begins with a reserved element name. xtme has no automatic incrimental save; the user is expected to periodically 'Save' the document during editing.

Sample of Interface:

• Main Editing window (12K) This is a screen grab of an older two-paned version of xtme wihich didn't have a 'hints' pane, sorry.
• Help window for a metadata element
• Search window (3K)

Sample Output:

• Madison West DRG with a local 'Summary_Information' extension