function tripal_pub_create_citation

2.x tripal_pub.pub_citation.inc tripal_pub_create_citation($pub)
3.x tripal_chado.module.DEPRECATED.api.inc tripal_pub_create_citation($pub)
1.x tripal_pub.api.inc tripal_pub_create_citation($pub)

This function generates citations for publications. It requires an array structure with keys being the terms in the Tripal publication ontology. This function is intended to be used for any function that needs to generate a citation.

Parameters

$pub: An array structure containing publication details where the keys are the publication ontology term names and values are the corresponding details. The pub array can contain the following keys with corresponding values:

  • Publication Type: an array of publication types. a publication can have more than one type.
  • Authors: a string containing all of the authors of a publication.
  • Journal Name: a string containing the journal name.
  • Journal Abbreviation: a string containing the journal name abbreviation.
  • Series Name: a string containing the series (e.g. conference proceedings) name.
  • Series Abbreviation: a string containing the series name abbreviation
  • Volume: the serives volume number.
  • Issue: the series issue number.
  • Pages: the page numbers for the publication.
  • Publication Date: A date in the format "Year Month Day".

Return value

A text string containing the citation.

3 calls to tripal_pub_create_citation()
chado_pub_insert in legacy/tripal_pub/includes/tripal_pub.chado_node.inc
Implements hook_insert().
chado_pub_update in legacy/tripal_pub/includes/tripal_pub.chado_node.inc
Implements hook_update().
chado_pub_validate in legacy/tripal_pub/includes/tripal_pub.chado_node.inc
Implements hook_validate().

File

tripal_chado/api/modules/tripal_chado.module.DEPRECATED.api.inc, line 1445
These api functions are deprecated, if your site is currently using them please update your code with the newer tripal_chado functions.

Code

function tripal_pub_create_citation($pub) {
  chado_pub_create_citation($pub);
}