Oxygen frameworks directory structure…?

<oXygen/> general issues.
Posts: 107
Joined: Mon Jul 30, 2007 11:31 pm
Location: College Park, MD, United States

Oxygen frameworks directory structure…?

Post by Zearin » Sat Mar 05, 2011 7:43 pm

I’ve been trying to develop more customized defaults for Oxygen, and I decided to mirror Oxygen’s frameworks directory structure in a separate location (and then customize-as-I-go until I arrive at something stable).

So I looked around in Oxygen’s frameworks directory, and I’m noticing that some directories inside /frameworks seem to have a common structure, while others do not.

For example, some directories have various types of schemas (and DTDs) organized by type (that is, DTDs live under /dtd , RNGs live under /rng , and so on). However, other frameworks have schemas in their top level (such as /frameworks/xml, which contains DTDs and XSDs…and /frameworks/xforms, which contains a catalog.xml and a bunch of XSDs).

Is there an underlying logic behind the structure of these frameworks? Or are these difference simply the result of developer preferences changing over time (or perhaps between developer teams working on different frameworks)?
-- Zearin

Posts: 2654
Joined: Tue May 17, 2005 4:01 pm

Re: Oxygen frameworks directory structure…?

Post by adrian » Mon Mar 07, 2011 3:36 pm


Oxygen comes bundled with a variety of open source frameworks:
- DITA Open Toolkit
- DocBook XSL + OASIS DocBook XML Schema
- Office Open XML
- etc

These frameworks are each structured differently because they are kept in the original form(as much as possible) found in the open source project. There are also frameworks that are merged together from two or more parts(see DocBook) or simple frameworks that only provide a DTD/schema and an XML catalog.

All of these frameworks are complemented by a few Oxygen specific things:
- one or more framework files - where the entire framework configuration is stored: schemas, catalogs, CSSs, customizations
- an XML catalog file - which resolves the system and public ids to the local DTDs/schemas from the framework
- CSS files(with Oxygen extensions), usually found in a css folder, used by the Author mode for displaying the documents in the desired form.
- Oxygen customizations and extensions(a jar file).
- template files

So the folder structure is not strict, it's just a form of organizing the files by categories so you can easily locate them. You can create your own personalized folder structure.
Each of these categories of files(schemas, extensions, css, etc) has to be specified individually(or through their parent folders) in the framework configuration(Options -> Preferences -> Document Type Association, Edit).

If you want to develop new frameworks(or fine-tune the existing ones) I recommend this chapter from the user guide:
http://www.oxygenxml.com/doc/ug-oxygen/ ... intro.html

Adrian Buza
<oXygen/> XML Editor, Schema Editor and XSLT Editor/Debugger

Post Reply