From f87b34400eeb1889c5dd0067517580f3bbeb15d3 Mon Sep 17 00:00:00 2001 From: Shish Date: Thu, 20 Aug 2009 23:37:17 +0100 Subject: [PATCH] extension documentation updates --- contrib/ban_words/main.php | 2 +- contrib/browser_search/main.php | 10 ++++++---- contrib/bulk_add/main.php | 2 +- contrib/danbooru_api/main.php | 23 +++++++++++++---------- contrib/downtime/main.php | 7 ++++++- contrib/emoticons/main.php | 2 +- contrib/et/main.php | 2 +- contrib/favorites/main.php | 9 ++++++++- contrib/featured/main.php | 2 +- contrib/handle_archive/main.php | 2 +- contrib/handle_flash/main.php | 2 +- contrib/handle_ico/main.php | 2 +- contrib/handle_mp3/main.php | 2 +- contrib/handle_svg/main.php | 2 +- contrib/home/main.php | 2 +- contrib/image_hash_ban/main.php | 5 ++--- contrib/ipban/main.php | 2 +- contrib/link_image/main.php | 2 +- contrib/news/main.php | 2 +- contrib/numeric_score/main.php | 2 +- contrib/pm/main.php | 2 +- contrib/random_image/main.php | 2 +- contrib/rating/main.php | 2 +- contrib/regen_thumb/main.php | 2 +- contrib/res_limit/main.php | 2 +- contrib/rss_comments/main.php | 2 +- contrib/rss_images/main.php | 2 +- contrib/site_description/main.php | 2 +- contrib/sitemap/main.php | 2 +- contrib/tag_history/main.php | 2 +- contrib/wiki/main.php | 2 +- contrib/word_filter/main.php | 2 +- contrib/zoom/main.php | 2 +- 33 files changed, 63 insertions(+), 47 deletions(-) diff --git a/contrib/ban_words/main.php b/contrib/ban_words/main.php index d03ae3be..d7b640fa 100644 --- a/contrib/ban_words/main.php +++ b/contrib/ban_words/main.php @@ -1,5 +1,5 @@ * License: GPLv2 diff --git a/contrib/browser_search/main.php b/contrib/browser_search/main.php index 62df4a20..07930669 100755 --- a/contrib/browser_search/main.php +++ b/contrib/browser_search/main.php @@ -1,14 +1,16 @@ * Some code (and lots of help) by Artanis (Erik Youngren ) from the 'tagger' extention - Used with permission * Link: http://atravelinggeek.com/ * License: GPLv2 * Description: Allows the user to add a browser 'plugin' to search the site with real-time suggestions - * Version 0.1c - * October 26, 2007 - * + * Version: 0.1c, October 26, 2007 + * Documentation: + * Once installed, users with an opensearch compatible browser should see + * their search box light up with whatever "click here to add a search + * engine" notification they have */ class BrowserSearch implements Extension { diff --git a/contrib/bulk_add/main.php b/contrib/bulk_add/main.php index 3eb33d03..217dbd35 100644 --- a/contrib/bulk_add/main.php +++ b/contrib/bulk_add/main.php @@ -1,5 +1,5 @@ * License: GPLv2 diff --git a/contrib/danbooru_api/main.php b/contrib/danbooru_api/main.php index 53292cc9..449f4a6d 100644 --- a/contrib/danbooru_api/main.php +++ b/contrib/danbooru_api/main.php @@ -1,17 +1,20 @@ -Notes: -danbooru API based on documentation from danbooru 1.0 - http://attachr.com/7569 -I've only been able to test add_post and find_tags because I use the old danbooru firefox extension for firefox 1.5 - -Functions currently implemented: -add_post - title and rating are currently ignored because shimmie does not support them -find_posts - sort of works, filename is returned as the original filename and probably won't help when it comes to actually downloading it -find_tags - id, name, and after_id all work but the tags parameter is ignored just like danbooru 1.0 ignores it +Description: Allow Danbooru apps like Danbooru Uploader for Firefox to communicate with Shimmie +Documentation: +

Notes: +
danbooru API based on documentation from danbooru 1.0 - + http://attachr.com/7569 +
I've only been able to test add_post and find_tags because I use the + old danbooru firefox extension for firefox 1.5 +

Functions currently implemented: +

CHANGELOG 13-OCT-08 8:00PM CST - JJS diff --git a/contrib/downtime/main.php b/contrib/downtime/main.php index 8b43fae0..7c4261c0 100644 --- a/contrib/downtime/main.php +++ b/contrib/downtime/main.php @@ -1,9 +1,14 @@ * License: GPLv2 * Description: Show a "down for maintenance" page + * Documentation: + * Once installed there will be some more options on the config page -- + * Ticking "disable non-admin access" will mean that regular and anonymous + * users will be blocked from accessing the site, only able to view the + * message specified in the box. */ class Downtime implements Extension { diff --git a/contrib/emoticons/main.php b/contrib/emoticons/main.php index 5b1f0486..b7b9e82f 100644 --- a/contrib/emoticons/main.php +++ b/contrib/emoticons/main.php @@ -1,5 +1,5 @@ * License: GPLv2 diff --git a/contrib/et/main.php b/contrib/et/main.php index 17fc526e..00dfd2ae 100644 --- a/contrib/et/main.php +++ b/contrib/et/main.php @@ -1,5 +1,5 @@ * License: GPLv2 diff --git a/contrib/favorites/main.php b/contrib/favorites/main.php index 6a10725a..95b097c7 100644 --- a/contrib/favorites/main.php +++ b/contrib/favorites/main.php @@ -1,9 +1,16 @@ * License: GPLv2 * Description: Allow users to favorite images + * Documentation: + * Gives users a "favorite this image" button that they can press + *

Favorites for a user can then be retrieved by searching for + * "favorited_by=UserName" + *

Popular images can be searched for by eg. "favorites>5" + *

Favorite info can be added to an image's filename or tooltip + * using the $favorites placeholder */ class FavoriteSetEvent extends Event { diff --git a/contrib/featured/main.php b/contrib/featured/main.php index e3f13746..bceca71b 100644 --- a/contrib/featured/main.php +++ b/contrib/featured/main.php @@ -1,5 +1,5 @@ * License: GPLv2 diff --git a/contrib/handle_archive/main.php b/contrib/handle_archive/main.php index c3725a6b..13d6f314 100644 --- a/contrib/handle_archive/main.php +++ b/contrib/handle_archive/main.php @@ -1,5 +1,5 @@ * Description: Allow users to upload archives (zip, etc) diff --git a/contrib/handle_flash/main.php b/contrib/handle_flash/main.php index be3ac459..6a16b0a2 100644 --- a/contrib/handle_flash/main.php +++ b/contrib/handle_flash/main.php @@ -1,5 +1,5 @@ * Description: Handle Flash files diff --git a/contrib/handle_ico/main.php b/contrib/handle_ico/main.php index 45f2940f..3e337404 100644 --- a/contrib/handle_ico/main.php +++ b/contrib/handle_ico/main.php @@ -1,5 +1,5 @@ * Description: Handle windows icons diff --git a/contrib/handle_mp3/main.php b/contrib/handle_mp3/main.php index 91255f5a..f2ba6e42 100644 --- a/contrib/handle_mp3/main.php +++ b/contrib/handle_mp3/main.php @@ -1,5 +1,5 @@ * Description: Handle MP3 files diff --git a/contrib/handle_svg/main.php b/contrib/handle_svg/main.php index 401898cb..863d76a9 100644 --- a/contrib/handle_svg/main.php +++ b/contrib/handle_svg/main.php @@ -1,5 +1,5 @@ * Description: Handle SVG files diff --git a/contrib/home/main.php b/contrib/home/main.php index 9e383f95..63ee1b7f 100644 --- a/contrib/home/main.php +++ b/contrib/home/main.php @@ -1,5 +1,5 @@ * License: GPLv2 diff --git a/contrib/image_hash_ban/main.php b/contrib/image_hash_ban/main.php index 6fb2396f..00582ced 100644 --- a/contrib/image_hash_ban/main.php +++ b/contrib/image_hash_ban/main.php @@ -1,13 +1,12 @@ * Link: http://atravelinggeek.com/ * License: GPLv2 * Description: Ban images based on their hash * Based on the ResolutionLimit and IPban extensions by Shish - * Version 0.1 - * October 21, 2007 + * Version 0.1, October 21, 2007 */ // RemoveImageHashBanEvent {{{ diff --git a/contrib/ipban/main.php b/contrib/ipban/main.php index 237c7c07..ede9e4d5 100644 --- a/contrib/ipban/main.php +++ b/contrib/ipban/main.php @@ -1,5 +1,5 @@ * License: GPLv2 diff --git a/contrib/link_image/main.php b/contrib/link_image/main.php index 45255132..416891b9 100644 --- a/contrib/link_image/main.php +++ b/contrib/link_image/main.php @@ -1,5 +1,5 @@ * Description: Show various forms of link to each image, for copy & paste diff --git a/contrib/news/main.php b/contrib/news/main.php index 16eefa73..69c87255 100644 --- a/contrib/news/main.php +++ b/contrib/news/main.php @@ -1,5 +1,5 @@ * License: GPLv2 diff --git a/contrib/numeric_score/main.php b/contrib/numeric_score/main.php index 30d6e052..5553ce6c 100644 --- a/contrib/numeric_score/main.php +++ b/contrib/numeric_score/main.php @@ -1,5 +1,5 @@ * License: GPLv2 diff --git a/contrib/pm/main.php b/contrib/pm/main.php index bf986c62..5df0dda0 100644 --- a/contrib/pm/main.php +++ b/contrib/pm/main.php @@ -1,5 +1,5 @@ * License: GPLv2 diff --git a/contrib/random_image/main.php b/contrib/random_image/main.php index 7ea5d0db..0d9627d7 100644 --- a/contrib/random_image/main.php +++ b/contrib/random_image/main.php @@ -1,5 +1,5 @@ * License: GPLv2 diff --git a/contrib/rating/main.php b/contrib/rating/main.php index 114d6b79..f4cff877 100644 --- a/contrib/rating/main.php +++ b/contrib/rating/main.php @@ -1,5 +1,5 @@ * License: GPLv2 diff --git a/contrib/regen_thumb/main.php b/contrib/regen_thumb/main.php index 18df0c26..23aac9a6 100644 --- a/contrib/regen_thumb/main.php +++ b/contrib/regen_thumb/main.php @@ -1,5 +1,5 @@ * License: GPLv2 diff --git a/contrib/res_limit/main.php b/contrib/res_limit/main.php index ba6e20f8..a372d253 100644 --- a/contrib/res_limit/main.php +++ b/contrib/res_limit/main.php @@ -1,5 +1,5 @@ * License: GPLv2 diff --git a/contrib/rss_comments/main.php b/contrib/rss_comments/main.php index c432905b..4052877f 100644 --- a/contrib/rss_comments/main.php +++ b/contrib/rss_comments/main.php @@ -1,5 +1,5 @@ * License: GPLv2 diff --git a/contrib/rss_images/main.php b/contrib/rss_images/main.php index 0cf38e64..76527e7d 100644 --- a/contrib/rss_images/main.php +++ b/contrib/rss_images/main.php @@ -1,5 +1,5 @@ * License: GPLv2 diff --git a/contrib/site_description/main.php b/contrib/site_description/main.php index fd068c18..0eeed863 100644 --- a/contrib/site_description/main.php +++ b/contrib/site_description/main.php @@ -1,5 +1,5 @@ * License: GPLv2 diff --git a/contrib/sitemap/main.php b/contrib/sitemap/main.php index bdd350ab..8052ce39 100644 --- a/contrib/sitemap/main.php +++ b/contrib/sitemap/main.php @@ -1,5 +1,5 @@ * License: GPLv2 diff --git a/contrib/tag_history/main.php b/contrib/tag_history/main.php index 0d5e645c..f4561a54 100644 --- a/contrib/tag_history/main.php +++ b/contrib/tag_history/main.php @@ -1,5 +1,5 @@ * Description: Keep a record of tag changes diff --git a/contrib/wiki/main.php b/contrib/wiki/main.php index 1a9725eb..895dbde9 100644 --- a/contrib/wiki/main.php +++ b/contrib/wiki/main.php @@ -1,5 +1,5 @@ * License: GPLv2 diff --git a/contrib/word_filter/main.php b/contrib/word_filter/main.php index dc2a8f9a..2cfef471 100644 --- a/contrib/word_filter/main.php +++ b/contrib/word_filter/main.php @@ -1,5 +1,5 @@ * License: GPLv2 diff --git a/contrib/zoom/main.php b/contrib/zoom/main.php index c365b68c..365b842b 100644 --- a/contrib/zoom/main.php +++ b/contrib/zoom/main.php @@ -1,5 +1,5 @@ * License: GPLv2