Register icon repository

Hinweis: Diese Dokumentation bezieht sich auf die aktuellste Version des agorum core template managers. Aktualisieren Sie ggf. das hier beschriebene Plugin, um die Dokumentation verwenden zu können.

Mit der dateiabhängigen Aktion Register icon repository können Sie eigene Icons für die Verwendung in agorum core registrieren. Um die Aktion durchführen zu können, müssen Sie zunächst die Icons, die Sie verwenden wollen, in einer JavaScript-Datei hinterlegen. Anschließend können Sie die Icon-Sammlung registrieren.

Voraussetzung:

Sie benötigen Icons im SVG-Format, um diese in einer eigenen Icon-Sammlung für agorum core zu verwenden.

Erstellen der JavaScript-Datei mit der Icon-Sammlung

Erstellen Sie einen Ordner für Ihre Icons in Ihrem Konfigurationsprojekt:
```
/agorum/roi/customers/<konfigurationsprojekt>/js/icons
```
Wechseln Sie in den neu erstellten Ordner icons und erstellen Sie eine JavaScript-Datei über das Kontextmenü Neu > JS-Dokument.
Geben Sie den Namen Ihres Icon-Repositorys an, z. B. myIconRepository, und klicken Sie OK.

Erstellen Sie in der Datei Einträge nach folgendem Muster:

module.exports = {};

// Icon 1
module.exports['<icon-name>'] = {
  body: '<path d="<path>"/>',
  width: <width>,
  height: <height>,
};

// Icon 2
module.exports['<icon-name>'] = {
  body: '<path d="<path>"/>',
  width: <width>,
  height: <height>,
};

Speichern Sie Ihr Icon-Repository über Save.

Registrieren des Icon-Repositorys

Klicken Sie mit der rechten Maustaste auf die JavaScript-Datei mit dem Icon-Repository, um das Kontextmenü zu öffnen.
Wählen Sie im Kontextmenü agorum core template manager > Registrieren > icon repository.

Ergebnis: Die Registrierung des Icon-Repositories besteht aus dem Erstellen des MetaDB-Eintrags mit dem Verweis auf Ihre JavaScript-Datei als Icon-Repository sowie der Einträge, um die MetaDB-Informationen bei einem Export oder einer Deinstallation des Konfigurationsprojekts zu berücksichtigen.
Im Einzelnen werden folgende Einträge erstellt:
• Der MetaDB-Eintrag mit dem Verweis auf das Icon-Repository unter folgendem MetaDB-Pfad. Als Wert wird automatisch der Pfad zur JavaScript-Datei mit der Icon-Sammlung eingetragen.
```
MAIN_MODULE_MANAGEMENT/customers/agorum.icons/repositories/[ <konfigurationsprojekt> ]/0100 <konfigurationsprojekt>.<repositoryname>/script
```
• Ein Eintrag in der Datei export.yml des Konfigurationsprojekts, der auf den MetaDB-Pfad verweist.
• Eine uninstall-Datei im Workspace des Konfigurationsprojekts:
```
/agorum/roi/workspace/<konfigurationsprojekt>/uninstall/0100 <konfigurationsprojekt>.<repositoryname>/0100 <konfigurationsprojekt>.<repositoryname>.json
```

Nach dem Registrieren des Icon-Repositorys können Sie die Icons in agorum core verwenden. Sie finden die Icons auch im Menü Template Manager > Icon erstellen/bearbeiten:

Icon aus dem eigenen Icon-Repository (in diesem Beispiel ist der Icon-Name agorum.doc:open-book)