Skip to content

Commit

Permalink
Showing 8 changed files with 362 additions and 22 deletions.
37 changes: 18 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,39 @@
# Goobi workflow Plugin: plugin-workflow-barcode-generator
# Goobi workflow Plugin: goobi-plugin-workflow-barcode-generator

<img src="https://goobi.io/wp-content/uploads/logo_goobi_plugin.png" align="right" style="margin:0 0 20px 20px;" alt="Plugin for Goobi workflow" width="175" height="109">

This is a workflow plugin for Goobi workflow. It is used to allow users to generate any number of barcodes as pdf files. Using the configuration file and the provided user interface it can highly be customized and allow very individual barcodes with different numbering, amount, prefixes and even styling.
This Workflow plugin for Goobi workflow allows you to generate various barcodes for use outside Goobi workflow itself. The layout of the barcode pages can have a custom layout and be configured granualary

This is a plugin for Goobi workflow, the open source workflow tracking software for digitisation projects. More information about Goobi workflow is available under https://goobi.io. If you want to get in touch with the user community simply go to https://community.goobi.io.

## Plugin details

More information about the functionality of this plugin and the complete documentation can be found in the central documentation area at https://docs.goobi.io

Detail | Description
--- | ---
Detail | Description
--------------------------- | ----------------------
**Plugin identifier** | intranda_workflow_barcode_generator
**Plugin type** | Workflow plugin
**Licence** | GPL 2.0 or newer
**Documentation (German)** | https://docs.goobi.io/goobi-workflow-plugins-de/workflow/intranda_workflow_barcode_generator
**Documentation (English)** | https://docs.goobi.io/goobi-workflow-plugins-en/workflow/intranda_workflow_barcode_generator
**Plugin type** | workflow
**Licence** | GPL 2.0 or newer
**Documentation (German)** | https://docs.goobi.io/workflow-plugins/v/eng/workflow/goobi-plugin-workflow-barcode-generator
**Documentation (English)** | https://docs.goobi.io/workflow-plugins/v/ger/workflow/goobi-plugin-workflow-barcode-generator

## Goobi details

Goobi workflow is an open source web application to manage small and large digitisation projects mostly in cultural heritage institutions all around the world. More information about Goobi can be found here:

Detail | Description
--- | ---
**Goobi web site** | https://www.goobi.io
**Twitter** | https://twitter.com/goobi
**Goobi community** | https://community.goobi.io
Detail | Description
--------------------------- | ---------------------------
**Goobi web site** | https://www.goobi.io
**Goobi community** | https://community.goobi.io
**Goobi documentation** | https://docs.goobi.io

## Development

This plugin was developed by intranda. If you have any issues, feedback, question or if you are looking for more information about Goobi workflow, Goobi viewer and all our other developments that are used in digitisation projects please get in touch with us.

Contact | Details
--- | ---
**Company name** | intranda GmbH
**Address** | Bertha-von-Suttner-Str. 9, 37085 Göttingen, Germany
**Web site** | https://www.intranda.com
**Twitter** | https://twitter.com/intranda
Contact | Details
--------------------------- | ----------------------------------------------------
**Company name** | intranda GmbH
**Address** | Bertha-von-Suttner-Str. 9, 37085 Göttingen, Germany
**Web site** | https://www.intranda.com
170 changes: 170 additions & 0 deletions docs/index_de.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,170 @@
---
title: Barcode Generator
identifier: intranda_workflow_barcode_generator
description: Dieses Workflow Plugin erlaubt die Generierung von verschiedenen Barcodes für die Verwendung auch außerhalb von Goobi selbst.
published: true
---
## Einführung
Dieses Workflow-Plugin dient zur flexiblen Generierung von Barcodes in einer mehrseitigen PDF-Datei. Hierzu kann der Nutzer in einer Nutzeroberfläche verschiedene Werte konfigurieren und festlegen, welche Anzahl an Barcodes mit welchem Präfix und welchem Zähler erzeugt werden sollen. Zugleich kann festgelegt werden, welche `xsl-Datei` für de Generierung der `PDF-Datei` verwendet werden soll, so dass ein großes Maß an Freiheit hinsichtlich der optischen Gestaltung besteht.


## Installation
Zur Installation des Plugins müssen folgende beiden Dateien installiert werden:

```bash
/opt/digiverso/goobi/plugins/workflow/plugin-intranda-workflow-barcode-generator-base.jar
/opt/digiverso/goobi/plugins/GUI/plugin-intranda-workflow-barcode-generator-gui.jar
```

Um zu konfigurieren, wie sich das Plugin verhalten soll, können verschiedene Werte in der Konfigurationsdatei angepasst werden. Die Konfigurationsdatei befindet sich üblicherweise hier:

```bash
/opt/digiverso/goobi/config/plugin_intranda_workflow_barcode-generator.xml
```

Der Inhalt dieser Konfigurationsdatei sieht wie folgt aus:

```xml
<config_plugin>

<!-- default value for the number format -->
<format>00000</format>

<!-- default value for the amount of barcodes to be generated -->
<amount>200</amount>

<!-- default value the first barcode number -->
<start>1</start>

<!-- default value the first barcode number -->
<prefix></prefix>

<!-- default separator to use between prefix and counter,
if the prefix is empty this separator does not get used -->
<separator>_</separator>

<!-- path to xslt file for barcode generation,
this value can exist multiple times and gets displayed as dropdown list -->
<xslt-path>/opt/digiverso/goobi/xslt/barcodes.xsl</xslt-path>

</config_plugin>
```

## Überblick und Funktionsweise
Wenn das Plugin korrekt installiert und konfiguriert wurde, ist es innerhalb des Menüpunkts Workflow zu finden. Nach dem Betreten können in der Oberfläche die oben beschriebenen Parameter noch einmal individuell angepasst werden.

![Nutzeroberfläche des Plugins](screen2.png)

Nach dem Klick auf den Button Barcodes generieren steht eine PDF-Datei zum Download bereit. Eine PDF-Datei mit der hier aufgeführten Referenzkonfiguration sieht beispielsweise folgendermaßen aus:

![Generiertes PDF-Dokument mit den enthaltenen Barcodes](screen1.png)

Zur Veranschaulichung der Bedienung steht hier ein Screencast für die Benutzung des Plugins zur Verfügung.

[Screencast zur Benutzung des Plugins](https://www.youtube.com/watch?v=Eh8H4k1sKvE)


## Konfiguration

### Allgemeine Konfiguration des Plugins
Die Konfiguration des Plugins erfolgt innerhalb der oben bereits erwähnten Konfigurationsdatei. Dort können für verschiedene Felder Defaultwerte definiert werden. Diese lauten wie folgt:

| Wert | Beschreibung |
| :--- | :--- |
| `format` | Dieser Parameter legt fest, ob die Zähler mit führenden Nullen aufgefüllt werden sollen. Der Wert `00000` beispielsweise legt fest, dass alle Zahlen zumindest mit fünf Stellen angezeigt werden. |
| `amount` | Dieser Parameter legt fest, wieviele Barcodes festgelegt werden. |
| `start` | Soll der Zähler für die Barcodes bei einem bestimmten Startwert beginnen, so kann dieser hier festgelegt werden. |
| `prefix` | Dieser Parameter definiert einen Präfix, der dem Zähler mit einem Unterstrich `_` vorangestellt wird. |
| `separator` | Mit diesem Parameter kann ein Trennzeichen angegeben werden, dass zwischen Präfix und dem Zähler verwendet werden soll. Sollte der Präfix hingegen nicht angegeben sein, wird das Trennzeichen nicht verwendet. |
| `xslt-path` | Der Parameter `xslt-path` erlaubt die Definition beliebig vieler xsl-Dateien. Die hier konfigurierten Dateien werden dem Nutzer anschließend innerhalb der Nutzeroberfläche zur Auswahl angeboten. |


### Layout der Barcodes
Die Generierung der Barcodes erfolgt auf der Basis sogenannter [XSLT Transformation](https://www.w3schools.com/xml/xsl_transformation.asp). Dazu wird auf der Basis einer XSL-Datei eine PDF-Datei generiert und anschließend zum Download angeboten. Die Festlegung, wie die zu generierende PDF-Datei aussehen soll und welche Inhalte sie wie anzeigt erfolgt innerhalb einer solchen XSL-Datei. Genau wie auch die anderen XSL-Dateien, die Goobi workflow bereits für die Generierung der Laufzettel verwendet, sollten die XSL-Dateien im Idealfall im zentralen Verzeichnis `xslt` von Goobi liegen. Dieses befindet sich üblicherweise hier:

```bash
/opt/digiverso/goobi/xslt/
```

In diesem Ordner befinden sich zumeist mehrere solcher XSL-Dateien. Die Referenzdatei für den Aufbau der generierten Barcodes befindet sich in dieser ebenfalls im Rahmen der Plugin-Installation installierten Datei:

```bash
/opt/digiverso/goobi/xslt/barcodes.xsl
```

Sie verfügt über den folgenden Inhalt:

```xml
<?xml version="1.0" encoding="iso-8859-1"?>
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:fo="http://www.w3.org/1999/XSL/Format"
xmlns:goobi="http://www.goobi.io/logfile" version="1.1" exclude-result-prefixes="fo">
<xsl:output method="xml" indent="yes" />
<xsl:template match="goobi:process">
<fo:root xmlns:fo="http://www.w3.org/1999/XSL/Format">

<!-- general layout -->
<fo:layout-master-set>
<fo:simple-page-master master-name="page" page-width="14.8cm" page-height="21.0cm" margin-left="1cm" margin-top="0.7cm"
margin-right="1cm">
<fo:region-body />
</fo:simple-page-master>
</fo:layout-master-set>

<!-- run through each item to generate a new page with a barcode -->
<xsl:for-each select="goobi:item">
<fo:page-sequence master-reference="page">
<fo:flow flow-name="xsl-region-body" font-family="opensans, unicode">

<!-- Institution logos -->
<fo:block text-align="right">
<fo:external-graphic src="/opt/digiverso/goobi/xslt/logo_favicon.png" content-width="10mm" top="0cm"/>
</fo:block>

<!-- Separator -->
<fo:block border-top-width="1pt" border-top-style="solid" border-top-color="#cccccc" margin-top="7pt" />

<!-- identifier as readable text -->
<fo:block text-align="center" font-weight="bold" font-size="20pt" margin-top="160pt">
<xsl:value-of select="." />
</fo:block>

<!-- Separator -->
<fo:block border-top-width="1pt" border-top-style="solid" border-top-color="#cccccc" margin-top="20pt" margin-bottom="20pt" />

<!-- Barcode generation -->
<xsl:variable name="barcode" select="." />
<fo:block text-align="center">
<fo:instream-foreign-object>
<barcode:barcode xmlns:barcode="http://barcode4j.krysalis.org/ns" message="{$barcode}">
<barcode:code128>
<barcode:module-width>0.21mm</barcode:module-width>
<barcode:height>20mm</barcode:height>
</barcode:code128>
</barcode:barcode>
</fo:instream-foreign-object>
</fo:block>

<!-- Separator -->
<fo:block border-top-width="1pt" border-top-style="solid" border-top-color="#cccccc" margin-top="195pt" margin-bottom="10pt" />

<!-- Goobi logo -->
<fo:block-container position="fixed" left="1cm" top="19.5cm">
<fo:block>
<fo:external-graphic src="/opt/digiverso/goobi/xslt/logo.png" content-width="22mm" />
</fo:block>
</fo:block-container>

<!-- Goobi URL -->
<fo:block-container position="fixed" left="11.85cm" top="20.0cm">
<fo:block font-size="7pt">
https://goobi.io
</fo:block>
</fo:block-container>

</fo:flow>
</fo:page-sequence>
</xsl:for-each>
</fo:root>
</xsl:template>
</xsl:stylesheet>
```
Loading

0 comments on commit 645d376

Please sign in to comment.