yawn.md

   1 (YAhoo! Weather Notification)
   2
   3 Yawn provides brief and compact Yahoo! Weather notification.
   4
   5 Usage
   6 -----
   7
   8 You can ``register`` Yawn to get a set of widgets, or ``attach`` it to
   9 an existent widget.
  10
  11 ### register
  12
  13     yawn = lain.widgets.yawn(id, args)
  14
  15 - ``id``
  16
  17     An integer that defines the WOEID code of your city.
  18     To obtain it you can google 'yahoo weather %CITYNAME%' and follow the first link.
  19     It will look like:
  20
  21         http://weather.yahoo.com/united-states/california/san-diego-2487889/
  22
  23     and the last number in that link will be the ID you need.
  24
  25 - ``args``
  26
  27     An optional table which can contain the following settings:
  28
  29     Variables | Meaning | Type | Possible values | Default value
  30     --- | --- | --- | --- | ---
  31     `u` | Units | string | "c" (Celsius), "f" (Fahrenheit) | "c"
  32     `toshow` | What to show | string | "forecast", "units", "both" | "forecast"
  33     `color` | ``yawn.widget`` color | string | hexadecimal colors |
  34
  35 The function creates an imagebox icon and a textbox widget. Add them to you wibox like this:
  36
  37     right_layout:add(yawn.icon)
  38     right_layout:add(yawn.widget)
  39
  40 Hovering over ``yawn.icon`` will display the notification.
  41
  42 ### attach
  43
  44     lain.widgets.yawn.attach(widget, id, args)
  45
  46 Arguments:
  47
  48 - ``widget``
  49
  50     The widget which you want to attach Yawn to.
  51
  52 - ``id``
  53
  54     Same as in ``register``.
  55
  56 - ``args``
  57
  58    Same as in ``register``.
  59
  60 Hovering over ``widget`` will display the notification.
  61
  62 Popup shortcut
  63 --------------
  64
  65 You can also create a keybinding for the weather popup like this:
  66
  67     awful.key( { "Mod1" }, "w", function () yawn.show(5) end )
  68
  69 where ``show`` argument is an integer defining timeout seconds.
  70
  71 Localization
  72 ------------
  73
  74 Default language is English, but Yawn can be localized.
  75
  76 Move to `localizations` subdirectory and fill `localization_template`.
  77
  78 Once you're done, rename it like your locale id. In my case:
  79
  80     $ lua
  81     Lua 5.2.2  Copyright (C) 1994-2013 Lua.org, PUC-Rio
  82     > print(os.getenv("LANG"):match("(%S*$*)[.]"))
  83     it_IT
  84     >
  85
  86 hence I named my file "it_IT" (Italian localization).
  87
  88 **NOTE:** If you create a localization, feel free to send me! I will add it.