| Name | oarepo-citations JSON |
| Version |
1.0.2
JSON |
| download |
| home_page | None |
| Summary | Support for citations |
| upload_time | 2025-07-29 07:50:10 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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:
```bash
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:
```python
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:
```jsx
<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:
```javascript
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.
Raw data
{
"_id": null,
"home_page": null,
"name": "oarepo-citations",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/58/af/95658a0e4ff4e7e472d68aa78dbde07eebc2c5a616807792c39bca6dd881/oarepo_citations-1.0.2.tar.gz",
"platform": null,
"description": "# OARepo Citations\n\nA 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.\n\n## Installation\n\nInstall the package using pip:\n\n```bash\npip install oarepo-citations\n```\n\n## Usage\n\n### Basic Integration\n\nOnce installed, the citation functionality is automatically available on record detail pages. The package provides:\n\n1. **Citation Dropdown Component**: A compact dropdown selector for citation styles\n2. **Citation Modal Component**: An expanded modal view for detailed citation information\n\n### Configuration & Integration\n\nTo customize the citation styles and default style, update the configuration settings in your `invenio.cfg` or equivalent configuration file:\n\n```python\nCITATION_STYLES = [\n { \"style\": \"iso690-author-date-cs\", \"label\": _(\"\u010cSN ISO 690\") },\n { \"style\": \"bibtex\", \"label\": _(\"BibTeX\") }\n]\nCITATION_STYLES_DEFAULT = \"iso690-author-date-cs\"\n```\n\nInclude citations in your record JinjaX templates:\n\n```jsx\n<RecordCitations record={record} styles={config.get(\"CITATION_STYLES\")} defaultStyle={config.get(\"CITATION_STYLES_DEFAULT\")} />\n```\n\n#### Supported Citation Styles\nThe package supports various citation styles, including but not limited to:\n- `{ \"style\": \"iso690-author-date-cs\", \"label\": \"\u010cSN ISO 690\" }`\n- `{ \"style\": \"apa\", \"label\": \"APA\" }`\n- `{ \"style\": \"harvard-cite-them-right\", \"label\": \"Harvard\" }`\n- `{ \"style\": \"modern-language-association\", \"label\": \"MLA\" }`\n- `{ \"style\": \"vancouver\", \"label\": \"Vancouver\" }`\n- `{ \"style\": \"chicago-fullnote-bibliography\", \"label\": \"Chicago\" }`\n- `{ \"style\": \"ieee\", \"label\": \"IEEE\" }`\n- `{ \"style\": \"bibtex\", \"label\": \"BibTeX\" }`\n\n### JavaScript Components\n\nThe package exports React components that can be used in custom implementations:\n\n```javascript\nimport { RecordCitationsDropdown, RecordCitationsModal } from '@js/record_citations';\n```\n\n## License\n\nThis project is part of the OARepo ecosystem developed by CESNET.\n\n## Support\n\nFor issues and questions, please use the project's issue tracker or contact the development team at CESNET.\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Support for citations",
"version": "1.0.2",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "748cc39ba5cdd7efb39f7164725233b55f02e7eebf005f6f1d000f5c4f302080",
"md5": "2df03e937cc1dcabcfb8b3a063db65c3",
"sha256": "f10d35f8081356139071c3fcd058ec0c1af2bd9158bd54f872968a1556cbd7ee"
},
"downloads": -1,
"filename": "oarepo_citations-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2df03e937cc1dcabcfb8b3a063db65c3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 25721,
"upload_time": "2025-07-29T07:50:09",
"upload_time_iso_8601": "2025-07-29T07:50:09.796473Z",
"url": "https://files.pythonhosted.org/packages/74/8c/c39ba5cdd7efb39f7164725233b55f02e7eebf005f6f1d000f5c4f302080/oarepo_citations-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "58af95658a0e4ff4e7e472d68aa78dbde07eebc2c5a616807792c39bca6dd881",
"md5": "2e35799dd9460b30ffd2344c3ea61f7c",
"sha256": "e9d4bf1eb4aec181b028d9a0c1d597dd7831f05adce9d367a1d200602b313ba6"
},
"downloads": -1,
"filename": "oarepo_citations-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "2e35799dd9460b30ffd2344c3ea61f7c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 15403,
"upload_time": "2025-07-29T07:50:10",
"upload_time_iso_8601": "2025-07-29T07:50:10.914166Z",
"url": "https://files.pythonhosted.org/packages/58/af/95658a0e4ff4e7e472d68aa78dbde07eebc2c5a616807792c39bca6dd881/oarepo_citations-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-29 07:50:10",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "oarepo-citations"
}
