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