Help:VCard format

From Linux Web Expert

Revision as of 12:04, 27 July 2019 by >Kghbln (fix)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

VCard format
Exports data in vCard format.
Further Information
Provided by: Semantic Result Formats
Added: 1.4.2
Removed: still supported
Requirements: none
Format name: vcard
Enabled? Indicates whether the result format is enabled by default upon installation of the respective extension. yes
Authors: Markus Krötzsch , Denny Vrandecic , Frank Dengler
Categories: export
Table of Contents

The result format vcard, part of extension "Semantic Result Formats"No description was provided., is used to produce links for downloading data from a wiki in vCard format. It is a special format for data export as explained in Help:Inline queries, and therefore properties must use known labels to specify how the wiki data relates to the vCard format.

Parameters

⧼validator-describe-header-parameter⧽ ⧼validator-describe-header-type⧽ ⧼validator-describe-header-default⧽ ⧼validator-describe-header-description⧽
filename ⧼validator-type-string⧽ vCard.vcf The name for the output file

Starting with extension "Semantic Result Formats"No description was provided. version 3.1.0 this result format provides the new "filename" parameter that allows to set a specific name for the output file which defaults to "vCard.vcf".1

Data fields

Properties in printout statements should use one of the following labels, or otherwise are ignored in the resulting vCard. The available fields are:

  • name (displayed full name)
  • prefix (something like "Dr.")
  • suffix (something like "Jr.")
  • firstname
  • extraname (middle name)
  • lastname
  • birthday (a date)
  • homepage
  • note (any other text)
  • email
  • workphone
  • cellphone
  • homephone
  • organization
  • workpostofficebox
  • workextendedaddress
  • workstreet
  • worklocality
  • workregion
  • workpostalcode
  • workcountry
  • homepostofficebox
  • homeextendedaddress
  • homestreet
  • homelocality
  • homeregion
  • homepostalcode
  • homecountry

Most fields including the phone numbers have no special format and will take whatever you give them.

Example

{{#ask:
 [[Category:Person]]
 |?firstname
 |?lastname
 |?mail=email
 |?url=homepage
 |?skype=note
 |format=vcard
 |searchlabel=vCard
}}

This would display a link to download the vCard. The example shows that you have to label the queried properties in case they do not correspond to the name of the data fields mentioned below, e.g property "mail" has to be labeled with "email".

Note

Lists of vCards work very well on most address book tools with the notable exception of MS Outlook. Outlook users can only import the first contact in each vCard file, and must therefore import contacts individually from many links, or consider moving to another tool for personal information management, such as Thunderbird. Outlook also is reported to fail at character decoding in some cases, e.g. if names use non-latin encoding.

#scite could not render a citation text for reference "gh:srf:513" because type "pullrequest" was not assigned to a template.

References

  1. ^ gh:srf:513