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     A required table which can contain:
  28
  29     Variables | Meaning | Type | Possible values | Default value
  30     --- | --- | --- | --- | ---
  31     `u` | Units | string | "c" (Celsius), "f" (Fahrenheit) | "c"
  32     `timeout` | Refresh timeout seconds | int | integers | 600
  33     `settings` | User settings | function | function | empty function
  34
  35     `settings` can use strings `forecast`, `units', and can modify `notification_preset` table, which
  36      will be the preset for the naughty notifications. Check [here](http://awesome.naquadah.org/doc/api/modules/naughty.html#notify) for the list of variables it can contain.
  37
  38 The function `register` creates an imagebox icon and a textbox widget. Add them to you wibox like this:
  39
  40     right_layout:add(yawn.icon)
  41     right_layout:add(yawn.widget)
  42
  43 Hovering over ``yawn.icon`` will display the notification.
  44
  45 ### attach
  46
  47     lain.widgets.yawn.attach(widget, id, args)
  48
  49 Arguments:
  50
  51 - ``widget``
  52
  53     The widget which you want to attach Yawn to.
  54
  55 - ``id``
  56
  57     Same as in ``register``.
  58
  59 - ``args``
  60
  61    Same as in ``register``.
  62
  63 Hovering over ``widget`` will display the notification.
  64
  65 Popup shortcut
  66 --------------
  67
  68 You can also create a keybinding for the weather popup like this:
  69
  70     awful.key( { "Mod1" }, "w", function () yawn.show(5) end )
  71
  72 where ``show`` argument is an integer defining timeout seconds.
  73
  74 Localization
  75 ------------
  76
  77 Default language is English, but Yawn can be localized.
  78
  79 Move to `localizations` subdirectory and fill `localization_template`.
  80
  81 Once you're done, rename it like your locale id. In my case:
  82
  83     $ lua
  84     Lua 5.2.2  Copyright (C) 1994-2013 Lua.org, PUC-Rio
  85     > print(os.getenv("LANG"):match("(%S*$*)[.]"))
  86     it_IT
  87     >
  88
  89 hence I named my file "it_IT" (Italian localization).
  90
  91 **NOTE:** If you create a localization, feel free to send me! I will add it.