Tripal website instance houses data from many sources whether from an individual researcher or institutions. Tripal Citation module provides automated citations for various data based on properties and/or publication. Citations text can easily be copied and pasted into research papers or publications to accurately attribute an entity.
- Add Tripal Citation module into you Drupal host modules directory.
- Install and enable Tripal Citation module like you would any other Drupal module.
- Configure module after installation. Link to configuration page is displayed next to the enabled module in the Modules page of Drupal.
Compose citation templates with tokens in the form of {CV NAME:CVTERM NAME} format. Each template can be positioned to specific Tripal Content Type to enable targetted citaiton and/or attribution to specific data. Automated resolution of all tokens in a template are based on properties + publications information stored in CHADO prop and pub tables as shown in the illustration below.
Tripal Citation module provides predefined style options to customize overall appearance of citation elements in relation to the page it is attached to. Below are general information on configuring citation style and setting up citation template for a content type.
See Tripal Citation Module Confiuration Page
Style Citation
Prepared styling options applied to citation element that will define its overall form and appearance. See Style Options table below.
| Style | Description | Example |
|---|---|---|
| SMART | Uses quotation marks to create design interests that appear smart and formal |  |
| BANNER | Encapsulates a citation into a rectangular container (banner-like) |  |
| SIMPLE | Plain text and no styling applied to citation |  |
Title Text
A text field to set a title placed on every citation instance. An override title in Citation Template can be used to apply title to specific content type. See Configure Citation Template below.
Copy Button
Enable or disable option for citation text to be copied to clipboard by providing a copy button placed on the upper right-hand corner of a citation block. When text is copied, it can be pasted onto other documents by using the text editor paste icon or through paste key combination command.
This configuration becomes available when Tripal Citation Custom Field is attached to a content type.
See Tripal Citation Content Type Configuration
Citation Template
This setting will define a text template with set of tokens in the form of {CV NAME:CVTERM NAME}, also called cvterm tokens, which corresponds to a value in a chado table. Apart from cvterm tokens, the following non-cvterm tokens are supported.
Examples: {local:authors}, {ncit:citation}
| Token | Description |
|---|---|
| {CURRENT_DATE} | token resolves to the current date and time. The date and time format to apply can be customized using the Date format setting. |
| {CURRENT_URL} | token resolves to the current URL (page) the citation is attached or viewed. |
Date Format
{CURRENT_DATE} token output can be formatted through this setting. Each option in this field shows an example to evaluate the format to match desired format.
Alternate Title
Module configuration for citation title that applies to every citation instance can be overridden by this alternate citation text setting. Title text set to setting applies only to the content type.
Prefer Publication
When a content is referenced in a publication that has attribution, this setting will use that attribution information instead of the citation template defined by Citation Template setting.
Compose citation template in the content type citation template settings field using the following illustration to form a valid CVTERM tokens. Other non-cvterms tokens namely {CURRENT_DATE} and {CURRENT_URL} are also supported and must be encoded as they appear in the table above.
Each token in a citation template contains specific terms to query and match against a relevant properties + publication chado tables the content type is mapped to.
Example: In this example, the citation template below was attached to Germplasm Accession Tripal Content Type which mapped to chado.stock table.
{local:authors} Unpublished Phenotypic data. Data collected by and funded by Project B.
Data was accessed from mysite. All rights reserved.
The token {local:authors} will be resolved by inspecting chado.project+projectprop (project connection) and chado.stockprop table for citation/author record where the column type_id (cvterm) is equals to authors. All value or values will be ranked and processed to generate the final citation text.
James Y., Robert F., Rose B. and Crystal Q. Unpublished Phenotypic data. Data collected by and funded by Project B.
Data was accessed from mysite. All rights reserved.