Main Page

From xena

This wiki contains information about installing and using the Xena digital preservation software.

Contents 1 Xena Digital Preservation Software 2 Installing Xena 2.1 Downloading Xena 2.2 Building Xena 3 Starting Xena 4 Configuring Xena 4.1 Setting Preferences 4.2 Setting up plugins 4.3 Setting the log level 5 How Xena works 6 Development 6.1 Bug/Feature Priorities 6.2 Xena APIs 6.3 XML Schemas 6.4 How to create a Xena plugin 6.5 Distribution 7 Known Issues 8 FAQs

Xena Digital Preservation Software

• What is Xena? - A description of the Xena digital preservation software
• Xena vision - The Xena vision
• Xena Help - Xena Help documentation (PDF, 1.6 MB)
• Supported Formats - A list of the file formats supported by Xena can be found on the Supported Formats page of the Xena website.

Installing Xena

• Installation overview - An overview of the Xena installation process

Downloading Xena

• Preparing for installation - What you need to do before installing Xena
• Installing Xena for Linux- Downloading and installing Xena from an archive file (.tar.bz2)
• Installing Xena for Windows - Downloading and installing Xena from the executable (.exe)
• Installing Xena for Mac OS X - Downloading and installing Xena from an Apple Disk Image (.dmg) (Mac OS X 10.5 or later only)

Building Xena

• Preparing for the build process - What you need to do before building Xena
• Downloading source files - Downloading the Xena source
• Building Xena - Building the Xena digital preservation software

Starting Xena

• Starting Xena GUI - How to start Xena in a Linux or Windows operating system
• Using Xena via the command line - How to use Xena from the command line

Configuring Xena

• Getting started - What you need to do before using Xena

Setting Preferences

• Setting preferences - How to configure Xena preferences

Setting up plugins

• About plugins - Explains the use of plugins in Xena
• Setting up the audio plugin - How to set the audio plugin preferences
• Setting up the email plugin - How to set the email plugin preferences
• Setting up the image plugins - How to set the image plugin preferences
• Setting up the office plugin - How to set the OpenOffice.org plugin preferences

Setting the log level

• Setting the log level - Optional. How to set level of detail recorded in the Xena logs

How Xena works

• How Xena performs file format identification (PDF, 420 KB).
• How Xena creates text versions of image and text-based input files - draft (PDF, 215 KB).

Development

The current architecture isn't scaling too well. We're looking at a DigitalArchiveRedesign_architecture and a re-examination of the Redesign Xena File format

Bug/Feature Priorities

The development priorities will be for the highest priority regardless of whether it is a bug or feature.

#	Bug Description	Feature Description
1 (lowest)	Fix optional.	Cosmetic change. For example, minor GUI changes.
2	Minor business impact. For example, low priority cross platform compatibility.	For example, new file formats of low priority or enhanced metadata on existing formats.
3	Fix if possible. Workaround exists. For example, build warning.	New file formats of medium priority.
4	Poor preservation/normalisation of minor features in existing supported documents.	Scaling architecture; incorrect documentation.
5	Fix before next release. For example, high priority cross platform(Linux/Windows) compatibility.	New high-priority file format. For example, video.
6	Major business impact. workaround does not exist. For example, defective visualisation and extraction. Incorrect user interface messages.	Improved usability.
7	Fix as soon as possible. For example, poor preservation/normalisation missing important document information.	Features scheduled for next release; incorrect install/build/overview instructions or documentation.
8	Critical error. System cannot run, module not working. For example, uncaught exceptions stopping processing.
9 (highest)	Fix immediately. For example, build errors / Causes loss of data.

Xena APIs

• Xena API Documentation - Xena Application Programming Interface (API) documentation

XML Schemas

Refer to: Xena schemas

How to create a Xena plugin

Note: Following recent changes to Xena, this tutorial is possibly out of date. It requires review.

• 1 - Introduction - A description of the plugin components
• 2 - Setup - Initial steps for creating a new plugin
• 3 - Creating a type and a guesser - Creating a plugin type and guesser
• 4 - Creating a basic normaliser - Creating a basic normaliser plugin
• 5 - Extending the normaliser - Extending the basic normaliser plugin
• 6 - Creating a viewer - Creating a viewer to display files normalised by the plugin
• 7 - Creating an exporter - Creating an exporter to export normalised files
• 8 - Creating a plugin - Creating the 'OrgX' plugin
• 9 - Creating a file namer - Create the 'OrgX' FileNamer
• 10 - Creating a metadata package wrapper - Create the 'OrgX' metadata wrapper
• 11 - Creating Properties - Creating plugin properties

Distribution

Tips for mac: [Bundling] and [other methods]

Known Issues

• Known Issues - Known issues with Xena preservation software

FAQs

• Frequently Asked Questions - Frequently Asked Questions about the Xena digital preservation software