From 3c1980c284378c99b6929447409e16737d6de2ac Mon Sep 17 00:00:00 2001 From: gitlost Date: Wed, 14 Jun 2023 15:16:09 +0100 Subject: [PATCH] manual: add new ZINT_WARN_HRT_TRUNCATED warning; add missing Table caption "Micro QR ECC Levels"; update README for pandoc-3.1.3; remove TODO Windows instructions which never worked and likely never will --- docs/README | 38 +++++++++++++------------------------- docs/manual.pmd | 10 ++++++++++ docs/manual.txt | 8 ++++++++ docs/zint.1 | 2 +- 4 files changed, 32 insertions(+), 26 deletions(-) diff --git a/docs/README b/docs/README index 63699a55..8744c1f2 100644 --- a/docs/README +++ b/docs/README @@ -2,25 +2,31 @@ For generation of "docs/manual.pdf" and "docs/manual.txt" from "manual.pmd" usin On Ubuntu/Debian (tested on Ubuntu 22.04) - wget https://github.com/jgm/pandoc/releases/download/2.19.2/pandoc-2.19.2-1-amd64.deb - sudo dpkg -i pandoc-2.19.2-1-amd64.deb + wget https://github.com/jgm/pandoc/releases/download/3.1.3/pandoc-3.1.3-1-amd64.deb + sudo dpkg -i pandoc-3.1.3-1-amd64.deb sudo apt install python3-pip pip install pandoc-tablenos --user export PATH=~/.local/bin:"$PATH" + # Temporary fix for version regex - see https://github.com/tomduck/pandoc-xnos/pull/29 + python -m pip install --force-reinstall \ + git+https://github.com/tomduck/pandoc-xnos@284474574f51888be75603e7d1df667a0890504d#egg=pandoc-xnos sudo apt install librsvg2-bin sudo apt install texlive-xetex sudo apt install texlive-lang-cjk sudo apt install fonts-wqy-microhei make -On Fedora (tested on Fedora Linux 36 (Workstation Edition)) +On Fedora (tested on Fedora Linux 38 (Workstation Edition)) - wget https://github.com/jgm/pandoc/releases/download/2.19.2/pandoc-2.19.2-linux-amd64.tar.gz - tar xf pandoc-2.19.2-linux-amd64.tar.gz - sudo mv -i pandoc-2.19.2/bin/pandoc /usr/local/bin + wget https://github.com/jgm/pandoc/releases/download/3.1.3/pandoc-3.1.3-linux-amd64.tar.gz + tar xf pandoc-3.1.3-linux-amd64.tar.gz + sudo mv -i pandoc-3.1.3/bin/pandoc /usr/local/bin sudo dnf install python3-pip pip install pandoc-tablenos --user export PATH=~/.local/bin:"$PATH" + # Temporary fix for version regex - see https://github.com/tomduck/pandoc-xnos/pull/29 + python -m pip install --force-reinstall \ + git+https://github.com/tomduck/pandoc-xnos@284474574f51888be75603e7d1df667a0890504d#egg=pandoc-xnos sudo dnf install librsvg2-tools.x86_64 sudo dnf install texlive-xetex sudo dnf install texlive-ctex.noarch @@ -35,22 +41,4 @@ On Fedora (tested on Fedora Linux 36 (Workstation Edition)) On Windows -Install https://github.com/jgm/pandoc/releases/download/2.18/pandoc-2.18-windows-x86_64.msi - -From command prompt run as administrator - - choco install make - choco install rsvg-convert - choco install python - choco install miktex - - pip install pandoc-tablenos --user - -From normal command prompt run from zint "docs" directory - - set "PATH=:%PATH%" - # e.g. set "PATH=%userprofile%\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.10_qbz5n2kfra8p0\LocalCache\local-packages\Python310\Scripts:%PATH%" - -TODO -??? Various font errors Helvetica, TeX Gyre Pagella which miktex can't handle (ok may be non-activated Windows issue) ??? -??? pandoc-tablenos filter craps out ??? + Not compatible. diff --git a/docs/manual.pmd b/docs/manual.pmd index 3ae3b170..c693c783 100644 --- a/docs/manual.pmd +++ b/docs/manual.pmd @@ -1959,6 +1959,9 @@ detailing the nature of the error. The errors generated by Zint are: -------------------------------------------------------------------------------- Return Value Meaning ----------------------------- ------------------------------------------------- +`ZINT_WARN_HRT_TRUNCATED` The Human Readable Text returned in `text` was + truncated (maximum 159 bytes). + `ZINT_WARN_INVALID_OPTION` One of the values in `zint_struct` was set incorrectly but Zint has made a guess at what it should have been and generated a barcode @@ -2010,6 +2013,9 @@ Return Value Meaning `ZINT_ERROR_NONCOMPLIANT` Returned if `warn_level` set to `WARN_FAIL_ALL` and `ZINT_WARN_NONCOMPLIANT` occurs. + +`ZINT_ERROR_HRT_TRUNCATED` Returned if `warn_level` set to `WARN_FAIL_ALL` + and `ZINT_WARN_HRT_TRUNCATED` occurs. -------------------------------------------------------------------------------- Table: {#tbl:api_warnings_errors tag=": API Warning and Error Return Values"} @@ -2791,6 +2797,8 @@ stop (`.`), space, asterisk (`*`), dollar (`$`), slash (`/`), plus (`+`) and percent (`%`). The standard does not require a check digit but a modulo-43 check digit can be added if desired by setting `--vers=1` (API `option_2 = 1`). +\clearpage + #### 6.1.7.2 Extended Code 39 ![`zint -b EXCODE39 --compliantheight -d "123.45$@fd"`](images/excode39.svg) @@ -3881,6 +3889,8 @@ Input ECC Error Correction Recovery Available for 3 Q Approx 55% of symbol Approx 25% M4 ---------------------------------------------------------------------- +Table: {#tbl:micrqr_eccs tag=": Micro QR ECC Levels"} + The defaults for symbol size and ECC level depend on the input and whether either of them is specified. diff --git a/docs/manual.txt b/docs/manual.txt index 55a65ecc..4ca506d6 100644 --- a/docs/manual.txt +++ b/docs/manual.txt @@ -1972,6 +1972,9 @@ detailing the nature of the error. The errors generated by Zint are: ------------------------------------------------------------------------------- Return Value Meaning ------------------------------ ------------------------------------------------ + ZINT_WARN_HRT_TRUNCATED The Human Readable Text returned in text was + truncated (maximum 159 bytes). + ZINT_WARN_INVALID_OPTION One of the values in zint_struct was set incorrectly but Zint has made a guess at what it should have been and generated a barcode @@ -2026,6 +2029,9 @@ detailing the nature of the error. The errors generated by Zint are: ZINT_ERROR_NONCOMPLIANT Returned if warn_level set to WARN_FAIL_ALL and ZINT_WARN_NONCOMPLIANT occurs. + + ZINT_ERROR_HRT_TRUNCATED Returned if warn_level set to WARN_FAIL_ALL and + ZINT_WARN_HRT_TRUNCATED occurs. ------------------------------------------------------------------------------- : Table : API Warning and Error Return Values: @@ -3746,6 +3752,8 @@ not available for any version, and ECC level Q is only available for version M4: 3 Q Approx 55% of symbol Approx 25% M4 ---------------------------------------------------------------------- + : Table : Micro QR ECC Levels: + The defaults for symbol size and ECC level depend on the input and whether either of them is specified. diff --git a/docs/zint.1 b/docs/zint.1 index 3ff17e30..b8632745 100644 --- a/docs/zint.1 +++ b/docs/zint.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pandoc 3.0.1 +.\" Automatically generated by Pandoc 3.1.3 .\" .\" Define V font for inline verbatim, using C font in formats .\" that render this, and otherwise B font.