Blame data/README

Packit Service 4897fc
The format of Locations.xml[.in] is something like this:
Packit Service 4897fc
Packit Service 4897fc
<gweather format="1.0">
Packit Service 4897fc
  <region>
Packit Service 4897fc
    <_name>North America</_name>
Packit Service 4897fc
    <country>
Packit Service 4897fc
      <_name>United States</_name>
Packit Service 4897fc
      <iso-code>US</iso-code>
Packit Service 4897fc
      <state>
Packit Service 4897fc
        <_name>Alabama</_name>
Packit Service 4897fc
        <tz-hint>America/Chicago</tz-hint>
Packit Service 4897fc
        <location>
Packit Service 4897fc
          
Packit Service 4897fc
          <_name>Alabaster</_name>
Packit Service 4897fc
          KEET
Packit Service 4897fc
          <zone>ALZ019</zone>
Packit Service 4897fc
          <radar>bhm</radar>
Packit Service 4897fc
          <coordinates>33-10-42N 086-46-54W</coordinates>
Packit Service 4897fc
        </location>
Packit Service 4897fc
        <city>
Packit Service 4897fc
          
Packit Service 4897fc
          <_name>Mobile</_name>
Packit Service 4897fc
          <location>
Packit Service 4897fc
            
Packit Service 4897fc
            <_name>Mobile Downtown Airport</_name>
Packit Service 4897fc
            KBFM
Packit Service 4897fc
            <zone>ALZ061</zone>
Packit Service 4897fc
            <radar>bix</radar>
Packit Service 4897fc
            <coordinates>30-36-50N 088-03-48W</coordinates>
Packit Service 4897fc
          </location>
Packit Service 4897fc
        </city>
Packit Service 4897fc
        ...
Packit Service 4897fc
Packit Service 4897fc
Most of the data in the file appears inside <location> entries.
Packit Service 4897fc
However, various larger geographic divisions exist to make things
Packit Service 4897fc
easier for both users and maintainers.
Packit Service 4897fc
Packit Service 4897fc
At the top level are <region>s. These mostly correspond to continents,
Packit Service 4897fc
but not entirely. They are arbitrary, and could be changed in the
Packit Service 4897fc
future if we wanted.
Packit Service 4897fc
Packit Service 4897fc
Each <region> is divided into <country>s. Every internationally-
Packit Service 4897fc
recognized country for which at least one <location> is defined should
Packit Service 4897fc
have its own <country>. For the most part, "dependencies",
Packit Service 4897fc
"territories", "protectorates" and the like are listed as <location>s
Packit Service 4897fc
within their ruling country if they are in the same <region>, but
Packit Service 4897fc
separately if they are in a different <region>. This is not followed
Packit Service 4897fc
100% consistently.
Packit Service 4897fc
Packit Service 4897fc
Every <country> must have an <iso-code> tag giving its ISO 3166-1
Packit Service 4897fc
alpha-2 code. Sub-country <location>s can also specify their own
Packit Service 4897fc
<iso-code> if they have one.
Packit Service 4897fc
Packit Service 4897fc
A <country> MAY specify a <tz-hint>, giving the default time zone name
Packit Service 4897fc
for the country. Countries that only have one timezone (or where the
Packit Service 4897fc
majority of the country is covered by a single timezone) should list
Packit Service 4897fc
it at the <country> level. Countries with multiple timezones and no
Packit Service 4897fc
obvious "default" should not list anything here. (See README.timezones
Packit Service 4897fc
for more information about timezones in Locations.xml.)
Packit Service 4897fc
Packit Service 4897fc
A <country> can contain <city>s and <location>s directly, or can be
Packit Service 4897fc
split into <state>s which contain <city>s and <location>s. The name
Packit Service 4897fc
"state" comes from the US states, but it can be used to represent any
Packit Service 4897fc
sort of well-defined sub-country region that has a name which will be
Packit Service 4897fc
familiar to local users. A <state> may specify a <tz-hint> which will
Packit Service 4897fc
override the <country>'s <tz-hint> for <location>s within the state.
Packit Service 4897fc
Packit Service 4897fc
<city> is an optional element used to group together multiple
Packit Service 4897fc
<location>s within the same city.
Packit Service 4897fc
Packit Service 4897fc
Finally, a <location> represents a location for which weather data can
Packit Service 4897fc
be retrieved. Its fields are:
Packit Service 4897fc
Packit Service 4897fc
    <_name>       - required, the name of the location
Packit Service 4897fc
Packit Service 4897fc
    <iso-code>    - optional, the ISO 3166 code of the location, if not
Packit Service 4897fc
                    the same as its parent <country>
Packit Service 4897fc
Packit Service 4897fc
    <tz-hint>     - optional, the timezone of the location, if not the
Packit Service 4897fc
                    same as its parent <state> or <country>
Packit Service 4897fc
Packit Service 4897fc
            - required, the METAR code identifying this location
Packit Service 4897fc
Packit Service 4897fc
    <zone>        - optional, secondary weather source information:
Packit Service 4897fc
                    US: the NOAA IWIN zone
Packit Service 4897fc
		    UK: the Met Office region name, prefixed with ":"
Packit Service 4897fc
		    AU: the BOM forecast name, prefixed with "@"
Packit Service 4897fc
Packit Service 4897fc
    <radar>       - optional, the Weather.com radar map name for the
Packit Service 4897fc
                    location (North America only)
Packit Service 4897fc
Packit Service 4897fc
    <coordinates> - optional, the latitude and longitude of the
Packit Service 4897fc
                    location, as "[-]ddd.dddddd [-]ddd.dddddd"
Packit Service 4897fc
                    Positive values are North and East respectively,
Packit Service 4897fc
                    negative values are South and West.