mirror of
https://git.code.sf.net/p/zint/code
synced 2025-12-17 09:57:02 +00:00
Temporarily disable BARCODE_RAW_TEXT prior to 2.15.0 release, as
it's not stable yet. `text_length` is kept.
This commit is contained in:
gitlost
153
docs/manual.html
153
docs/manual.html
@@ -2379,11 +2379,12 @@ X-dimension at 600 dpi specify:</p>
|
||||
class="sourceCode bash"><code class="sourceCode bash"><span id="cb41-1"><a href="#cb41-1" aria-hidden="true" tabindex="-1"></a><span class="ex">zint</span> <span class="at">-b</span> MAXICODE <span class="at">-d</span> <span class="st">"MaxiCode (19 chars)"</span> <span class="at">--scalexdimdp</span><span class="op">=</span>0,600dpi</span></code></pre></div>
|
||||
<h2 id="human-readable-text-hrt-options">4.10 Human Readable Text (HRT)
|
||||
Options</h2>
|
||||
<p>For linear barcodes the text present in the output image can be
|
||||
removed by using the <code>--notext</code> option. Note also that for
|
||||
raster output text will not be printed for scales less than 1 (see <a
|
||||
href="#adjusting-image-size-x-dimension">4.9 Adjusting Image Size
|
||||
(X-dimension)</a>).</p>
|
||||
<p>For linear barcodes the text present<a href="#fn5"
|
||||
class="footnote-ref" id="fnref5" role="doc-noteref"><sup>5</sup></a> in
|
||||
the output image can be removed by using the <code>--notext</code>
|
||||
option. Note also that for raster output text will not be printed for
|
||||
scales less than 1 (see <a href="#adjusting-image-size-x-dimension">4.9
|
||||
Adjusting Image Size (X-dimension)</a>).</p>
|
||||
<p>Text can be set to bold using the <code>--bold</code> option, or a
|
||||
smaller font can be substituted using the <code>--small</code> option.
|
||||
The <code>--bold</code> and <code>--small</code> options can be used
|
||||
@@ -2497,8 +2498,8 @@ data-tag=": Default Character Sets">
|
||||
<tr>
|
||||
<td style="text-align: left;">Micro QR Code</td>
|
||||
<td style="text-align: left;">Latin-1</td>
|
||||
<td>Shift JIS (includes ASCII<a href="#fn5" class="footnote-ref"
|
||||
id="fnref5" role="doc-noteref"><sup>5</sup></a>)</td>
|
||||
<td>Shift JIS (includes ASCII<a href="#fn6" class="footnote-ref"
|
||||
id="fnref6" role="doc-noteref"><sup>6</sup></a>)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="text-align: left;">PDF417</td>
|
||||
@@ -2746,8 +2747,8 @@ translates the data into the target encoding.</p>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>170</td>
|
||||
<td>ISO/IEC 646 Invariant<a href="#fn6" class="footnote-ref" id="fnref6"
|
||||
role="doc-noteref"><sup>6</sup></a></td>
|
||||
<td>ISO/IEC 646 Invariant<a href="#fn7" class="footnote-ref" id="fnref7"
|
||||
role="doc-noteref"><sup>7</sup></a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>899</td>
|
||||
@@ -3332,8 +3333,8 @@ member <code>memfile</code> instead of to the output file
|
||||
<span id="cb64-16"><a href="#cb64-16" aria-hidden="true" tabindex="-1"></a><span class="op">}</span></span></code></pre></div>
|
||||
<p>will print the SVG output to <code>stdout</code> (the file
|
||||
<code>"mem.svg"</code> is not created). This is particularly useful for
|
||||
the textual formats EPS and SVG,<a href="#fn7" class="footnote-ref"
|
||||
id="fnref7" role="doc-noteref"><sup>7</sup></a> allowing the output to
|
||||
the textual formats EPS and SVG,<a href="#fn8" class="footnote-ref"
|
||||
id="fnref8" role="doc-noteref"><sup>8</sup></a> allowing the output to
|
||||
be manipulated and processed by the client.</p>
|
||||
<h2 id="setting-options">5.7 Setting Options</h2>
|
||||
<p>So far our application is not very useful unless we plan to only make
|
||||
@@ -3373,8 +3374,8 @@ href="#specifying-a-symbology">5.9 Specifying a Symbology</a>.</td>
|
||||
<td style="text-align: left;"><code>height</code></td>
|
||||
<td style="text-align: left;">float</td>
|
||||
<td style="text-align: left;">Symbol height in X-dimensions, excluding
|
||||
fixed width-to-height symbols.<a href="#fn8" class="footnote-ref"
|
||||
id="fnref8" role="doc-noteref"><sup>8</sup></a></td>
|
||||
fixed width-to-height symbols.<a href="#fn9" class="footnote-ref"
|
||||
id="fnref9" role="doc-noteref"><sup>9</sup></a></td>
|
||||
<td style="text-align: left;">Symbol dependent</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -3449,8 +3450,8 @@ resulting barcode symbol to. Must end in <code>.png</code>,
|
||||
<code>.gif</code>, <code>.bmp</code>, <code>.emf</code>,
|
||||
<code>.eps</code>, <code>.pcx</code>, <code>.svg</code>,
|
||||
<code>.tif</code> or <code>.txt</code> followed by a terminating
|
||||
<code>NUL</code>.<a href="#fn9" class="footnote-ref" id="fnref9"
|
||||
role="doc-noteref"><sup>9</sup></a></td>
|
||||
<code>NUL</code>.<a href="#fn10" class="footnote-ref" id="fnref10"
|
||||
role="doc-noteref"><sup>10</sup></a></td>
|
||||
<td style="text-align: left;"><code>"out.png"</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -3692,12 +3693,6 @@ data-tag=": API Warning and Error Return Values">
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td style="text-align: left;"><code>ZINT_WARN_HRT_RAW_TEXT</code></td>
|
||||
<td style="text-align: left;">The Human Readable Text returned in
|
||||
<code>text</code> was outputted as raw text (<code>output_options</code>
|
||||
set to <code>BARCODE_RAW_TEXT</code>).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="text-align: left;"><code>ZINT_WARN_HRT_TRUNCATED</code></td>
|
||||
<td style="text-align: left;">The Human Readable Text returned in
|
||||
<code>text</code> was truncated (maximum 255 bytes).</td>
|
||||
@@ -3790,12 +3785,6 @@ occurs.</td>
|
||||
<code>WARN_FAIL_ALL</code> and <code>ZINT_WARN_HRT_TRUNCATED</code>
|
||||
occurs.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="text-align: left;"><code>ZINT_ERROR_HRT_RAW_TEXT</code></td>
|
||||
<td style="text-align: left;">Returned if <code>warn_level</code> set to
|
||||
<code>WARN_FAIL_ALL</code> and <code>ZINT_WARN_HRT_RAW_TEXT</code>
|
||||
occurs.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
@@ -3864,15 +3853,15 @@ value:</p>
|
||||
<tr>
|
||||
<td style="text-align: left;"><code>BARCODE_BIND_TOP</code></td>
|
||||
<td style="text-align: left;">Boundary bar above the symbol only.<a
|
||||
href="#fn10" class="footnote-ref" id="fnref10"
|
||||
role="doc-noteref"><sup>10</sup></a></td>
|
||||
href="#fn11" class="footnote-ref" id="fnref11"
|
||||
role="doc-noteref"><sup>11</sup></a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="text-align: left;"><code>BARCODE_BIND</code></td>
|
||||
<td style="text-align: left;">Boundary bars above and below the symbol
|
||||
and between rows if stacking multiple symbols.<a href="#fn11"
|
||||
class="footnote-ref" id="fnref11"
|
||||
role="doc-noteref"><sup>11</sup></a></td>
|
||||
and between rows if stacking multiple symbols.<a href="#fn12"
|
||||
class="footnote-ref" id="fnref12"
|
||||
role="doc-noteref"><sup>12</sup></a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="text-align: left;"><code>BARCODE_BOX</code></td>
|
||||
@@ -3922,8 +3911,8 @@ Memory (raster)</a>.</td>
|
||||
<tr>
|
||||
<td style="text-align: left;"><code>BARCODE_QUIET_ZONES</code></td>
|
||||
<td style="text-align: left;">Add compliant quiet zones (additional to
|
||||
any specified whitespace).<a href="#fn12" class="footnote-ref"
|
||||
id="fnref12" role="doc-noteref"><sup>12</sup></a></td>
|
||||
any specified whitespace).<a href="#fn13" class="footnote-ref"
|
||||
id="fnref13" role="doc-noteref"><sup>13</sup></a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="text-align: left;"><code>BARCODE_NO_QUIET_ZONES</code></td>
|
||||
@@ -3952,18 +3941,6 @@ available for SVG output only.</td>
|
||||
<code>symbol->memfile</code> instead of to <code>outfile</code>
|
||||
file.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="text-align: left;"><code>BARCODE_RAW_TEXT</code></td>
|
||||
<td style="text-align: left;">Set HRT with no decoration,<a href="#fn13"
|
||||
class="footnote-ref" id="fnref13" role="doc-noteref"><sup>13</sup></a>
|
||||
complete with any control characters<a href="#fn14" class="footnote-ref"
|
||||
id="fnref14" role="doc-noteref"><sup>14</sup></a> and check
|
||||
characters,<a href="#fn15" class="footnote-ref" id="fnref15"
|
||||
role="doc-noteref"><sup>15</sup></a> and for all linear symbologies,
|
||||
including those that normally don’t set it.<a href="#fn16"
|
||||
class="footnote-ref" id="fnref16"
|
||||
role="doc-noteref"><sup>16</sup></a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
@@ -4225,8 +4202,8 @@ Text?</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="text-align: left;"><code>ZINT_CAP_EANUPC</code><a
|
||||
href="#fn17" class="footnote-ref" id="fnref17"
|
||||
role="doc-noteref"><sup>17</sup></a></td>
|
||||
href="#fn14" class="footnote-ref" id="fnref14"
|
||||
role="doc-noteref"><sup>14</sup></a></td>
|
||||
<td style="text-align: left;">Is the symbology EAN/UPC?</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -4901,8 +4878,8 @@ aria-hidden="true"><code>zint -b CODE128AB -d "130170X178"</code></figcaption>
|
||||
</figure>
|
||||
<p>It is sometimes advantageous to stop Code 128 from using Code Set C
|
||||
which compresses numerical data. The <code>BARCODE_CODE128AB</code><a
|
||||
href="#fn18" class="footnote-ref" id="fnref18"
|
||||
role="doc-noteref"><sup>18</sup></a> variant (symbology 60) suppresses
|
||||
href="#fn15" class="footnote-ref" id="fnref15"
|
||||
role="doc-noteref"><sup>15</sup></a> variant (symbology 60) suppresses
|
||||
Code Set C in favour of Code Sets A and B.</p>
|
||||
<p>Note that the special extra escapes mentioned above are not available
|
||||
for this variant (nor for any other).</p>
|
||||
@@ -5642,8 +5619,8 @@ the 6-digit version the first and last digit are ignored, leaving a
|
||||
2047. The second format <code>"NNN-NN"</code> represents the DX Extract
|
||||
as two numbers separated by a dash (<code>-</code>), the first number
|
||||
being 1 to 3 digits (range 1 to 127) and the second 1 to 2 digits (range
|
||||
0 to 15).<a href="#fn19" class="footnote-ref" id="fnref19"
|
||||
role="doc-noteref"><sup>19</sup></a></p>
|
||||
0 to 15).<a href="#fn16" class="footnote-ref" id="fnref16"
|
||||
role="doc-noteref"><sup>16</sup></a></p>
|
||||
<p>The optional frame number is a number in the range 0 to 63, and may
|
||||
have a half frame indicator <code>"A"</code> appended. Special character
|
||||
sequences (with or without a half frame indicator appended) may also be
|
||||
@@ -9534,68 +9511,58 @@ and SVG when <code>--nobackground</code> is given. For raster outputs
|
||||
GIF, PCX, PNG and TIF, the background’s alpha channel is set to zero
|
||||
(fully transparent).<a href="#fnref4" class="footnote-back"
|
||||
role="doc-backlink">↩︎</a></p></li>
|
||||
<li id="fn5"><p>Shift JIS (JIS X 0201 Roman) re-maps two ASCII
|
||||
<li id="fn5"><p>For linear barcodes, Human Readable Text (HRT) is not
|
||||
shown for the postal codes Australia Post (all variants), USPS
|
||||
Intelligent Mail, POSTNET and PLANET, Brazilian CEPNet, Royal Mail
|
||||
4-State Customer Code and 4-State Mailmark, Dutch Post KIX Code,
|
||||
Japanese Postal Code, DAFT Code and FIM, the pharma codes Pharmacode
|
||||
One-Track and Pharmacode Two-Track, and the specialist codes DX Film
|
||||
Edge Barcode and Flattermarken. Note that HRT is never shown for stacked
|
||||
and matrix barcodes.<a href="#fnref5" class="footnote-back"
|
||||
role="doc-backlink">↩︎</a></p></li>
|
||||
<li id="fn6"><p>Shift JIS (JIS X 0201 Roman) re-maps two ASCII
|
||||
characters: backslash (<code>\</code>) to the yen sign (¥), and tilde
|
||||
(<code>~</code>) to overline (U+203E).<a href="#fnref5"
|
||||
(<code>~</code>) to overline (U+203E).<a href="#fnref6"
|
||||
class="footnote-back" role="doc-backlink">↩︎</a></p></li>
|
||||
<li id="fn6"><p>ISO/IEC 646 Invariant is a subset of ASCII with 12
|
||||
<li id="fn7"><p>ISO/IEC 646 Invariant is a subset of ASCII with 12
|
||||
characters undefined: <code>#</code>, <code>$</code>, <code>@</code>,
|
||||
<code>[</code>, <code>\</code>, <code>]</code>, <code>^</code>,
|
||||
<code>`</code>, <code>{</code>, <code>|</code>, <code>}</code>,
|
||||
<code>~</code>.<a href="#fnref6" class="footnote-back"
|
||||
<code>~</code>.<a href="#fnref7" class="footnote-back"
|
||||
role="doc-backlink">↩︎</a></p></li>
|
||||
<li id="fn7"><p>BARCODE_MEMORY_FILE textual formats EPS and SVG will
|
||||
<li id="fn8"><p>BARCODE_MEMORY_FILE textual formats EPS and SVG will
|
||||
have Unix newlines (LF) on both Windows and Unix, i.e. not CR+LF on
|
||||
Windows.<a href="#fnref7" class="footnote-back"
|
||||
Windows.<a href="#fnref8" class="footnote-back"
|
||||
role="doc-backlink">↩︎</a></p></li>
|
||||
<li id="fn8"><p>The <code>height</code> value is ignored for Aztec
|
||||
<li id="fn9"><p>The <code>height</code> value is ignored for Aztec
|
||||
(including HIBC and Aztec Rune), Code One, Data Matrix (including HIBC),
|
||||
DotCode, Grid Matrix, Han Xin, MaxiCode, QR Code (including HIBC, Micro
|
||||
QR, rMQR and UPNQR), and Ultracode - all of which have a fixed
|
||||
width-to-height ratio (or, in the case of Code One, a fixed height).<a
|
||||
href="#fnref8" class="footnote-back" role="doc-backlink">↩︎</a></p></li>
|
||||
<li id="fn9"><p>For Windows, <code>outfile</code> is assumed to be UTF-8
|
||||
encoded.<a href="#fnref9" class="footnote-back"
|
||||
href="#fnref9" class="footnote-back" role="doc-backlink">↩︎</a></p></li>
|
||||
<li id="fn10"><p>For Windows, <code>outfile</code> is assumed to be
|
||||
UTF-8 encoded.<a href="#fnref10" class="footnote-back"
|
||||
role="doc-backlink">↩︎</a></p></li>
|
||||
<li id="fn10"><p>The <code>BARCODE_BIND_TOP</code> flag is set by
|
||||
<li id="fn11"><p>The <code>BARCODE_BIND_TOP</code> flag is set by
|
||||
default for DPD - see <a href="#dpd-code">6.1.10.7 DPD Code</a>.<a
|
||||
href="#fnref10" class="footnote-back" role="doc-backlink">↩︎</a></p></li>
|
||||
<li id="fn11"><p>The <code>BARCODE_BIND</code> flag is always set for
|
||||
href="#fnref11" class="footnote-back" role="doc-backlink">↩︎</a></p></li>
|
||||
<li id="fn12"><p>The <code>BARCODE_BIND</code> flag is always set for
|
||||
Codablock-F, Code 16K and Code 49. Special considerations apply to
|
||||
ITF-14 - see <a href="#itf-14">6.1.2.6 ITF-14</a>.<a href="#fnref11"
|
||||
ITF-14 - see <a href="#itf-14">6.1.2.6 ITF-14</a>.<a href="#fnref12"
|
||||
class="footnote-back" role="doc-backlink">↩︎</a></p></li>
|
||||
<li id="fn12"><p>Codablock-F, Code 16K, Code 49, EAN-2 to EAN-13, ISBN,
|
||||
<li id="fn13"><p>Codablock-F, Code 16K, Code 49, EAN-2 to EAN-13, ISBN,
|
||||
ITF-14, UPC-A and UPC-E have compliant quiet zones added by default.<a
|
||||
href="#fnref12" class="footnote-back" role="doc-backlink">↩︎</a></p></li>
|
||||
<li id="fn13"><p>In particular no parentheses will appear in the HRT for
|
||||
GS1 symbologies, and <code>GS</code> separators will be added as
|
||||
required. However for EAN/UPC symbologies, any add-on data will be
|
||||
separated by a <code>+</code> character as usual.<a href="#fnref13"
|
||||
class="footnote-back" role="doc-backlink">↩︎</a></p></li>
|
||||
<li id="fn14"><p>Normally control characters (including
|
||||
<code>DEL</code>) and non-ISO/IEC 8859-1 are replaced by spaces in the
|
||||
HRT.<a href="#fnref14" class="footnote-back"
|
||||
role="doc-backlink">↩︎</a></p></li>
|
||||
<li id="fn15"><p>Except for Japanese Postal Code, whose check character
|
||||
is not truly representable in HRT.<a href="#fnref15"
|
||||
class="footnote-back" role="doc-backlink">↩︎</a></p></li>
|
||||
<li id="fn16"><p>HRT is normally not set for the postal codes Australia
|
||||
Post (all variants), USPS Intelligent Mail, POSTNET and PLANET,
|
||||
Brazilian CEPNet, Royal Mail 4-State Customer Code and 4-State Mailmark,
|
||||
Dutch Post KIX Code, Japanese Postal Code, DAFT Code and FIM, the pharma
|
||||
codes Pharmacode One-Track and Pharmacode Two-Track, and DX Film Edge
|
||||
Barcode and Flattermarken.<a href="#fnref16" class="footnote-back"
|
||||
role="doc-backlink">↩︎</a></p></li>
|
||||
<li id="fn17"><p><code>ZINT_CAP_EANUPC</code> was previously named
|
||||
href="#fnref13" class="footnote-back" role="doc-backlink">↩︎</a></p></li>
|
||||
<li id="fn14"><p><code>ZINT_CAP_EANUPC</code> was previously named
|
||||
<code>ZINT_CAP_EXTENDABLE</code>, which is still recognised.<a
|
||||
href="#fnref17" class="footnote-back" role="doc-backlink">↩︎</a></p></li>
|
||||
<li id="fn18"><p><code>BARCODE_CODE128AB</code> previously used the name
|
||||
href="#fnref14" class="footnote-back" role="doc-backlink">↩︎</a></p></li>
|
||||
<li id="fn15"><p><code>BARCODE_CODE128AB</code> previously used the name
|
||||
<code>BARCODE_CODE128B</code>, which is still recognised.<a
|
||||
href="#fnref18" class="footnote-back" role="doc-backlink">↩︎</a></p></li>
|
||||
<li id="fn19"><p>The DX number may be looked up in The (Modified) Big
|
||||
href="#fnref15" class="footnote-back" role="doc-backlink">↩︎</a></p></li>
|
||||
<li id="fn16"><p>The DX number may be looked up in The (Modified) Big
|
||||
Film Database at <a
|
||||
href="https://thebigfilmdatabase.merinorus.com">https://thebigfilmdatabase.merinorus.com</a>.<a
|
||||
href="#fnref19" class="footnote-back" role="doc-backlink">↩︎</a></p></li>
|
||||
href="#fnref16" class="footnote-back" role="doc-backlink">↩︎</a></p></li>
|
||||
</ol>
|
||||
</section>
|
||||
</body>
|
||||
|
||||
@@ -1186,9 +1186,9 @@ zint -b MAXICODE -d "MaxiCode (19 chars)" --scalexdimdp=0,600dpi
|
||||
|
||||
## 4.10 Human Readable Text (HRT) Options
|
||||
|
||||
For linear barcodes the text present in the output image can be removed by using
|
||||
the `--notext` option. Note also that for raster output text will not be printed
|
||||
for scales less than 1 (see [4.9 Adjusting Image Size (X-dimension)]).
|
||||
For linear barcodes the text present[^5] in the output image can be removed by
|
||||
using the `--notext` option. Note also that for raster output text will not be
|
||||
printed for scales less than 1 (see [4.9 Adjusting Image Size (X-dimension)]).
|
||||
|
||||
Text can be set to bold using the `--bold` option, or a smaller font can be
|
||||
substituted using the `--small` option. The `--bold` and `--small` options can
|
||||
@@ -1210,6 +1210,14 @@ for all others) can be embedded in the file for portability using the
|
||||
|
||||
{.lin}
|
||||
|
||||
[^5]: For linear barcodes, Human Readable Text (HRT) is not shown for the postal
|
||||
codes Australia Post (all variants), USPS Intelligent Mail, POSTNET and PLANET,
|
||||
Brazilian CEPNet, Royal Mail 4-State Customer Code and 4-State Mailmark, Dutch
|
||||
Post KIX Code, Japanese Postal Code, DAFT Code and FIM, the pharma codes
|
||||
Pharmacode One-Track and Pharmacode Two-Track, and the specialist codes DX Film
|
||||
Edge Barcode and Flattermarken. Note that HRT is never shown for stacked and
|
||||
matrix barcodes.
|
||||
|
||||
## 4.11 Input Modes
|
||||
|
||||
### 4.11.1 Unicode, Data, and GS1 Modes
|
||||
@@ -1238,7 +1246,7 @@ Grid Matrix GB 2312 (includes ASCII) N/A
|
||||
Han Xin Latin-1 GB 18030 (includes ASCII)
|
||||
MaxiCode Latin-1 None
|
||||
MicroPDF417 Latin-1 None
|
||||
Micro QR Code Latin-1 Shift JIS (includes ASCII[^5])
|
||||
Micro QR Code Latin-1 Shift JIS (includes ASCII[^6])
|
||||
PDF417 Latin-1 None
|
||||
QR Code Latin-1 Shift JIS (see above)
|
||||
rMQR Latin-1 Shift JIS (see above)
|
||||
@@ -1248,7 +1256,7 @@ All others ASCII N/A
|
||||
|
||||
Table: {#tbl:default_character_sets tag=": Default Character Sets"}
|
||||
|
||||
[^5]: Shift JIS (JIS X 0201 Roman) re-maps two ASCII characters: backslash (`\`)
|
||||
[^6]: Shift JIS (JIS X 0201 Roman) re-maps two ASCII characters: backslash (`\`)
|
||||
to the yen sign (¥), and tilde (`~`) to overline (U+203E).
|
||||
|
||||
If Zint encounters characters which can not be encoded using the default
|
||||
@@ -1343,12 +1351,12 @@ ECI Code Character Encoding Scheme (ISO/IEC 8859 schemes include ASCII)
|
||||
33 UTF-16LE (Low order byte first)
|
||||
34 UTF-32BE (High order bytes first)
|
||||
35 UTF-32LE (Low order bytes first)
|
||||
170 ISO/IEC 646 Invariant[^6]
|
||||
170 ISO/IEC 646 Invariant[^7]
|
||||
899 8-bit binary data
|
||||
|
||||
Table: {#tbl:eci_codes tag=": ECI Codes"}
|
||||
|
||||
[^6]: ISO/IEC 646 Invariant is a subset of ASCII with 12 characters undefined:
|
||||
[^7]: ISO/IEC 646 Invariant is a subset of ASCII with 12 characters undefined:
|
||||
`#`, `$`, `@`, `[`, `\`, `]`, `^`, `` ` ``, `{`, `|`, `}`, `~`.
|
||||
|
||||
An ECI value of 0 does not encode any ECI information in the code symbol (unless
|
||||
@@ -1907,10 +1915,10 @@ int main(int argc, char **argv)
|
||||
```
|
||||
|
||||
will print the SVG output to `stdout` (the file `"mem.svg"` is not created).
|
||||
This is particularly useful for the textual formats EPS and SVG,[^7] allowing
|
||||
This is particularly useful for the textual formats EPS and SVG,[^8] allowing
|
||||
the output to be manipulated and processed by the client.
|
||||
|
||||
[^7]: BARCODE_MEMORY_FILE textual formats EPS and SVG will have Unix newlines
|
||||
[^8]: BARCODE_MEMORY_FILE textual formats EPS and SVG will have Unix newlines
|
||||
(LF) on both Windows and Unix, i.e. not CR+LF on Windows.
|
||||
|
||||
## 5.7 Setting Options
|
||||
@@ -1931,7 +1939,7 @@ Member Name Type Meaning Default Value
|
||||
`height` float Symbol height in Symbol dependent
|
||||
X-dimensions, excluding
|
||||
fixed width-to-height
|
||||
symbols.[^8]
|
||||
symbols.[^9]
|
||||
|
||||
`scale` float Scale factor for 1.0
|
||||
adjusting size of image
|
||||
@@ -1981,7 +1989,7 @@ Member Name Type Meaning Default Value
|
||||
`.eps`, `.pcx`, `.svg`,
|
||||
`.tif` or `.txt` followed
|
||||
by a terminating
|
||||
`NUL`.[^9]
|
||||
`NUL`.[^10]
|
||||
|
||||
`primary` character Primary message data for `""` (empty)
|
||||
string more complex symbols,
|
||||
@@ -2100,13 +2108,13 @@ Member Name Type Meaning Default Value
|
||||
|
||||
Table: API Structure `zint_symbol` {#tbl:api_structure_zint_symbol tag="$ $"}
|
||||
|
||||
[^8]: The `height` value is ignored for Aztec (including HIBC and Aztec Rune),
|
||||
[^9]: The `height` value is ignored for Aztec (including HIBC and Aztec Rune),
|
||||
Code One, Data Matrix (including HIBC), DotCode, Grid Matrix, Han Xin, MaxiCode,
|
||||
QR Code (including HIBC, Micro QR, rMQR and UPNQR), and Ultracode - all of which
|
||||
have a fixed width-to-height ratio (or, in the case of Code One, a fixed
|
||||
height).
|
||||
|
||||
[^9]: For Windows, `outfile` is assumed to be UTF-8 encoded.
|
||||
[^10]: For Windows, `outfile` is assumed to be UTF-8 encoded.
|
||||
|
||||
To alter these values use the syntax shown in the example below. This code has
|
||||
the same result as the previous example except the output is now taller and
|
||||
@@ -2146,10 +2154,6 @@ detailing the nature of the error. The errors generated by Zint are:
|
||||
------------------------------------------------------------------------------
|
||||
Return Value Meaning
|
||||
----------------------------- -----------------------------------------------
|
||||
`ZINT_WARN_HRT_RAW_TEXT` The Human Readable Text returned in `text` was
|
||||
outputted as raw text (`output_options` set to
|
||||
`BARCODE_RAW_TEXT`).
|
||||
|
||||
`ZINT_WARN_HRT_TRUNCATED` The Human Readable Text returned in `text` was
|
||||
truncated (maximum 255 bytes).
|
||||
|
||||
@@ -2211,9 +2215,6 @@ Return Value Meaning
|
||||
|
||||
`ZINT_ERROR_HRT_TRUNCATED` Returned if `warn_level` set to `WARN_FAIL_ALL`
|
||||
and `ZINT_WARN_HRT_TRUNCATED` occurs.
|
||||
|
||||
`ZINT_ERROR_HRT_RAW_TEXT` Returned if `warn_level` set to `WARN_FAIL_ALL`
|
||||
and `ZINT_WARN_HRT_RAW_TEXT` occurs.
|
||||
------------------------------------------------------------------------------
|
||||
|
||||
Table: {#tbl:api_warnings_errors tag=": API Warning and Error Return Values"}
|
||||
@@ -2285,10 +2286,10 @@ Value Effect
|
||||
------------------------- ---------------------------------------------------
|
||||
0 No options selected.
|
||||
|
||||
`BARCODE_BIND_TOP` Boundary bar above the symbol only.[^10]
|
||||
`BARCODE_BIND_TOP` Boundary bar above the symbol only.[^11]
|
||||
|
||||
`BARCODE_BIND` Boundary bars above and below the symbol and
|
||||
between rows if stacking multiple symbols.[^11]
|
||||
between rows if stacking multiple symbols.[^12]
|
||||
|
||||
`BARCODE_BOX` Add a box surrounding the symbol and whitespace.
|
||||
|
||||
@@ -2315,7 +2316,7 @@ Value Effect
|
||||
Symbols in Memory (raster)].
|
||||
|
||||
`BARCODE_QUIET_ZONES` Add compliant quiet zones (additional to any
|
||||
specified whitespace).[^12]
|
||||
specified whitespace).[^13]
|
||||
|
||||
`BARCODE_NO_QUIET_ZONES` Disable quiet zones, notably those with defaults.
|
||||
|
||||
@@ -2330,40 +2331,19 @@ Value Effect
|
||||
|
||||
`BARCODE_MEMORY_FILE` Write output to in-memory buffer `symbol->memfile`
|
||||
instead of to `outfile` file.
|
||||
|
||||
`BARCODE_RAW_TEXT` Set HRT with no decoration,[^13] complete with any
|
||||
control characters[^14] and check characters,[^15]
|
||||
and for all linear symbologies, including those
|
||||
that normally don't set it.[^16]
|
||||
------------------------------------------------------------------------------
|
||||
|
||||
Table: API `output_options` Values {#tbl:api_output_options tag="$ $"}
|
||||
|
||||
[^10]: The `BARCODE_BIND_TOP` flag is set by default for DPD - see [6.1.10.7 DPD
|
||||
[^11]: The `BARCODE_BIND_TOP` flag is set by default for DPD - see [6.1.10.7 DPD
|
||||
Code].
|
||||
|
||||
[^11]: The `BARCODE_BIND` flag is always set for Codablock-F, Code 16K and Code
|
||||
[^12]: The `BARCODE_BIND` flag is always set for Codablock-F, Code 16K and Code
|
||||
49. Special considerations apply to ITF-14 - see [6.1.2.6 ITF-14].
|
||||
|
||||
[^12]: Codablock-F, Code 16K, Code 49, EAN-2 to EAN-13, ISBN, ITF-14, UPC-A and
|
||||
[^13]: Codablock-F, Code 16K, Code 49, EAN-2 to EAN-13, ISBN, ITF-14, UPC-A and
|
||||
UPC-E have compliant quiet zones added by default.
|
||||
|
||||
[^13]: In particular no parentheses will appear in the HRT for GS1 symbologies,
|
||||
and `GS` separators will be added as required. However for EAN/UPC symbologies,
|
||||
any add-on data will be separated by a `+` character as usual.
|
||||
|
||||
[^14]: Normally control characters (including `DEL`) and non-ISO/IEC 8859-1 are
|
||||
replaced by spaces in the HRT.
|
||||
|
||||
[^15]: Except for Japanese Postal Code, whose check character is not truly
|
||||
representable in HRT.
|
||||
|
||||
[^16]: HRT is normally not set for the postal codes Australia Post (all
|
||||
variants), USPS Intelligent Mail, POSTNET and PLANET, Brazilian CEPNet, Royal
|
||||
Mail 4-State Customer Code and 4-State Mailmark, Dutch Post KIX Code, Japanese
|
||||
Postal Code, DAFT Code and FIM, the pharma codes Pharmacode One-Track and
|
||||
Pharmacode Two-Track, and DX Film Edge Barcode and Flattermarken.
|
||||
|
||||
## 5.11 Setting the Input Mode
|
||||
|
||||
The way in which the input data is encoded can be set using the `input_mode`
|
||||
@@ -2616,7 +2596,7 @@ Value Meaning
|
||||
|
||||
`ZINT_CAP_STACKABLE` Is the symbology stackable?
|
||||
|
||||
`ZINT_CAP_EANUPC`[^17] Is the symbology EAN/UPC?
|
||||
`ZINT_CAP_EANUPC`[^14] Is the symbology EAN/UPC?
|
||||
|
||||
`ZINT_CAP_COMPOSITE` Does the symbology support composite data? (see
|
||||
[6.3 GS1 Composite Symbols (ISO 24723)] below)
|
||||
@@ -2647,7 +2627,7 @@ Value Meaning
|
||||
|
||||
Table: {#tbl:api_cap tag=": API Capability Flags"}
|
||||
|
||||
[^17]: `ZINT_CAP_EANUPC` was previously named `ZINT_CAP_EXTENDABLE`, which is
|
||||
[^14]: `ZINT_CAP_EANUPC` was previously named `ZINT_CAP_EXTENDABLE`, which is
|
||||
still recognised.
|
||||
|
||||
For example:
|
||||
@@ -3190,13 +3170,13 @@ alphanumerics) are not recommended.
|
||||
{.lin}
|
||||
|
||||
It is sometimes advantageous to stop Code 128 from using Code Set C which
|
||||
compresses numerical data. The `BARCODE_CODE128AB`[^18] variant (symbology 60)
|
||||
compresses numerical data. The `BARCODE_CODE128AB`[^15] variant (symbology 60)
|
||||
suppresses Code Set C in favour of Code Sets A and B.
|
||||
|
||||
Note that the special extra escapes mentioned above are not available for this
|
||||
variant (nor for any other).
|
||||
|
||||
[^18]: `BARCODE_CODE128AB` previously used the name `BARCODE_CODE128B`, which is
|
||||
[^15]: `BARCODE_CODE128AB` previously used the name `BARCODE_CODE128B`, which is
|
||||
still recognised.
|
||||
|
||||
#### 6.1.10.3 GS1-128
|
||||
@@ -3788,7 +3768,7 @@ first and last digit are ignored, leaving a 4-digit DX Extract number in any
|
||||
case, which must be in the range 16 to 2047. The second format `"NNN-NN"`
|
||||
represents the DX Extract as two numbers separated by a dash (`-`), the first
|
||||
number being 1 to 3 digits (range 1 to 127) and the second 1 to 2 digits (range
|
||||
0 to 15).[^19]
|
||||
0 to 15).[^16]
|
||||
|
||||
The optional frame number is a number in the range 0 to 63, and may have a half
|
||||
frame indicator `"A"` appended. Special character sequences (with or without a
|
||||
@@ -3798,7 +3778,7 @@ number 62, `"K"` or `"00"` means frame number 63, and `"F"` means frame number
|
||||
|
||||
A parity bit is automatically added by Zint.
|
||||
|
||||
[^19]: The DX number may be looked up in The (Modified) Big Film Database at
|
||||
[^16]: The DX number may be looked up in The (Modified) Big Film Database at
|
||||
[https://thebigfilmdatabase.merinorus.com](
|
||||
https://thebigfilmdatabase.merinorus.com).
|
||||
|
||||
|
||||
@@ -1268,9 +1268,9 @@ MaxiCode symbols have fixed size ranges of 24.82mm to 27.93mm in width, and
|
||||
|
||||
4.10 Human Readable Text (HRT) Options
|
||||
|
||||
For linear barcodes the text present in the output image can be removed by using
|
||||
the --notext option. Note also that for raster output text will not be printed
|
||||
for scales less than 1 (see 4.9 Adjusting Image Size (X-dimension)).
|
||||
For linear barcodes the text present[5] in the output image can be removed by
|
||||
using the --notext option. Note also that for raster output text will not be
|
||||
printed for scales less than 1 (see 4.9 Adjusting Image Size (X-dimension)).
|
||||
|
||||
Text can be set to bold using the --bold option, or a smaller font can be
|
||||
substituted using the --small option. The --bold and --small options can be used
|
||||
@@ -1320,7 +1320,7 @@ Latin-2 (ISO/IEC 8859-2 plus ASCII).
|
||||
Han Xin Latin-1 GB 18030 (includes ASCII)
|
||||
MaxiCode Latin-1 None
|
||||
MicroPDF417 Latin-1 None
|
||||
Micro QR Code Latin-1 Shift JIS (includes ASCII[5])
|
||||
Micro QR Code Latin-1 Shift JIS (includes ASCII[6])
|
||||
PDF417 Latin-1 None
|
||||
QR Code Latin-1 Shift JIS (see above)
|
||||
rMQR Latin-1 Shift JIS (see above)
|
||||
@@ -1422,7 +1422,7 @@ formatted. Zint automatically translates the data into the target encoding.
|
||||
33 UTF-16LE (Low order byte first)
|
||||
34 UTF-32BE (High order bytes first)
|
||||
35 UTF-32LE (Low order bytes first)
|
||||
170 ISO/IEC 646 Invariant[6]
|
||||
170 ISO/IEC 646 Invariant[7]
|
||||
899 8-bit binary data
|
||||
|
||||
Table : ECI Codes
|
||||
@@ -1929,7 +1929,7 @@ the buffer is given in memfile_size. For instance:
|
||||
}
|
||||
|
||||
will print the SVG output to stdout (the file "mem.svg" is not created). This is
|
||||
particularly useful for the textual formats EPS and SVG,[7] allowing the output
|
||||
particularly useful for the textual formats EPS and SVG,[8] allowing the output
|
||||
to be manipulated and processed by the client.
|
||||
|
||||
5.7 Setting Options
|
||||
@@ -1950,7 +1950,7 @@ the following members:
|
||||
height float Symbol height in Symbol dependent
|
||||
X-dimensions, excluding
|
||||
fixed width-to-height
|
||||
symbols.[8]
|
||||
symbols.[9]
|
||||
|
||||
scale float Scale factor for adjusting 1.0
|
||||
size of image (sets
|
||||
@@ -1997,7 +1997,7 @@ the following members:
|
||||
end in .png, .gif, .bmp,
|
||||
.emf, .eps, .pcx, .svg,
|
||||
.tif or .txt followed by a
|
||||
terminating NUL.[9]
|
||||
terminating NUL.[10]
|
||||
|
||||
primary character Primary message data for "" (empty)
|
||||
string more complex symbols, with
|
||||
@@ -2146,10 +2146,6 @@ the nature of the error. The errors generated by Zint are:
|
||||
------------------------------------------------------------------------------
|
||||
Return Value Meaning
|
||||
------------------------------ -----------------------------------------------
|
||||
ZINT_WARN_HRT_RAW_TEXT The Human Readable Text returned in text was
|
||||
outputted as raw text (output_options set to
|
||||
BARCODE_RAW_TEXT).
|
||||
|
||||
ZINT_WARN_HRT_TRUNCATED The Human Readable Text returned in text was
|
||||
truncated (maximum 255 bytes).
|
||||
|
||||
@@ -2211,9 +2207,6 @@ the nature of the error. The errors generated by Zint are:
|
||||
|
||||
ZINT_ERROR_HRT_TRUNCATED Returned if warn_level set to WARN_FAIL_ALL and
|
||||
ZINT_WARN_HRT_TRUNCATED occurs.
|
||||
|
||||
ZINT_ERROR_HRT_RAW_TEXT Returned if warn_level set to WARN_FAIL_ALL and
|
||||
ZINT_WARN_HRT_RAW_TEXT occurs.
|
||||
------------------------------------------------------------------------------
|
||||
|
||||
Table : API Warning and Error Return Values
|
||||
@@ -2275,10 +2268,10 @@ together when adjusting this value:
|
||||
-------------------------- ---------------------------------------------------
|
||||
0 No options selected.
|
||||
|
||||
BARCODE_BIND_TOP Boundary bar above the symbol only.[10]
|
||||
BARCODE_BIND_TOP Boundary bar above the symbol only.[11]
|
||||
|
||||
BARCODE_BIND Boundary bars above and below the symbol and
|
||||
between rows if stacking multiple symbols.[11]
|
||||
between rows if stacking multiple symbols.[12]
|
||||
|
||||
BARCODE_BOX Add a box surrounding the symbol and whitespace.
|
||||
|
||||
@@ -2305,7 +2298,7 @@ together when adjusting this value:
|
||||
Symbols in Memory (raster).
|
||||
|
||||
BARCODE_QUIET_ZONES Add compliant quiet zones (additional to any
|
||||
specified whitespace).[12]
|
||||
specified whitespace).[13]
|
||||
|
||||
BARCODE_NO_QUIET_ZONES Disable quiet zones, notably those with defaults.
|
||||
|
||||
@@ -2320,11 +2313,6 @@ together when adjusting this value:
|
||||
|
||||
BARCODE_MEMORY_FILE Write output to in-memory buffer symbol->memfile
|
||||
instead of to outfile file.
|
||||
|
||||
BARCODE_RAW_TEXT Set HRT with no decoration,[13] complete with any
|
||||
control characters[14] and check characters,[15]
|
||||
and for all linear symbologies, including those
|
||||
that normally don’t set it.[16]
|
||||
------------------------------------------------------------------------------
|
||||
|
||||
: Table : API output_options Values
|
||||
@@ -2553,7 +2541,7 @@ see which are set.
|
||||
|
||||
ZINT_CAP_STACKABLE Is the symbology stackable?
|
||||
|
||||
ZINT_CAP_EANUPC[17] Is the symbology EAN/UPC?
|
||||
ZINT_CAP_EANUPC[14] Is the symbology EAN/UPC?
|
||||
|
||||
ZINT_CAP_COMPOSITE Does the symbology support composite data? (see
|
||||
6.3 GS1 Composite Symbols (ISO 24723) below)
|
||||
@@ -3069,7 +3057,7 @@ alphanumerics) are not recommended.
|
||||
[zint -b CODE128AB -d "130170X178"]
|
||||
|
||||
It is sometimes advantageous to stop Code 128 from using Code Set C which
|
||||
compresses numerical data. The BARCODE_CODE128AB[18] variant (symbology 60)
|
||||
compresses numerical data. The BARCODE_CODE128AB[15] variant (symbology 60)
|
||||
suppresses Code Set C in favour of Code Sets A and B.
|
||||
|
||||
Note that the special extra escapes mentioned above are not available for this
|
||||
@@ -3621,7 +3609,7 @@ first and last digit are ignored, leaving a 4-digit DX Extract number in any
|
||||
case, which must be in the range 16 to 2047. The second format "NNN-NN"
|
||||
represents the DX Extract as two numbers separated by a dash (-), the first
|
||||
number being 1 to 3 digits (range 1 to 127) and the second 1 to 2 digits (range
|
||||
0 to 15).[19]
|
||||
0 to 15).[16]
|
||||
|
||||
The optional frame number is a number in the range 0 to 63, and may have a half
|
||||
frame indicator "A" appended. Special character sequences (with or without a
|
||||
@@ -5609,53 +5597,45 @@ supported in future versions.
|
||||
--nobackground is given. For raster outputs GIF, PCX, PNG and TIF, the
|
||||
background’s alpha channel is set to zero (fully transparent).
|
||||
|
||||
[5] Shift JIS (JIS X 0201 Roman) re-maps two ASCII characters: backslash (\) to
|
||||
[5] For linear barcodes, Human Readable Text (HRT) is not shown for the postal
|
||||
codes Australia Post (all variants), USPS Intelligent Mail, POSTNET and PLANET,
|
||||
Brazilian CEPNet, Royal Mail 4-State Customer Code and 4-State Mailmark, Dutch
|
||||
Post KIX Code, Japanese Postal Code, DAFT Code and FIM, the pharma codes
|
||||
Pharmacode One-Track and Pharmacode Two-Track, and the specialist codes DX Film
|
||||
Edge Barcode and Flattermarken. Note that HRT is never shown for stacked and
|
||||
matrix barcodes.
|
||||
|
||||
[6] Shift JIS (JIS X 0201 Roman) re-maps two ASCII characters: backslash (\) to
|
||||
the yen sign (¥), and tilde (~) to overline (U+203E).
|
||||
|
||||
[6] ISO/IEC 646 Invariant is a subset of ASCII with 12 characters undefined: #,
|
||||
[7] ISO/IEC 646 Invariant is a subset of ASCII with 12 characters undefined: #,
|
||||
$, @, [, \, ], ^, `, {, |, }, ~.
|
||||
|
||||
[7] BARCODE_MEMORY_FILE textual formats EPS and SVG will have Unix newlines (LF)
|
||||
[8] BARCODE_MEMORY_FILE textual formats EPS and SVG will have Unix newlines (LF)
|
||||
on both Windows and Unix, i.e. not CR+LF on Windows.
|
||||
|
||||
[8] The height value is ignored for Aztec (including HIBC and Aztec Rune), Code
|
||||
[9] The height value is ignored for Aztec (including HIBC and Aztec Rune), Code
|
||||
One, Data Matrix (including HIBC), DotCode, Grid Matrix, Han Xin, MaxiCode, QR
|
||||
Code (including HIBC, Micro QR, rMQR and UPNQR), and Ultracode - all of which
|
||||
have a fixed width-to-height ratio (or, in the case of Code One, a fixed
|
||||
height).
|
||||
|
||||
[9] For Windows, outfile is assumed to be UTF-8 encoded.
|
||||
[10] For Windows, outfile is assumed to be UTF-8 encoded.
|
||||
|
||||
[10] The BARCODE_BIND_TOP flag is set by default for DPD - see 6.1.10.7 DPD
|
||||
[11] The BARCODE_BIND_TOP flag is set by default for DPD - see 6.1.10.7 DPD
|
||||
Code.
|
||||
|
||||
[11] The BARCODE_BIND flag is always set for Codablock-F, Code 16K and Code 49.
|
||||
[12] The BARCODE_BIND flag is always set for Codablock-F, Code 16K and Code 49.
|
||||
Special considerations apply to ITF-14 - see 6.1.2.6 ITF-14.
|
||||
|
||||
[12] Codablock-F, Code 16K, Code 49, EAN-2 to EAN-13, ISBN, ITF-14, UPC-A and
|
||||
[13] Codablock-F, Code 16K, Code 49, EAN-2 to EAN-13, ISBN, ITF-14, UPC-A and
|
||||
UPC-E have compliant quiet zones added by default.
|
||||
|
||||
[13] In particular no parentheses will appear in the HRT for GS1 symbologies,
|
||||
and GS separators will be added as required. However for EAN/UPC symbologies,
|
||||
any add-on data will be separated by a + character as usual.
|
||||
|
||||
[14] Normally control characters (including DEL) and non-ISO/IEC 8859-1 are
|
||||
replaced by spaces in the HRT.
|
||||
|
||||
[15] Except for Japanese Postal Code, whose check character is not truly
|
||||
representable in HRT.
|
||||
|
||||
[16] HRT is normally not set for the postal codes Australia Post (all variants),
|
||||
USPS Intelligent Mail, POSTNET and PLANET, Brazilian CEPNet, Royal Mail 4-State
|
||||
Customer Code and 4-State Mailmark, Dutch Post KIX Code, Japanese Postal Code,
|
||||
DAFT Code and FIM, the pharma codes Pharmacode One-Track and Pharmacode
|
||||
Two-Track, and DX Film Edge Barcode and Flattermarken.
|
||||
|
||||
[17] ZINT_CAP_EANUPC was previously named ZINT_CAP_EXTENDABLE, which is still
|
||||
[14] ZINT_CAP_EANUPC was previously named ZINT_CAP_EXTENDABLE, which is still
|
||||
recognised.
|
||||
|
||||
[18] BARCODE_CODE128AB previously used the name BARCODE_CODE128B, which is still
|
||||
[15] BARCODE_CODE128AB previously used the name BARCODE_CODE128B, which is still
|
||||
recognised.
|
||||
|
||||
[19] The DX number may be looked up in The (Modified) Big Film Database at
|
||||
[16] The DX number may be looked up in The (Modified) Big Film Database at
|
||||
https://thebigfilmdatabase.merinorus.com.
|
||||
|
||||
Reference in New Issue
Block a user