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