Open Source Dokumentenmanagement
Dokumentation
Durchsuchbare Dokumentation aufrufen | Zurück zur Dokumentationsübersicht
Navigation: Dokumentationen agorum core > agorum core template manager
Namensschema und Definitionen für agorum core-Plugins
Hinweis: Diese Dokumentation bezieht sich auf die aktuellste Version des Plugins. Aktualisieren Sie ggf. das hier beschriebene Plugin, um die Dokumentation verwenden zu können.
Diese Dokumentation beschreibt die Vereinheitlichung der Namensvergabe von agorum core-Plugins.
Plugins für agorum core
Plugins, die von agorum erstellt werden und für agorum core sind, haben folgende Definition (Definition in der Datei project.yml):
name
Beginnt mit agorum.
Beispiele
- agorum.calendar
- agorum.searchView.tab
- agorum.onlyoffice
- agorum.composite.form
Definition
- Der Name beginnt immer mit agorum, alles ist kleingeschrieben.
- Wörter können mit . (Punkt) getrennt werden.
- Wörter müssen stets klein anfangen, können aber CamelCase beinhalten, etwa agorum.searchView.tab.
description
Der sichtbare Name des Plugins. Es ist der Produktname des Plugins und beginnt somit immer mit agorum core und wird in der Regel kleingeschrieben.
Beispiele
- agorum core calendar
- agorum core search view tab
Ausnahmen
Externe Eigennamen werden so geschrieben, wie sie geschrieben werden, etwa agorum core ONLYOFFICE oder agorum core basic archive DSGVO.
präfix
Das Präfix ergibt sich aus dem Namen und beginnt immer mit agorum_. Es wird immer kleingeschrieben.
Beispiele
- agorum_calendar_
- agorum_searchview_tab_
- agorum_onlyoffice_
- agorum_composite_form_
ACL_agorum_searchview_tab
GRP_agorum_searchview_tab
Metadaten-Gruppe:
agorum.searchView.tab
MetaDb-Gruppen:
[ agorum.searchView.tab ]
Plugins für Kunden /Externe
Werden Plugins für Kunden erstellt, wird der Kundenname als Präfix verwendet. Außerdem wird customer. vor den Namen gesetzt.
Beispiel
Kunde lautet Musterfirma.
name
musterfirma oder wenn ein spezielles Plugin für einen Bereich erstellt wird, dann musterfirma.rechnungseingang (letzteres kommt selten vor, meistens ist alles in einem Kunden-Plugin)
description
Musterfirma (hier greift der Eigenname)
prefix
musterfirma_
Plugins von Partnern
Wenn Partner Plugins erstellen, dann sollte ihr Partnername als Präfix verwendet werden oder ein Kürzel davon. Auf jeden Fall etwas für Sie eindeutiges.
Beispiel
Partner lautet Musterpartner und er erstellt ein Plugin für den Rechnungseingang.
name
musterpartner.rechnungseingang
description
Musterpartner Rechnungseingang (wie er seine Description wählt, ist egal).
prefix
musterpartner_rechnungseingang_