mirrors/zint
2
0
Fork 0
mirror of https://github.com/zint/zint synced 2024-11-16 20:57:25 +13:00
Code Issues Actions Packages Projects Releases Wiki Activity

general: use explicit float consts rather than calced ones

Browse Source 
manual: remove extra tags from "manual.txt" and clean up table
  captions
This commit is contained in:
gitlost
2024-01-09 18:38:21 +00:00
parent f3a982c1dd
commit cf04ac15b0
21 changed files with 174 additions and 136 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/Makefile
View File

@ -167,11 +167,14 @@ $(OUT_TXT) : $(SOURCE) $(SOURCE_MAN_PAGE) $(INCLUDES_TXT) Makefile
-V $(MAIN_FONT) -V $(MONO_FONT) -V $(CJK_FONT) \
$(TXT_OPTS) \
-o $(OUT_TXT)
# Indent Man Page sections in TOC, remove trailing spaces and echoed image tags
# Indent Man Page sections in TOC, remove trailing spaces, echoed image tags, tbl: hashes
# & clean up Table captions
sed -i \
-e 's/^\(- [A-Z][A-Z ]*\)$$/ \1/' \
-e 's/ *$$//' \
-e '/^\[.*\]$$/{N;N;s/\[\(.*\)\]\n\n\1/[\1]/;p;d}' \
-e 's/ *{#tbl:[^}]*}//' \
-e 's/: Table\xC2\xA0: \([^:]*\):/Table : \1/' \
$(OUT_TXT)
# Wrap
sed -i '/.\{81\}/{s/.\{80\}/&\n/}' $(OUT_TXT)

10
docs/README
View File

@ -2,8 +2,8 @@ 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/3.1.11/pandoc-3.1.11-1-amd64.deb
sudo dpkg -i pandoc-3.1.11-1-amd64.deb
wget https://github.com/jgm/pandoc/releases/download/3.1.11.1/pandoc-3.1.11.1-1-amd64.deb
sudo dpkg -i pandoc-3.1.11.1-1-amd64.deb
sudo apt install python3-pip
pip install pandoc-tablenos --user
export PATH=~/.local/bin:"$PATH"
@ -18,9 +18,9 @@ On Ubuntu/Debian (tested on Ubuntu 22.04)
On Fedora (tested on Fedora Linux 38 (Workstation Edition))
wget https://github.com/jgm/pandoc/releases/download/3.1.11/pandoc-3.1.11-linux-amd64.tar.gz
tar xf pandoc-3.1.11-linux-amd64.tar.gz
sudo mv -i pandoc-3.1.11/bin/pandoc /usr/local/bin
wget https://github.com/jgm/pandoc/releases/download/3.1.11.1/pandoc-3.1.11.1-linux-amd64.tar.gz
tar xf pandoc-3.1.11.1-linux-amd64.tar.gz
sudo mv -i pandoc-3.1.11.1/bin/pandoc /usr/local/bin
sudo dnf install python3-pip
pip install pandoc-tablenos --user
export PATH=~/.local/bin:"$PATH"

90
docs/manual.txt
View File

@ -593,7 +593,7 @@ meanings as given below:
* Insert leading asterisks
Any other character Interpreted literally
: Table : Sequence Format Characters:
Table : Sequence Format Characters
Once you’re happy with the Sequence Data, click the "Export..." button to bring
up the Export Dialog, discussed next.
@ -717,7 +717,7 @@ sequences are shown in the table below.
is hexadecimal (000000-10FFFF)
----------------------------------------------------------------------------
: Table : Escape Sequences:
Table : Escape Sequences
(Special escape sequences are available for Code 128 only to manually switch
Code Sets - see 6.1.10.1 Standard Code 128 (ISO 15417) for details.)
@ -761,7 +761,7 @@ The currently supported output file formats are shown in the following table.
tif Tagged Image File Format
txt Text file (see 4.19 Other Options)
: Table : Output File Formats:
Table : Output File Formats
The filename can contain directories and sub-directories also, which will be
created if they don’t already exist:
@ -999,7 +999,7 @@ underscores are optional.
146 BARCODE_BC412 IBM BC412 (SEMI T1-95)
------------------------------------------------------------------------------
: Table : Barcode Types (Symbologies):
Table : Barcode Types (Symbologies)
4.4 Adjusting Height
@ -1206,7 +1206,7 @@ To summarize the more intricate details:
Yes EMF 40 0.1 N/A
-------------------------------------------------------------------
: Table : Scaling Multipliers and Minima:
Table : Scaling Multipliers and Minima
4.9.1 Scaling by X-dimension and Resolution
@ -1325,7 +1325,7 @@ Latin-2 (ISO/IEC 8859-2 plus ASCII).
UPNQR Latin-2 N/A
All others ASCII N/A
: Table : Default Character Sets:
Table : Default Character Sets
If Zint encounters characters which can not be encoded using the default
character encoding then it will take advantage of the ECI (Extended Channel
@ -1375,7 +1375,7 @@ data. The symbologies that support ECI are
DotCode MicroPDF417 Ultracode
------------- -------------- -----------
: Table : ECI-Aware Symbologies:
Table : ECI-Aware Symbologies
Be aware that not all barcode readers support ECI mode, so this can sometimes
lead to unreadable barcodes. If you are using characters beyond those supported
@ -1422,7 +1422,7 @@ formatted. Zint automatically translates the data into the target encoding.
170 ISO/IEC 646 Invariant[6]
899 8-bit binary data
: Table : ECI Codes:
Table : ECI Codes
An ECI value of 0 does not encode any ECI information in the code symbol (unless
the data contains non-default character set characters). In this case, the
@ -1525,7 +1525,7 @@ characters in the output filename as shown in the table below:
@ Insert a number or * (or + on Windows)
Any other Insert literally
: Table : Batch Filename Formatting:
Table : Batch Filename Formatting
For instance
@ -1541,7 +1541,7 @@ The following table shows some examples to clarify this method:
-o my~~~bar.eps "my001bar.eps", "my002bar.eps", "my003bar.eps"
-o t#es~t~.png "t es0t1.png", "t es0t2.png", "t es0t3.png"
: Table : Batch Filename Examples:
Table : Batch Filename Examples
The special characters can span directories also, which is useful when creating
a large number of barcodes:
@ -1551,7 +1551,7 @@ a large number of barcodes:
-o dir~/file~~~.svg "dir0/file001.svg", "dir0/file002.svg", …
, "dir0/file999.svg", "dir1/file000.svg", …
: Table : Batch Directory Examples:
Table : Batch Directory Examples
For an alternative method of naming output files see the --mirror option in 4.14
Automatic Filenames below.
@ -2204,7 +2204,7 @@ the nature of the error. The errors generated by Zint are:
ZINT_WARN_HRT_TRUNCATED occurs.
------------------------------------------------------------------------------
: Table : API Warning and Error Return Values:
Table : API Warning and Error Return Values
To catch errors use an integer variable as shown in the code below:
@ -2562,7 +2562,7 @@ see which are set.
defined?
------------------------------------------------------------------------------
: Table : API Capability Flags:
Table : API Capability Flags
For example:
@ -2869,7 +2869,7 @@ below:
5 Modulo-11 (NCR)
6 Modulo-11 (NCR) & Modulo-10
: Table : MSI Plessey Check Digit Options:
Table : MSI Plessey Check Digit Options
To not show the check digit or digits in the Human Readable Text, add 10 to the
--vers value. For example --vers=12 (API option_2 = 12) will add two hidden
@ -3114,7 +3114,7 @@ and is of the form:
-----------------------------------------------------------------------
: Table : DPD Input Fields:
Table : DPD Input Fields
A warning will be generated if the Service Code, the Destination Country Code,
or the last 10 characters of the Tracking Number are non-numeric.
@ -3230,7 +3230,7 @@ the table below:
7 000000 576688
8 0000000 7742862
: Table : Channel Value Ranges:
Table : Channel Value Ranges
6.1.14 BC412 (SEMI T1-95)
@ -3463,7 +3463,7 @@ encoding methods. Valid values are shown below.
Expanded Stacked component
----------------------------------------------------------------------------
: Table : GS1 Composite Symbology Values:
Table : GS1 Composite Symbology Values
The data to be encoded in the linear component of a composite symbol should be
entered into a primary string with the data for the 2D component being entered
@ -3600,7 +3600,7 @@ shown in the following table.
23 99999999999999999999999 67-bar 62 N
---------------------------------------------------------------
: Table : Australia Post Input Formats:
Table : Australia Post Input Formats
6.5.1.2 Reply Paid Barcode
@ -3660,7 +3660,8 @@ the following table.
----------------------------------------------------------------------------
: Table : Royal Mail 4-State Mailmark Input Fields:
Table : Royal Mail 4-State Mailmark Input Fields
The 6 Destination+DPS (Destination Post Code plus Delivery Point Suffix)
patterns are:
@ -3670,7 +3671,8 @@ patterns are:
FFNFNLLNL FNNLLNLSS FNNNLLNLS
----------- ----------- -----------
: Table : Royal Mail Mailmark Destination+DPS Patterns:
Table : Royal Mail Mailmark Destination+DPS Patterns
where 'F' stands for full alphabetic (A-Z), 'L' for limited alphabetic (A-Z less
'CIKMOV'), 'N' for numeric (0-9), and 'S' for space.
@ -3757,7 +3759,7 @@ standards have now been removed from Zint.
9 26 x 26 19 88 x 88 29 16 x 36
10 32 x 32 20 96 x 96 30 16 x 48
: Table : Data Matrix Sizes:
Table : Data Matrix Sizes
The largest version 24 (144 x 144) can encode 3116 digits, around 2335
alphanumeric characters, or 1555 bytes of data.
@ -3781,7 +3783,7 @@ the following values as before:
38 12 x 88 47 26 x 48
39 16 x 64 48 26 x 64
: Table : DMRE Sizes:
Table : DMRE Sizes
DMRE symbol sizes may be activated in automatic size mode using the option
--dmre (API option_3 = DM_DMRE).
@ -3828,7 +3830,7 @@ section, as summarized below.
Reserved 6 Spaces
Customer Data 6, 45 or 29 Anything (Latin-1)
: Table : Royal Mail 2D Mailmark Input Fields:
Table : Royal Mail 2D Mailmark Input Fields
The 6 Destination+DPS (Destination Post Code plus Delivery Point Suffix)
patterns are the same as for the 4-state - see Table
@ -3841,7 +3843,7 @@ i.e.
FFNFNLL FNNLLSS FNNNLLS
--------- --------- ---------
: Table : Royal Mail 2D Mailmark RTS Patterns:
Table : Royal Mail 2D Mailmark RTS Patterns
where 'F' is full alphabetic (A-Z), 'L' limited alphabetic (A-Z less 'CIKMOV'),
'N' numeric (0-9), and 'S' space.
@ -3855,7 +3857,7 @@ optional customer data:
Type 9 32 x 32 45 characters 10
Type 29 16 x 48 29 characters 30
: Table : Royal Mail 2D Mailmark Sizes:
Table : Royal Mail 2D Mailmark Sizes
Zint will automatically select a size based on the amount of customer data, or
it can be specified using the --vers option (API option_2), which takes the Zint
@ -3882,7 +3884,7 @@ option_1) as shown in the following table.
3 Q Approx 55% of symbol Approx 25%
4 H Approx 65% of symbol Approx 30%
: Table : QR Code ECC Levels:
Table : QR Code ECC Levels
The size of the symbol can be specified by setting the --vers option (API
option_2) to the QR Code version required (1-40). The size of symbol generated
@ -3905,7 +3907,7 @@ is shown in the table below.
13 69 x 69 27 125 x 125
14 73 x 73 28 129 x 129
: Table : QR Code Sizes:
Table : QR Code Sizes
The maximum capacity of a QR Code symbol (version 40) is 7089 numeric digits,
4296 alphanumeric characters or 2953 bytes of data. QR Code symbols can also be
@ -3963,7 +3965,7 @@ that versions M1 and M2 have restrictions on what characters can be encoded.
4 M4 17 x 17 Latin-1 and Shift JIS
------------------------------------------------------------------
: Table : Micro QR Code Sizes:
Table : Micro QR Code Sizes
Version M4 can encode up to 35 digits, 21 alphanumerics, 15 bytes or 9 Kanji
characters.
@ -3983,7 +3985,7 @@ 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:
Table : Micro QR ECC Levels
The defaults for symbol size and ECC level depend on the input and whether
either of them is specified.
@ -4014,7 +4016,7 @@ valid for this type of symbol.
2 M Approx 37% of symbol Approx 15%
4 H Approx 65% of symbol Approx 30%
: Table : rMQR ECC Levels:
Table : rMQR ECC Levels
The preferred symbol sizes can be selected using the --vers option (API
option_2) as shown in the table below. Input values between 33 and 38 fix the
@ -4062,7 +4064,7 @@ height of the symbol while allowing Zint to determine the minimum symbol width.
19 R13x59 13 x 59 38 R17xW 17 x automatic width
------------------------------------------------------------------------------
: Table : rMQR Sizes:
Table : rMQR Sizes
The largest version R17x139 (32) can encode up to 361 digits, 219 alphanumerics,
150 bytes, or 92 Kanji characters.
@ -4113,7 +4115,7 @@ message required by Zint is given in the following table.
10 - 12 Three-digit country code according to ISO 3166-1.
13 - 15 Three-digit service code. This depends on your parcel courier.
: Table : MaxiCode Structured Carrier Message Format:
Table : MaxiCode Structured Carrier Message Format
The primary message can be set at the command prompt using the --primary switch
(API primary). The secondary message uses the normal data entry method. For
@ -4168,7 +4170,7 @@ Example maximum data lengths are given in the table below:
6 93 138 50
------------------------------------------------------------------------
: Table : MaxiCode Data Length Maxima:
Table : MaxiCode Data Length Maxima
* - secondary only
@ -4212,7 +4214,7 @@ a smaller bullseye pattern at the centre of the symbol.
11 45 x 45 23 95 x 95 35 147 x 147
12 49 x 49 24 101 x 101 36 151 x 151
: Table : Aztec Code Sizes:
Table : Aztec Code Sizes
Note that in symbols which have a specified size the amount of error correction
is dependent on the length of the data input and Zint will allow error
@ -4228,7 +4230,7 @@ the --secure option (API option_1) to a value from the following table.
3 >36% + 3 codewords
4 >50% + 3 codewords
: Table : Aztec Code Error Correction Modes:
Table : Aztec Code Error Correction Modes
It is not possible to select both symbol size and error correction capacity for
the same symbol. If both options are selected then the error correction capacity
@ -4288,7 +4290,7 @@ and variable-width versions (versions S and T). These can be selected by using
10 T width x 16 90 55
--------------------------------------------------------------
: Table : Code One Sizes:
Table : Code One Sizes
Version S symbols can only encode numeric data. The width of version S and
version T symbols is determined by the length of the input data.
@ -4326,7 +4328,7 @@ using the --secure option (API option_1), according to the following tables.
6 78 x 78 13 162 x 162
7 90 x 90
: Table : Grid Matrix Sizes:
Table : Grid Matrix Sizes
Mode Error Correction Capacity
------ ---------------------------
@ -4336,7 +4338,7 @@ using the --secure option (API option_1), according to the following tables.
4 Approximately 40%
5 Approximately 50%
: Table : Grid Matrix Error Correction Modes:
Table : Grid Matrix Error Correction Modes
Non-ASCII data density may be maximized by using the --fullmultibyte switch (API
option_3 = ZINT_FULL_MULTIBYTE), but check that your barcode reader supports
@ -4414,7 +4416,7 @@ to a value between 1 and 84 according to the following table.
27 75 x 75 55 131 x 131 83 187 x 187
28 77 x 77 56 133 x 133 84 189 x 189
: Table : Han Xin Sizes:
Table : Han Xin Sizes
The largest version (84) can encode 7827 digits, 4350 ASCII characters, up to
2175 Chinese characters, or 3261 bytes, making it the most capacious of all the
@ -4431,7 +4433,7 @@ following table.
3 Approx 23%
4 Approx 30%
: Table : Han Xin Error Correction Modes:
Table : Han Xin Error Correction Modes
Non-ASCII data density may be maximized by using the --fullmultibyte switch (API
option_3 = ZINT_FULL_MULTIBYTE), but check that your barcode reader supports
@ -4461,7 +4463,7 @@ modes are supported. The amount of error correction can be set using the
5 EC4 Approx 25%
6 EC5 Approx 33%
: Table : Ultracode Error Correction Values:
Table : Ultracode Error Correction Values
Zint does not currently implement data compression by default, but this can be
initiated through the API by setting
@ -4505,7 +4507,7 @@ generated using the characters A-E as shown in the table below.
D Used for Information Based Indicia (IBI) postage.
E Used for customized mail with a USPS Intelligent Mail barcode.
: Table : Valid FIM Characters:
Table : Valid FIM Characters
6.7.2 Flattermarken
@ -4695,7 +4697,7 @@ reproduced here for reference.
E SO RS . > N ^ n ~
F SI US / ? O _ o DEL
: Table : ASCII:
Table : ASCII
A.2 Latin Alphabet No. 1 (ISO/IEC 8859-1)
@ -4724,7 +4726,7 @@ defined.
E ® ¾ Î Þ î þ
F ¯ ¿ Ï ß ï ÿ
: Table : ISO/IEC 8859-1:
Table : ISO/IEC 8859-1
Annex B. Qt Backend QZint

2
docs/zint.1
View File

@ -1,4 +1,4 @@
.\" Automatically generated by Pandoc 3.1.11
.\" Automatically generated by Pandoc 3.1.11.1
.\"
.TH "ZINT" "1" "January 2024" "Version 2.13.0.9" ""
.SH NAME