Skip to main content

Support for citations

Project description

OARepo Citations

A citation management extension for OARepo that provides comprehensive citation functionality for academic records. This package enables users to generate and export citations in multiple academic formats directly from record detail pages.

Installation

Install the package using pip:

pip install oarepo-citations

Usage

Basic Integration

Once installed, the citation functionality is automatically available on record detail pages. The package provides:

  1. Citation Dropdown Component: A compact dropdown selector for citation styles
  2. Citation Modal Component: An expanded modal view for detailed citation information

Configuration & Integration

To customize the citation styles and default style, update the configuration settings in your invenio.cfg or equivalent configuration file:

CITATION_STYLES = [
    { "style": "iso690-author-date-cs", "label": _("ČSN ISO 690") },
    { "style": "bibtex", "label": _("BibTeX") }
]
CITATION_STYLES_DEFAULT = "iso690-author-date-cs"

Include citations in your record JinjaX templates:

<RecordCitations record={record} styles={config.get("CITATION_STYLES")} defaultStyle={config.get("CITATION_STYLES_DEFAULT")} />

Supported Citation Styles

The package supports various citation styles, including but not limited to:

  • { "style": "iso690-author-date-cs", "label": "ČSN ISO 690" }
  • { "style": "apa", "label": "APA" }
  • { "style": "harvard-cite-them-right", "label": "Harvard" }
  • { "style": "modern-language-association", "label": "MLA" }
  • { "style": "vancouver", "label": "Vancouver" }
  • { "style": "chicago-fullnote-bibliography", "label": "Chicago" }
  • { "style": "ieee", "label": "IEEE" }
  • { "style": "bibtex", "label": "BibTeX" }

JavaScript Components

The package exports React components that can be used in custom implementations:

import { RecordCitationsDropdown, RecordCitationsModal } from '@js/record_citations';

License

This project is part of the OARepo ecosystem developed by CESNET.

Support

For issues and questions, please use the project's issue tracker or contact the development team at CESNET.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

oarepo_citations-1.0.2.tar.gz (15.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

oarepo_citations-1.0.2-py3-none-any.whl (25.7 kB view details)

Uploaded Python 3

File details

Details for the file oarepo_citations-1.0.2.tar.gz.

File metadata

  • Download URL: oarepo_citations-1.0.2.tar.gz
  • Upload date:
  • Size: 15.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for oarepo_citations-1.0.2.tar.gz
Algorithm Hash digest
SHA256 e9d4bf1eb4aec181b028d9a0c1d597dd7831f05adce9d367a1d200602b313ba6
MD5 2e35799dd9460b30ffd2344c3ea61f7c
BLAKE2b-256 58af95658a0e4ff4e7e472d68aa78dbde07eebc2c5a616807792c39bca6dd881

See more details on using hashes here.

File details

Details for the file oarepo_citations-1.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for oarepo_citations-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f10d35f8081356139071c3fcd058ec0c1af2bd9158bd54f872968a1556cbd7ee
MD5 2df03e937cc1dcabcfb8b3a063db65c3
BLAKE2b-256 748cc39ba5cdd7efb39f7164725233b55f02e7eebf005f6f1d000f5c4f302080

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page