Tags:
create new tag
, view all tags

WundergroundPluginDev Discussion: Page for developer collaboration, enhancement requests, patches and improved versions on WundergroundPlugin contributed by the TWikiCommunity.
• Please let us know what you think of this extension.
• For support, check the existing questions, or ask a new support question in the Support web!
• Please report bugs below

WundergroundPlugin Feedback and Development

Release Notes: This replaces the GoogleWeatherPlugin. It provides better data and some additional location options.

It also provides more detailed data - hovering over most elements is worthwhile.

It should service the %WEATHER% macros in existing topics, although the resulting table size and contents vary.

Some options from GoogleWeatherPlugin are not required/used by WundergroundPlugin; they are ignored for compatibility with existing topics, but should be removed from topics when the opportunity arises.

As noted above, a WU license key is required (but for many applications, a free license suffices.)

This release is alpha quality - there are some issues with non-English output, both in TWiki and in the WU API.

Some links on this page may not render properly without the LinkOptionsPlugin, as they open new windows (or tabs). (How about installing it on twiki.org?)

-- Timothe Litt - 2014-01-13

Thank you Timothe for contributing this new plugin!

I created supporting topics (this dev topic, WundergroundPluginAppraisal, Support.WundergroundPlugin) and tagged the plugin topic.

Some feedback on the plugin topic:

  • I copied your release notes to this plugin dev topic. You could remove it from the plugin topic.
  • I recommend to avoid LinkOptionsPlugin syntax. That plugin is no longer needed in TWiki-6.0, which opens external links in new tabs by default (configurable)
  • Escape special characters, such as ° for the degree symbol, and © for copyright symbol.
  • Hint: If you indent the package content table it will align nicely with the bullet.
  • The bullet below "Configure the Plugin" is indented twice.
  • Instead of asking user to create a lib/TWiki/Plugins/WundergroundPlugin/APIKEY.pm how about creating a {Plugins}{WundergroundPlugin}{ApiKey} configure setting? You could ship a Config.spec to make it easy for the user - see example SVN:BackupRestorePlugin/lib/TWiki/Plugins/BackupRestorePlugin/Config.spec.
  • Small detail: TWiki uses ISO date format: 2014-01-12 instead of 12 Jan 2014.

-- Peter Thoeny - 2014-01-13

Thanks for the packaging feedback. I'll keep your notes in mind if WU fixes their API bugs & I do another release.

I said it was alpha quality. Time was (and is) very limited. I needed something quick and dirty to get several key pages back on line, and figured others might too.

The release notes aren't in the zip file's plugin topic or the master copy; just in the copy on twiki.org (where people shop). Shoppers don't visit dev topics.

I don't run 6.0 - or even 5.0. And I explicitly want these links in new tabs, not following a site default. They are for steps in a procedure. For compatibility, 6.0 should support the long-established LinkOptionsPlugin syntax.

Escape - where? I use ° in the output where I generate it. There are some issues with non-English text returned by WU. But escaping won't fix them.

I copied the topic format from the previous plugin. The indentation & date format will be corrected.

The double indentation of the list was intentional.

I know Configure well. Config.spec - yes. And a checker. And...other features - if I have time.

The higher priority is dealing with the WU-induced issues with non-English text.

Feedback on what I selected for the content/presentation would be welcome. The title (hover) method for detail is better than nothing, but something less awkward would be nice.

-- Timothe Litt - 2014-01-13

On unescaped symbols, degree is in the units parameter description, copyright in the Copyright table row.

Ah, the issue is actually an empty bullet, which renders indented bullets as two bullets at the same line in FF.

-- Peter Thoeny - 2014-01-13

Thanks, I missed the degree in units (the code that outputs the macro expansion gets it right, but apparently I did the wrong copy & paste to the topic.) The copyright was inherited. Both are fixed.

Not sure how the extra bullet got there, it's not in my master copy. Anyhow, it will go away in the next drop, which eliminates the dependency on LinkOptionsPlugin and moves the API key to configure.

Now if I can figure out what character encoding is being used by Ciel dégagé ... which is more line-noise than French frown

-- Timothe Litt - 2014-01-13

Umm, the watch function is nice - but suggestion - could it not notify the author of a change?? The person making the change obviously knows that (s)he edited the topic.

-- Timothe Litt - 2014-01-13

V1.01 Released, should address your issues. Also fixes the character encodings. (TWiki::Net doesn't encode to utf-8 when the header says it should.)

On to other things.

-- Timothe Litt - 2014-01-14

On watchlist suggestion, I recommend filing an enhancement request at TWikibug:WatchlistPlugin.

-- Peter Thoeny - 2014-01-14

Edit | Attach | Watch | Print version | History: r6 < r5 < r4 < r3 < r2 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r6 - 2014-01-14 - PeterThoeny
 
  • Learn about TWiki  
  • Download TWiki
This site is powered by the TWiki collaboration platform Powered by Perl Hosted by OICcam.com Ideas, requests, problems regarding TWiki? Send feedback. Ask community in the support forum.
Copyright © 1999-2017 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.