Network Working Group Frank Dawson, Lotus Internet Draft draft-dawson-vcard-xml-dtd-03.txt Expires six months after: June 22, 1998 The vCard v3.0 XML DTD Status of this Memo This document is an Internet-Draft and is in full conformance with all provisions of Section 10 of RFC2026. Internet-Drafts are working documents of the Internet Engineering Task Force (IETF), its areas, and its working groups. Note that other groups may also distribute working documents as Internet-Drafts. Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet- Drafts as reference material or to cite them other than as "work in progress." The list of current Internet-Drafts can be accessed at http://www.ietf.org/ietf/1id-abstracts.txt The list of Internet-Draft Shadow Directories can be accessed at http://www.ietf.org/shadow.html. Distribution of this document is unlimited. Copyright (C) The Internet Society 1999. All Rights Reserved. Abstract This memo defines a [XML] Document Type Definition (DTD) that corresponds to the vCard, electronic business card format defined by [RFC2426]. This DTD provides equivalent functionality to the standard format defined by [RFC2426]. Documents structured in accordance with this DTD may also be known as "XML vCard" documents. The mailing list for discussion of this memo is "ietf-vcard- xml@imc.org". Send an email to " ietf-vcard-xml-request@imc.org" with the message "SUBSCRIBE" to add your email address to this mailing list. Send an email to " ietf-vcard-xml-request@imc.org" with the message "UNSUBSCRIBE" to remove your email address from this mailing list. The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY" and "OPTIONAL" in this document are to be interpreted as described in [RFC 2119]. Dawson 1 Expires December 1999 Internet Draft vCard v3.0 XML DTD June 22, 1998 Table of Contents 1. INTRODUCTION........................................................4 2. USING XML FOR REPRESENTING VCARD....................................5 2.1 XML DEPENDENCIES .................................................5 2.2 DOCUMENT TYPE DEFINITION .........................................5 2.3 WORKING WITH STANDARD AND XML VCARD REPRESENTATIONS ..............5 2.3.1 Conversion ....................................................5 2.3.2 Mixed Use of Both Representations .............................5 2.4 USING DATA TYPES .................................................6 2.5 INCLUDING BINARY CONTENT .........................................7 2.6 INCLUDING MULTIPLE VCARD OBJECTS .................................8 2.7 MAPPING VCARD TYPE PARAMETERS TO XML .............................8 2.8 MAPPING VCARD TYPES TO XML ......................................10 2.9 PARAMETER ENTITIES ..............................................12 2.10 NAMESPACE ......................................................12 2.11 EMAILING THE VCARD XML REPRESENTATION ..........................13 2.12 VCARD XML REPRESENTATION AND FILE SYSTEMS ......................13 3. VCARD XML DOCUMENT TYPE DEFINITION.................................13 4. VCARD V3.0 NOTATION................................................20 5. EXAMPLE USAGE......................................................21 5.1 SIMPLE VCARD ....................................................21 5.2 VCARD WITH NON-STANDARD EXTENSION ...............................21 5.3 VCARD WITH PHOTO ELEMENT ........................................22 5.4 VCARD WITH AN AGENT ELEMENT .....................................22 5.5 DOCUMENT WITH MULTIPLE VCARDS ...................................23 5.6 DOCUMENT UTILIZING VCARD NAMESPACE ..............................23 5.7 XML DOCUMENT REFERENCE TO A NON-XML VCARD .......................24 6. NAMESPACE..........................................................24 7. MAJOR CONTRIBUTORS.................................................25 8. ACKNOWLEDGMENTS....................................................25 9. SECURITY CONSIDERATIONS............................................25 10. BIBLIOGRAPHY......................................................25 Dawson 2 Expires December 1999 Internet Draft vCard v3.0 XML DTD June 22, 1998 11. AUTHOR'S ADDRESS..................................................26 12. FULL COPYRIGHT STATEMENT..........................................26 Dawson 3 Expires December 1999 Internet Draft vCard v3.0 XML DTD June 22, 1998 1. Introduction The Extended Markup Language (XML) as defined in [XML] is gaining widespread attention as a "web friendly" syntax for representing and exchanging documents and data on the Internet. This interest includes requests for and discussion of possible document type definitions (DTD) for IETF standards such at the vCard, electronic business card format defined by [RFC2426]. The XML DTD in this memo is in no way intended to create a separate definition for the vCard schema. The sole purpose for this memo is to define an alternative XML representation for the format defined by [RFC2426]. The vCard DTD does not introduce any capability not expressible in the format defined by [RFC2426]. An attempt has been made to leverage the standard features of the XMl syntax in order to represent the vCard semantics. For example, strong data typing is specified using the XML notation declaration. It is the responsibility of the XML application supporting this DTD to make sure that the content information is formatted consistently with the notation declared for each element. The vCard DTD promotes a number of vCard properties into attributes on the "vCard" element. This has been done to express these properties as "global attributes" for the vCard object, as a whole. For example, the VERSION, REV, PRODID, UID, CLASS properties have been "mapped" into attributes on the vCard object. Binary content in the PHOTO, LOGO, SOUND and KEY properties may either be specified through an external entity reference to the non- XML image or sound content or may be included in the content after first encoding the binary information using the BASE64 encoding of [RFC 2045]. The publication of [XML] was followed by the publication of a World- Wide-Web Consortium (W3C) recommendation on "Namespaces in XML". A XML namespace is a collection of names, identified by a URI. In anticipation of the broader use of XML namespaces, this memo includes the definition of the URI to be used to identify the namespace associated with the vCard DTD element types in other XML documents. XML applications that conform to this memo and also make use of namespaces MUST NOT include other non-vCard namespaces in a vCard XML document. It is expected that the DTD defined in this memo will not normally be included with vCard XML documents that are distributed. Instead, the DTD will be referenced in the document type declaration in the document entity. Such vCard XML documents will be well-formed and valid, as defined in [XML]. In addition, other vCard XML documents will be specified that do not include the XML prolog. Such vCard XML documents will be well-formed but not valid. Dawson 4 Expires December 1999 Internet Draft vCard v3.0 XML DTD June 22, 1998 2. Using XML for Representing vCard XML is a simplified version of the text markup syntax defined by ISO 8879, Standard Generalized Markup Language (SGML). XML was published as a recommendation [XML] by the W3C on February 10, 1998. 2.1 XML Dependencies This memo specifies the XML representation for the standard vCard format defined by [RFC2426]. There are no XML dependencies other than the [XML] and the [XMLNS] recommendations. 2.2 Document Type Definition A XML DTD for vCard is defined by the DTD specified in section 3. The formal public identifier (FPI) for the DTD is: "-//IETF/DTD VCARDXML/vCard XML//EN" NOTE: The "VCARDXML" text in the FPI value will be replaced with the text "RFC xxxx", where "xxxx" is the RFC number, when the memo is published as a RFC. This FPI MUST be used on the DOCTYPE statement within a XML document referencing the DTD defined by this memo. This FPI SHOULD also be used to identify vCard XML documents within operating system registries of file, clipboard and interactive rendering (e.g., memory clipboard or drag/drop) formats. 2.3 Working With Standard and XML vCard Representations This memo defines an alternative, XML representation for the standard vCard format defined in [RFC2426]. This alternative representation provides the same semantics as that defined in the standard format. 2.3.1 Conversion The standard format can be converted to and from this XML format without loss of any vCard information. When the XML representation was defined, every attempt was made to use existing vCard type and naming conventions for type parameters. This greatly facilitates transformations between the two representations of the vCard. 2.3.2 Mixed Use of Both Representations As previously indicated, conversion between the standard and XML representations of vCard is a straightforward process. In addition, mixed use of both representations is also possible. With the use of the MIME multipart content-types, such as multipart/alternative, compound MIME entities containing a mix of the standard and XML representations can be specified. This capability is Dawson 5 Expires December 1999 Internet Draft vCard v3.0 XML DTD June 22, 1998 useful in applications where both representations might be encountered. In addition, this capability demonstrates the isomeric nature of the two representations. XML applications conforming to this specification MUST be able to properly parse and process a MIME multipart entity containing the MIME content-type associated with this vCard XML document type. 2.4 Using Data Types Strong "data typing" is an integral design principle in the vCard format. Strong data typing in vCard means that the format type for each vCard type value is well known. Within [RFC2426], the data type is called the "value type". The standard format defined by [RFC2426] specifies a default value type for each vCard type. In addition, many of the vCard types allow for the specification of alternate value types. This XML representation continues this design principle. Explicit value typing in the XML representation is specified with the "value" attribute on each element type. In addition, the XML DTD specifies a default value type for each element type. XML documents conforming to this memo need only specify the "value" attribute on element types when the default value type is overridden. The standard value types defined in [RFC2426] are specified in the XML DTD by individual notation declarations. The formal public identifier for standard value types all have the common string format of: -//IETF/NOTATION VCARDXML/VALUE TYPE/xxx//EN NOTE: The "VCARDXML" text in the FPI value will be replaced with the text "RFC xxxx", where "xxxx" is the RFC number, when the memo is published as a RFC. Where "xxx" is replaced with the text specified in the table below. The following table specifies the XML value type that corresponds to each of the standard value types defined in [RFC2426]. +--------------+--------------+-------------------------+ | RFC 2426 | XML Value | Notation FPI Text | | Value Type | Type | | +--------------+--------------+-------------------------+ | BINARY | BINARY | Binary | | BOOLEAN | BOOLEAN | Boolean | | DATE | DATE | Date | | DATE-TIME | DATE-TIME | Date-Time | | FLOAT | FLOAT | Float | | INTEGER | INTEGER | Integer | | PHONE-NUMBER | PHONE-NUMBER | Phone-Number | | TEXT | TEXT | Text | | TIME | TIME | Time | | URI | URI | URI | | UTC-OFFSET | UTC-OFFSET | UTC-Offset | | VCARD | VCARD | vCard | | Non-standard | X-NAME | X-Name | Dawson 6 Expires December 1999 Internet Draft vCard v3.0 XML DTD June 22, 1998 +--------------+--------------+-------------------------+ 2.5 Including Binary Content Binary content can be included in a standard format of vCard with the "PHOTO", "LOGO", or "SOUND" type. In the standard vCard format this content may either be specified through an external entity reference, using a URI value type, or maybe specified within the vCard object, after first BASE64 encoding the content. The XML representation for vCard also supports including binary content in a vCard with the "photo", "logo" and "sound" types. It also supports either an external reference to the non-XML binary content or inclusion of the binary content after first encoding the binary information using the BASE64 encoding of [RFC2045]. Any vCard type defined in [RFC2426] that can be used to include binary content are defined in the XML DTD as an element type with a content model that consists of either the "extref" or the "b64bin" element type. The "extref" element type is used to reference an external entity containing the binary content. An external reference to the binary content is specified by the "uri" attribute on the "extref" element type. For every external reference, an ENTITY declaration and a corresponding NOTATION declaration MUST also be specified in an internal DTD to identify the location and format of the external entity. For example, the following XML snippets would be needed to include a reference to the executable "foo.jpg" in the "photo" element type: <!-- Following specified within the internal DTD. --> <!NOTATION JPEG PUBLIC "ISO/IEC 10918:1993//NOTATION Digital Compression and Coding of Continuous-tone Still Images (JPEG)//EN" > <!ENTITY photo1 SYSTEM "http://host.com/pub/photos/foo.jpg" NDATA JPEG> <!-- Following specified within the body of the XML document. --> <photo><extref uri="photo1" /></photo> The "b64bin" element type is used to include the binary content within the XML document after first character encoding the binary information using the BASE64 encoding method of [RFC2045]. For example, the following XML snippets would be needed to include the executable "foo.jpg" in the "photo" element type; after first BASE64 encoding the binary information: <!-- Following specified within the body of the XML document. --> <photo><b64bin fmttype="IMAGE/JPEG"> MIICajCC AdOgAwIBAgICBEUwDQEEBQAwdzELMAkGA1UEBhMCVVMxLDAqBgNVBAoTI05l dHNjYXBlIENvbW11bmljYXRpb25z...and so on...IENvcnBvc==</b64bin> </photo> Dawson 7 Expires December 1999 Internet Draft vCard v3.0 XML DTD June 22, 1998 2.6 Including Multiple vCard Objects The vCard standard format has the capability for including multiple, individual vCards in a single data stream. The XML representation also supports this feature. Individual vCards are specified by the "vCard" element type. One or more "vCard" element types are permitted within the parent element type, called "vCardSet". For example: <vCardSet><vCard version="3.0"> <!-- remainder of the first vCard object --> </vCard> <vCard version="3.0"> <!-- remainder of the second vCard object --> </vCard></vCardSet> 2.7 Mapping vCard Type Parameters to XML The type parameters defined in the standard vCard format are represented in the XML representation as attributes on element types. The following table specifies the attribute name corresponding to each type parameter. +----------------+------------+-----------+-----------------+ | Type | Attribute | Attribute | Default | | Parameter Name | Name | Type | Value | +----------------+------------+-----------+-----------------+ | ENCODING | Not Used | n/a | n/a | | LANGUAGE | lang | CDATA | IMPLIED | | TYPE for ADR | del.type | NMTOKENS | 'INTL POSTAL | | and LABEL | | | PARCEL WORK' | | TYPE for TEL | tel.type | NMTOKENS | 'VOICE' | | TYPE for EMAIL | email.type | NMTOKENS | 'INTERNET' | | TYPE for PHOTO,| img.type | CDATA | REQUIRED | | and LOGO | | | | | TYPE for SOUND | aud.type | CDATA | REQUIRED | | VALUE | value | NOTATION | See elements | +----------------+------------+-----------+-----------------+ The "VERSION", "REV", "PRODID", "UID" and "CLASS" vCard types have been mapped into the attributes as specified by the following table. +----------------+------------+------------+----------------+ | Type | Attribute | Attribute | Default | | Name | Name | Type | Value | +----------------+------------+------------+----------------+ | CLASS | class | enumerated | 'PUBLIC' | | PRODID | prodid | CDATA | IMPLIED | | REV | rev | CDATA | IMPLIED | | UID | uid | CDATA | IMPLIED | | VERSION | version | CDATA | IMPLIED | +----------------+------------+------------+----------------+ Dawson 8 Expires December 1999 Internet Draft vCard v3.0 XML DTD June 22, 1998 The inline "ENCODING" property parameter is not needed in the XML representation. Inline binary information is always included as parsable character data, after first being encoded using the BASE64 encoding of [RFC 2045]. A non-standard, experimental parameter can be added to the XML representation by declaring it in an attribute list declaration and assigning it a XML attribute type and corresponding default value. In addition to these attributes, the "vCard" element type can also have the following attributes: +-----------+-----------+---------+----------------------------+ | Attribute | Attribute | Default | Description | | Name | Type | Value | | +-----------+-----------+---------+----------------------------+ | xmlns | CDATA | FIXED | Used to specify the default| | | | | vCard XML name space. | | xmlns: + | CDATA | FIXED | Used to specify the | | <namespace| | | A string with "xmlns:" | | prefix> | | | prefix is used to specify | | | | | a namespace. | +-----------+-----------+---------+----------------------------+ The semantics of the"xmlns" attribute, and any attribute with "xmlns:" as a prefix, is as specified in [XMLNS]. It is used to declare a namespace in XML. It can be used to declare the vCard XML namespace in a XML document with a document type other than the vCard XML document type. The vCard XML document type MUST only use element types from the vCard namespace. To specify the vCard namespace, the attribute value for the "xmlns" and any attribute with the prefix "xmlns:" MUST be: 'http://www.ietf.org/internet-drafts/draft-dawson-vCard-xml-dtd- 04.txt' NOTE: This attribute value will be replaced with the URL "http://www.ietf.org/rfc/rfcxxxx.txt", where "xxxx" is the RFC number, when this memo is published as a RFC. For example: <vCard xmlns:xcfxml='http://www.ietf.org/internet- drafts/draft-dawson-vcard-xml-dtd-04.txt'> <!-- the "xcfxml" prefix is bound to 'http://www.ietf.org/internet-drafts/draft-dawson-vcard-xml-dtd- 04.txt' for the "vCard" element and contents--> </vCard> Dawson 9 Expires December 1999 Internet Draft vCard v3.0 XML DTD June 22, 1998 2.8 Mapping vCard Types to XML The following tables provide mappings of the vCard types to their corresponding XML element types along with their respective content models. Identification Types +----------------+------------+-----------------------------+ | vCard | Element | Element Content Model | | Type Name | Name | | +----------------+------------+-----------------------------+ | FN | fn | PCDATA | | N | n | family*,given*,other*, | | | | prefix*, suffix* | | | family | PCDATA | | | given | PCDATA | | | other | PCDATA | | | prefix | PCDATA | | | suffix | PCDATA | | NICKNAME | nickname | PCDATA | | PHOTO | photo | extref or b64bin | | | extref | EMPTY | | | b64bin | PCDATA | | BDAY | bday | PCDATA | +----------------+------------+-----------------------------+ Delivery Addressing Types +----------------+------------+-----------------------------+ | vCard | Element | Element Content Model | | Type Name | Name | | +----------------+------------+-----------------------------+ | ADR | adr | pobox*,extadd*,street*, | | | | locality*,region*,pcode*, | | | | country* | | | pobox | PCDATA | | | extadd | PCDATA | | | street | PCDATA | | | locality | PCDATA | | | region | PCDATA | | | pcode | PCDATA | | | country | PCDATA | | LABEL | LABEL | PCDATA | +----------------+------------+-----------------------------+ Telecommunications Addressing Types +----------------+------------+-----------------------------+ | vCard | Element | Element Content Model | | Type Name | Name | | +----------------+------------+-----------------------------+ | TEL | tel | PCDATA | | EMAIL | email | PCDATA | | MAILER | mailer | PCDATA | +----------------+------------+-----------------------------+ Dawson 10 Expires December 1999 Internet Draft vCard v3.0 XML DTD June 22, 1998 Geographical Types +----------------+------------+-----------------------------+ | vCard | Element | Element Content Model | | Type Name | Name | | +----------------+------------+-----------------------------+ | TZ | tz | PCDATA | | GEO | geo | lat,lon | | | lat | PCDATA | | | lon | PCDATA | +----------------+------------+-----------------------------+ Organizational Types +----------------+------------+-----------------------------+ | vCard | Element | Element Content Model | | Type Name | Name | | +----------------+------------+-----------------------------+ | TITLE | title | PCDATA | | ROLE | role | PCDATA | | LOGO | logo | extref or b64bin | | | extref | EMPTY | | | b64bin | PCDATA | | AGENT | agent | vCard | extref | | ORG | org | orgnam,orgunit* | | | orgnam | PCDATA | | | orgunit | PCDATA +----------------+------------+-----------------------------+ Explanatory Types +----------------+------------+-----------------------------+ | vCard | Element | Element Content Model | | Type Name | Name | | +----------------+------------+-----------------------------+ | CATEGORIES | categories | item* | | | item | PCDATA | | NOTE | note | PCDATA | | SORT-STRING | sort | PCDATA | | SOUND | sound | extref | b64bin | | | extref | EMPTY | | | b64bin | PCDATA | | URL | url | PCDATA | | URI | uri | PCDATA | +----------------+------------+-----------------------------+ Security Types +----------------+------------+-----------------------------+ | vCard | Element | Element Content Model | | Type Name | Name | | +----------------+------------+-----------------------------+ | KEY | key | extref | b64bin | | | extref | EMPTY | | | b64bin | PCDATA | Dawson 11 Expires December 1999 Internet Draft vCard v3.0 XML DTD June 22, 1998 +----------------+------------+-----------------------------+ Non-standard, experimental element types and attributes lists MUST only be specified by declarations in an internal DTD within the vCard XML document. The [RFC2426] specification specifies that the vCard types corresponding to the "label" and "note" element types can contain formatted content, such as is specified by multiple lines of text. In such cases, the formatted text should be specified as CDATA section content. The CDATA section specifies arbitrary character data that is not meant to be interpretted. It is not scanned for markup by the XML parser. 2.9 Parameter Entities The external, vCard XML DTD specified in section 3 makes use of parameter entity declarations. This XML feature is used to group declarations within the DTD. This technique has been used in DTD design in order to facilitate the reading and comprehension of the structure specified by the DTD. 2.10 Namespace [XMLNS] defines "Namespaces in XML" to be a collection of names, identified by a URI, which are used in XML documents as element types and attribute names. The [XML] specification does not include a definition for namespaces, but does set down some guidelines for experimental naming of namespaces. XML namespaces allow multiple markup vocabularies in a single document. Considering the utility of the vCard types in other applications, it is important for the vCard XML DTD to define a namespace for the vCard element types and attributes. This memo defines the value that MUST be used in non-vCard XML documents that reference element types or attribute lists from the vCard namespace. The following is an example of a well-formed but invalid "xdoc" document type that includes elements and attribute lists from the vCard namespace: <?xml version="1.0" encoding="UTF-8"?> <xdoc> <xcfxml:vCard version="3.0" xmlns:xcfxml="http://www.ietf.org/internet -drafts/draft-dawson-vcard-xml-dtd-04.txt"> <!-- Remainder of the XML document, each element from the --> <!-- vCard namespace with the "xcfxml:" prefix. --> </xcfxml:vCard> </xdoc> Dawson 12 Expires December 1999 Internet Draft vCard v3.0 XML DTD June 22, 1998 2.11 Emailing the vCard XML Representation It is expected that vCard XML documents will need to be sent over SMTP/MIME email. The "text/xml" and "application/xml" content-types have been registered for XML documents. The "text/xml" and "application/xml" content-type definitions do not provide for any header field parameters to identify the type of XML document contained in the MIME entity. This means that a recipient mail user agent must (MUA) open up each "text/xml" or "application/xml" content in order to determine what object handler is needed to process the information. To a MUA, all XML documents look like just plain "text/xml" or "application/xml" content. Internet application conforming to this memo MUST identify vCard XML documents with the experimental content-type "text/x-xcfxml". For example, a vCard XML document would have the following content-type header field: content-type:text/x-xcfxml An XML application supporting the vCard XML document type MUST be able to receive and properly process the "text/x-vcardxml" content- type contained within a "multipart" message. 2.12 vCard XML Representation and File Systems The vCard XML documents will be stored in file systems. The accepted practice for file extensions for XML documents is the text "XML". However, in order to uniquely identify vCard XML documents for file association with applications that can directly process this document type, it is RECOMMENDED that the file extension be the text "XCF". 3. vCard XML Document Type Definition The following DTD conforms to XML version 1.0, as specified by [XML]. <?xml version="1.0" encoding="UTF-8"?> <!-- ******************************************** --> <!-- Entity declarations and references --> <!-- ******************************************** --> <!ENTITY % attr.lang " lang CDATA #IMPLIED "> <!-- lang value is a valid RFC 1766 language string --> <!ENTITY % attr.del " del.type NMTOKENS 'INTL POSTAL PARCEL WORK' "> <!-- Valid name tokens are "INTL", "DOM", "POSTAL", "PARCEL" Dawson 13 Expires December 1999 Internet Draft vCard v3.0 XML DTD June 22, 1998 "WORK", "HOME" --> <!ENTITY % attr.tel " tel.type NMTOKENS 'VOICE' "> <!-- Valid name tokens are "HOME", "WORK", "MSG", "PREF" "VOICE", "FAX", "CELL", "VIDEO", "PAGER", "BBS", "MODEM" "CAR", "ISDN", "PCS" --> <!ENTITY % attr.email " email.type NMTOKENS 'INTERNET' "> <!-- Valid name tokens are "INTERNET", "X.400", "PREF" --> <!ENTITY % attr.img " img.type CDATA #REQUIRED "> <!-- img.type value is an IANA registered image type --> <!ENTITY % attr.aud " aud.type CDATA #REQUIRED "> <!-- aud.type value is an IANA registered audio type --> <!-- The mandatory properties in any vCard --> <!ENTITY % prop.man " (fn, n) "> <!-- Identification properties --> <!ENTITY % prop.id " (nickname | photo | bday) "> <!-- Delivery addressing properties --> <!ENTITY % prop.del " (adr | label) "> <!-- Telecommunications addressing properties --> <!ENTITY % prop.tel " (tel | email | mailer) "> <!-- Geographical properties --> <!ENTITY % prop.geo " (tz | geo) "> <!-- Organizational properties --> <!ENTITY % prop.org " (title | role | logo | agent | org) "> Dawson 14 Expires December 1999 Internet Draft vCard v3.0 XML DTD June 22, 1998 <!-- Explanatory propeties --> <!ENTITY % prop.exp " (categories | note | sort | sound | url) "> <!-- Security properties --> <!ENTITY % prop.sec " (key) "> <!-- The optional properties in a vCard --> <!ENTITY % prop.opt " %prop.id; | %prop.del; | %prop.tel; | %prop.geo; | %prop.org; | %prop.exp; | %prop.sec; "> <!-- ******************************************** --> <!-- vCard value type notation declarations --> <!-- ******************************************** --> <!NOTATION URI PUBLIC "-//IETF//NOTATION VCARDXML/Value Type URI//EN"> <!NOTATION TEXT PUBLIC "-//IETF//NOTATION VCARDXML/Value Type Text//EN"> <!NOTATION DATE PUBLIC "-//IETF//NOTATION VCARDXML/Value Type Date//EN"> <!NOTATION TIME PUBLIC "-//IETF//NOTATION VCARDXML/Value Type Time//EN"> <!NOTATION DATE-TIME PUBLIC "-//IETF//NOTATION VCARDXML/Value Type Date-Time//EN"> <!NOTATION INTEGER PUBLIC "-//IETF//NOTATION VCARDXML/Value Type Integer//EN"> <!NOTATION BOOLEAN PUBLIC "-//IETF//NOTATION VCARDXML/Value Type Boolean//EN"> <!NOTATION FLOAT PUBLIC "-//IETF//NOTATION VCARDXML/Value Type Float//EN"> <!NOTATION X-NAME PUBLIC "-//IETF//NOTATION VCARDXML/Value Type X- Name//EN"> <!NOTATION BINARY PUBLIC "-//IETF//NOTATION VCARDXML/Value Type Binary//EN"> <!NOTATION VCARD PUBLIC "-//IETF//NOTATION VCARDXML/Value Type vCard//EN"> Dawson 15 Expires December 1999 Internet Draft vCard v3.0 XML DTD June 22, 1998 <!NOTATION PHONE-NUMBER PUBLIC "-//IETF//NOTATION VCARDXML/Value Type Phone-Number//EN"> <!NOTATION UTC-OFFSET PUBLIC "-//IETF//NOTATION VCARDXML/Value Type UTC-Offset//EN"> <!-- ******************************************** --> <!-- vCard element and attribute declarations --> <!-- ******************************************** --> <!ELEMENT vCardSet (vCard*)> <!ATTLIST vCardSet name CDATA #IMPLIED> <!ELEMENT vCard (%prop.man;, (%prop.opt;)*)> <!ATTLIST vCard %attr.lang; xmlns CDATA #FIXED 'http://www.ietf.org/internet-drafts/draft- dawson-vcard-xml-dtd-03.txt' xmlns:vcf CDATA #FIXED 'http://www.ietf.org/internet- drafts/draft-dawson-vcard-xml-dtd-03.txt' version CDATA #REQUIRED rev CDATA #IMPLIED uid CDATA #IMPLIED prodid CDATA #IMPLIED class (PUBLIC | PRIVATE | CONFIDENTIAL) "PUBLIC" value NOTATION (VCARD) #IMPLIED> <!-- version - Must be "3.0" if document conforms to this spec --> <!-- rev - ISO 8601 formatted date or date/time string --> <!-- uid - UID associated with the object described by the vCard --> <!-- prodid - ISO 9070 FPI for product that generated vCard --> <!-- class - Security classification for vCard information --> <!-- Identification properties --> <!-- Element and attribute declarations --> <!ELEMENT fn (#PCDATA)> <!ATTLIST fn %attr.lang; value NOTATION (TEXT) #IMPLIED> <!ELEMENT n (family*, given*, other*, prefix*, suffix*)> <!ELEMENT family (#PCDATA)> <!ATTLIST family %attr.lang; value NOTATION (TEXT) #IMPLIED> <!ELEMENT given (#PCDATA)> <!ATTLIST given %attr.lang; value NOTATION (TEXT) #IMPLIED> <!ELEMENT other (#PCDATA)> <!ATTLIST other Dawson 16 Expires December 1999 Internet Draft vCard v3.0 XML DTD June 22, 1998 %attr.lang; value NOTATION (TEXT) #IMPLIED> <!ELEMENT prefix (#PCDATA)> <!ATTLIST prefix %attr.lang; value NOTATION (TEXT) #IMPLIED> <!ELEMENT suffix (#PCDATA)> <!ATTLIST suffix %attr.lang; value NOTATION (TEXT) #IMPLIED> <!ELEMENT nickname (#PCDATA)> <!ATTLIST nickname %attr.lang; value NOTATION (TEXT) #IMPLIED> <!ELEMENT photo (extref | b64bin)> <!ATTLIST photo %attr.img;> <!-- extref holds a reference to an external entity that --> <!-- has the photo. b64bin holds the inline BASE64 encoded --> <!-- binary data for the photo as defined in RFC 2045. --> <!ELEMENT extref EMPTY> <!ATTLIST extref uri ENTITY #REQUIRED> <!ELEMENT b64bin (#PCDATA)> <!ATTLIST b64bin value NOTATION (BINARY) #IMPLIED> <!ELEMENT bday (#PCDATA)> <!ATTLIST bday value NOTATION (DATE | DATE-TIME) #IMPLIED> <!-- bday holds a ISO 8601 formatted date or date/time string --> <!-- value MUST be "DATE" for a date string and "DATE-TIME" for --> <!-- date/time string. --> <!-- Delivery addressing properties --> <!-- Element and attribute declarations --> <!ELEMENT adr (pobox*, extadd*, street*, locality*, region*, pcode*, country*)> <!ATTLIST adr %attr.del; > <!ELEMENT pobox (#PCDATA)> <!ATTLIST pobox %attr.lang; value NOTATION (TEXT) #IMPLIED> <!ELEMENT extadd (#PCDATA)> Dawson 17 Expires December 1999 Internet Draft vCard v3.0 XML DTD June 22, 1998 <!ATTLIST extadd %attr.lang; value NOTATION (TEXT) #IMPLIED> <!ELEMENT street (#PCDATA)> <!ATTLIST street %attr.lang; value NOTATION (TEXT) #IMPLIED> <!ELEMENT locality (#PCDATA)> <!ATTLIST locality %attr.lang; value NOTATION (TEXT) #IMPLIED> <!ELEMENT region (#PCDATA)> <!ATTLIST region %attr.lang; value NOTATION (TEXT) #IMPLIED> <!ELEMENT pcode (#PCDATA)> <!ATTLIST pcode %attr.lang; value NOTATION (TEXT) #IMPLIED> <!ELEMENT country (#PCDATA)> <!ATTLIST country %attr.lang; value NOTATION (TEXT) #IMPLIED> <!ELEMENT label (#PCDATA)*> <!ATTLIST label %attr.del; %attr.lang; value NOTATION (TEXT) #IMPLIED> <!-- Telecommunications addressing properties --> <!-- Element and attribute declarations --> <!ELEMENT tel (#PCDATA)> <!-- A valid ITU standard telephone numbers string. --> <!ATTLIST tel %attr.tel; value NOTATION (PHONE-NUMBER) #IMPLIED> <!ELEMENT email (#PCDATA)> <!ATTLIST email %attr.email; value NOTATION (TEXT) #IMPLIED> <!ELEMENT mailer (#PCDATA)> <!ATTLIST mailer %attr.lang; value NOTATION (TEXT) #IMPLIED> Dawson 18 Expires December 1999 Internet Draft vCard v3.0 XML DTD June 22, 1998 <!-- Geographical properties --> <!-- Element and attribute declarations --> <!ELEMENT tz (#PCDATA)> <!ATTLIST tz value NOTATION (UTC-OFFSET) #IMPLIED> <!-- tz holds an ISO 8601 formatted time zone offset. --> <!ELEMENT geo (lat, lon)> <!ELEMENT lat (#PCDATA)> <!ATTLIST lat value NOTATION (FLOAT) #IMPLIED> <!-- A decimal degree float number to 6 decimal places --> <!ELEMENT lon (#PCDATA)> <!ATTLIST lon value NOTATION (FLOAT) #IMPLIED> <!-- A decimal degree float number to 6 decimal places --> <!-- Organizational properties --> <!-- Element and attribute declarations --> <!ELEMENT title (#PCDATA)> <!ATTLIST title %attr.lang; value NOTATION (TEXT) #IMPLIED> <!ELEMENT role (#PCDATA)> <!ATTLIST role %attr.lang; value NOTATION (TEXT) #IMPLIED> <!ELEMENT logo (extref | b64bin)> <!ATTLIST logo %attr.img;> <!-- extref holds a reference to an external entity that --> <!-- has the logo. b64bin holds the inline BASE64 encoded --> <!-- binary data for the logo as defined in RFC 2045. --> <!ELEMENT agent (vCard | extref)> <!-- value MUST be "VCARD" for a "vCard" content model and --> <!-- "URI" for a "extref" content model. --> <!ELEMENT org (orgnam, orgunit*)> <!ELEMENT orgnam (#PCDATA)> <!ATTLIST orgnam %attr.lang; value NOTATION (TEXT) #IMPLIED> <!ELEMENT orgunit (#PCDATA)> <!ATTLIST orgunit %attr.lang; value NOTATION (TEXT) #IMPLIED> Dawson 19 Expires December 1999 Internet Draft vCard v3.0 XML DTD June 22, 1998 <!-- Explanatory properties --> <!-- Element and attribute declarations --> <!ELEMENT categories (item)*> <!ELEMENT item (#PCDATA)> <!ATTLIST item %attr.lang; value NOTATION (TEXT) #IMPLIED> <!ELEMENT note (#PCDATA)*> <!ATTLIST note %attr.lang; value NOTATION (TEXT) #IMPLIED> <!ELEMENT sort (#PCDATA)> <!ATTLIST sort %attr.lang; value NOTATION (TEXT) #IMPLIED> <!ELEMENT sound (extref | b64bin)> <!ATTLIST sound %attr.aud;> <!-- extref holds a reference to an external entity that --> <!-- has the sound. b64bin holds the inline BASE64 encoded --> <!-- binary data for the sound as defined in RFC 2045. --> <!ELEMENT url EMPTY> <!ATTLIST url uri ENTITY #REQUIRED> <!-- url holds a RFC 1738 formatted Uniform Resource Locator --> <!-- Security properties --> <!-- Element and attribute declarations --> <!ELEMENT key (extref | b64bin)> <!-- extref holds a reference to an external entity that --> <!-- has the key or cert. base64-data has the actual data for --> <!-- the key or cert, encoded with Base64 as defined in the --> <!-- MIME spec. --> 4. vCard v3.0 Notation The formal public identifier (FPI) for the DTD described in this specification is "-//IETF//DTD vCard v3.0//EN". A XML document can reference an external non-XML entity containing a vCard v3.0 object, as specified by [RFC2426]. The vCard v3.0 object, while encoded in the standard, non-XML format can be referenced in an external entity reference that identifies the [RFC2426] format in a notation declaration. The [RFC2426] format is identified by the Dawson 20 Expires December 1999 Internet Draft vCard v3.0 XML DTD June 22, 1998 formal public identifier "-//IETF//NONSGML vCard version 3.0//EN", as defined in [FPI]. 5. Example Usage 5.1 Simple vCard The following is a simple example of a XML document using this DTD. <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE vCard PUBLIC "-//IETF//DTD vCard v3.0//EN"> <vCard version="3.0"> <fn>Frank Dawson</fn> <n><family>Dawson</family> <given>Frank</given></n> <tel tel.type="WORK MSG PREF">+1-617-693-8728</tel> <tel tel.type="WORK MSG">+1-919-676-9515</tel> <adr del.type="POSTAL PARCEL WORK"> <street>6544 Battleford Drive</street> <locality>Raleigh</locality> <region>NC</region> <pcode>27613-3502</pcode> <country>US</country></adr> <label del.type="POSTAL PARCEL WORK"><![CDATA[6544 Battleford Drive Raleigh, NC 27613-3502 US]]></label> <email email.type="INTERNET">Frank_Dawson@Lotus.com</email> </vCard> 5.2 vCard with non-standard extension The following is an example of vCard that also includes a non- standard extension. <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE vCard PUBLIC "-//IETF//DTD vCard v3.0//EN" [ <!ELEMENT vCard (%prop.man;, (%prop.opt; | x-foo-blood-type)+)> <!ELEMENT x-foo-blood-type (#PCDATA)> <!ATTLIST x-foo-blood-type value NOTATION(X-NAME) #IMPLIED> ]> <vCard version="3.0" prodid="-//HandGen//NONSGML vGen v1.0//EN"> <fn>Frank Dawson</fn> <n> <family>Dawson</family> <given>Frank</given></n> <tel tel.type="WORK MSG">+1-617-693-8728</tel> <x-foo-blood-type>O+</x-foo-blood-type> </vCard> Dawson 21 Expires December 1999 Internet Draft vCard v3.0 XML DTD June 22, 1998 5.3 vCard with photo element The following is an example of a vCard that also includes an external reference to a photo. Similar structure would be used to represent a vCard with an external reference to a logo, sound or public key/certificate. <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE vCard PUBLIC "-//IETF//DTD vCard v3.0//EN" [ <!NOTATION JPEG PUBLIC "ISO/IEC 10918:1993//NOTATION Digital Compression and Coding of Continuous-tone Still Images (JPEG)//EN" > <!ENTITY photo1 SYSTEM "http://host.com/pub/photos/frd-photo.jpg" NDATA JPEG> ]> <vCard version="3.0" prodid="-//HandGen//NONSGML vGen v1.0//EN"> <fn>Frank Dawson</fn> <n> <family>Dawson</family> <given>Frank</given></n> <tel tel.type="WORK MSG">+1-617-693-8728</tel> <photo img.type="JPEG"><extref uri="photo1" /></photo> <email email.type="INTERNET">Frank_Dawson@Lotus.com</email> </vCard> The following is an example of a vCard that includes a photo element as inline binary content. <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE vCard PUBLIC "-//IETF//DTD vCard v3.0//EN"> <vCard version="3.0"> <fn>Frank Dawson</fn> <n><family>Dawson</family><given>Frank</given></n> <photo img.type="JPEG"><b64bin>MIICajCCAdOgAwIBAgICBEUwDQ EEBQAwdzELMAkGA1UEBhMCVVMxLDAqBgNVBAoTI05ldHNjYXBlIENvbW11bmlj YXRpb25z...and so on...IENvcnBvc==</b64bin></photo> </vCard> 5.4 vCard with an agent element The following is an example of a vCard that includes an agent element. The content of the agent element is another vCard. <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE vCard PUBLIC "-//IETF//DTD vCard v3.0//EN"> <vCard version="3.0" prodid="-//HandGen//NONSGML vGen v1.0//EN"> <fn>Frank Dawson</fn> <n> <family>Dawson</family> Dawson 22 Expires December 1999 Internet Draft vCard v3.0 XML DTD June 22, 1998 <given>Frank</given></n> <tel tel.type="WORK MSG">+1.617.693.8728</tel> <agent><vCard version="3.0" prodid="-//HandGen//NONSGML vGen v1.0//EN"> <fn>Kathie Collins</fn> <n> <family>Collins</family> <given>Kathie</given></n> <tel tel.type="WORK MSG">+1.617.693-5660</tel> <email email.type="INTERNET">Kathie_Collins@Lotus.com</email> </vCard></agent> <email email.type="INTERNET">Frank_Dawson@Lotus.com</email> </vCard> 5.5 Document with multiple vCards The following is an example of a vCard document that includes more than one vCard. <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE vCard PUBLIC "-//IETF//DTD vCard v3.0//EN"> <vCardSet name="Mailing List"> <vCard version="3.0"> <fn>John Smith</fn> <n> <family>Smith</family> <given>John</given> <email email.type="INTERNET">jsmith@host.com</email> </vCard> <vCard version="3.0"> <fn>Fred Stone</fn> <n> <family>Stone</family> <given>Fred</given> <email email.type="INTERNET">fstone@host1.com</email> </vCard> </vCardSet> 5.6 Document utilizing vCard namespace The following is an example of a XML document that declares the vCard namespace as its default namespace. <?xml version="1.0" encoding="UTF-8"?> <vCard version="3.0" xmlns="http://www.ietf.org/internet-drafts/ draft-dawson-vcard-xml-dtd-03.txt"> <fn>Frank Dawson</fn> <n> <family>Dawson</family> <given>Frank</given> <email email.type="INTERNET">fdawson@host1.com</email> </vCard> The following is an example of a XML document that includes elements from the vCard namespace. Dawson 23 Expires December 1999 Internet Draft vCard v3.0 XML DTD June 22, 1998 <?xml version="1.0" encoding="UTF-8"?> <x xmlns:vcf="http://www.ietf.org/internet-drafts/ draft-dawson-vcard-xml-dtd-03.txt" xmlns:pdi="http://pdi.org/schema"> <vcf:fn>John Smith</vcf:fn> <vcf:tel tel.type="WORK">+1-919-555-1234</vcf:tel> <pdi:idnum>1234567</pdi:idnum> <pdi:usage>999.99</pdi:usage> </x> 5.7 XML document reference to a non-XML vCard The following is an example of a XML document with a proper reference to a non-XML entity containing a vCard object in the format defined by [RFC2426]. This example shows how existing vCard objects can be integrated into XML documents using the XML structure defined in this document. <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE loanappl SYSTEM "http://host.finance.com/loanappl.dtd" [ <!ENTITY fdawson SYSTEM "http://fdawson.com/myvcard.vcf" NDATA vCard> <!NOTATION vCard PUBLIC "-//IETF//NOTATION vCard version 3.0//EN"> ]> <loan> <pd vcard=fdawson></pd> <acct name=CFCU id="http://www.cfu.org">01234-56789</acct> <amt need="immediate">$1,000,000</amt> </loan> 6. Namespace [XMLNS] defines "XML namespaces" to be a collection of names, identified by a URI, which are used in XML documents as element types and attribute names. XML namespaces allow multiple markup vocabulary in a single document. Considering the utility of the vCard properties in other applications, it is important for the vCard XML DTD to define a namespace for the vCard element types. This memo includes the definition of both a qualified name for the vCard namespace and also a default namespace. The namespace declaration is specified by attributes on the "vCard" element. The default namespace is specified with the "xmlns" attribute and the qualified name for the vCard namespace is specified with the "xmlns:vcf" attribute. The default namespace attribute is useful in XML documents that are based on the vCard document types. The qualified name for the vCard Dawson 24 Expires December 1999 Internet Draft vCard v3.0 XML DTD June 22, 1998 namespace is useful in XML documents that partially consist of vCard elements types but also consist of element types from other schemas. The following is an example of the a vCard namespace declaration using the qualified namespace: <?xml version="1.0" encoding="UTF-8"?> <xcf:vCard version="3.0" xmlns:xcf="http://www.ietf.org/internet- drafts/ draft-dawson-vcard-xml-dtd-03.txt"> <!-- Remainder of the XML document, each vCard element prefaced --> <!-- with the "xcf:" prefix... --> </xcf:vCard> The following is an example of a vCard namespace declaration using the default namespace: <?xml version="1.0" encoding="UTF-8"?> <x xmlns="http://www.ietf.org/internet-drafts/ draft-dawson-vcard-xml-dtd-04.txt"> <!-- Remainder of the XML document, each vCard element prefaced --> <!-- with the "xcf:" prefix... --> </x> 7. Major Contributors The following individual has provided major contribution in the concepts and content to this memo: Paul Hoffman 8. Acknowledgments The following have participated in the drafting and discussion of this memo: Scott Boag, Dean Burton, Charles Goldfarb, Alex Hoppman, Lisa Lippert, Sean McGrath, Noah Mendelsohn, Surendra Reddy, Thomas Rowe, Doug Royer 9. Security Considerations Security issues are not currently discussed in this memo. 10. Bibliography [FPI] F. Dawson and P. Hoffman, "vCard v3.0 Formal Public Identifier", Internet Draft, http://www.internic.net/internet- drafts/draft-dawson-vcard-fpi-00.txt, July 1998. Dawson 25 Expires December 1999 Internet Draft vCard v3.0 XML DTD June 22, 1998 [ISO9070] "Information Technology_SGML Support Facilities_ Registration Procedures for Public Text Owner Identifiers", ISO/IEC 9070, Second Edition, International Organization for Standardization, April, 1991. [RFC 2045] N. Freed, N. Borenstein, "Multipurpose Internet Mail Extensions (MIME) - Part One: Format of Internet Message Bodies", RFC 2045, http://www.ietf.org/rfc/rfc2045.txt, November 1996. [RFC 2119] S. Bradner, "Key words for use in RFCs to Indicate Requirement Levels", RFC 2119, http://www.ietf.org/rfc/rfc2119.txt, March 1997. [RFC2426] F. Dawson and T. Howes, "vCard MIME Directory Profile", RFC 2426, http://www.ietf.org/rfc/rfc2426.txt, September 1998. [XML] "Extensible Markup Language (XML)", Worldwid Web Consortium, http://www.w3.org/TR/1998/REC-xml-19980210, February 1998. [XMLNS] "Namespaces in XML", Worldwide Web Consortium, http://www.w3.org/TR/1999/REC-xml-names-19990114, January 1999. 11. Author's Address The following address information is provided in a vCard XML DTD electronic business card, format. <vCard version="3.0" prodid="-//HandGen//NONSGML vGen v1.0//EN"> <fn>Frank Dawson</fn> <n> <family>Dawson</family> <given>Frank</given></n> <org><orgname>Lotus Development Corporation</orgname> <adr adr.type="WORK POSTAL PARCEL"> <street>6544 Battleford Drive</street> <locality>Raleigh</locality> <region>NC</region> <pcode>27613-3502</pcode> <countryUSA</country></adr> <tel tel.type="PREF WORK MSG">+1-617-693-8728</tel> <tel tel.type="WORK MSG">+1-919-676-9515</tel> <email email.type="PREF INTERNET">Frank_Dawson@Lotus.com</email> <email email.type="INTERNET">fdawson@earthlink.net</email> </vCard> 12. Full Copyright Statement "Copyright (C) The Internet Society (1999).All Rights Reserved. This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it Dawson 26 Expires December 1999 Internet Draft vCard v3.0 XML DTD June 22, 1998 or assist in its implmentation may be prepared, copied, published and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this paragraph are included on all such copies and derivative works.However, this document itself may not be modified in any way, such as by removing the copyright notice or references to the Internet Society or other Internet organizations, except as needed for the purpose of developing Internet standards in which case the procedures for copyrights defined in the Internet Standards process MUST be followed, or as required to translate it into languages other than English. The limited permissions granted above are perpetual and will not be revoked by the Internet Society or its successors or assigns. This document and the information contained herein is provided on an "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Dawson 27 Expires December 1999