CCK Reference

Overview

Add references in text areas via an input filter to citations stored in CCK multigroup fields. Citations are displayed as a hover/tool-tip when the mouse is placed over the reference.

Usage

The multigroup should contain at least one (optionally two) text field(s) for the citation ID plus a text field for the citation text itself. Two IDs for a citation are allowed to allow for different reference formats within the text (eg a long and short version). The input filter must be enabled for this module to work.

References are added to text areas via a tag of the format [ref <ID>], where <ID> is (one of) the ID(s) associated with a citation in the CCK multigroup. Multiple references can be separated with a | character, eg: [ref 1|2|3]. The tag(s) is(are) replaced with the ID text in the selected format. Multiple references are displayed separated by commas, eg [1,2,3]. The IDs may be any text string, so you can use any ID/numbering/labelling system you like. The IDs should be unique for a node (if they're not then the first one found will be used when searching for an associated citation).

To enable for a node type: go to the node types settings page and select the fields for the ID(s) and citation text. Only text fields in CCK multigroups are shown, and only if the multigroup contains at least two text fields).

In the node type settings page you can also specify several formatting options for references in nodes of that type, such as whether to display the references in superscript, a prefix and suffix character or string (eg to create references like [a]), and the text to display in the hover tip if the citation corresponding to an ID cannot be found.

Requirements

This module makes use of the (still, looks like indefinitely) experimental content multigroup module. This module is only available in the 6.x-3.x releases of CCK. This module was developed on, and has only been tested on, a dev release of CCK 6.x-3.x from January 2010 (and has been running in a production environment using that release of CCK for the last year). It doesn't do anything fancy with the CCK fields in multigroups so it probably (hopefully) works with the latest releases of CCK 6.x-3.x. I don't have time to test it on the latest 6.x-3.x CCK releases (otherwise you wouldn't be reading this, would you?), but if it doesn't work feel free to post a patch. :)