diff --git a/docs/index_de.md b/docs/index_de.md new file mode 100644 index 0000000..4f155ca --- /dev/null +++ b/docs/index_de.md @@ -0,0 +1,62 @@ +--- +title: Erweitertes Dashboard +identifier: intranda_dashboard_extended +description: Dashboard Plugin für erweiterte Anzeige von Informationen +published: true +--- + +## Einführung +Dieses Dashboard Plugin ermöglicht durch eine detaillierte Darstellung einen verbesserten Überblick. Es können beispielsweise die zuletzt bearbeiteten Aufgaben oder relevante Statistiken angezeigt werden. + +## Installation +Um das Plugin nutzen zu können, müssen folgende Dateien installiert werden: + +```bash +/opt/digiverso/goobi/plugins/dashboard/plugin-dashboard-extended-base.jar +/opt/digiverso/goobi/plugins/GUI/plugin-dashboard-extended-gui.jar +/opt/digiverso/goobi/config/plugin_intranda_dashboard_extended.xml +``` + +Für eine Nutzung dieses Plugins muss der Nutzer innerhalb der Einstellungen für das Dashboard den Wert `intranda_dashboard_extended` auswählen. + +![Auswahl des Dashboards in den Nutzereinstellungen](screen1_de.png) + + +## Überblick und Funktionsweise +Wenn das Plugin korrekt installiert ist und Nutzer sich dieses als Dashboard eingestellt haben, ist es nach dem Login in Goobi workflow anstelle der Startseite sichtbar. + +![Nutzeroberfläche des Dashboards](screen2_de.png) + +## Konfiguration +Die Konfiguration des Plugins erfolgt in der Datei `plugin_intranda_dashboard_extended.xml` wie hier aufgezeigt: + +{{CONFIG_CONTENT}} + +Die folgende Tabelle enthält eine Zusammenstellung der Parameter und ihrer Beschreibungen: + +Parameter | Erläuterung +------------------------|------------------------------------ +`` | Dieser Parameter legt fest, ob die aktuell laufenden Jobs des intranda Task Managers angezeigt werden sollen. +`` | Dieser Wert wird in Millisekunden angegeben und legt fest, wie oft die Werte aus dem intranda Task Manager aktualisiert werden sollen. +`` | Hier wird die URL angegeben, unter der der intranda Task Manager erreichbar ist. +`` | Dieser Parameter legt fest, ob Neuigkeiten angezeigt werden sollen, die per RSS-Feed abgefragt werden können. +`` | Dieser Wert wird in Millisekunden angegeben und gibt an, wie oft der RSS-Feed aktualisiert werden soll. +`` | Dieser Paramter legt fest, von welcher Webseite der RSS-Feed geladen werden soll. +`` | Hier wird der Titel festgelegt, der über den Neuigkeiten stehen soll. +`` | Dieser Parameter legt fest, ob das `Suche`-Formular angezeigt werden soll. +`` | Dieser Parameter legt fest, ob der Bereich `Kürzlich abgeschlossene Aufgaben` angezeigt werden soll. +`` | Hier wird festgelegt, wie viele der kürzlich abgeschlossenen Aufgaben angezeigt werden sollen. +`` | Hiermit kann man sich den Verlauf der letzten Aufgaben anzeigen lassen. +`` | Mithilfe dieses Parameters kann festgelegt werden, welcher Aufgabentyp angezeigt werden soll. +`` | Dieser Parameter legt fest, wie lange die letzte Bearbeitung maximal zurückliegen darf (in Tagen), damit diese noch angezeigt wird. | +`` | Hier kann festgelegt werden, ob die zuletzt bearbeiteten Aufgaben angezeigt werden sollen. +`` | Dieser Parameter gibt die Anzahl der letzten zu zeigenden Änderungen an. +`` | Hier wird definiert, ob Statistiken angezeigt werden sollen. +`` | Dieser Parameter gibt, ob die `Batches` angezeigt werden sollen. +`` | Hier wird festgelegt, vor wie vielen Monaten die Batches angefangen wurden zu bearbeiten, damit diese angezeigt werden. +`` | Hier wird festgelegt, wie vielen Monate nach Beginn der Bearbeitung die Batches angezeigt werden. +`` | Dieser Parameter legt fest, ob die Produktionsvorlagen angezeigt werden sollen. +`` | Hier wird festgelegt, ob die Status-Spalte angezeigt werden soll. +`` | Hier wird festgelegt, ob die Projekt-Spalte angezeigt werden soll. +`` | Hier wird festgelegt, ob der Massenimport-Button angezeigt werden soll. +``. | Dieser Parameter legt fest, ob im Dashboard angezeigt werden soll, wie viele Vorgänge gerade in der Warteschlange sind und in welchem Status sie sich befinden. \ No newline at end of file diff --git a/docs/index_en.md b/docs/index_en.md new file mode 100644 index 0000000..a55331e --- /dev/null +++ b/docs/index_en.md @@ -0,0 +1,62 @@ +--- +title: Extended Dashboard +identifier: intranda_dashboard_extended +description: Dashboard plugin for extended information display +published: true +--- + +## Introduction +This dashboard plugin provides an improved overview through detailed display options. For example, the most recently edited tasks or relevant statistics can be shown. + +## Installation +In order to use the plugin, the following files must be installed: + +```bash +/opt/digiverso/goobi/plugins/dashboard/plugin-dashboard-extended-base.jar +/opt/digiverso/goobi/plugins/GUI/plugin-dashboard-extended-gui.jar +/opt/digiverso/goobi/config/plugin_intranda_dashboard_extended.xml +``` + +To use this plugin, the user must select the value `intranda_dashboard_extended` within the dashboard settings. + +![Selection of the dashboard in the user settings](screen1_en.png) + + +## Overview and functionality +If the plugin is installed correctly and users have set it as their dashboard, it will be visible after logging into Goobi workflow instead of the start page. + +![User interface of the dashboard](screen2_en.png) + +## Configuration +The plugin is configured in the file `plugin_intranda_dashboard_extended.xml` as shown here: + +{{CONFIG_CONTENT}} + +The following table contains a summary of the parameters and their descriptions: + +Parameter | Explanation +------------------------|------------------------------------ +`` | This parameter defines whether the currently running jobs of the intranda Task Manager should be displayed. +`` | This value is specified in milliseconds and defines how often the values from the intranda Task Manager should be updated. +`` | The URL at which the intranda Task Manager can be accessed is specified here. +`` | This parameter defines whether news that can be retrieved via RSS feed should be displayed. +`` | This value is specified in milliseconds and indicates how often the RSS feed should be updated. +`` | This parameter specifies the website from which the RSS feed is to be loaded. +`` | The title that is to appear above the news items is defined here. +`` | This parameter determines whether the `Search` form should be displayed. +`` | This parameter defines whether the `Recently completed tasks` area should be displayed. +`` | Here you can specify how many of the recently completed tasks should be displayed. +`` | This can be used to display the history of the last tasks. +`` | This parameter can be used to specify which task type is to be displayed. +`` | This parameter defines the maximum length of time (in days) that may have passed since the last edit for it to still be displayed. +`` | Here you can specify whether the most recently processed tasks should be displayed. +`` | This parameter specifies the number of the last changes to be shown. +`` | Here you define whether statistics are to be displayed. +`` | This parameter specifies whether the batches are to be displayed. +`` | Here you specify how many months ago the batches were started to be processed so that they are displayed. +`` | Here you can specify how many months after the start of processing the batches are displayed. +`` | This parameter defines whether the production templates are to be displayed. +`` | Here you can specify whether the status column should be displayed. +`` | Here you can specify whether the project column should be displayed. +`` | Here you can specify whether the bulk import button should be displayed. +``. | This parameter defines whether the dashboard should display how many processes are currently in the queue and what their status is. \ No newline at end of file diff --git a/docs/screen1_de.png b/docs/screen1_de.png new file mode 100644 index 0000000..bf83a87 Binary files /dev/null and b/docs/screen1_de.png differ diff --git a/docs/screen1_en.png b/docs/screen1_en.png new file mode 100644 index 0000000..7ccda95 Binary files /dev/null and b/docs/screen1_en.png differ diff --git a/docs/screen2_de.png b/docs/screen2_de.png new file mode 100644 index 0000000..8b0f925 Binary files /dev/null and b/docs/screen2_de.png differ diff --git a/docs/screen2_en.png b/docs/screen2_en.png new file mode 100644 index 0000000..5155635 Binary files /dev/null and b/docs/screen2_en.png differ diff --git a/install/plugin_intranda_dashboard_extended.xml b/install/plugin_intranda_dashboard_extended.xml index 9b48598..f8decb4 100644 --- a/install/plugin_intranda_dashboard_extended.xml +++ b/install/plugin_intranda_dashboard_extended.xml @@ -111,4 +111,3 @@ ]]> -