| 1 |
qrcodetikz.sty --- prettier QR codes |
| 2 |
=================================== |
| 3 |
|
| 4 |
Version |
| 5 |
1.0 -> initial version, 2025-05-28 |
| 6 |
|
| 7 |
Copyright (C) 2025 Miguel V. S. Frasson ([email protected]) |
| 8 |
|
| 9 |
LICENSE |
| 10 |
======= |
| 11 |
|
| 12 |
This file is the README file, part of the `qrcodetikz' package. |
| 13 |
|
| 14 |
This package may be distributed under the terms of the LaTeX |
| 15 |
Project Public License, as described in lppl.txt in the base |
| 16 |
LaTeX distribution, either version 1.3 or (at your option) |
| 17 |
any later version. |
| 18 |
|
| 19 |
You can obtain a copy of the lppl.txt file from the internet on |
| 20 |
http://www.latex-project.org/lppl.txt |
| 21 |
|
| 22 |
INTRODUCTION |
| 23 |
============ |
| 24 |
|
| 25 |
_qrcodetikz_ improves the display of QR codes provided by _qrcode_. |
| 26 |
|
| 27 |
The Quick Response (QR) codes provided by package _qrcode_ show white |
| 28 |
borders on each square (from little to very proeminent depending on |
| 29 |
pdf viewer). This is because the QR code is printed square by square, |
| 30 |
not the connected regions of squares as such, and pdf screen viewers |
| 31 |
show these undesired borders. |
| 32 |
|
| 33 |
This package overwrites the _qrcode_ printing functions to fill |
| 34 |
connected regions of the QR code using TikZ, allowing prettier qrcodes |
| 35 |
on screen visualization, with possibility of customization. |
| 36 |
|
| 37 |
USAGE |
| 38 |
===== |
| 39 |
|
| 40 |
Just load _qrcodetikz_ package, with same options as _qrcode_ package, |
| 41 |
namely: |
| 42 |
nolinks: disable links if hyperref is loaded. |
| 43 |
|
| 44 |
draft: displays dummy QR code (doesn't compute QR code). |
| 45 |
|
| 46 |
final: computes and displays QR code (default). |
| 47 |
|
| 48 |
forget: recompute QR cades in every run, for debug purposes; |
| 49 |
without it, saves computed QR codes into aux file. |
| 50 |
|
| 51 |
Use |
| 52 |
|
| 53 |
\qrcode{<text>} or \qrcode[<options>]{<text>} |
| 54 |
|
| 55 |
where options are: |
| 56 |
|
| 57 |
height=<side length>: side lenght of the QR code, default is 2cm. |
| 58 |
|
| 59 |
level=<L,M,Q,H>: sets the quality of the error correction: |
| 60 |
L=low, M=medium (default), Q=Quality, H=high. |
| 61 |
|
| 62 |
version=<1-to-40>: sets the minimum size of the QR code. |
| 63 |
(In QR code jargon, version sets the size= 4 * <version> + 17.) |
| 64 |
|
| 65 |
padding: adds white space around QR code (4 modules in length) |
| 66 |
|
| 67 |
tight: opposite to padding, no white space added (default). |
| 68 |
|
| 69 |
As QR codes are now printed with TikZ in a \fill command, user can add |
| 70 |
fill options with \qrcodeFillOptions{<fill options>}, that have effect |
| 71 |
until the next call of it. Remove customizations with |
| 72 |
\qrcodeFillOptions{}. |