Marc Wäckerlin
73d0ec06b0
|
6 years ago | |
---|---|---|
examples | 6 years ago | |
screenshots | 6 years ago | |
AUTHORS | 6 years ago | |
LICENSE | 6 years ago | |
README.md | 6 years ago | |
autogen.sh | 6 years ago | |
businesscard-qrcode.cls | 6 years ago | |
configure.ac | 6 years ago | |
makefile.am | 6 years ago |
README.md
Businesscard with QR-Code
What happens, if you give your visiting card to someone? Either he manually types the text into his computer or mobilefone, or it will end up in a box and be forgotten. Nowadays data is required electronically, not on paper. Here is the solution: A visiting card with QR-Code that contains a full vcard, so that it can be scanned with an app on the mobilefone and therefore automatically imported into the electronic contacts. This also works well, when you are offline and bluetooth transfer fails. So here is the highly configurable businescard or visitingcards with full vcard as QR-Code, ready to send to online printers. You can specify the exact size of the paper and the content within the paper, inluding generation of crop marks.
Other available visitingcard templates, such as mschlenker distribute the cards on an A4 paper. But if you want a professional printer, such as onlineprinters, then you need to be able to generate a PDF with exactly one card, an exactly defined border and crop marks.
Features
- all information is in the QR-Code
- full privacy control: input is optional, specify only what you need, you decide what information to share, e.g. I print three cards, with phone and address, without address and only with electronical contacts, no phone nor address
- optional icons, optional small hint texts
- several alignments
- freely defined size of paper and content
- supports honoric titles, full names, address with post office box and extended information
- supports telefone, email, jabber and matrix chat
- supports several urls for your hompages
- supports gitea, github, git
- supports facebook, twitter, google+, youtube, wikipedia
- supports pgp key url and fingerprint
- supports nextcloud federation id
Usage
Installation
Copy businesscard-qrcode/businesscard-qrcode.cls
to your LaTeX class path. Simplest way for installation on Linux:
mkdir ~/texmf/tex/latex/businesscard-qrcode
cp businesscard-qrcode/businesscard-qrcode.cls ~/texmf/tex/latex/businesscard-qrcode/
Compilation
Important: You must use xelatex
for compilation, because xelatex
properly supports UTF-8 (e.g. needed for german umlauts or chinese characters). The package inputenc
messes up with package qrcode
.
Document Structure
\documentclass[<layout-options>]{businesscard-qrcode}
<data-definitions>
\begin{document}
\drawcard
\end{document}
where <layout-options>
and <data-definitions>
are explained below.
Layout Options
Layout options are set as options to the \documentclass
, e.g.:
\documentclass[textwidth=0.7,qrwidth=0.25,www,nofill,iconright,rightalign,hint,icon,textfirst]{businesscard-qrcode}
Available Options:
paperwidth=
: width of the physical paper where the card is printed on (incl. border), default:89mm
paperheight=
: height of the physical paper where the card is printed on (incl. border), default:59mm
contentwidth=
: width of the card's content without the border that is cut, default:85mm
contentheight=
: height of the card's content without the border that is cut, default:55mm
fontsize=
: any fontsize allowed inextarticle
, that are8pt
,9pt
,10pt
,11pt
,12pt
,14pt
,17pt
and20pt
, default:8pt
padding=
: padding within the card's content, default:2mm
cutdist=
: distance inmm
where the cut marks are set, default:2
cutlen=
: length of the cut marks inmm
, default:1
textwidth=
: relative width of the text block1
means full width, soqrwidth
plustextwidth
should be smaller than1
the remainig space is left empty between the text and QR-Code, default:0.55
(that's 55% of the available space)qrwidth=
: relative width of the QR-Code1
means full width, soqrwidth
plustextwidth
should be smaller than1
the remainig space is left empty between the text and QR-Code, default:0.40
(that's 40% of the available space)lang=
: language of the wikipedia page, will be prepended beforewikipedia.org
, e.g.de.wikipedia.org
, default:de
address
ornoaddress
: disable rendering of the address in text and QR-Code, default: addresshint
ornohint
: show the little text hints, default:hint
icon
ornoicon
: show the icons, default:icon
rightalign
orleftalign
: align text left or right, default:rightalign
iconleft
oriconright
: show icon left or right of the text, default:iconleft
fill
ornofill
: fill empty space between icon and text, default:fill
qrfirst
ortextfirst
: switch position of QR-Code and text block, default:qrfirst
https
orwww
: should links in the hints be prefixed withhttps://
orwww.
, default:https
Data Definitions
Your data is entered with commands in the document, e.g.:
\email{name@example.com}
Important:: Spaces must be escaped by a backslash \
in all data definitions, if they should be kept in the QR-Code. This is a limitation of the qrcode
-package- Without escaping \
, spaces are show in the text block, but not in the QR-Code. You may make use of this feature, if you do not escape the spaces in \phone
and \pgpfingerprint
, but everywhere else. This way, phone number and pgp fingerprint are condensed in the QR-Code.
See this example_
\givennames{Juan\ Pablo}
\familynames{Martínez\ Escudero}
\additionalnames{Example\ Company\ Ltd.}
\street{Im\ Stutz\ 123}
\pobox{Postfach\ 4567}
\phone{+41 52 123 45 67}
\pgpurl{https://pgp.mit.edu/pks/lookup?op=get\&search=0xF62315D04D4C0C62}
Recognized Commands:
\type
: eitherhome
orwork
for personal or business cards\givennames
: your first name and eventual middle names\familynames
: your family names\honoricprefix
: honorix name prefixes, e.g. academic titles\honoricsuffix
: honoric name suffixes\additionalnames
: additionl names — I use it for the company name in business cards\pobox
: post office box\extaddr
: address extension, e.g. name of a building or floor number\street
: street and number of the address\city
: name of the address location\region
: region of the address\zip
: zip code of the address\country
: full name of country of the address in the language of the card\phone
: your phone number, the phone is marked as mobile, so to be used for voice and text (SMS)\email
: your email address\jabber
: your jabber or xmpp chat address\matrixorg
: your matrix chat addres, hint: use riot messenger for matrix\cloud
: your nextcloud federation id — the url is prepended automatically\homepage
: url to a web site with «home» icon — withouthttps://
notwww
(unless it is required), this is prepended automatically\world
: url to a web site with «world» icon — withouthttps://
notwww
(unless it is required), this is prepended automatically\link
: url to a web site with «link» icon — withouthttps://
notwww
(unless it is required), this is prepended automatically\wordpress
: url to a web site with «wordpress» icon — withouthttps://
notwww
(unless it is required), this is prepended automatically\drupal
: url to a web site with «» icon — withouthttps://
notwww
(unless it is required), this is prepended automatically\joomla
: url to a web site with «joomla» icon — withouthttps://
notwww
(unless it is required), this is prepended automatically\wikipedia
: if you or your company have a wikipedia entry, specify documentclass optionlang
for the language of you entry and use this definition for the name of your page — the url is prepended automatically\git
: the url of your git repository — withouthttps://
notwww
(unless it is required), this is prepended automatically\gitea
: the url of your gitea project page, you can use this tag also for other project management sites, such as gogs — withouthttps://
notwww
(unless it is required), this is prepended automatically\github
: your account name on github — only the name of the account, the url is prepended automatically\facebook
: your account name on facebook or the name of your page — only the name of the account or page, the url is prepended automatically\twitter
: your account name on twitter — only the name of the account, the url is prepended automatically\youtube
: your account name on youtube — only the name of the account, the url is prepended automatically\google
: your account name on google+ — only the name of the account, the url is prepended automatically\pgpurl
: the full url to your pgp public key (only added to the QR-Code, not shown in the text)\pgpfingerprint
: the fingerprint of your pgp public key
Print the Card
The card is designed for professional printing service, such as onlineprinters. Please check the card and the QR-Code well before you pay money for printing! Choose a format, default is 89mm×59mm
with 2mm boder, so the card content is 85mm×55mm
. But the card can be adapted to any other printing format. To print cards of size 10cm×5cm
with 2mm
cut, you specify, e.g.:
\documentclass[paperheight=5.4cm,paperwidth=10.4cm,
contentheight=5cm,contentwidth=10cm,
cutdist=2]
{businesscard-qrcode}
Usage Example
Include the documentclass, define your data and add the document environment:
\documentclass{businesscard-qrcode}
\type{home}
\givennames{An}
\familynames{Example}
\street{Einbahnstrasse\ 84}
\city{Irgendwo}
\zip{1001}
\country{Switzerland}
\homepage{example.com}
\email{name@example.com}
\begin{document}
\drawcard
\end{document}
Save it as file texstudio_d30266.tex and compile it to get texstudio_d30266.pdf:
xelatex -synctex=1 -interaction=nonstopmode texstudio_d30266.tex
See examples for more examples.
Need More
If you are missing a feature or a configuration option, just open a ticket and I will care about it.