Funnelback logo

Documentation

CATEGORY

Search forms

Introduction

Funnelback uses form templates to allow administrators to customise their search interface. It supports changes to the appearance of the search page, as well as advanced search and inclusion of metadata/XML fields in result summaries.

Editing the Default Form

To edit the default simple.form (Classic UI) or simple.ftl (Modern UI) file for a collection:

  1. Select the collection you wish to modify in the Manage Collection section of the Administration home page
  2. In the Customise tab click on the Design Results link.
  3. This will take you to the Edit form page (shown below), which allows you to edit the form directly.

Edit-simple-form.png

Managing forms

To access other forms or create a new one:

  1. Select the collection you wish to modify in the Manage Collection section of the Administration home page
  2. Click on the Administer tab
  3. Click on the Browse Collection Configuration Files link
  4. This will take you to the file-manager page (shown below)

File-manager.png

From this page you can select an existing form to modify (e.g. simple.form, simple.ftl), or create a new custom form file (see Create files section of page). The preview link allows you to view what the form looks like when generated, and you can also download the forms for editing on your desktop.

Search Form Templates

The simple.form (Classic UI) or simple.ftl (Modern UI) templates provide a powerful mechanism for enabling the following customisations:

  1. Inserting the value of any configuration file option, environment variable, query string parameter or general XML result element.
  2. Controlling the presentation format of search results.
  3. Putting arbitrary HTML above, below and between the variables and results.

When using the Modern UI, the form templates are a FreeMarker file contains a mix of HTML and FreeMarker directives.

When using the Clasic UI, the form templates are a HTML file containing special search form tags that are expanded by search.cgi.

A form converter tool is provided to convert Classic UI form files to Modern UI FreeMarker files.

See also

top ⇑