EXT: QR-Codes¶

What does it do?¶

This “CB QR-Code” extension adds the functionality to create individual QR-Codes, based on

• a simple string
• a phone number
• an email address
• a website address (url)
• the current website
• an address in vCard–format
• or an appointment

to your frontend in a simple and quick way. QR-Codes can be included as a simple frontend-plugin , by typoscript or as an additional marker to your tt_address template !

Screenshots¶

Here you see what the extension does:

a typical QR-Code, which will be published to the frontend view. And here you see in the backend view why the extension does this:

Here we have selected “URL” as type of QR-Code and insert the desired URL.

Furthermore we can adjust appearance of the QR-Code. Options to set the pixel and border size, enabling border and the level of error correction are also available.

Insert QR-Code as frontend-plugin¶

If you would like to include a QR-Code by frontend-plugin, just insert a new content element to the desired page and position, choose: “Insert Plugin” as type of content element.

Define QR-Code content """"""""""""""""""""""

Select “QR-Code” as “Selected Plugin” on the “Plugin” tab.

Now insert the desired informations you would like to store as QR- Code. The following fields are supported to each QR-Code type:

Insert QR-Code as tt_address marker¶

The combination of this extension and tt_address makes it obviously to export contact data to vCard formated QR-Codes. Therefore two new markers will be available to your tt_address templates.

After installation of this extension your can directly use the following two markers in your tt_address templates, if your typoscript template definitions based on the default template and inherits to your individual definitions!

###CBQRCODE####             // will be substituted with an IMAGE TS-object and

###CBQRCODEURI###                 // will be substituted with an IMG_RESOURCE object

Insert QR-Code by TypoScript¶

There are two typoscript objects available for publishing and linking QR-Codes to your frontend.

To include the QR-Code image directly import the following typoscript:

lib.myQrCode < plugin.tx_cbqrcodes_pi1.qrCodeImageByTS

“ lib.myQrCode.userFunc.qrCodeString” is a TEXT content object and can be filled with various contents, f.e. to publish static text:

lib.myQrCode.userFunc.qrCodeString.value = Hello World

or to publish the current date

lib.myQrCode.userFunc.qrCodeString.data = date:d.m.Y

or to publish title of a specific page

lib.myQrCode.userFunc.qrCodeString.data = DB:pages:255:title

or to publish a link to the current page

lib.myQrCode.userFunc.qrCodeString.typolink{
   parameter.data = TSFE:id
   returnLast = url
   forceAbsoluteUrl = 1
   forceAbsoluteUrl.scheme = http
}

The previous examples will include the QR-Code as an IMAGE object. If your like to use an IMG_RESOURCE just use:

lib.myQrCode < plugin.tx_cbqrcodes_pi1.qrCodeImageByTS

Examples to insert content are the same as above. That all, for configuration see next chapter.

Configuration to frontend-plugin usage¶

If the QR-Code extension will be insert as a frontend plugin the whole configuration will be done in the backend on the tab “QR-Code Layout”

Configuration to tt_address usage ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Let's have a look to the configuration if QR-Code will be used as tt_address marker. It can be conducted by constant editor or by typoscript.

The most options be set comfortable in the constant editor. Only some values are shown in the following screenshot:

Available options are described in the typoscript configuration chapter

This extensions extends the tt_address typoscript branch with some additional definitions you can use to customize the layout and appearance of the QR-Code.

plugin.tx_ttaddress_pi1.template.default{
   cbqrcodes.vcard{
     // … additional typoscript, see typoscript browser or following chapter
   }
}

If no QR-Code will be displayed in your frontend, make sure that this typoscript branch exists in your template definition!

This extensions extends the tt_address typoscript branch with some definitions by which you can customize the layout and appearance of the QR-Code. The following options could be set to the following typoscript branch:

plugin.tx_ttaddress_pi1.template.default.cbqrcodes.vcard{
   errorCorrection = L
   pixelSize = 2
   enableBorder = 1
   borderSize = 2
}

plugin.tx_ttaddress_pi1.template.default.cbqrcodes.vcard.enableFields{
   organisation = 1
   description = 1
   phone = 1
   fax = 1
   cell = 1
   email = 1
   image = 1
   birthday = 1
   url = 1
}

plugin.tx_ttaddress_pi1.template.default.cbqrcodes.vcard.photo = IMG_RESOURCE
plugin.tx_ttaddress_pi1.template.default.cbqrcodes.vcard.photo{
   file = GIFBUILDER
   file{
      10 = IMAGE
      10.file.width = 64
      10.offset = 0,64-[10.h]/2
      XY = 64,64
      format = jpg
      quality = 90
   }
}

plugin.tx_ttaddress_pi1.template.default.cbqrcodes.vcard.fieldTypes{
   adrType = intl,postal,parcel,work
   telType = work,voice
   faxType = work,fax
   cellType = work,cell
   emailType = internet
}

Configuration by typoscript usage/integration¶

If you insert QR-Codes by typoscript, you can configure the appearance in the following way and with the following parameters:

plugin.tx_cbqrcodes_pi1.qrCodeImageByTS.userFunc{
   errorCorrection = L
   pixelSize = 2
   enableBorder = true
   borderSize = 2

   qrCodeString = TEXT
   qrCodeString{
      value = Hello World
   }
}

The “qrCodeString” is a typoscript TEXT content object and all known properties can be used. For samples see chapter “Insert QR-Code by TypoScript” on page 8.

3.1.0¶

2.0.2 – 2.0.5¶

2.0.1¶

2.0.0¶

1.0.0¶