SixCMS_Plugin: QR Code Generator Stand: TT.MM.JJJJ

Größe: px

Ab Seite anzeigen:

Download "SixCMS_Plugin: QR Code Generator Stand: TT.MM.JJJJ"

Lieselotte Fertig
vor 7 Jahren
Abrufe

1 SixCMS_Plugin: QR Code Generator Stand: TT.MM.JJJJ Entwickler: Vor und Nachname Six Offene Systeme GmbH Am Wallgraben Stuttgart Tel. +49-( xx Fax +49-( Mail oder

GmbH Am Wallgraben 99 70565 Stuttgart Tel.

2 Inhaltsverzeichnis 1 Kurzbeschreibung Anwendungsfälle Features Voraussetzungen Installation Konfiguration Einschränkungen Beispiele Ausgabe von Text- und Rohdaten Syntax Syntax-Beschreibung Beispiel zur Ausgabe von Text und Rohdaten Ausgabe von URLs Syntax Syntax-Beschreibung Beispiel zur Ausgabe von URLs Ausgabe von s Syntax Syntax-Beschreibung Ausgabe von Visitenkarten Syntax Beschreibung Beispiel zur Ausgabe von Visitenkarten Anmerkung zu den Beispielen...8 2/8

..5 6.2.1 Syntax...5 6.2.2 Syntax-Beschreibung...5 6.2.3 Beispiel zur Ausgabe von URLs...5 6.3 Ausgabe von E-Mails...6 6.3.1 Syntax...6 6.3.2 Syntax-Beschreibung...6 6.4 Ausgabe von Visitenkarten.

3 1 Kurzbeschreibung Mit dem 'QR Code Generator'-Plugin können Sie auf einfachem Weg QR-Codes erzeugen die unter Anderem von Smartphones gelesen werden können, z.b. zur Übermittlung einer Visitenkarte oder einer URL. Der 'QR Code Generator' erzeugt aus den ihm übermittelten Daten einen QR-Code und zeigt diesen als Bild im Frontend an. Verschiedene Schnittstellen erlauben es unterschiedliche Protokoll-Formate gezielt zu erzeugen. 1.1 Anwendungsfälle Bereitstellung einer URL für die schnelle Eingabe in ein Smartphone. Als Bestandteil einer Kontakt-Seite die Visitenkarte als QR-Code. Erzeugen von QR-Codes für Print-Erzeugnisse direkt im Intranet. Uvm. 1.2 Features Erzeugen von QR-Codes auf Grundlage eigener Daten. Erzeugt QR-Codes im verlustfreien PNG-Format. Bereits verarbeitete Daten werden zwischen gespeichert (Caching für mehr Performance. Unterstützt die gängigen Kodierqualitäten für QR-Codes: L, M, Q und H. Die Pixeldiagonale eines einzelnen Dots lässt sich einstellen. Unterstützt neben der Ausgabe von Rohdaten auch die etablierten Smartphone- Standards für URLs (Bookmarks, s und Visitenkarten der Firma NTT Docomo. 2 Voraussetzungen Keine besonderen Voraussetzungen. 3 Installation Die Installation ist direkt nach Upload und Aktivierung des Plugins abgeschlossen. Es werden neben dem Plugin-Verzeichnis keine weiteren Daten oder Strukturen erhoben oder geändert. 4 Konfiguration Siehe Beispiele 5 Einschränkungen keine 3/8

Verschiedene Schnittstellen erlauben es unterschiedliche Protokoll-Formate gezielt zu erzeugen. 1.1 Anwendungsfälle Bereitstellung einer URL für die schnelle Eingabe in ein Smartphone.

4 6 Beispiele 6.1 Ausgabe von Text- und Rohdaten Zur Ausgabe von Texten und anderen als String vorliegenden Rohdaten kann die Methode Raw( verwendet werden Syntax %CMS_PLUGIN_QRCODE::Raw( text= <string> [quality= L M Q H ] [dotsize= <int> ] Die Methode kann auch über deren Alias %CMS_PLUGIN_QRCODE::Text( aufgerufen werden Syntax-Beschreibung text Ein String mit den Text- bzw. Rohdaten die als QR-Code ausgegeben werden sollen. quality Kodierqualitaet des QR Codes. Moegliche Werte sind 'L' (Low, 'M' (Middle, 'Q' (Quick, default und 'H' (High. Von 'L' nach 'H' nimmt die Redundanz der Daten und somit auch die Datensicherheit kontinuierlich zu. Die Größe und Komplexität des resultierenden QR-Codes hängt maßgeblich von dieser Einstellung ab. dotsize Gibt an wie viele Bildpixel ein einzelner Dot eines QR-Codes in der Diagonalen hat. Bei der Standard-Einstellung von 4 ist ein QR-Dot also 4 mal 4 Pixel groß Beispiel zur Ausgabe von Text und Rohdaten Gibt den Namen des Plugins als maschinenlesbaren QR-Code aus. %CMS_PLUGIN_QRCODE::Text( text= SixCMS QR Code Generator quality= M dotsize= 3 4/8

Moegliche Werte sind 'L' (Low, 'M' (Middle, 'Q' (Quick, default und 'H' (High. Von 'L' nach 'H' nimmt die Redundanz der Daten und somit auch die Datensicherheit kontinuierlich zu.

5 6.2 Ausgabe von URLs Zur Ausgabe von Bookmarks (URLs als QR-Code kann die Methode Bookmark( verwendet werden. Die Ausgabe erfolgt im bookmark-format der Firma NTT Docomo, siehe auch on/bookmark/ Syntax %CMS_PLUGIN_QRCODE::Bookmark( title= <string> url= <url> [quality= L M Q H ] [dotsize= <int> ] Die Methode kann auch über deren Alias %CMS_PLUGIN_QRCODE::URL( aufgerufen werden Syntax-Beschreibung Title Ein String mit einer kurzen Beschreibung des Bookmarks, z.b. der Firmenname. Url Die eigentliche URL des zu erstellenden Bookmarks. quality Kodierqualitaet des QR Codes. Mögliche Werte sind 'L' (Low, 'M' (Middle, 'Q' (Quick, default und 'H' (High. Von 'L' nach 'H' nimmt die Redundanz der Daten und somit auch die Datensicherheit kontinuierlich zu. Die Größe und Komplexität des resultierenden QR-Codes hängt maßgeblich von dieser Einstellung ab. dotsize Gibt an wie viele Bildpixel ein einzelner Dot eines QR-Codes in der Diagonalen hat. Bei der Standard-Einstellung von 4 ist ein einzelner QR-Dot also 4 mal 4 Pixel groß Beispiel zur Ausgabe von URLs Erzeugt ein Bookmark des Webauftritts der Six Offene Systeme GmbH. %CMS_PLUGIN_QRCODE::URL( title= Six Offene Systeme GmbH url= 5/8

1 Syntax %CMS_PLUGIN_QRCODE::Bookmark( title= <string> url= <url> [quality= L M Q H ] [dotsize= <int> ] Die Methode kann auch über deren Alias %CMS_PLUGIN_QRCODE::URL( aufgerufen werden. 6.2.

6 6.3 Ausgabe von s -Adressen sowie komplette Mail-Vorlagen für Smartphones lassen sich mittels der Methode Mail( erzeugen. Es wird hierbei das Mail-Format der Firma NTT Docomo verwendet, siehe: on/mail/ Syntax %CMS_PLUGIN_QRCODE::Mail( = < > [subject= <string> ] [body= <string> ] [quality= L M Q H ] [dotsize= <int> ] Syntax-Beschreibung -Adresse des Empfaengers. subject Text der Betreff-Zeile falls diese vorausgefüllt sein soll. body Text der falls dieser vorausgefüllt sein soll. quality Kodierqualitaet des QR Codes. Moegliche Werte sind 'L' (Low, 'M' (Middle, 'Q' (Quick, default und 'H' (High. Von 'L' nach 'H' nimmt die Redundanz der Daten und somit auch die Datensicherheit kontinuierlich zu. Die Größe und Komplexität des resultierenden QR-Codes hängt maßgeblich von dieser Einstellung ab. dotsize Gibt an wie viele Bildpixel ein einzelner Dot eines QR-Codes in der Diagonalen hat. Bei der Standard-Einstellung von 4 ist ein QR-Dot also 4 mal 4 Pixel groß.beispiel zur Ausgabe von s Erstellt einen QR-Code der eine schnelle Kontaktaufnahme zu unserem Support über ein Smartphone ermöglicht. %CMS_PLUGIN_QRCODE::Mail( = sixcms-support@six.de subject= Frage zum QR Code Generator body= Bitte fügen Sie hier Ihre Frage an unseren Support ein! 6/8

1 Syntax %CMS_PLUGIN_QRCODE::Mail( email= <email> [subject= <string> ] [body= <string> ] [quality= L M Q H ] [dotsize= <int> ] 6.3.2 Syntax-Beschreibung email E-Mail-Adresse des Empfaengers.

7 6.4 Ausgabe von Visitenkarten Zur schnellen Bereitstellung von Adress- und Kontaktdaten bietet sich die Methode Contact( an. Diese erzeugt eine QR-Code-Visitenkarte im addressbook-format der Firma NTT Docomo, siehe on/addressbook/ Syntax %CMS_PLUGIN_QRCODE::Contact( contact= <array> [quality= L M Q H ] [dotsize= <int> ] Beschreibung Contact Ein Array mit den Adress- und Kontaktdaten der als QR-Code zu erstellenden Visitenkarte. In diesem Array können die folgenden Felder belegt werden: firstname Vorname lastname Nachname phone Telefonnummer videophone Videofonnummer -Adresse note Eine kurze Notiz birthday Der Geburtstag (in der Form "YYYYMMDD" url URL nickname Spitz- bzw. Rufname po_box Postfach room_number Raumnummer street Strasse inkl. der Hausnummer zip Postleitzahl city Stadt prefecture Verwaltungsbezirk (Bundesland country Land Felder können auch mehrfach belegt werden (z.b. eine zweite Telefonnummer indem statt eines Strings ein Array übergeben wird (siehe Beispiel weiter unten. 7/8

1 Syntax %CMS_PLUGIN_QRCODE::Contact( contact= <array> [quality= L M Q H ] [dotsize= <int> ] 6.4.

8 quality dotsize Kodierqualitaet des QR Codes. Moegliche Werte sind 'L' (Low, 'M' (Middle, 'Q' (Quick, default und 'H' (High. Von 'L' nach 'H' nimmt die Redundanz der Daten und somit auch die Datensicherheit kontinuierlich zu. Die Größe und Komplexität des resultierenden QR-Codes hängt maßgeblich von dieser Einstellung ab. Gibt an wie viele Bildpixel ein einzelner Dot eines QR-Codes in der Diagonalen hat. Bei der Standard-Einstellung von 4 ist ein QR-Dot also 4 mal 4 Pixel groß Beispiel zur Ausgabe von Visitenkarten Gibt die Visitenkarte von Frau Tanja Mustermann aus. %CMS_PLUGIN_QRCODE::Contact( contact[firstname]= Tanja contact[lastname]= Mustermann contact[phone][]= contact[phone][]= contact[ ]= tanja.mustermann@example.com contact[note]= CTO example inc. Die Adressdaten können selbstverständlich auch in einem vorbereiteten PHP-Array übergeben werden. <?php?> $hadressdaten = array( ; 'firstname' => Tanja, 'lastname' => Mustermann, 'phone' => array( , " , ' ' => tanja.mustermann@example.com, 'note' => CTO example inc., %CMS_PLUGIN_QRCODE::Contact( contact=$hadressdaten 6.5 Anmerkung zu den Beispielen Die Cache-Dateien aller oben erwähnten Methoden werden innerhalb des Plugin- Verzeichnis im Verzeichnis./qrcode/current/tmp/cache abgelegt und können bei Bedarf bedenkenlos gelöscht werden. 8/8

Gibt an wie viele Bildpixel ein einzelner Dot eines QR-Codes in der Diagonalen hat. Bei der Standard-Einstellung von 4

Ähnliche Dokumente

Inhaltsverzeichnis. Stand: Seite 1 Copyright Melville-Schellmann GbR

Inhaltsverzeichnis. Stand: Seite 1 Copyright Melville-Schellmann GbR Inhaltsverzeichnis 1 Einsatz von ACT2Mail... 2 2 Konfiguration und Bedienung von ACT2Mail... 2 3 Transferfelder von ACT! nach Outlook... 4 4 Start von ACT2Mail mit Befehlszeilenparametern... 6 Stand: 21.06.2005