Le module ZXing ("Zebra Crossing") permet de construire des codes à barres ou QR codes et de les afficher sous la forme d'une image dans un document. Ce module utilise le framework Java open source Zxing : https://github.com/zxing/zxing.
Il se base sur la version ZXing 3.5.1.
Ce module supporte la création des types de codes à barres 1D ou 2D (une ou deux dimensions) suivants :
1D product
|
1D industrial
|
2D |
UPC-A
|
Code 39
|
QR Code
|
UPC-E
|
Code 93
|
Data Matrix
|
EAN-8
|
Code 128 |
Aztec
|
EAN-13
|
Codabar
|
PDF 417
|
| UPC/EAN Extension 2/5 |
ITF
|
MaxiCode
|
|
|
RSS-14
|
|
|
RSS-Expanded
|
L'utilisation du module ZXing dans un template APE se fait à l'aide d'une directive d'inclusion à insérer en début de template :
<#import "/lib_xzingbarcode.ftl" as zxingModule/>
Remarque : Le nom du namespace "zxingModule" est donné à titre d'exemple et peut être remplacé par un nom de votre choix (respectant la syntaxe des namespaces Apache Freemarker).
Ce module offre une macro de nom "barcode" permettant de représenter l'ensemble des différents types de codes à barres supportés. Cette macro n'a pas de contenu (pas de balises de fin). La description d'un code à barres se fait en renseignant les paramètres de celles-ci.
- Paramètres obligatoires :
| Type du paramètre |
Nom du paramètre |
Description |
| String |
type |
Type du code à barres 1D / 2D parmi les valeurs suivantes :
aztec : Aztec 2D barcode format, codabar : CODABAR 1D format, code_39 : Code 39 1D format, code_93 : Code 93 1D format, code_128 : Code 128 1D format, data_matrix : Data Matrix 2D barcode format, ean_8 : EAN-8 1D format, ean_13 : EAN-13 1D format, ITF : ITF (Interleaved Two of Five) 1D format, maxicode : MaxiCode 2D barcode format, pdf_417 : PDF 417 2D barcode format, qr_code : QR Code 2D barcode format, rss_14 : RSS-14 2D barcode format, rss_expanded : RSS-Expanded 2D barcode format, upc-a : UPC-A 1D format, upc_e : UPC-E 1D format, upc_ean_extension : UPC/EAN extension format. Not a stand-alone format. |
String |
content |
Donnée numérique ou alphanumérique à afficher sous la forme d'un code à barres. |
Number
|
width
|
La largeur souhaitée en pixels de l'image représentant le code à barres. La valeur réelle peut être légèrement différente de la largeur souhaitée en fonction des contraintes du format choisi. |
Number
|
height
|
La hauteur souhaitée en pixels de l'image représentant le code à barres. La valeur réelle peut être légèrement différente de la hauteur souhaitée en fonction des contraintes du format choisi. |
| Type du paramètre |
Nom du paramètre |
Description |
Hash |
hints |
Options d'affichage dépendantes du type choisi. Chaque option est définie par un couple nom/valeur et l'ensemble des options sont regroupées dans un objet Hash. Cf. la documentation plus détaillée du framework Java Zxing à ce sujet : https://zxing.github.io/zxing/apidocs/com/google/zxing/EncodeHintType.html. Le nom d'option doit être défini avec l'un des noms présents dans la liste ci-après :
- aztec_layers : Spécifie le nombre requis de couches pour un code à barres de type "aztec". La valeur doit être un nombre (number) compris entre -4 et 32.
- character_set : Spécifie l'encodage de caractère à utiliser. La valeur doit être une chaîne de caractères (string).
- code128_compact : Spécifie l'utilisation du mode compact pour un code à barres de type "code_128". La valeur doit être un boléen (boolean).
- data_matrix_compact : Spécifie l'utilisation du mode compact pour un code à barres de type "data_matrix". La valeur doit être un boléen.
- data_matrix_shape : Spécifie la forme de la matrice pour un code à barres de type "data_matrix". La valeur doit être une chaîne de caractères. . Valeurs possibles : "FORCE_NONE", "FORCE_RECTANGLE" et "FORCE_SQUARE".
- error_correction : Spécifie le degré de correction d'erreur à utiliser. Pour le type "qr_code", la valeur doit être une chaîne de caractères. Valeurs possibles : "H", "L", "M" et "Q". Pour le type "aztec", la valeur doit être numérique. Pour le type "pdf_417", la valeur doit être un nombre compris entre 0 et 8,
- force_c40 : Spécifie l'utilisation de l'encodage C40 pour un code à barres de type "data_matrix". La valeur doit être un booléen,
- force_code_set : Spécifie l'encodage à utiliser pour un code à barres de type "code_128". La valeur doit être une chaîne de caractères. Valeurs possibles : "A", "B" et "C".
- gs1_format : Spécifie si les données doivent être encodées selon la norme GS1. La valeur doit être un booléen,
- margin : Spécifie la marge en pixels à utiliser pour générer le code à barres. La valeur doit être un nombre.
- pdf417_auto_eci : Spécifie s'il faut insérer automatiquement les ECI lors de l'encodage PDF417 pour un code à barres de type "pdf_417". La valeur doit être un booléen.
- pdf417_compact : Spécifie l'utilisation du mode compact pour un code à barres de type "pdf_417". La valeur doit être un booléen.
- pdf417_compaction : Spécifie le mode de compactage à utiliser lors de l'encodage PDF417 pour un code à barres de type "pdf_417". La valeur doit être une chaîne de caractères. Valeurs possibles : "AUTO", "BYTE", "NUMERIC" et "TEXT".
- pdf417_dimensions : Spécifie le nombre minimum et maximum de lignes et de colonnes à utiliser lors de l'encodage PDF417 pour un code à barres de type "pdf_417". La valeur doit être un objet Hash ayant les propriétés suivantes :
- min_cols : Nombre minimum de colonnes. La valeur doit être un nombre.
- max_cols : Nombre maximum de colonnes. La valeur doit être un nombre.
- min_rows : Nombre minimum de lignes. La valeur doit être un nombre.
- max_rows : Nombre maximum de lignes. La valeur doit être un nombre.
- qr_compact : Spécifie l'utilisation du mode compact pour un code à barres de type "qr_code". La valeur doit être un booléen,
- qr_mask_pattern : Spécifie le modèle de masque de QR code à utiliser pour un code à barres de type "qr_code". La valeur doit être un nombre compris entre 0 et 7.
- qr_version : Spécifie la version de QR code à utiliser pour un code à barres de type "qr_code". La valeur doit être un nombre.
|
Any
|
inner* |
La macro barcode s'appuie sur la macro foExternalGraphic pour afficher l'image (au format PNG) du code à barres dans le template APE. Il est possible de spécifier des paramètres spécifiques à la macro foExternalGraphic générée en préfixant le nom des paramètres par la chaîne "inner" et en mettant la première lettre du paramètre en majuscule.
|
Par exemple :
<#-- Display a QRCode -->
<#assign hintsQRCode = {"error_correction" : "H", "qr_mask_pattern" : 2} />
<@zxingModule.barcode type="qr_code" content="https://www.hardis-group.com/" width=150 height=150 hints=hintsQRCode innerBorder="2px solid black" />
<#-- Display a Code 128 -->
<@zxingModule.barcode type="code_128" content="SW-02643/1" width=100 height=50 hints={"force_code_set" : "A"} />
↑ Haut de page
