]> CyberLeo.Net >> Repos - SourceForge/phpwiki.git/blob - pgsrc/PhpWeatherPlugin
ending LF: #950617 Clean up CVS repository
[SourceForge/phpwiki.git] / pgsrc / PhpWeatherPlugin
1 Date: Sat, 11 Jan 2003 14:53:00 -0500
2 Mime-Version: 1.0 (Produced by PhpWiki 1.3.4)
3 X-Rcs-Id: $Id: PhpWeatherPlugin,v 1.5 2004-05-09 00:57:32 rurban Exp $
4 Content-Type: application/x-phpwiki;
5   pagename=PhpWeatherPlugin;
6   pgsrc_version="2 $Revision: 1.5 $";
7   flags="";
8   markup=2;
9   charset=iso-8859-1
10 Content-Transfer-Encoding: binary
11
12 !!! Synopsis
13
14 The ~PhpWeatherPlugin is a WikiPlugin that uses PhpWeather to display
15 a block of text with the current weather for some airport in the
16 world. It looks like this:
17
18 <?plugin PhpWeather menu=true ?>
19
20 !!! Plugin Arguments
21
22 __menu__:
23   Set this to =true= to have the plugin generate a menu after the
24   report. The user will able to select a country from this menu, and
25   after that, an airport and a language. The default value is
26   <tt>false</tt>.
27
28 __icao__:
29   Use this to pre-select a specific airport instead of using the
30   default one which is <tt>EKAH</tt>. If you want the user to be able
31   to change the station using the menu, then you have to use this as
32   <verbatim>
33   <?plugin PhpWeather menu=true icao||=EKYT ?>
34   </verbatim>
35   so that the value can be overwritten when the user submits the
36   form. If you just use
37   <verbatim>
38   <?plugin PhpWeather menu=true icao=EKYT ?>
39   </verbatim>
40   then nothing will happen when the user selects another station from
41   the list.
42
43 __cc__:
44   Specify the country code. You can use this if you want pre-select a
45   different country than the one specified in the ICAO. So using
46   <verbatim>
47   <?plugin PhpWeather menu=true cc||=GB icao||=KTTS ?>
48   </verbatim>
49   will show the current weather at the NASA Shuttle Facility, United
50   States (<tt>KTTS</tt>) and at the same time give the user a list of
51   stations in the United Kingdom. As the example shows, then you
52   should use <tt>cc||=XX</tt> when combining it with __menu__ set to
53   <tt>true</tt>.
54
55 __language__:
56   The default language. When combining __language__ with __menu__ set
57   to <tt>true</tt> then remember to use the <code>language||=xx</code>
58   form.
59
60 __units__:
61   You can specify the way the units are printed. The choice is between
62   having both metric and imperial units printed, or just one of
63   them. Setting __units__ to =both_metric= will print the metric value
64   first and then the imperial value in parenthesis. Using
65   =both_imperial= instead will do the opposite.
66
67   If you only need the metric or imperial units to be shown, then
68   setting __units__ to =only_metric= or =only_imperial= will do just
69   that.
70 ----
71 WikiPlugin