About Features Downloads Getting Started Documentation Events Support GitHub

Site Tools


development:howtos:supporting_a_new_export_format

Supporting a New Export Format

VuFind supports export both to a variety of file formats (MARC, MARC-XML, etc.) and third-party systems (EndNote, Refworks, etc.).

It is relatively straightforward to add support for additional export formats.

Step 1: Set Up export.ini

VuFind contains an export.ini file which defines all available export formats.

Comments within this file explain all available settings for defining new export formats. Generally, you need to define which record driver methods must be callable to allow support by the format (requiredMethods[]), you set the HTTP headers necessary for the export output (headers[]), and if the data needs to be forwarded to an external system, you provide the target URL (redirectUrl).

Step 2: Define Export Templates

VuFind needs a template file to build the export document. These can be customized on a record driver by record driver basis. However, since most exports are metadata and theme agnostic, it is usually best to define export templates in the AbstractBase record driver in the root theme. You can find all of the existing example templates here.

Templates must be named export-{format}.phtml, where {format} is an all-lower-case name corresponding with a section of export.ini.

development/howtos/supporting_a_new_export_format.txt · Last modified: 2020/09/22 14:12 by demiankatz