pandoc-latex-barcode 1.1.1
A pandoc filter to insert barcodes and QR codes in a latex/pdf document
License: BSD
Keywords: pandoc,filters,latex,barcode,qrcode

pandoc-latex-barcode
===============================================================================

[![Build Status](https://travis-ci.org/daamien/pandoc-latex-barcode.svg?branch=master)](https://travis-ci.org/daamien/pandoc-latex-barcode)
[![Docker Automated Build](https://img.shields.io/docker/automated/daamien/pandoc-latex-barcode.svg)](https://hub.docker.com/r/daamien/pandoc-latex-barcode/)

A pandoc filter to insert barcodes and QR codes in a latex/pdf document

The filter is written in Python with [panflute](http://scorreia.com/software/panflute/) 
which I recommend if you want to create your own pandoc filters.
 

Install
-------------------------------------------------------------------------------

```
sudo pip install pandoc-latex-barcode
```

or 

```
docker run -d daamien/pandoc-latex-barcode
```

Quick Start
-------------------------------------------------------------------------------

### 1- Create a specific pandoc template

First you need to the following packages to the latex template :

```latex
\usepackage{pstricks}
\usepackage{pst-barcode}
```

For your convenience, here's a complete one based on the pandoc default latex
template :

[pandoc-latex-barcode.template.tex](pandoc-latex-barcode.template.tex)


### 2- Add a barcode tag to your markdown file


To generate a generic barcode:

```                                                                             
<div class="barcode">Hello World !</div>                                 
```      

To generate an ISBN barcode:

```
<div class="barcode isbn">978-3-86541-114</div>
```

To generate a QR code:

```                                                                             
<div class="qrcode">http://www.pandoc.org</div>                                 
```      


### 3- Enjoy !

```
pandoc --filter pandoc-latex-barcode \
       --template ./pandoc_latex_barcode.template.tex \
       --latex-engine xelatex \
       ./pandoc_latex_barcode.sample.md \ 
       -o ./pandoc_latex_barcode.sample.pdf
```

Note : The xelatex engine is mandatory because of pstricks.


Configuration
-------------------------------------------------------------------------------



There's also few parameters you can setup in the document front matter :

```yaml
barcode: {                                                                      
  barcode_width: '50mm',                                                       
  barcode_height: '30mm',                                                       
  qrcode_width: '25mm',                                                         
  qrcode_height: '25mm' ,                                                       
  isbn: '123-4-56789-111',                                                      
}                                                                               
                                                                                
```

- **barcode_width** and **barcode_height** defines the size of the barcode.
  _Default_ : 50mmx30mm

- **qrcode_width** and **qrcode_height** defines the size of the QR code. 
  _Default_ : 25mmx25mm

- **isbn** : overides the value inside the ``<div>``
  __Default__ : ``None``

For more details, please refer to the _pst-barcode_ documentation :

http://texdoc.net/texmf-dist/doc/generic/pst-barcode/pst-barcode-doc.pdf

Example
-------------------------------------------------------------------------------

See [pandoc-latex-barcode.sample.md](pandoc-latex-barcode.sample.md)

and [pandoc-latex-barcode.sample.pdf](pandoc-latex-barcode.sample.pdf)

Contributing & Getting Help
-------------------------------------------------------------------------------

If you have any difficulties with this software, please file an issue here :

https://github.com/daamien/pandoc-latex-barcode/issues

License
-------------------------------------------------------------------------------

This software is available under the BSD 3-Clause Licence.

see [LICENSE](LICENSE)