pgsrc/Help%2FPhpWeatherPlugin

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