path: root/mateweather/docs/C/index.docbook

<?xml version="1.0"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
  <!ENTITY legal SYSTEM "legal.xml">
  <!ENTITY appletversion "2.12">
  <!ENTITY applet "Weather Report">
]>
<!-- 
      (Do not remove this comment block.)
  Maintained by the MATE Documentation Project
  http://developer.mate.org/projects/gdp
  Template version: 2.0 beta
  Template last modified Feb 12, 2002
-->
<!-- =============Document Header ============================= -->
<article id="index" lang="en">
   <!-- please do not change the id; for translations, change lang to -->
   <!-- appropriate code -->
     
   <articleinfo>
      <title>&applet; Manual</title>
      <abstract role="description">
	<para>The &applet; Applet downloads weather information for a
given location from the internet and displays the temperature and a
symbol representing the current weather conditions in the panel. When
clicked on, more information is given, such as the forecast, the time of
sunrise and sunset, wind direction, pressure, and more. All units are
customizable.</para>
      </abstract>
      <copyright>
        <year>2005</year>
	<holder>Davyd Madeley</holder>
      </copyright>
      <copyright>
	<year>2004</year>
	<holder>Angela Boyle</holder>
      </copyright>
      <copyright>
		<year>2002</year>
		<year>2003</year>
		<year>2004</year>
		<holder>Sun Microsystems</holder>    	 
      </copyright>
      <copyright>
		<year>1999</year>  		
		<year>2000</year>
		<holder>Spiros Papadimitriou</holder>  	 
      </copyright>
      <copyright>
		<year>1999</year>  		
		<year>2000</year>
		<holder>Dan Mueth</holder>  	 
      </copyright>
      <!-- translators: uncomment this:
      
        <copyright>
         <year>2002</year>
         <holder>ME-THE-TRANSLATOR (Latin translation)</holder>
        </copyright>
      
         -->
      <!-- An address can be added to the publisher information.  If a role is 
           not specified, the publisher/author is the same for all versions of the 
           document.  -->
      	 
      <publisher role="maintainer">
		<publishername> MATE Documentation Project </publishername>  	 
      </publisher>
        &legal;
      <!-- This file  contains link to license for the documentation (GNU FDL), and 
           other legal stuff such as "NO WARRANTY" statement. Please do not change 
           any of this. -->
      	 
      <authorgroup>
        <author>
	  <firstname>Davyd</firstname><surname>Madeley</surname>
	  <affiliation>
	   <orgname>MATE Project</orgname>
	   <address><email>davyd@madeley.id.au</email></address>
	  </affiliation>
	</author>
	<author>
	  <firstname>Angela</firstname>
	  <surname>Boyle</surname>
	</author>
           		
	<author>
	<firstname>Sun </firstname>  		  
	<surname>MATE Documentation Team</surname>            		  

            <affiliation>
		<orgname>Sun Microsystems</orgname>  			 
            </affiliation>
              		
        </author>
           		
        <author>
	<firstname>Spiros</firstname>  		  
	<surname>Papadimitriou</surname>
             		  
            <affiliation>
		<orgname>MATE Documentation Project</orgname>  			 
		<address><email>spapadim+@cs.cmu.edu</email> </address>  		  
            </affiliation>
              		
         </author>
           		
         <author>
	 <firstname>Dan</firstname>
	 <surname>Mueth</surname>  	
	  
	     <affiliation>
 		<orgname>MATE Documentation Project</orgname>  			 
		<address><email>d-mueth@uchicago.edu</email> </address>  		  
             </affiliation>
              		
         </author>
               
         <!-- This is appropriate place for other contributors: translators,
                    maintainers,  etc. Commented out by default.
                    <othercredit role="translator">
         	     <firstname>Latin</firstname> 
         	     <surname>Translator 1</surname> 
         	     <affiliation> 
         	       <orgname>Latin Translation Team</orgname> 
         	       <address> <email>translator@gnome.org</email> </address> 
         	     </affiliation>
         	     <contrib>Latin translation</contrib>
                    </othercredit>
         -->
         	 
      </authorgroup>
	  
	  <releaseinfo revision="2.26" role="review"/>
      	 
      <revhistory>
        <revision>
	  <revnumber>Version 2.12</revnumber>
	  <date>March 2005</date>
	  <revdescription>
	    <para role="author">Davyd Madeley</para>
	  </revdescription>
	</revision>
        <revision>
	  <revnumber>Version 2.10</revnumber>
	  <date>March 2005</date>
	  <revdescription>
	    <para role="author">Davyd Madeley</para>
	  </revdescription>
	</revision>
	<revision>
	  <revnumber>Version 2.8</revnumber>
	  <date>September 2004</date>
	  <revdescription>
	    <para role="author">Angela Boyle</para>
	    <para role="publisher">MATE Documentation Project</para>
	  </revdescription>
	</revision>
        <revision>
          <revnumber>&applet; Applet Manual V2.4</revnumber>  		
          <date>February 2004</date>  		  
          <revdescription>
	    <para role="author">Sun GNOME Documentation Team</para>
	    <para role="publisher">MATE Documentation Project</para>
          </revdescription>
        </revision>
        <revision>
          <revnumber>Weather Report Applet Manual V2.3</revnumber>  		
          <date>January 2003</date>  		  
          <revdescription>
	    <para role="author">Sun GNOME Documentation Team</para>
	    <para role="publisher">MATE Documentation Project</para>
          </revdescription>
        </revision>  
        <revision>
          <revnumber>Weather Report Applet Manual V2.2</revnumber>  		
          <date>August 2002</date>  		  
          <revdescription>
	    <para role="author">Sun GNOME Documentation Team</para>
	    <para role="publisher">MATE Documentation Project</para>
          </revdescription>
        </revision>  
        <revision>
          <revnumber>Weather Report Applet Manual V2.1</revnumber>  		
          <date>July 2002</date>  		  
          <revdescription>
	    <para role="author">Sun GNOME Documentation Team</para>
	    <para role="publisher">MATE Documentation Project</para>
          </revdescription>
        </revision>
        <revision>
          <revnumber>Weather Report Applet Manual V2.0</revnumber>  		
          <date>March 2002</date>  		  
          <revdescription>
	    <para role="author">Sun GNOME Documentation Team</para>
	    <para role="publisher">MATE Documentation Project</para>
          </revdescription>
        </revision>
        <revision>
	  <revnumber>MATE Weather Applet</revnumber>  		  
	  <date>2000</date>
          <revdescription>
            <para role="author">
              Spiros Papadimitriou 				
              <email>spapadim+@cs.cmu.edu</email>
            </para>
            <para role="author">
              Dan Mueth 				
	      <email>d-mueth@uchicago.edu</email>
            </para>
            <para role="publisher">
              MATE Documentation Project
            </para>
          </revdescription>
        </revision>
      </revhistory>
        	 
      <releaseinfo>
          This manual describes version &appletversion; of &applet;. 		
      </releaseinfo>
        	 
   </articleinfo>
       <indexterm>  	 
       <primary>Weather Report</primary>    
       </indexterm> 
   <!-- ============= Document Body ============================= -->
   <!-- ============= Introduction ============================== -->
   <sect1 id="mateweather-introduction">
      <title>Introduction</title>
      <!-- ==== Figure ============================================= -->
      	 
      <figure id="weather-applet-fig">
	<title>&applet;</title>  		
         <screenshot>             		  
            <mediaobject>                 			 
               <imageobject>
                  <imagedata fileref="figures/mateweather_applet.png" format="PNG"/>                  			 
               </imageobject>
               <textobject>
                  <phrase>Shows &applet;. Contains a weather icon and current temperature</phrase> 			 
               </textobject>
            </mediaobject>
         </screenshot>
      </figure>
       
      <!-- ==== End of Figure ======================================= -->
      <para>
         The <application>&applet;</application> downloads weather information from the U.S National Weather Service (NWS) servers, including the Interactive Weather Information Network (IWIN) and other weather services. You can use <application>&applet;</application> to display current weather information and weather forecasts on your computer. 
      </para>
      <note id="proxies-note-1">
         <para>
            If your computer is located behind a firewall, you must use a proxy server to access the weather servers. To configure the MATE Desktop to use a proxy server, use your preference tools to specify the network proxy server for Internet connections.       
         </para>
      </note>   
      <para>
         <application>&applet;</application> displays the following information for the default location, or a location that you specify:
      </para>
      <itemizedlist>
         <listitem>
            <para>
               A weather icon that represents the general weather conditions.
	       See <xref linkend="mateweather-introduction-icons" />.
            </para>
         </listitem>
         <listitem>
            <para>
               The current temperature.
            </para>
         </listitem>
      </itemizedlist>

    <sect2 id="mateweather-introduction-icons">
     <title>Weather Icons on Panel</title>
     <informaltable frame="all">
      <tgroup cols="2" colsep="1" rowsep="1">
       <colspec colname="COLSPEC0" colwidth="50*"/>
       <colspec colname="COLSPEC1" colwidth="50*"/>
       <thead>
        <row valign="top">
	 <entry colname="COLSPEC0"><para>Icon</para></entry>
	 <entry colname="COLSPEC1"><para>Description</para></entry>
	</row>
       </thead>
       <tbody>
            <row valign="top">
              <entry><para><inlinemediaobject><imageobject>
	       <imagedata fileref="figures/stock_weather-sunny.png"
	       		  format="PNG"/>
	      </imageobject><textobject>
	       <phrase>Stock Sunny</phrase>
	      </textobject></inlinemediaobject>
	      <inlinemediaobject><imageobject>
	       <imagedata fileref="figures/stock_weather-night-clear.png"
	       		  format="PNG"/>
	      </imageobject><textobject>
	       <phrase>Stock Night</phrase>
	      </textobject></inlinemediaobject></para></entry>
              <entry><para>
                  It is clear and fine.
                </para></entry>
             </row>
            <row valign="top">
              <entry><para><inlinemediaobject><imageobject>
	       <imagedata fileref="figures/stock_weather-few-clouds.png"
	       		  format="PNG"/>
	      </imageobject><textobject>
	       <phrase>Stock Few Clouds</phrase>
	      </textobject></inlinemediaobject>
	      <inlinemediaobject><imageobject>
	       <imagedata fileref="figures/stock_weather-night-few-clouds.png"
	       		  format="PNG"/>
	      </imageobject><textobject>
	       <phrase>Stock Night Few Clouds</phrase>
	      </textobject></inlinemediaobject></para></entry>
              <entry><para>
                  It is partly cloudy.
                </para></entry>
             </row>
            <row valign="top">
              <entry><para><inlinemediaobject><imageobject>
	       <imagedata fileref="figures/stock_weather-cloudy.png"
	       		  format="PNG"/>
	      </imageobject><textobject>
	       <phrase>Stock Cloudy</phrase>
	      </textobject></inlinemediaobject></para></entry>
              <entry><para>
                  It is cloudy.
                </para></entry>
             </row>
            <row valign="top">
              <entry><para><inlinemediaobject><imageobject>
	       <imagedata fileref="figures/stock_weather-fog.png"
	       		  format="PNG"/>
	      </imageobject><textobject>
	       <phrase>Stock Fog</phrase>
	      </textobject></inlinemediaobject></para></entry>
              <entry><para>
                  It is foggy or overcast.
                </para></entry>
             </row>
            <row valign="top">
              <entry><para><inlinemediaobject><imageobject>
	       <imagedata fileref="figures/stock_weather-showers.png"
	       		  format="PNG"/>
	      </imageobject><textobject>
	       <phrase>Stock Rain</phrase>
	      </textobject></inlinemediaobject></para></entry>
              <entry><para>
                  It is rainy or wet.
                </para></entry>
             </row>
            <row valign="top">
              <entry><para><inlinemediaobject><imageobject>
	       <imagedata fileref="figures/stock_weather-snow.png"
	       		  format="PNG"/>
	      </imageobject><textobject>
	       <phrase>Stock Snow</phrase>
	      </textobject></inlinemediaobject></para></entry>
              <entry><para>
                  It is snowing.
                </para></entry>
             </row>
            <row valign="top">
              <entry><para><inlinemediaobject><imageobject>
	       <imagedata fileref="figures/stock_weather-storm.png"
	       		  format="PNG"/>
	      </imageobject><textobject>
	       <phrase>Stock Storm</phrase>
	      </textobject></inlinemediaobject></para></entry>
              <entry><para>
                  It is stormy.
                </para></entry>
             </row>
       </tbody>
      </tgroup>
     </informaltable>
    </sect2>

    <sect2 id="mateweather-introduction-add">
      <title>To Add &applet; to a Panel</title>
      <para>To add <application>&applet;</application> to a panel,
      right-click on the panel, then choose <guimenuitem>Add to
      Panel</guimenuitem>.  Select <application>&applet;</application>
      in the <application>Add to the panel</application> dialog, then
      click <guibutton>OK</guibutton>.</para>
    </sect2>

      
   </sect1>
   <!-- ============= Usage ===================================== -->
   <sect1 id="mateweather-usage">
      <title>Preferences</title>
      <para>
       The preferences dialog is accessed by right-clicking on the &applet; in
       the panel.
      <figure id="weather-applet-menu-prefs">
	<title>&applet; menu</title>
         <screenshot>
            <mediaobject>                 			 
               <imageobject>
                  <imagedata fileref="figures/mateweather-menu-prefs.png" format="PNG"/>                  			 
               </imageobject>
               <textobject>
                  <phrase>Context menu</phrase>
               </textobject>
            </mediaobject>
         </screenshot>
      </figure>
      </para>
      <sect2 id="mateweather-change-location">
         <title>Changing to Particular Location</title>
      <figure id="weather-applet-prefs-locations-fig">
	<title>Location Preferences</title>
         <screenshot>
            <mediaobject>                 			 
               <imageobject>
                  <imagedata fileref="figures/mateweather-prefs-locations.png" format="PNG"/>                  			 
               </imageobject>
               <textobject>
                  <phrase>Location Preferences</phrase>
               </textobject>
            </mediaobject>
         </screenshot>
      </figure>
         <para>
            When you add the <application>&applet;</application> to a panel for
	    the first time, the application displays the weather for Pittsburg, Pennsylvania by default. To display the weather for a different location, perform the following steps:
         </para>
         <orderedlist>
            <listitem>
               <para>
                  Right-click on the application.
               </para>
            </listitem>
            <listitem>
               <para>
                  Choose <guimenuitem>Preferences</guimenuitem> from the
		  application popup menu. The application displays the <guilabel>Weather Preferences</guilabel> dialog.
               </para>
            </listitem>
            <listitem>
               <para>
                  Select the <guilabel>Location</guilabel> tab. The <guilabel>Location</guilabel> tabbed section contains a list of geographical regions, subregions, and specific locations.
               </para>
            </listitem>
            <listitem>
               <para>
                  Click on the arrow next to a region to display the subregions in the region.
               </para>
            </listitem>
            <listitem>
               <para>
                  Click on the arrow next to a subregion to display the locations in the subregion.
               </para>
            </listitem>
            <listitem>
               <para>
                  Click on a location. While the application retrieves the
		  weather information for the new location, the tooltip
		  "Updating" is displayed when you point to the icon.
               </para>
            </listitem>
            <listitem>
               <para>
                  Click <guibutton>Close</guibutton> to close the <guilabel>Weather Preferences</guilabel> dialog.
               </para>
            </listitem>
         </orderedlist>
	 <para>
	  You can already try searching by entering the name of your city into
	  the <guilabel>Find</guilabel> field. Be aware that for cities close
	  together, or for cities with no airport you may have to pick a nearby
	  city in the region.
	 </para>
      </sect2>
      <sect2 id="mateweather-update">
         <title>Updating Weather Information</title>
         <para>
            To update the weather information that the &applet; displays in the
	    panel, right-click on the icon, then choose <guimenuitem>Update</guimenuitem>.
         </para>
         <para>To automatically update the weather information at regular intervals, perform the following steps:</para>
	    <orderedlist>
                  <listitem><para>Go to the right-click menu and select <guimenuitem>Preferences</guimenuitem>.</para></listitem>
                   <listitem><para>In the <guilabel>Weather Preferences</guilabel> dialog under the <guilabel>General</guilabel> tab, select the <guilabel>Automatically update every ... minutes</guilabel> option.</para></listitem>
		<listitem><para>Use the spin box to specify the interval at
		which the &applet; retrieves updated information from the weather server. The default is to check every thirty minutes.</para></listitem>
                    <listitem><para>Click <guibutton>Close</guibutton> to close the <guilabel>Weather Preferences</guilabel> dialog.</para></listitem>
	      </orderedlist>
         </sect2>
        <sect2 id="mateweather-metric"> 
               <title>Changing Units</title>
      <figure id="weather-applet-prefs-general-fig">
	<title>General Preferences</title>
         <screenshot>
            <mediaobject>                 			 
               <imageobject>
                  <imagedata fileref="figures/mateweather-prefs-general.png" format="PNG"/>
               </imageobject>
               <textobject>
                  <phrase>General Preferences</phrase>
               </textobject>
            </mediaobject>
         </screenshot>
      </figure>
		     <para>
                        Go to the right-click menu and select
			<guimenuitem>Preferences</guimenuitem>. In the
			<guilabel>Weather Preferences</guilabel> dialog under
			the <guilabel>General</guilabel> tab, select the
			units of measurement you want to use.
                     </para>
		     <para>
		      A number of different measurements are available,
		      including metric, imperial, SI and others. The choice
		      <guilabel>Default</guilabel> will use what we think
		      is the default for your region, based off your chosen
		      locale.
		     </para>
          </sect2>
         
   </sect1>
   <!-- ============= Preferences ================================== -->
   <sect1 id="mateweather-settings">
      <title>Details</title>

         <para>
            To view detailed weather information, right-click on the &applet;,
	    then choose <guimenuitem>Details</guimenuitem>. The &applet; displays the <guilabel>Details</guilabel> dialog. The <guilabel>Details</guilabel> dialog contains the following default tabbed sections:
         </para>
         <itemizedlist>
            <listitem>
               <para>
                  <guilabel>Current Conditions</guilabel>
               </para>
            </listitem>
            <listitem>
               <para>
                  <guilabel>Forecast</guilabel>
               </para>
            </listitem>
            <listitem>
               <para>
                  <guilabel>Radar Map (optional)</guilabel>
               </para>
            </listitem>
         </itemizedlist>
         <sect2 id="mateweather-current-conditions">
            <title>Current Conditions</title>
      <figure id="weather-applet-details-fig">
	<title>&applet; Details</title>  		
         <screenshot>             		  
            <mediaobject>                 			 
               <imageobject>
                  <imagedata fileref="figures/mateweather-details.png" format="PNG"/>                  			 
               </imageobject>
               <textobject>
                  <phrase>&applet; details</phrase>
               </textobject>
            </mediaobject>
         </screenshot>
      </figure>
            <para>
               The <guilabel>Current Conditions</guilabel> tabbed section displays the following information:
            </para>
            <informaltable>
               <tgroup cols="2">
                  <colspec colname="col1" colwidth="0.81*"/><colspec colname="col2"
                  colwidth="1.19*"/>
                  <tbody>
                     <row valign="top">
                        <entry colname="col1">
                           <para>
                              City
                           </para>
                        </entry>
                        <entry colname="col2">
                           <para>
                              Location to which the current weather conditions apply.
                           </para>
                        </entry>
                     </row>
                     <row valign="top">
                        <entry colname="col1">
                           <para>
                              Last update
                           </para>
                        </entry>
                        <entry colname="col2">
                           <para>
                              Time at which the weather conditions were last updated on the weather server.
                           </para>
                        </entry>
                     </row>
                     <row valign="top">
                        <entry colname="col1">
                           <para>
                              Conditions
                           </para>
                        </entry>
                        <entry colname="col2">
                           <para>
                              General weather conditions.
                           </para>
                        </entry>
                     </row>
                     <row valign="top">
                        <entry colname="col1">
                           <para>
                              Sky
                           </para>
                        </entry>
                        <entry colname="col2">
                           <para>
                              General sky conditions.
                           </para>
                        </entry>
                     </row>
                     <row valign="top">
                        <entry colname="col1">
                           <para>
                              Temperature
                           </para>
                        </entry>
                        <entry colname="col2">
                           <para>
                              Current temperature.
                           </para>
                        </entry>
                     </row>
                     <row valign="top">
                        <entry colname="col1">
                           <para>
                              Dew point
                           </para>
                        </entry>
                        <entry colname="col2">
                           <para>
                              Temperature at which dew forms.
                           </para>
                        </entry>
                     </row>
                     <row valign="top">
                        <entry colname="col1">
                           <para>
                              Humidity
                           </para>
                        </entry>
                        <entry colname="col2">
                           <para>
                              Percentage of moisture in the atmosphere.
                           </para>
                        </entry>
                     </row>
                     <row valign="top">
                        <entry colname="col1">
                           <para>
                              Wind
                           </para>
                        </entry>
                        <entry colname="col2">
                           <para>
                              Direction and speed of the wind.
                           </para>
                        </entry>
                     </row>
                     <row valign="top">
                        <entry colname="col1">
                           <para>
                              Pressure
                           </para>
                        </entry>
                        <entry colname="col2">
                           <para>
                              Atmospheric pressure. 
                           </para>
                        </entry>
                     </row>
                     <row valign="top">
                        <entry colname="col1">
                           <para>
                              Visibility
                           </para>
                        </entry>
                        <entry colname="col2">
                           <para>
                              Range of vision as determined by the light and atmosphere conditions.
                           </para>
                        </entry>
                     </row>
		     <row valign="top">
		      <entry colname="col1">
		       <para>Sunrise</para>
		      </entry>
		      <entry colname="col2">
		       <para>The calculated sunrise time for your location</para>
		      </entry>
		     </row>
		     <row valign="top">
		      <entry colname="col1">
		       <para>Sunset</para>
		      </entry>
		      <entry>
		       <para>The calculated sunset time for your location</para>
		      </entry>
		     </row>
                  </tbody>
               </tgroup>
            </informaltable>

	    <note><para>
	     Sunrise and sunset times are calculated locally from
	     latitude and longitude information stored on your computer. Some
	     conditions, such as refraction of light through the air, are hard
	     to model. Resultantly, the calculated values for sunrise and
	     sunset may be off by up to 10 minutes.
	    </para></note>
         </sect2>
         <sect2 id="mateweather-forecast">
            <title>Forecast</title>
            <para>
               The <guilabel>Forecast</guilabel> tabbed section displays a forecast for the location for the immediate future, usually the next five days. 
            </para>
            <note>
               <para>
                  Forecasts are only available for some locations in the U.S.A,
		  Australia and the United Kingdom.
               </para>
            </note>
         </sect2>
         <sect2 id="mateweather-radar-map">
            <title>Radar Map</title>
            <para>
               By default, the <guilabel>Radar Map</guilabel> tabbed section is
	       not displayed in the <guilabel>Forecast</guilabel> dialog.
	       <application>&applet;</application>  downloads the radar maps
	       from www.weather.com. If the radar map is not available from
	       www.weather.com, &applet; displays a question mark. To go to the www.weather.com web site, click on the <guibutton>Visit Weather.com</guibutton> button.
            </para>
            <para>To enable the radar map, perform the following steps:
	     <orderedlist>
		<listitem><para>Go to the <guilabel>Weather Preferences</guilabel> dialog by selecting <guilabel>Preferences</guilabel> in the right-click menu.</para></listitem>
 		<listitem><para>In the <guilabel>General</guilabel> tab, select the <guilabel>Enable radar map</guilabel> option. </para></listitem>
		<listitem><para>By default, <application>&applet;</application> downloads the radar maps from www.weather.com. Select the <guilabel>Use custom address for radar map</guilabel> option to display radar maps from an alternative Internet address. You must type the address in the <guilabel>Address</guilabel> text box.</para></listitem>
	      </orderedlist>
                     </para>
	<note><para>
	 Most locations do not define a default radar map, especially outside
	 of the U.S.A. Many locations will require you to specify a custom URL,
	 if you wish to have a radar map.
	</para></note>
      </sect2>
   </sect1>
</article>