Main_Page

NO LONGER MAINTAINED, NO LONGER SUPPORTED

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

• Xena Digital Preservation Software
• Installing Xena
  • Downloading Xena
  • Building Xena
• Starting Xena
• Configuring Xena
  • Setting Preferences
  • Setting up plugins
  • Setting the log level
• How Xena works
• Development
  • Bug/Feature Priorities
  • Xena APIs
  • XML Schemas
  • How to create a Xena plugin
  • Distribution
• Known Issues
• 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 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