Subversion Repositories ezqrcode

[/] [tags/] [1.0-alpha2/] [README.txt] - Blame information for rev 5

Details | Compare with Previous | View Log

Line No. Rev Author Line
1 2 bd
==========
2
eZ QR Code
3
==========
4
 
5
Author: Bertrand Dunogier, eZ Systems
6
 
7
Synopsis
8
========
9
 
10
This extension provides an API as well as the ezpublish features to generate QR Codes based on content.
11
 
12
What are QR Codes
13
=================
14
QR Codes are two dimensional bar codes, created by Denso-Wave in 1994 (thank you Wikipedia). These codes can contain a
15
large variety of data: URLs, vCards, geographical data, etc, and have been picked up by google for Android based
16
devices. As an example, you can see on http://code.google.com/ that any downloadable file has a QR code image.
17
 
18
QR codes can be scanned using a hand held device, which will then propose an action based on the decrypted data:
19
open an URL, install an app, etc.
20
 
21
This extension
22
==============
23
 
24
Google chart API
25
----------------
26
 
27
The current implementation only uses the google chart API. This very simple API allows you to provide an URL with a few
28
fields regarding the desired chart, and get an image in return. While this is far from perfect when it comes to data
29
privacy, it does the job.
30
 
31
Implementation
32
--------------
33
ezqrcode is very simple at the moment.
34
 
35
It has a base class, eZQRCode, that can be used to set all the available parameters: size, error correction, data, etc.
36
Based on this, the class will return the URL for the image on chart.apis.google.com.
37
 
38
This class is currently only implemented in a template operator named qrcode::
39
 
40
    {'http://share.ez.no/'|qrcode( "200x200" )}
41
 
42
Will return a link to the QR code for the URL share.ez.no.