diff options
author | Karl Berry <karl@freefriends.org> | 2024-10-05 19:36:57 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2024-10-05 19:36:57 +0000 |
commit | 18c360b3af8b09449ad5282f15e0100e2bc2d3e4 (patch) | |
tree | 42a72b4a7fc21e99c918361b1fb370a26b1eb32b /Master/texmf-dist/doc/latex/fancyqr | |
parent | 0edaac412b5855da1658f104aa92d404f80472d1 (diff) |
fancyqr (5oct24)
git-svn-id: svn://tug.org/texlive/trunk@72472 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/fancyqr')
-rw-r--r-- | Master/texmf-dist/doc/latex/fancyqr/README.md | 40 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/fancyqr/fancyqr-doc.pdf | bin | 247479 -> 262328 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/fancyqr/fancyqr-doc.tex | 23 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/fancyqr/qr-example.tex | 12 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/fancyqr/qr-minimal.tex | 12 |
5 files changed, 59 insertions, 28 deletions
diff --git a/Master/texmf-dist/doc/latex/fancyqr/README.md b/Master/texmf-dist/doc/latex/fancyqr/README.md index 63432f93e05..ed09e369ce6 100644 --- a/Master/texmf-dist/doc/latex/fancyqr/README.md +++ b/Master/texmf-dist/doc/latex/fancyqr/README.md @@ -5,7 +5,7 @@ [<img src="https://github.com/EagleoutIce/fancyqr/blob/gh-pages/preview-1.png?raw=true" width="600"/>](qr-example.tex) A simple package to create fancy qr-codes with the help of the [`qrcode`][qrcode]-package. -You may use `\fancyqr` just like the normal `\qrcode` (`\fancyqr[<qr-options>]{<url>}`). See the [documentation](https://media.githubusercontent.com/media/EagleoutIce/fancyqr/gh-pages/build/fancyqr-doc.pdf). +You may use `\fancyqr` just like the normal `\qrcode` (`\fancyqr[<qr-options>]{<url>}`). See the [documentation](https://media.githubusercontent.com/media/EagleoutIce/fancyqr/gh-pages/build/fancyqr-doc.pdf). If you just want to create a simple qr-code, please refer to the [minimal example](qr-minimal.tex). *fancyqr* is actively developed by *Florian Sihler* (contact me at: <florian.sihler@uni-ulm.de>) under the [GPLv3 License](LICENSE). I am very happy about every contribution (see [CONTRIBUTING.md](CONTRIBUTING.md)). You can find it on CTAN (<https://www.ctan.org/pkg/fancyqr>). @@ -13,22 +13,28 @@ If you do want to hide a center square (e.g., because you want to embed an image At the moment, there are six other styles (`flat`, `frame`, `blobs`, `glitch`, and `dots`) that you can load (locally) by using `\FancyQrLoad{<name>}`. The default style is named `default` and can be 'reset' by `\FancyQrLoad{default}` or `\FancyQrLoadDefault`. There are the following extra qr-options (you can set all of them with `\fancyqrset{<keys>}`): -| Option | Type | Default | Explanation | -| ----------------- | ------- | :------: | ---------------------------------------------------------- | -| `image` | LaTeX | | Automatically center an image.[^1] | -| `image padding` | number | | Additionally hide blocks (x & y) around the image. | -| `image x padding` | number | `0` | Additionally hide blocks (x) around the image. | -| `image y padding` | number | `0` | Additionally hide blocks (y) around the image. | -| `gradient` | boolean | true | Toggle the color gradient | -| `color` | color | | Disables the `gradient` and sets the qr color accordingly. | -| `l color` | color | `purple` | Set the top left gradient color. | -| `left color` | color | | Alias for `l color`. | -| `r color` | color | `teal` | Set the bottom right gradient color. | -| `right color` | color | | Alias for `r color`. | -| `gradient angle` | angle | `135` | Change the gradient angle. | -| `random color` | colors | | Allow to set a random color pool to pick from. | -| `width` | length | | Alias for [`qrcode`'s][qrcode] `height` option. | -| `size` | length | | Alias for [`qrcode`'s][qrcode] `height` option. | + +| Option | Type | Default | Explanation | +| ----------------- | ----------- | :------: | ------------------------------------------------------------------------------------------------------------------------------------------ | +| `classic` | boolean | `false` | Use the classic qr-code style (black with flat rectangles, this loads the `flat` style). | +| `color` | color | | Disables the `gradient` and sets the qr color accordingly. | +| `gradient angle` | angle | `135` | Change the gradient angle. | +| `gradient` | boolean | true | Toggle the color gradient | +| `image` | LaTeX | | Automatically center an image (you have to care for the size and maybe adjust the `version` and `level` to keep the qr-code readable).[^1] | +| `image padding` | number | | Additionally hide blocks (x & y) around the image. | +| `image x padding` | number | `0` | Additionally hide blocks (x) around the image. | +| `image y padding` | number | `0` | Additionally hide blocks (y) around the image. | +| `l color` | color | `purple` | Set the top left gradient color. | +| `left color` | color | | Alias for `l color`. | +| `level` | L/M/Q/H | `M` | [`qrcode`][qrcode] option affecting error correction (low, medium, quartile, high). | +| `padding` | flag | | [`qrcode`][qrcode] option adding sufficient additional space around the qr-code. | +| `r color` | color | `teal` | Set the bottom right gradient color. | +| `random color` | colors | | Allow to set a random color pool to pick from. | +| `right color` | color | | Alias for `r color`. | +| `size` | length | | Alias for [`qrcode`'s][qrcode] `height` option. | +| `tight` | flag | | [`qrcode`][qrcode] option adding no additional space around the qr-code. | +| `version` | [0..40] ∈ ℕ | `0` | [`qrcode`][qrcode] option affecting the size (tries to be as small as possible). | +| `width` | length | | Alias for [`qrcode`'s][qrcode] `height` option. | The defaults are set like this: diff --git a/Master/texmf-dist/doc/latex/fancyqr/fancyqr-doc.pdf b/Master/texmf-dist/doc/latex/fancyqr/fancyqr-doc.pdf Binary files differindex c96c62abbcd..cccceaca244 100644 --- a/Master/texmf-dist/doc/latex/fancyqr/fancyqr-doc.pdf +++ b/Master/texmf-dist/doc/latex/fancyqr/fancyqr-doc.pdf diff --git a/Master/texmf-dist/doc/latex/fancyqr/fancyqr-doc.tex b/Master/texmf-dist/doc/latex/fancyqr/fancyqr-doc.tex index 1f3b00ba2db..52338832c59 100644 --- a/Master/texmf-dist/doc/latex/fancyqr/fancyqr-doc.tex +++ b/Master/texmf-dist/doc/latex/fancyqr/fancyqr-doc.tex @@ -18,6 +18,7 @@ \usepackage{fancyqr} \usepackage{xcolor} \usepackage[tex]{listings} +\usepackage{amssymb} \lstdefinelanguage{ltx}{ language={[LaTeX]TeX}, @@ -34,14 +35,13 @@ \texorpdfstring{Florian Sihler\medskip\\* \fancyqr{https://github.com/EagleoutIce/fancyqr} }{Florian Sihler}} -\date{Version v2.0 \textendash{} 2024/04/13} - +\date{Version v2.1 \textendash{} 2024/10/05} \begin{document} \maketitle - \texttt{fancyqr} is a simple package to create fancy qr codes with the help of the \textit{\href{https://www.ctan.org/pkg/qrcode}{qrcode}}-package. + \texttt{fancyqr} is a simple package to create fancy qr-codes with the help of the \textit{\href{https://www.ctan.org/pkg/qrcode}{qrcode}}-package. You can use the |\fancyqr|-macro just like the normal |\qrcode|.\footnote{\ltx{\\fancyqr[<qr-options>]\{<url>\}}} If you do want to hide a center square (e.g, because you want to embed an image) you can use |\FancyQrDoNotPrintSquare{<x>}{<y>}| to hide a rectangle with radius x and y set from the center. If you choose this option, the default |\FancyQrRoundCut| that rounds cut corners can be changed with |\FancyQrHardCut|. @@ -66,20 +66,25 @@ \toprule \multicolumn{1}{l}{Option} & Type & \multicolumn{1}{c}{Default} & Explanation \\ \midrule - image & \LaTeX & & Automatically center an image.\footnote{The package will automatically calculate the required \ltx{\\FancyQrDoNotPrintSquare} (you have to make sure that the qr code still has enough information to be readable). Therefore, the image will not scale with the qr code.} \\ + classic & boolean & false & Use the classic qr-code style (black with flat rectangles, this loads the |flat| style). \\ + color & color & & Disables the |gradient| and sets the color accordingly. \\ + gradient & boolean & true & Toggle the color gradient \\ + gradient angle & angle & 135 & Change the gradient angle. \\ + image & \LaTeX & & Automatically center an image (you have to care for the size and maybe adjust the |version| and |level| to keep the qr-code readable).\footnote{The package will automatically calculate the required \ltx{\\FancyQrDoNotPrintSquare} (you have to make sure that the qr-code still has enough information to be readable). Therefore, the image will not scale with the qr-code.} \\ image padding & number & & Additionally hide blocks (x \& y) around the image. \\ image x padding & number & 0 & Additionally hide blocks (x) around the image. \\ image y padding & number & 0 & Additionally hide blocks (y) around the image. \\ - gradient & boolean & true & Toggle the color gradient \\ - color & color & & Disables the |gradient| and sets the color accordingly. \\ l color & color & purple & Set the top left gradient color. \\ left color & color & & Alias for |l color|. \\ + level & L/M/Q/H & M & |qrcode| option affecting error correction (low, medium, quartile, high). \\ + padding & flag & & |qrcode| option adding sufficient additional space around the qr-code. \\ r color & color & teal & Set the bottom right gradient color. \\ - right color & color & & Alias for |r color|. \\ - gradient angle & angle & 135 & Change the gradient angle. \\ random color & colors & & Allow to set a random color pool to pick from. \\ - width & length & & Alias for |qrcode|'s |height| option. \\ + right color & color & & Alias for |r color|. \\ size & length & & Alias for |qrcode|'s |height| option. \\ + tight & flag & & |qrcode| option adding no additional space around the qr-code. \\ + version & \([0..40] \in \mathbb{N}\) & 0 & |qrcode| option affecting the size (tries to be as small as possible). \\ + width & length & & Alias for |qrcode|'s |height| option. \\ \bottomrule \end{tabular} \caption{Overview of special qr-options.} diff --git a/Master/texmf-dist/doc/latex/fancyqr/qr-example.tex b/Master/texmf-dist/doc/latex/fancyqr/qr-example.tex index e0518297ebb..fe32ae73c94 100644 --- a/Master/texmf-dist/doc/latex/fancyqr/qr-example.tex +++ b/Master/texmf-dist/doc/latex/fancyqr/qr-example.tex @@ -3,6 +3,7 @@ % https://opensource.org/licenses/gpl-3.0.html \documentclass{article} +\usepackage[T1]{fontenc} \usepackage{fontawesome} \usepackage{fancyqr} @@ -13,13 +14,18 @@ % to showcase scalebox \usepackage{graphicx} +% for the coding font +\usepackage{FiraMono} + \usepackage[active,tightpage]{preview} % for presentation \setlength\PreviewBorder{15pt} -\fancyqrset{size=3.25cm,level=H,padding} +\fancyqrset{size=3.25cm, level=H, padding} +\errorcontextlines=9999 \begin{document} \preview +\begin{center} % \FancyQrDoNotPrintSquare{8}{9} % \FancyQrHardCut \mbox{\FancyQrLoad{blobs}% @@ -28,6 +34,8 @@ \fancyqr{https://github.com/EagleoutIce/fancyqr}% \FancyQrLoad{dots}% \fancyqr[image={\textsf{\textbf{\textcolor{gray}{fancy}qr}}}, random color={@Red}{@Pink}{@Purple}{@DeepPurple}{@Indigo}{@Blue}{@Cyan}{@Teal}{@Green}{@Amber}{@Orange}{@DeepOrange}{@Brown}]{https://github.com/EagleoutIce/fancyqr}% -}% +}\\[4mm] +\texttt{\textbackslash \textbf{fancyqr}\{\textcolor{@Grey}{https://github.com/EagleoutIce/fancyqr}\}} +\end{center} \endpreview \end{document}
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/fancyqr/qr-minimal.tex b/Master/texmf-dist/doc/latex/fancyqr/qr-minimal.tex new file mode 100644 index 00000000000..b9127098085 --- /dev/null +++ b/Master/texmf-dist/doc/latex/fancyqr/qr-minimal.tex @@ -0,0 +1,12 @@ +\documentclass{article} + +\usepackage{fancyqr} + +\usepackage[active,tightpage]{preview} +\setlength\PreviewBorder{0pt} + +\begin{document} +\preview +\fancyqr[classic,padding]{https://github.com/EagleoutIce/fancyqr} +\endpreview +\end{document} |