About Features Downloads Getting Started Documentation Events Support GitHub

Site Tools


Warning: This page has not been updated in over over a year and may be outdated or deprecated.
development:howtos:supporting_a_new_citation_style

Supporting a New Citation Style

By default, VuFind supports MLA and APA citations. More can be added by following these steps:

  1. Pick a name for your citation format. This must be a single word containing no special characters, so that the same value can be shared by configuration files, PHP method names, etc. The value used internally by code/configuration does not have to be the same as the text displayed to the end user (for example, we use “Chicago” as shorthand for “Chicago Style”).
  2. Make sure the record drivers for records that can be cited in the new format return the name of the new citation format through their getSupportedCitationFormats() methods. Usually this can be accomplished by modifying VuFind\RecordDriver\DefaultRecord, which is the base class for most other record drivers.
  3. Make sure the VuFind\View\Helper\Root\Citation view helper contains a getCitation* method for your new format – the existing getCitationMLA and getCitationAPA methods show how existing citations are generated by collecting information from the record driver and rendering a template.
  4. Create necessary template(s) for the new citation format; existing templates can be found in the Citation folder of the root theme.
  5. Modify the language file(s) to include an appropriate display label for your citation format. VuFind will use the name of your format concatenated with the word “Citation” as a translation key. This is your opportunity to provide a more complete, human-readable version of the format name for display – e.g. Chicago Citation = “Chicago Style Citation”.
development/howtos/supporting_a_new_citation_style.txt · Last modified: 2020/09/22 14:03 by demiankatz