How can we help?
omm-citations Klassenreferenz
Übersicht
Das omm-citations Plugin bietet eine vollständige Lösung für die Verwaltung wissenschaftlicher Zitationen mit Zotero-Integration und CSL-Formatierung.
Namespace
OmmCitations\
Konstanten
| Konstante | Beschreibung |
|---|---|
OMM_CITATIONS_VERSION |
Aktuelle Plugin-Version |
OMM_CITATIONS_PATH |
Absoluter Pfad zum Plugin |
OMM_CITATIONS_URL |
URL zum Plugin-Verzeichnis |
Klasse: API\ZoteroClient
Kommuniziert mit der Zotero Web API.
Konstruktor
public function __construct(string $api_key, string $library_id, string $library_type = 'user')
Methoden
| Methode | Rückgabe | Beschreibung |
|---|---|---|
get_collections() |
array |
Ruft alle Sammlungen ab |
get_items($collection_id) |
array |
Ruft Einträge einer Sammlung ab |
sync_library() |
array |
Synchronisiert die Bibliothek |
get_item_types() |
array |
Gibt Literaturtypen zurück |
Klasse: API\CslParser
Verarbeitet CSL-Stildateien für Zitationsformatierung.
Methoden
| Methode | Beschreibung |
|---|---|
format_citation($item) |
Formatiert InText-Zitation |
format_bibliography($items) |
Erstellt Bibliographie |
load_style($style_name) |
Lädt CSL-Stildatei |
format_authors($creators, $options) |
Formatiert Autorenliste mit et al. |
Unterstützte Stile
apa– APA 7th Editionharvard– Harvard (Author-Date)chicago-author-date– Chicago Manualieee– IEEE (Numeric)din-1505-2– DIN 1505-2
Klasse: API\MultiStyleManager
Verwaltet mehrere Zitationsstile.
Stil-Typen
| Typ | InText-Format | Beispiel |
|---|---|---|
| Author-Date | (Autor Jahr) | (Müller 2023) |
| Numeric | [1] | [1] |
| Note | Fußnote | ¹ |
Klasse: Frontend\Shortcodes
Verfügbare Shortcodes
| Shortcode | Attribute | Beschreibung |
|---|---|---|
[omm_cite] |
id, page, prefix, suffix | InText-Zitation |
[omm_bibliography] |
style, order | Bibliographie |
[omm_citation_list] |
collection, type, limit | Literaturliste |
Beispiele
[omm_cite id="123"] [omm_cite id="123" page="42-45"] [omm_cite id="123" prefix="vgl." suffix=", Hervorhebung im Original"] [omm_bibliography style="harvard"]
Klasse: Editor\Blocks
Registrierte Gutenberg-Blöcke
| Block | Beschreibung |
|---|---|
omm/citation-inline |
Inline-Zitation mit Suchfunktion |
omm/bibliography |
Automatische Bibliographie |
omm/citation-list |
Liste von Zitationen |
omm/citation-card |
Einzelne Zitationskarte |