7.3: Document Plugins

This section describes how to configure the document plugins the collection uses. It explains how you specify what plugins to use, what parameters to pass to them, and in what order they occur. Under "Design Sections", click "Document Plugins".

Contents

Simple Instructions: Add a plugin Remove a plugin Configure a plugin Change plugin order Advanced Instructions: Custom configuration Rebuilding the plugin database

Simple Instructions:

To add a plugin, select it using the "Select plugin to add" pull-down list near the bottom and then click "Add Plugin". A window appears entitled "Configuring Arguments"; it is described later. Once you have configured the new plugin, it is added to the end of the "Currently Assigned Plugins" list. Note that a plugin may only occur once in the list.

To remove a plugin, select it in the list and click "Remove Plugin".

Plugins are configured by providing arguments. To alter them, select the plugin from the list and click "Configure Plugin" (or double-click the plugin). A "Configuring Arguments" dialog appears with three parts: a text field for entering custom arguments, an area containing controls for specifying arguments, and two buttons at the bottom.

There are different kinds of controls. Some are checkboxes, and clicking one adds the appropriate option to the plugin. Others are text strings, with a checkbox and a text field. Click the box to enable the argument, then type appropriate text (regular expression, file path etc) in the box. Others are pull-down menus from which you can select from a given set of values. Still others allow multiple selections from a list. To add a value, select it and click "Add"; to remove it, select it and click "Remove". To learn what an argument does, let the mouse hover over its name for a moment and a description will appear.

When you have changed the configuration, click "OK" to commit the changes and close the dialog, or "Cancel" to close the dialog without changing any plugin arguments.

The plugins in the list are executed in order, and the ordering is sometimes important. Two plugins, ArcPlug and RecPlug, are vital to the collection building process, and are fixed in place at the end of the list (with a separator line). To change the ordering of the other ones, select the plugin you want to move and click "Move To Top", "Move Up", "Move Down", or "Move To Bottom".

Advanced Instructions:

The Librarian Interface does its best to determine what arguments a plugin supports. However, there may be cases where the user wants to specify special arguments, and for this a text field called "Custom Arguments" (at the top) is provided. Any text in it is appended verbatim to the end of the plugin command.