zint-barcode-generator/docs
gitlost fcb3f9b422 GS1PARENS_MODE: allow parentheses in AI data if backslashed and
in `ESCAPE_MODE`
composite: empty primary now returns `ZINT_ERROR_INVALID_DATA`
  rather than `ZINT_ERROR_INVALID_OPTION`;
  check that primary NUL-terminated
library: check that `outfile` NUL-terminated
gs1: preface all routines and linters with "gs1_"
general: some code fiddling
2025-04-24 18:40:50 +01:00
..
images - Add new symbologies BARCODE_EAN8, BARCODE_EAN_2ADDON, 2025-04-16 22:26:43 +01:00
templates gs1/gs1_lint: update to latest gs1-syntax-dictionary, removing 2024-06-27 23:00:13 +01:00
inc_before_body_html.html Remove bitmap_byte_length member from zint_symbol 2023-07-18 11:11:50 +01:00
inc_before_body_pdf.tex GRIDMATRIX: default char set is GB 2312 only, not Latin-1 with GB 2312 alt 2022-05-19 10:17:51 +01:00
inc_header_pdf.tex Remove bitmap_byte_length member from zint_symbol 2023-07-18 11:11:50 +01:00
inc_header_txt.tex Update URL for manual (no longer ASPX) 2022-08-23 10:53:56 +01:00
Makefile - Add new symbologies BARCODE_EAN8, BARCODE_EAN_2ADDON, 2025-04-16 22:26:43 +01:00
manual.html GS1PARENS_MODE: allow parentheses in AI data if backslashed and 2025-04-24 18:40:50 +01:00
manual.pmd GS1PARENS_MODE: allow parentheses in AI data if backslashed and 2025-04-24 18:40:50 +01:00
manual.txt GS1PARENS_MODE: allow parentheses in AI data if backslashed and 2025-04-24 18:40:50 +01:00
README general: change BARCODE_RAW_TEXT to write to new zint_symbol 2025-03-28 10:02:19 +00:00
zint.1 GS1PARENS_MODE: allow parentheses in AI data if backslashed and 2025-04-24 18:40:50 +01:00
zint.1.pmd GS1PARENS_MODE: allow parentheses in AI data if backslashed and 2025-04-24 18:40:50 +01:00
zint_images.sh - Add new symbologies BARCODE_EAN8, BARCODE_EAN_2ADDON, 2025-04-16 22:26:43 +01:00
zint_org_uk.py Transition to Python script for HTML generation, also correcting pandoc theme issue 2022-07-19 17:11:33 +01:00
zint_org_uk.sh Harmonise manual versions and add auto-formatting tool for Zint.org.uk website 2022-07-19 12:33:51 +01:00

% docs/README 2025-03-28

For generation of "docs/manual.pdf" and "docs/manual.txt" from "manual.pmd" using a recent version of pandoc

On Ubuntu/Debian (tested on Ubuntu 22.04 and Ubuntu 24.04)

    wget https://github.com/jgm/pandoc/releases/download/3.6.4/pandoc-3.6.4-1-amd64.deb
    sudo dpkg -i pandoc-3.6.4-1-amd64.deb
For Ubuntu 22.04 (python < 3.12)
    sudo apt install python3-pip
    pip install pandoc-tablenos --user
Else for Ubuntu 24.04 (one way around "externally-managed-environment" error, PEP 668)
    sudo apt install python3-full
    python3 -m venv ~/py_envs
    source ~/py_envs/bin/activate
    pip install pandoc-tablenos
Then
    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 38 (Workstation Edition) and Fedora Linux 40 (Workstation Edition))

    wget https://github.com/jgm/pandoc/releases/download/3.6.4/pandoc-3.6.4-linux-amd64.tar.gz
    tar xf pandoc-3.6.4-linux-amd64.tar.gz
    sudo mv -i pandoc-3.6.4/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
    sudo dnf install texlive-framed.noarch
    sudo dnf install texlive-fvextra.noarch
    sudo dnf install texlive-mdwtools.noarch
    sudo dnf install texlive-sectsty.noarch
    sudo dnf install texlive-xecjk.noarch
    sudo dnf install texlive-tex-gyre.noarch
    sudo dnf install wqy-microhei-fonts.noarch
    make

On Windows

    Not compatible.