From 700d2c7d463c88c1aa1c9caccf3e014ea0e0211d Mon Sep 17 00:00:00 2001 From: Mikaela Suomalainen Date: Mon, 19 May 2014 12:20:55 +0300 Subject: [PATCH 1/3] Aka: update README. Fixes #639 for those who read READMEs. --- plugins/Aka/README.md | 72 ++++++++++++++++++++++++++++++++++++++++++ plugins/Aka/README.txt | 25 --------------- 2 files changed, 72 insertions(+), 25 deletions(-) create mode 100644 plugins/Aka/README.md delete mode 100644 plugins/Aka/README.txt diff --git a/plugins/Aka/README.md b/plugins/Aka/README.md new file mode 100644 index 000000000..5250c0fa5 --- /dev/null +++ b/plugins/Aka/README.md @@ -0,0 +1,72 @@ +This plugin allows the user to create various aliases (known as "Akas", +since Alias is the name of another plugin Aka is based on) to other +commands or combinations of other commands (via nested commands). +It is a good idea to always quote the commands that are being aliased so +that any nested commands are not immediately run. + +Basic usage +----------- + +### Alias + +Add an aka, Alias, which eases the transitioning to Aka from Alias. + +First we will load Alias and Aka. + +``` + @load Alias + jamessan: The operation succeeded. + @load Aka + jamessan: The operation succeeded. + +``` + +Then we import the Alias database to Aka in case it exists and unload +Alias. + +``` + @importaliasdatabase + jamessan: The operation succeeded. + @unload Alias + jamessan: The operation succeeded. +``` + +And now we will finally add the Aka `alias` itself. + +``` + @aka add "alias" "aka $1 $*" + jamessan: The operation succeeded. +``` + +Now you can use Aka as you used Alias before. + +### Trout + +Add an aka, trout, which expects a word as an argument + +``` + @aka add trout "reply action slaps $1 with a large trout" + jamessan: The operation succeeded. + @trout me +* bot slaps me with a large trout +``` + +This `trout` aka requires the plugin `Reply` to be loaded since it +provides the `action` command. + +### LastFM + +Add an aka, `lastfm`, which expects a last.fm username and replies with +their most recently played item. + +`@aka add lastfm "rss [format concat http://ws.audioscrobbler.com/1.0/user/ [format concat [web urlquote $1] /recenttracks.rss]]"` + +This `lastfm` aka requires the following plugins to be loaded: `RSS`, +`Format` and `Web`. + +`RSS` provides `rss`, `Format provides `concat` and `Web` provides +`urlquote`. + +Note that if the nested commands being aliased hadn't been quoted, then +those commands would have been run immediately, and `@lastfm` would always +reply with the same information, the result of those commands. diff --git a/plugins/Aka/README.txt b/plugins/Aka/README.txt deleted file mode 100644 index 5ef0c68bd..000000000 --- a/plugins/Aka/README.txt +++ /dev/null @@ -1,25 +0,0 @@ -This plugin allows the user to create various aliases (known as "Akas", -since Alias is the name of another plugin Aka is based on) to other commands -or combinations of other commands (via nested commands). It is a good -idea to always quote the commands that are being aliased so that any -nested commands are not immediately run. - -Basic usage ------------ - -Add an aka, trout, which expects a word as an argument - - @aka add trout "action slaps $1 with a large trout" - jamessan: The operation succeeded. - @trout me -* bot slaps me with a large trout - -Add an aka, lastfm, which expects a last.fm user and replies with -their recently played items. - -@aka add lastfm "rss [format concat http://ws.audioscrobbler.com/1.0/user/ [format concat [urlquote $1] /recenttracks.rss]]" - -Note that if the nested commands being aliased hadn't been quoted, then -those commands would have been run immediately, and @lastfm would always -reply with the same information, the result of those commands. - with any notes, etc. about using it. From f87052788eec292f52a801fefb78194e0320573d Mon Sep 17 00:00:00 2001 From: Mikaela Suomalainen Date: Mon, 19 May 2014 12:27:07 +0300 Subject: [PATCH 2/3] Aka: use better quotes for lastfm in README.md. --- plugins/Aka/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/plugins/Aka/README.md b/plugins/Aka/README.md index 5250c0fa5..64d6deadd 100644 --- a/plugins/Aka/README.md +++ b/plugins/Aka/README.md @@ -59,7 +59,9 @@ provides the `action` command. Add an aka, `lastfm`, which expects a last.fm username and replies with their most recently played item. -`@aka add lastfm "rss [format concat http://ws.audioscrobbler.com/1.0/user/ [format concat [web urlquote $1] /recenttracks.rss]]"` +``` +@aka add lastfm "rss [format concat http://ws.audioscrobbler.com/1.0/user/ [format concat [web urlquote $1] /recenttracks.rss]]" +``` This `lastfm` aka requires the following plugins to be loaded: `RSS`, `Format` and `Web`. From e8e16e6f3f143ee66b13fa41218476cfd2c9dd82 Mon Sep 17 00:00:00 2001 From: Mikaela Suomalainen Date: Mon, 19 May 2014 17:07:01 +0300 Subject: [PATCH 3/3] .travis.yml: disable email spam. [SKIP CI] --- .travis.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.travis.yml b/.travis.yml index 770497932..2d7ca9514 100644 --- a/.travis.yml +++ b/.travis.yml @@ -16,3 +16,6 @@ script: - supybot-test test --plugins-dir=./build/lib*/supybot/plugins/ --no-network --disable-multiprocessing --exclude=./build/lib*/supybot/plugins/Scheduler --exclude=./build/lib*/supybot/plugins/Filter after_success: - sandbox/check_trans.py plugins/ +notifications: + on_success: never + on_failure: never