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.1.tar.gz (15.2 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.1-py3-none-any.whl (25.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: oarepo_citations-1.0.1.tar.gz
  • Upload date:
  • Size: 15.2 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.1.tar.gz
Algorithm Hash digest
SHA256 a6e4f8742d9f5bb9d5d1c2c4d609f8f9755f7adfe3d1335db26d01e2355fd4c2
MD5 2a5ec95ba6737c5656caa3b9adc60ca5
BLAKE2b-256 7600d98213105d90ef1fccb7ef47464140af531fd34c436b35082ef0514aa1a7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for oarepo_citations-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 dbf8bf54e37abe7eb1b89f9bdcb71024bb7acdaa73a71b8d1d40974692200c0b
MD5 e425349156d4c11fad152252fffec4f4
BLAKE2b-256 9eeaf15427fa3d4834cb1b934ef549eb2881164bf827d7346f2521d7b78dfb77

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