diff options
author | Rob Taylor <rob.taylor@codethink.co.uk> | 2009-04-24 10:17:38 +0100 |
---|---|---|
committer | Marius Vollmer <marius.vollmer@nokia.com> | 2009-04-28 13:18:22 +0300 |
commit | d507636b0cbbdff01f7a99eebc964b76d215575f (patch) | |
tree | d68ce577009c6418e38589c4d6743230a09a501c /spec | |
parent | 46008f6860386f61c55e7e0626ef45bf2c5caba0 (diff) |
Update core properties spec for new Location keys.
Updates the core properties specification for Location keys based off
Geoclue's schema for addresses, which is more generic and hence fits
different countrie's address schemes better.
Also this removes the 'Context.' prefix as its really rather pointless
Signed-off-by: Marius Vollmer <marius.vollmer@nokia.com>
Diffstat (limited to 'spec')
-rw-r--r-- | spec/context.xml | 168 |
1 files changed, 77 insertions, 91 deletions
diff --git a/spec/context.xml b/spec/context.xml index f1853b7f..c6228c5f 100644 --- a/spec/context.xml +++ b/spec/context.xml @@ -16,120 +16,107 @@ change for some time still. Only the ones explicitly marked as stable should be used for now. </doc> - <node name="Context"> - <node name="Screen"> - <doc> + <node name="Screen"> + <doc> Display screens --------------- These properties talk about the display screens of the device. - </doc> - <key name="TopEdge" type="STRING"> - <doc> + </doc> + <key name="TopEdge" type="STRING"> + <doc> The edge of the main display screen where the user expects the top-most UI elements to be. Possible values are the strings "top", "bottom", "left", and "right", which refer to the edges of the screen in its normal orientation as defined by the graphics hardware. _(stable)_ - </doc> - </key> - <key name="IsCovered" type="TRUTH"> - <doc> + </doc> + </key> + <key name="IsCovered" type="TRUTH"> + <doc> Whether or not the main display screen is covered and can thus not be seen by the user. This might mean that the device is laying face down on a table, or that its lid is closed if it has one. _(stable)_ - </doc> - </key> - </node> - <node name="Location"> - <doc> + </doc> + </key> + </node> + <node name="Location"> + <doc> Location -------- -Information about the geographic location of the device. - </doc> - <key name="Streets" type="STRING"> - <doc> -The names of the nearby streets, as a set of strings. The set might -be empty when the current location is not near any street, or there -might be more than one name in the list when we are at an -intersection. - </doc> - </key> - <key name="City" type="STRING"> - <doc> -The localized name of the current city, as a string. - </doc> - </key> - <key name="State" type="STRING"> - <doc> -The localized name of the current state, as a string. - </doc> - </key> - <key name="StateCode" type="STRING"> - <doc> -The ISO 3166-2 code of the current state, as a string. See -link:http://en.wikipedia.org/wiki/ISO_3166-2[here] for more -information. The value of this property includes the ISO 3166-1 -alpha-2 prefix, as is usual for ISO 3166-2 codes. - </doc> - </key> - <key name="Country" type="STRING"> - <doc> -The localized name of the current country, as a string. - </doc> - </key> - <key name="CountryCode" type="STRING"> - <doc> -The ISO 3166-1 alpha-2 code of the current country, as a string. See -link:http://en.wikipedia.org/wiki/ISO_3166-1[here] for more -information. - </doc> - </key> - <key name="Continent" type="STRING"> - <doc> -The localized name of the current continent, as a string. - </doc> - </key> - <key name="Planet" type="STRING"> - <doc> -The localized name of the current planet (or dwarf planet), as a -string. - </doc> - </key> - </node> - <node name="Connectivity"> - <doc> +Best effort location information. If any of the keys are not +appliciable to the current location, they will be unavailable. + </doc> + <key name="Latitude" type="DOUBLE"> + <doc>The latitude of the current position in degrees.</doc> + </key> + <key name="Longitude" type="DOUBLE"> + <doc>The longitude of the current position in degrees.</doc> + </key> + <key name="Altitide" type="DOUBLE"> + <doc>The altitude of the current position in meters.</doc> + </key> + <key name="Street" type="STRING"> + <doc>The street nearest the location of the device.</doc> + </key> + <key name="PostalCode" type="STRING"> + <doc>The postcode of the location of the device.</doc> + </key> + <key name="Area" type="STRING"> + <doc>The name of the local area where the device is, for example a neighborhood or campus.</doc> + </key> + <key name="Locality" type="STRING"> + <doc>The name of the village, town or city where the device is.</doc> + </key> + <key name="Region" type="STRING"> + <doc>The administrative region which contains the location of the device.</doc> + </key> + <key name="Country" type="STRING"> + <doc>The country which contains the location of the device.</doc> + </key> + <key name="CountryCode" type="STRING"> + <doc>The ISO 3166 two letter country code of the country which contains the location of the device.</doc> + </key> + <key name="Continent" type="STRING"> + <doc>The localized name of the current continent, as a string.</doc> + </key> + <key name="Planet" type="STRING"> + <doc>The localized name of the current planet (or dwarf planet), as a string.</doc> + </key> + </node> + <node name="Connectivity"> + <doc> Network connectivity -------------------- Information about the network connectivity of the device. - </doc> - </node> - <node name="Environment"> - <doc> + </doc> + </node> + <node name="Environment"> + <doc> Environment ----------- Information about the environment the device is in. - </doc> - <key name="IsDark" type="TRUTH"> - <doc> + </doc> + <key name="IsDark" type="TRUTH"> + <doc> Whether or not it is dark. - </doc> - </key> - <key name="SunRise" type="INT"> - <doc> + </doc> + </key> + <key name="SunRise" type="INT"> + <doc> The time of sun rise. - </doc> - </key> - <key name="SunSet" type="INT"> - <doc> + </doc> + </key> + <key name="SunSet" type="INT"> + <doc> The time of sun set. - </doc> - </key> - <key name="Weather" type="STRING"> - <doc> + </doc> + </key> + <key name="Weather" type="STRING"> + <doc> The current weather. See http://www.ominous-valve.com/wx_codes.txt for more information about codifying weather conditions. We should lift something from there, if just for extra geek points. @@ -204,8 +191,7 @@ compass terms: North, South-West, etc. - *WindDirectionD* + The wind direction in degrees. North is 0, east is 90, etc. - </doc> - </key> - </node> + </doc> + </key> </node> </properties> |