Oxygen XML Editor

From NOAA Environmental Data Management Wiki

Oxygen XML Editor is a cross platform xml editor. Oxygen provides a robust environment for editing ISO 19139 metadata in XML format. The purpose of this page is to share metadata authoring work flow and user tips in this environment. (To learn more or download a trial version go to http://www.oxygenxml.com.)

Getting Started

Oxygen Macros.jpg

License Server

  • Help/Register
    • Licensing Method: Use a license server

Set Up Oxygen

  • MaximizeScreenSpace.png
    The first time you open Oxygen XML Editor there will be a lot of floating windows that provide useful information, but take up a lot of space. Closing these extra windows so that you ONLY have what you need helps maximize your work space. The Figure at right shows Oxygen with just one editing window open. The project view is useful as you start to work with groups of related files and the outline view is very helpful when you are working with large files.
  • Menus.png
    Oxygen has a very flexible menu system that allows you to turn menus on and off as you need them and organize them in the menu bar in a way that works for you. This is great as you gain experience with Oxygen and what it can do, but it is a bit overwhelming at the beginning. This Figure shows the menus that are used for basic file tasks and for the critical associate schema, validation, and transform tasks.
  • ContentCompletion.PNG
    Once an XML schema is associated with your file, Oxygen knows the details of what can and cannot be in the XML. You can take advantage of this using Oxygen's content completion capabilities:
  1. Options Tab > Preferences > Content Completion
  2. Check the following
    • Add Element Content to automatically add required content for any element
    • Add Optional Content to automatically add optional content for any element. This can be very helpful at the beginning as you become familiar with the standard but as you gain experience you may want to turn it off.
    • Show all entities
    • Insert the required attributes - there are only a few required attributes in the ISO standards so this one will seem not to make a difference in most cases.

Basics

  • You can import folders from the desktop or add individual files by creating a Project. Here you can easily organize and edit multiple files.
  • Taking advantage of the Outline panel makes it easy to navigate a potentially large file and can help you get to know an unfamiliar standard.


Associating Schemas

  1. Click on: Document > Schema > Associate Schema...
  2. Under the XML Schema tab, enter the URL: http://www.ngdc.noaa.gov/metadata/published/xsd/schema.xsd

Editing

  • ISO Namespaces - One of the first things you need to do is make sure that the metadata is properly attributed with ISO namespace declarations and schema location.
  • ISO Object Ordering - Ordering of ISO objects
  • ISO Boilerplate- ISO Boilerplate

Components

Resources

Transformation

List of XSLTs
How to set transformation in Oxygen

Validating

Resources

User Tips

Oxygen in a Documentation Workflow

A number of metadata managers at NGDC are using Oxygen as their primary metadata creation and maintenance tool in the context of a larger documentation management architecture. Any full featured XML editor could fit into this architecture in the same slot as Oxygen. The expected workflow is:

  1. Authors edit and validate ISO Metadata using a desktop XML editor (Oxygen)
  2. Save metadata files from Oxygen to a version control system (Subversion). These files may contain xlinks to metadata components and are therefore called "unresolved" records.
  3. These files are automatically checked out from Subversion to a Web Accessible Folder (WAF).
  4. The xlinks in the unresolved files are automatically resolved and the complete files are checked in to a second version control system.
  5. The complete records are checked out from Subversion to a resolved/published WAF.
  6. Metadata are harvested to discovery sites.


Metadata Schemas Metadata Stylesheets