Merge pull request 'Created Documentation' (#27) from CreateDocumenta…

…tion into develop

Reviewed-on: https://gitea.intranda.com/goobi-workflow/goobi-plugin-dashboard-extended/pulls/27

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
+------------------------|------------------------------------
+`<itm-show>`            | Dieser Parameter legt fest, ob die aktuell laufenden Jobs des intranda Task Managers angezeigt werden sollen. 
+`<itm-cache-time>`      | Dieser Wert wird in Millisekunden angegeben und legt fest, wie oft die Werte aus dem intranda Task Manager aktualisiert werden sollen.
+`<itm-url>`             | Hier wird die URL angegeben, unter der der intranda Task Manager erreichbar ist.
+`<rss-show>`            | Dieser Parameter legt fest, ob Neuigkeiten angezeigt werden sollen, die per RSS-Feed abgefragt werden können.
+`<rss-cache-time>`      | Dieser Wert wird in Millisekunden angegeben und gibt an, wie oft der RSS-Feed aktualisiert werden soll.
+`<rss-url>`             | Dieser Paramter legt fest, von welcher Webseite der RSS-Feed geladen werden soll.
+`<rss-title>`           | Hier wird der Titel festgelegt, der über den Neuigkeiten stehen soll.
+`<search-show>`         | Dieser Parameter legt fest, ob das `Suche`-Formular angezeigt werden soll.
+`<tasks-show>`          | Dieser Parameter legt fest, ob der Bereich `Kürzlich abgeschlossene Aufgaben` angezeigt werden soll.
+`<tasks-show-size>`     | Hier wird festgelegt, wie viele der kürzlich abgeschlossenen Aufgaben angezeigt werden sollen.
+`<tasks-history>`       | Hiermit kann man sich den Verlauf der letzten Aufgaben anzeigen lassen. 
+`<tasks-history-title>` | Mithilfe dieses Parameters kann festgelegt werden, welcher Aufgabentyp angezeigt werden soll.
+`<tasks-history-period>` | Dieser Parameter legt fest, wie lange die letzte Bearbeitung maximal zurückliegen darf (in Tagen), damit diese noch angezeigt wird. |
+`<tasks-latestChanges>` | Hier kann festgelegt werden, ob die zuletzt bearbeiteten Aufgaben angezeigt werden sollen.
+`<tasks-latestChanges-size>` | Dieser Parameter gibt die Anzahl der letzten zu zeigenden Änderungen an.
+`<statistics-show>`     | Hier wird definiert, ob Statistiken angezeigt werden sollen.
+`<batches-show>`        | Dieser Parameter gibt, ob die `Batches` angezeigt werden sollen.
+`<batches-timerange-start>` | Hier wird festgelegt, vor wie vielen Monaten die Batches angefangen wurden zu bearbeiten, damit diese angezeigt werden.
+`<batches-timerange-end>` | Hier wird festgelegt, wie vielen Monate nach Beginn der Bearbeitung die Batches angezeigt werden.
+`<processTemplates-show>` | Dieser Parameter legt fest, ob die Produktionsvorlagen angezeigt werden sollen.
+`<processTemplates-show-statusColumn>` | Hier wird festgelegt, ob die Status-Spalte angezeigt werden soll.
+`<processTemplates-show-projectColumn>` | Hier wird festgelegt, ob die Projekt-Spalte angezeigt werden soll.
+`<processTemplates-show-massImportButton>` | Hier wird festgelegt, ob der Massenimport-Button angezeigt werden soll.
+`<queue-show>`.           | 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.

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
+------------------------|------------------------------------
+`<itm-show>`            | This parameter defines whether the currently running jobs of the intranda Task Manager should be displayed. 
+`<itm-cache-time>`      | This value is specified in milliseconds and defines how often the values from the intranda Task Manager should be updated.
+`<itm-url>`             | The URL at which the intranda Task Manager can be accessed is specified here.
+`<rss-show>`            | This parameter defines whether news that can be retrieved via RSS feed should be displayed.
+`<rss-cache-time>`      | This value is specified in milliseconds and indicates how often the RSS feed should be updated.
+`<rss-url>`             | This parameter specifies the website from which the RSS feed is to be loaded.
+`<rss-title>`           | The title that is to appear above the news items is defined here.
+`<search-show>`         | This parameter determines whether the `Search` form should be displayed.
+`<tasks-show>`          | This parameter defines whether the `Recently completed tasks` area should be displayed.
+`<tasks-show-size>`     | Here you can specify how many of the recently completed tasks should be displayed.
+`<tasks-history>`       | This can be used to display the history of the last tasks. 
+`<tasks-history-title>` | This parameter can be used to specify which task type is to be displayed.
+`<tasks-history-period>` | This parameter defines the maximum length of time (in days) that may have passed since the last edit for it to still be displayed.
+`<tasks-latestChanges>` | Here you can specify whether the most recently processed tasks should be displayed.
+`<tasks-latestChanges-size>` | This parameter specifies the number of the last changes to be shown.
+`<statistics-show>`     | Here you define whether statistics are to be displayed.
+`<batches-show>`        | This parameter specifies whether the batches are to be displayed.
+`<batches-timerange-start>` | Here you specify how many months ago the batches were started to be processed so that they are displayed.
+`<batches-timerange-end>` | Here you can specify how many months after the start of processing the batches are displayed.
+`<processTemplates-show>` | This parameter defines whether the production templates are to be displayed.
+`<processTemplates-show-statusColumn>` | Here you can specify whether the status column should be displayed.
+`<processTemplates-show-projectColumn>` | Here you can specify whether the project column should be displayed.
+`<processTemplates-show-massImportButton>` | Here you can specify whether the bulk import button should be displayed.
+`<queue-show>`.           | This parameter defines whether the dashboard should display how many processes are currently in the queue and what their status is.

install/plugin_intranda_dashboard_extended.xml

@@ -111,4 +111,3 @@
 	]]></html-box-content>
 
 </config_plugin>
-