pgsrc/Help%2FPhpWeatherPlugin

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