Internet DRAFT - draft-thomson-revised-civic-lo
draft-thomson-revised-civic-lo
GEOPRIV WG M. Thomson
Internet-Draft J. Winterbottom
Expires: April 6, 2006 Andrew
October 3, 2005
Revised Civic Location Format for PIDF-LO
draft-thomson-revised-civic-lo-01.txt
Status of this Memo
By submitting this Internet-Draft, each author represents that any
applicable patent or other IPR claims of which he or she is aware
have been or will be disclosed, and any of which he or she becomes
aware will be disclosed, in accordance with Section 6 of BCP 79.
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.
This Internet-Draft will expire on April 6, 2006.
Copyright Notice
Copyright (C) The Internet Society (2005).
Abstract
This document defines an XML format for the representation of civic
location. This format is designed for use with PIDF Location Object
(PIDF-LO) documents. The format is based on the civic address
definition in PIDF-LO, but adds several new elements based on the
civic types defined for DHCP. The format also includes support for
the xml:lang language tag and restricts the types of elements where
appropriate.
Thomson & Winterbottom Expires April 6, 2006 [Page 1]
Internet-Draft Revised Civic LO October 2005
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3
2. Changes from PIDF-LO . . . . . . . . . . . . . . . . . . . . . 4
2.1. Additional Civic Address Types . . . . . . . . . . . . . . 4
2.2. Country Element . . . . . . . . . . . . . . . . . . . . . 5
2.3. Languages and Scripts . . . . . . . . . . . . . . . . . . 5
2.4. Whitespace . . . . . . . . . . . . . . . . . . . . . . . . 6
3. Civic Address Schema . . . . . . . . . . . . . . . . . . . . . 7
4. Example . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
5. Security Considerations . . . . . . . . . . . . . . . . . . . 10
6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 11
6.1. URN sub-namespace registration for
'urn:ietf:params:xml:ns:pidf:geopriv10:civicAddr' . . . . 11
7. References . . . . . . . . . . . . . . . . . . . . . . . . . . 12
7.1. Normative References . . . . . . . . . . . . . . . . . . . 12
7.2. Informative References . . . . . . . . . . . . . . . . . . 12
Appendix A. Acknowledgements . . . . . . . . . . . . . . . . . . 13
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 14
Intellectual Property and Copyright Statements . . . . . . . . . . 15
Thomson & Winterbottom Expires April 6, 2006 [Page 2]
Internet-Draft Revised Civic LO October 2005
1. Introduction
Since the publication of the original PIDF-LO civic specification, in
[I-D.ietf-geopriv-pidf-lo], it has been found that the specification
is lacking a number of additional parameters that can be used to more
precisely specify a civic location. These additional parameters have
been suitably captured in [I-D.ietf-geopriv-dhcp-civil].
This document revises the GEOPRIV civic form to include the
additional civic parameters captured in [I-D.ietf-geopriv-dhcp-
civil]. New elements are also defined to allow for even more
precision in specifying location information.
Thomson & Winterbottom Expires April 6, 2006 [Page 3]
Internet-Draft Revised Civic LO October 2005
2. Changes from PIDF-LO
2.1. Additional Civic Address Types
[I-D.ietf-geopriv-dhcp-civil] provides a full set of parameters that
may used to describe a civic location. Specifically [I-D.ietf-
geopriv-dhcp-civil] lists 6 civic address types (CAtypes) that
require support in the formal PIDF-LO definition that are not in
[I-D.ietf-geopriv-pidf-lo]. Two additional types are also added that
enable a more complete specification of location. These are listed
in the table below for completeness.
+--------------+--------+-----------------------------+-------------+
| New Civic | CAtype | Description | Example |
| Field | | | |
+--------------+--------+-----------------------------+-------------+
| BLD | 24 | Building (structure) | Hope |
| | | | Theatre |
| | | | |
| UNIT | 26 | Unit (apartment, suite) | 12a |
| | | | |
| ROOM | 28 | Room | 450F |
| | | | |
| SEAT | 33 | Seat (desk, cubicle, | WS 181 |
| | | workstation) | |
| | | | |
| PLC | 29 | Placetype | office |
| | | | |
| POBOX | 31 | Post office box (P.O. box) | U40 |
| | | | |
| ADDCODE | 32 | Additional Code | 13203000003 |
+--------------+--------+-----------------------------+-------------+
Table 1: New Civic PIDF-LO Types
Building: The "building" (BLD) conveys the name of a single building
if the street address includes more than one building or the
building name is helpful in identifying the location. (For
example, on university campuses, the house number is often not
displayed on buildings, while the building name is prominently
shown.)
Unit: The "unit" (UNIT) contains the name or number of a part of a
structure where there are separate administrative units, owners or
tenants, such as separate companies or families who occupy that
structure. Common examples include suite or apartment
designations.
Thomson & Winterbottom Expires April 6, 2006 [Page 4]
Internet-Draft Revised Civic LO October 2005
Room: A "room" (ROOM) is the smallest identifiable subdivision of a
structure.
Seat: The "seat" element (SEAT) describes a single place where a
person might sit. Common examples include a seat in a theatre and
a cubicle in a cube farm.
Place type: The "type of place" element (PLC) describes the type of
place described by the civic coordinates. For example, it
describes whether it is a home, office, street or other public
space. The values are drawn from the items in the rich presence
[17] document. This information makes it easy, for example, for
the DHCP client to then populate the presence information.
Post office box: The "post office box" element (POBOX) describes a
container, such as a pigeon hole, at a central mailing location,
where mail is held.
Additional code: The "additional code" item (ADDCODE) provides an
additional, country-specific code identifying the location. For
example, for Japan, it contains the Japan Industry Standard (JIS)
address code. The JIS address code provides a unique address
inside of Japan, down to the level of indicating the floor of the
building.
2.2. Country Element
The "country" element differs from that defined in [I-D.ietf-geopriv-
pidf-lo] in that it now restricts the value space of the element to
two upper case characters, which more closely matches the definition
in [ISO.3166.1988].
2.3. Languages and Scripts
The XML schema defined for civic addresses allows for the addition of
the "xml:lang" attribute to all elements except "country" and "PLC",
which both contain enumerated values.
The "script" field defined in [I-D.ietf-geopriv-dhcp-civil] is
omitted in favour of using the "xml:lang" attribute.
It is RECOMMENDED that each "civicAddress" element use one language
only, or a combination of languages that is consistent. Where a
civic location is represented in multiple languages multiple
"civicAddress" elements SHOULD be included in the PIDF-LO document.
Thomson & Winterbottom Expires April 6, 2006 [Page 5]
Internet-Draft Revised Civic LO October 2005
2.4. Whitespace
The XML schema [W3C.REC-xmlschema-2-20041028] defined in Section 3
uses a base type of "token" instead of "string" as used in [I-D.ietf-
geopriv-pidf-lo].
The "token" type ensures that whitespace within instance documents is
normalized and collapsed before being passed to a processor. This
ensures that the following fragments are considered equivalent by XML
processors:
<A1>New South Wales</A1>
<A1>New
South Wales</A1>
<A1>
New South
Wales </A1>
Whitespace may still be included in values by using a character
reference, such as " ".
Thomson & Winterbottom Expires April 6, 2006 [Page 6]
Internet-Draft Revised Civic LO October 2005
3. Civic Address Schema
<?xml version="1.0"?>
<xs:schema
targetNamespace="urn:ietf:params:xml:ns:pidf:geopriv10:civicAddr"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:ca="urn:ietf:params:xml:ns:pidf:geopriv10:civicAddr"
xmlns:xml="http://www.w3.org/XML/1998/namespace"
elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:import namespace="http://www.w3.org/XML/1998/namespace"
schemaLocation="http://www.w3.org/2001/xml.xsd"/>
<xs:simpleType name="iso3166">
<xs:restriction base="xs:token">
<xs:pattern value="[A-Z]{2}"/>
</xs:restriction>
</xs:simpleType>
<xs:complexType name="caType">
<xs:simpleContent>
<xs:extension base="xs:token">
<xs:attribute ref="xml:lang" use="optional"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
<xs:element name="civicAddress" type="ca:civicAddress"/>
<xs:complexType name="civicAddress">
<xs:sequence>
<xs:element name="country" type="ca:iso3166" minOccurs="0"/>
<xs:element name="A1" type="ca:caType" minOccurs="0"/>
<xs:element name="A2" type="ca:caType" minOccurs="0"/>
<xs:element name="A3" type="ca:caType" minOccurs="0"/>
<xs:element name="A4" type="ca:caType" minOccurs="0"/>
<xs:element name="A5" type="ca:caType" minOccurs="0"/>
<xs:element name="A6" type="ca:caType" minOccurs="0"/>
<xs:element name="PRD" type="ca:caType" minOccurs="0"/>
<xs:element name="POD" type="ca:caType" minOccurs="0"/>
<xs:element name="STS" type="ca:caType" minOccurs="0"/>
<xs:element name="HNO" type="ca:caType" minOccurs="0"/>
<xs:element name="HNS" type="ca:caType" minOccurs="0"/>
<xs:element name="LMK" type="ca:caType" minOccurs="0"/>
<xs:element name="LOC" type="ca:caType" minOccurs="0"/>
<xs:element name="FLR" type="ca:caType" minOccurs="0"/>
<xs:element name="NAM" type="ca:caType" minOccurs="0"/>
<xs:element name="PC" type="ca:caType" minOccurs="0"/>
Thomson & Winterbottom Expires April 6, 2006 [Page 7]
Internet-Draft Revised Civic LO October 2005
<xs:element name="BLD" type="ca:caType" minOccurs="0"/>
<xs:element name="UNIT" type="ca:caType" minOccurs="0"/>
<xs:element name="ROOM" type="ca:caType" minOccurs="0"/>
<xs:element name="SEAT" type="ca:caType" minOccurs="0"/>
<xs:element name="PLC" type="xs:token" minOccurs="0"/>
<xs:element name="POBOX" type="ca:caType" minOccurs="0"/>
<xs:element name="ADDCODE" type="ca:caType" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute ref="xml:lang" use="optional"/>
</xs:complexType>
</xs:schema>
Thomson & Winterbottom Expires April 6, 2006 [Page 8]
Internet-Draft Revised Civic LO October 2005
4. Example
<?xml version="1.0"?>
<civicAddress xml:lang="de"
xmlns="urn:ietf:params:xml:ns:pidf:geopriv10:civicAddr">
<country>DE</country>
<A1> Bayern </A1> <A2> Oberbayern </A2>
<A3>
München
</A3>
<A6> Marienplatz </A6> <HNO> 8 </HNO>
<LMK>Rathaus</LMK>
<PC>80331</PC>
<PLC>public</PLC>
<POBOX>Postfach 1000</POBOX>
</civicAddress>
Thomson & Winterbottom Expires April 6, 2006 [Page 9]
Internet-Draft Revised Civic LO October 2005
5. Security Considerations
The XML representation described in this document is designed for
inclusion in a PIDF-LO document. As such, it is subject to the same
security considerations as are described in
[I-D.ietf-geopriv-pidf-lo]. Considerations relating to the inclusion
of this representation in other XML documents are outside the scope
of this document.
Thomson & Winterbottom Expires April 6, 2006 [Page 10]
Internet-Draft Revised Civic LO October 2005
6. IANA Considerations
This document calls for IANA to register a new XML namespace, as per
the guidelines in [RFC3688].
6.1. URN sub-namespace registration for
'urn:ietf:params:xml:ns:pidf:geopriv10:civicAddr'
URI
urn:ietf:params:xml:ns:pidf:geopriv10:civicAddr
Registrant Contact
IETF, GEOPRIV working group <geopriv@ietf.org>
Martin Thomson <martin.thomson@andrew.com>
XML
BEGIN
<?xml version="1.0"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<title>GEOPRIV Civic Address</title>
</head>
<body>
<h1>Format for Distributing Civic Address in GEOPRIV</h1>
<h2>urn:ietf:params:xml:ns:pidf:geopriv10:civicAddr</h2>
<p>See <a href="URL of published RFC">RFCXXXX</a>.</p>
</body>
</html>
END
Thomson & Winterbottom Expires April 6, 2006 [Page 11]
Internet-Draft Revised Civic LO October 2005
7. References
7.1. Normative References
[W3C.REC-xmlschema-2-20041028]
Malhotra, A. and P. Biron, "XML Schema Part 2: Datatypes
Second Edition", W3C REC REC-xmlschema-2-20041028,
October 2004.
[I-D.ietf-geopriv-dhcp-civil]
Schulzrinne, H., "Dynamic Host Configuration Protocol
(DHCPv4 and DHCPv6) Option for Civic Addresses
Configuration Information",
draft-ietf-geopriv-dhcp-civil-07 (work in progress),
September 2005.
[ISO.3166.1988]
International Organization for Standardization, "Codes for
the representation of names of countries, 3rd edition",
ISO Standard 3166, August 1988.
7.2. Informative References
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
January 2004.
[I-D.ietf-geopriv-pidf-lo]
Peterson, J., "A Presence-based GEOPRIV Location Object
Format", draft-ietf-geopriv-pidf-lo-03 (work in progress),
September 2004.
Thomson & Winterbottom Expires April 6, 2006 [Page 12]
Internet-Draft Revised Civic LO October 2005
Appendix A. Acknowledgements
The authors would like to thank Henning Schulzrinne for his research
and work on defining the additional civic address types. In addition
we would like to thank Jon Peterson for his work in defining the
PIDF-LO.
Thomson & Winterbottom Expires April 6, 2006 [Page 13]
Internet-Draft Revised Civic LO October 2005
Authors' Addresses
Martin Thomson
Andrew
PO Box U40
Wollongong University Campus, NSW 2500
AU
Phone: +61 2 4221 2915
Email: martin.thomson@andrew.com
URI: http://www.andrew.com/
James Winterbottom
Andrew
PO Box U40
Wollongong University Campus, NSW 2500
AU
Phone: +61 2 4221 2938
Email: james.winterbottom@andrew.com
URI: http://www.andrew.com/
Thomson & Winterbottom Expires April 6, 2006 [Page 14]
Internet-Draft Revised Civic LO October 2005
Intellectual Property Statement
The IETF takes no position regarding the validity or scope of any
Intellectual Property Rights or other rights that might be claimed to
pertain to the implementation or use of the technology described in
this document or the extent to which any license under such rights
might or might not be available; nor does it represent that it has
made any independent effort to identify any such rights. Information
on the procedures with respect to rights in RFC documents can be
found in BCP 78 and BCP 79.
Copies of IPR disclosures made to the IETF Secretariat and any
assurances of licenses to be made available, or the result of an
attempt made to obtain a general license or permission for the use of
such proprietary rights by implementers or users of this
specification can be obtained from the IETF on-line IPR repository at
http://www.ietf.org/ipr.
The IETF invites any interested party to bring to its attention any
copyrights, patents or patent applications, or other proprietary
rights that may cover technology that may be required to implement
this standard. Please address the information to the IETF at
ietf-ipr@ietf.org.
Disclaimer of Validity
This document and the information contained herein are provided on an
"AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET
ENGINEERING TASK FORCE DISCLAIM 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.
Copyright Statement
Copyright (C) The Internet Society (2005). This document is subject
to the rights, licenses and restrictions contained in BCP 78, and
except as set forth therein, the authors retain all their rights.
Acknowledgment
Funding for the RFC Editor function is currently provided by the
Internet Society.
Thomson & Winterbottom Expires April 6, 2006 [Page 15]
