====== barcodes Plugin ======
---- plugin ----
description: Barcodes (1D & 2D) for DokuWiki
author : MatthiasLohr
email : mail@mlohr.com
type : syntax
lastupdate : 2024-09-17
compatible : Igor, Jack Jackrum, Kaos
depends :
conflicts :
similar : barcode, code39, qrcode, qrcode2
tags : barcode, barcodes, qr, qrcode, qrcodes, datamatrix
downloadurl: https://gitlab.com/MatthiasLohr/dokuwiki-barcodes/-/releases/permalink/latest/downloads/dokuwiki-barcodes.zip
bugtracker : https://gitlab.com/MatthiasLohr/dokuwiki-barcodes/-/issues
sourcerepo : https://gitlab.com/MatthiasLohr/dokuwiki-barcodes
donationurl:
screenshot_img :
----
//Barcodes (1D & 2D) for DokuWiki//
===== Installation =====
The recommended way to install this plugin is to use the [[https://www.dokuwiki.org/plugin:extension|DokuWiki Extension Manager]]. Search for ''%%barcodes%%'' and click on //Install//.
Alternatively, you can [[https://gitlab.com/MatthiasLohr/dokuwiki-barcodes/-/releases/permalink/latest/downloads/dokuwiki-barcodes.zip|download the latest version here]] and manually upload and install it to your DokuWiki. Please take a look [[https://www.dokuwiki.org/plugins|here]] to learn how to install plugins manually.
===== Usage =====
Create a [[https://en.wikipedia.org/wiki/QR_code|QR code]], pointing to https:%%//%%dokuwiki.org:
Alternatively, put the same URL in [[https://en.wikipedia.org/wiki/Data_Matrix|Data Matrix]]:
Some Special Characters need to be replaced in the value. This may change in a later version.
" => "
' => '
< => <
> => >
& => &
==== Options ====
The following tables contains a list of attributes, which can be used to modify the different types of supported barcodes.
^Option ^QR Code ^Data Matrix ^Other Barcodes ^Description ^Example ^
|''%%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"%%''|
|''%%value%%'' |required |required |required |Value to be represented by the Barcode. |''%%value="https://dokuwiki.org"%%'' ''%%value="42"%%'' |
|''%%img-type%%'' |optional |optional |optional |Type of the image to be created. Must be one of ''%%svg%%'' (default) or ''%%png%%'' |''%%img-type="png"%%'' |
|''%%color%%'' |optional |optional |optional |Base color of the barcode. |''%%color="#FF0000"%%'' |
|''%%background-color%%''|optional |optional |optional |Background color of the barcode. Leave empty for transparent. |''%%background-color="#FFFFFF"%%'' |
|''%%size%%'' |optional |optional |optional |Set the size in px (width and height for QR code and Data Matrix, height for other barcodes). |''%%size="64px"%%'' |
|''%%scale%%'' |//N.A.// |//N.A.// |optional |Scale the width of the barcode. |''%%scale="1.5"%%'' |
|''%%padding%%'' |optional |optional |optional |Padding of the barcode in px. |''%%padding="10px"%%'' |
===== Development =====
This plugin is fairly new and therefore does not yet have all the features you might want. If you are missing a feature, feel invited to submit a [[https://gitlab.com/MatthiasLohr/dokuwiki-barcodes/-/issues/new|feature request]].
===== Change Log =====
The Changelog is available here: https:%%//%%gitlab.com/MatthiasLohr/dokuwiki-barcodes/-/blob/main/CHANGELOG.md.
===== License =====
This DokuWiki plugin is published under the [[LICENSE.md|GNU General Public License v3.0]].
DokuWiki barcodes Plugin Copyright (C) 2023 by [[https://mlohr.com/|Matthias Lohr]] <>
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.
===== Attributions =====
This DokuWiki plugin makes use of the [[https://github.com/jucksearm/php-barcode|php-barcode]] library from [[https://github.com/jucksearm|Jucksearm]].