README.md
1[](https://gitlab.com/MatthiasLohr/dokuwiki-barcodes/-/releases/permalink/latest/downloads/dokuwiki-barcodes.zip)
2
3# Barcodes for DokuWiki
4
5*Barcodes (1D & 2D) for DokuWiki*
6
7## Installation
8
9The recommended way to install this plugin is to use the [DokuWiki Extension Manager](https://www.dokuwiki.org/plugin:extension).
10Search for `barcodes` and lick on *Install*.
11
12Alternatively, you can [download the latest version here](https://gitlab.com/MatthiasLohr/dokuwiki-barcodes/-/releases/permalink/latest/downloads/dokuwiki-barcodes.zip) and manually upload and install it to your DokuWiki.
13Please take a look [here](https://www.dokuwiki.org/plugins) to learn how to install plugins manually.
14
15
16## Usage
17
18Create a [QR code](https://en.wikipedia.org/wiki/QR_code), pointing to https://dokuwiki.org:
19```xml
20<barcode type="QRCODE" value="https://dokuwiki.org" />
21```
22
23Alternatively, put the same URL in [Data Matrix](https://en.wikipedia.org/wiki/Data_Matrix):
24```xml
25<barcode type="DATAMATRIX" value="https://dokuwiki.org" />
26```
27
28### Options
29
30The following tables contains a list of attributes, which can be used to modify the different types of supported barcodes.
31
32| Option | QR Code | Data Matrix | Other Barcodes | Description | Example |
33|--------------------|-----------------|--------------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------|
34| `type` | `type="QRCODE"` | `type="DATAMATRIX` | `type=...` | One of: `C39`, `C39+`, `C39E`, `C39E+`, `C93`, `S25`, `S25+`, `I25`, `I25+`, `C128`, `C128A`, `C128B`, `C128C`, `EAN2`, `EAN5`, `EAN8`, `EAN13`, `UPCA`, `UPCE`, `MSI`, `MSI+`, `POSTNET`, `PLANET`, `RMS4CC`, `KIX`, `IMB`, `CODABAR`, `CODE11`, `PHARMA`, `PHARMA2T`. | `type="QRCODE"` `type="DATAMATRIX"` `type="EAN13"` |
35| `value` | required | required | required | Value to be represented by the Barcode. | `value="https://dokuwiki.org"` `value="42"` |
36| `img-type` | optional | optional | optional | Type of the image to be created. Must be one of `svg` (default) or `png` | `img-type="png"` |
37| `color` | optional | optional | optional | Base color of the barcode. | `color="#FF0000"` |
38| `background-color` | optional | optional | optional | Background color of the barcode. Leave empty for transparent. | `background-color="#FFFFFF"` |
39| `size` | optional | optional | optional | Set the size in px (width and height for QR code and Data Matrix, height for other barcodes). | `size="64px"` |
40| `scale ` | *N.A.* | *N.A.* | optional | Scale the width of the barcode. | `scale="1.5"` |
41| `padding` | optional | optional | optional | Padding of the barcode in px. | `padding="10px"` |
42
43## Development
44
45This plugin is fairly new and therefore does not yet have all the features you might want.
46If you are missing a feature, feel invited to submit a [feature request](https://gitlab.com/MatthiasLohr/dokuwiki-barcodes/-/issues/new).
47
48
49## Change Log
50
51The Changelog is available here: https://gitlab.com/MatthiasLohr/dokuwiki-barcodes/-/blob/main/CHANGELOG.md.
52
53
54## License
55
56This DokuWiki plugin is published under the [GNU General Public License v3.0](LICENSE.md).
57
58DokuWiki barcodes Plugin
59Copyright (C) 2023 by [Matthias Lohr](https://mlohr.com/) <[mail@mlohr.com](mailto:mail@mlohr.com)>
60
61This program is free software: you can redistribute it and/or modify
62it under the terms of the GNU General Public License as published by
63the Free Software Foundation, either version 3 of the License, or
64(at your option) any later version.
65
66This program is distributed in the hope that it will be useful,
67but WITHOUT ANY WARRANTY; without even the implied warranty of
68MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
69GNU General Public License for more details.
70
71You should have received a copy of the GNU General Public License
72along with this program. If not, see <http://www.gnu.org/licenses/>.
73
74
75## Attributions
76
77This DokuWiki plugin makes use of the [php-barcode](https://github.com/jucksearm/php-barcode) library from [Jucksearm](https://github.com/jucksearm).
78
){kind=link}