Difference between revisions of "Autocompletion"

From EPrints Documentation
Jump to: navigation, search
(Other useful CGI parameters)
(Anatomy of an input ID)
Line 113: Line 113:
For an explanation of how the id's are generated, and what the
For an explanation of how the id's are generated, and what the
== Anatomy of an input ID ==
[[Understanding IDs in Workflow Forms]]
This is an explanation of how the id="" tags are generated for individual input elements. (ie. a <input>) in a HTML page generated by the EPrints workflow system.
This is useful to understand if you're doing really complex stuff.
First of all, some jargon:
* The '''workflow''' contains '''pages'''
* A '''page''' is rendered as a web page. It is displayed containing one or more '''input components'''
* ''input components'' allow the inputing of zero or more ''eprint fields''.
* '''eprint fields''' may be multiple. If so they contain multiple '''rows''' of input. Otherwise they contain a single '''row'''
* a '''row''' in a compound field consists of all the '''input elements''' of all the sub-fields.
* a '''row''' in a non-compound field consists of the fields own '''input elements'''
* the '''input elements''' are the actual HTML bits needed to input the data (eg. 3 for date, 2 for page range, one for a title).
The id is constructed thus...
* EPrints assigns a prefix to the component. This is just a string eprints assigns when generating the page, and should not be relied on.
** eg. id3
** This is the '''component prefix'''
* For a field in a coponent, add "_" and the name of the field.
** eg. id3_creators
** This is the '''field prefix'''
* If this is a multiple field, add "_" and the number of the row. Otherwise add nothing.
** eg. id3_creators_2
** eg. id3_creators_3
** eg. id4_title (not multiple)
** eg. id5_pagerange
** This is the '''row prefix'''
* If this is a compound field, then add "_" and the sub-field id we're inputing.
** eg. id3_creators_2_name
** eg. id4_title  (not compound)
* If this (sub)field has more than one input component, add the suffix for that input component (see below).
* eg. id3_creators_2_name_given
* eg. id4_title
* eg. id5_pagerange_from
=== Field types with more than one input component ===
* date: _day, _month, _year
* name: _given, _family (and possibly _lineage and _honourific)
* pagerange: _from, _to
* time: _day, _month, _year, _second, _minute, _hour

Revision as of 19:58, 5 February 2007

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects

(link to how to?)

Autocompletion in EPrints 3 consists of serveral stages.

  • A field in the workflow is configured to say what autocompletion URL to use, plus any additional parameters to pass to the script. This URL must be on the same server (eg. foo.eprints.org) but does not have to be part of the EPrints system.
  • The autocomplete script takes the text typed so far (and maybe the additional parameters) and returns a chunk of XML describing possible autocomplete options. This XML consists of a number of rows (how many is up to the script).
  • Each row contains some HTML to show the person viewing plus a magic <ul> block which is hidden from display, but is used by the autocomplete javascript to autocomplete the page.

Autocomplete Scripts

EPrints autocomplete scripts live in /opt/eprints3/cgi/users/lookup/ you can add your own here, or maybe elsewhere if, for example, you needed to use PHP.

There are several kinds of autocomplete scripts:

  • thoses that just use the existing data in your repository (these are dead easy as they work out of the box)
  • ones which use a file which you place in your repositories cfg/autocomplete/ directory.
  • more clever ones.

You may be able to find new autocomplete scripts and authority files on http://files.eprints.org/

Scripts are in (rough) order of complexity to use...


Can only be used on the "publication" field. Looks up the publication in the existing publications in the repository and autocompletes the publication. If ISSN and/or publisher exist in the same input component as the journal field they will also be completed if data is available.


As above, but attached to the ISSN field.

event_by_name =

Similar to journal_by_name. Is attached to the event_title field and autocompletes from existing repository data. If they are in the same (multi) input component it will also try and autocomplete event_location, event_dates and event_type.


Attached to a multiple compound name/id field (eg. creators) looks up the name in the existing list in the repository. Can match on any id or given or family. Populates all parts of the current row it can.


This is a slightly odd script as it doesn't actually provide any autocomplete data. What it does is search the list of existing titles to see if there is a match. It only searches if there are 5 or more characters entered so far.

If it finds any matches it lists them with a warning that they might be a problem, but does not assist autocompletion. If many matches are made then a short title only is shown, if the list is only 4 or lest then a full citation is shown.

This is set to "on" by default in the hope that it will reduce duplicate submissions.


File needs an additional parameter to be passed to it. This is configured in the workflow. This parameter is the name of a file in the cfg/autocompete directory. This file contains a list of values which are searched (case insensitively) and matches returned. A second parameter of "mode=prefix" can be set to only match values which start with the text being typed, rather than contain it.


Similar to simple_file but gets its values from a database table.

The table must be in the eprints database used by this repository and start with "ac_". The script needs a param. passed from workflow to indicate the name of the table WITHOUT the ac_ prefix. Eg. if the table was "ac_badgers" the parameter would be "table=badgers". The only field used is "value" which works like the lines in the text file. If you want this to be blindingly fast you can make sure "value" is indexed, and set mode=prefix. With those set autocompleting from a dictionary of half a million words worked cheerfully.


(not included in 3.0, expected in 3.1) This script uses the EPrints/Romeo data to provide journal autocomplete data. Should be attached to the publication field. This is almost identical to file, but inserts the required Powered by Sherpa note.


This works like simple_sql except for the fact it uses three columns. url, name and value. It searches and autocompletes using value, but the human-readable description is supplied by "name" and if url is set then a (more info) link is shown. The link opens a new window to avoid mid-form trauma.


This is for more complex autocompletion authority files. It works like simple_file except that the file format is more complicated.

The file constists of lines which contan:

  • a value to search, (eg. "African Journal of Agricultural Research")
  • a tab
  • a
  • autocomplete chunk. (with no line breaks) eg.
 <li style='border-right: solid 50px #30FF30' >"African Journal of Agricultural 
 Research" published by "Academic Publishers"<br /><small>(a Green 
 publisher)</small>ISSN: 1991-637X<ul><li id="for:value:component:_publication">African 
 Journal of Agricultural Research</li><li id="for:value:component:_publisher">Academic 
 Publishers</li><li id="for:value:component:_issn">1991-637X</li></ul></li>

See below for more information on the meaning of this arcane chunk!


As for simple_sql except that a second column named "xml" is used to provide the actual results returned (value is still searched).

The xml column contains data in the autocomplete <li> format described below.

Making a custom script

Autocompletion scripts are configured to eprint fields within the workflow. If the field is multiple then the same script is attached to each input row.

The only parameter you need to look at is "q" which contains the text being autocompleted. For simple fields (eg. text), that is ones which only have one input-box per value. Not names, compound or pagerange etc.. the response should be of the format:

 <?xml version="1.0" encoding="UTF-8" ?>
  <li>Human Friendly Text <ul><li id='for:value:relative:'>text-to-insert</li></ul><li>
  <li>Human Friendly Text <ul><li id='for:value:relative:'>text-to-insert</li></ul><li>
  <li>Human Friendly Text <ul><li id='for:value:relative:'>text-to-insert</li></ul><li>
  <li>Human Friendly Text <ul><li id='for:value:relative:'>text-to-insert</li></ul><li>

Other useful CGI parameters

All parts of the field (or field row in multiple fields) get sent as CGI parameters. The name of these parameters is the ID of the HTML input element itself, but with the relative prefix removed (phew!).

Simple example: title field. One single value. It's not relevant, just use "q".

More complex example: pagerange field. While you were typing in the "to" box (the second one). It would send "?q=45&_from=12&_to=45". Obviously the numbers are made up. q= will always be the same as one of the values.

Even more complex example: creators field. Which is a multiple compound field. Parts sent would be q, _id, _name_given and _name_family.

For an explanation of how the id's are generated, and what the

Understanding IDs in Workflow Forms