extension documentation updates

contrib/ban_words/main.php

@@ -1,5 +1,5 @@
 <?php
-/**
+/*
  * Name: Comment Word Ban
  * Author: Shish <webmaster@shishnet.org>
  * License: GPLv2

contrib/browser_search/main.php

@@ -1,14 +1,16 @@
 <?php
-/**
+/*
  * Name: Browser Search
  * Author: ATravelingGeek <atg@atravelinggeek.com>
  * Some code (and lots of help) by Artanis (Erik Youngren <artanis.00@gmail.com>) 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
+ * Version: 0.1c, October 26, 2007
- * 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 {

contrib/bulk_add/main.php

@@ -1,5 +1,5 @@
 <?php
-/**
+/*
  * Name: Bulk Add
  * Author: Shish <webmaster@shishnet.org>
  * License: GPLv2

contrib/danbooru_api/main.php

@@ -1,17 +1,20 @@
 <?php
 /*
 Name: Danbooru Client API
-Description: Allow Danbooru apps like Danbooru Uploader for Firefox to communicate with Shimmie
-
 Author: JJS <jsutinen@gmail.com>
-Notes:
+Description: Allow Danbooru apps like Danbooru Uploader for Firefox to communicate with Shimmie
-danbooru API based on documentation from danbooru 1.0 - http://attachr.com/7569
+Documentation:
-I've only been able to test add_post and find_tags because I use the old danbooru firefox extension for firefox 1.5
+ <p>Notes:
-
+ <br>danbooru API based on documentation from danbooru 1.0 -
-Functions currently implemented:
+ http://attachr.com/7569
-add_post - title and rating are currently ignored because shimmie does not support them
+ <br>I've only been able to test add_post and find_tags because I use the
-find_posts - sort of works, filename is returned as the original filename and probably won't help when it comes to actually downloading it
+ old danbooru firefox extension for firefox 1.5
-find_tags - id, name, and after_id all work but the tags parameter is ignored just like danbooru 1.0 ignores it
+ <p>Functions currently implemented:
+ <ul>
+ <li>add_post - title and rating are currently ignored because shimmie does not support them
+ <li>find_posts - sort of works, filename is returned as the original filename and probably won't help when it comes to actually downloading it
+ <li>find_tags - id, name, and after_id all work but the tags parameter is ignored just like danbooru 1.0 ignores it
+ </ul>
 
 CHANGELOG
 13-OCT-08 8:00PM CST - JJS

contrib/downtime/main.php

@@ -1,9 +1,14 @@
 <?php
-/**
+/*
  * Name: Downtime
  * Author: Shish <webmaster@shishnet.org>
  * 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 {

contrib/emoticons/main.php

@@ -1,5 +1,5 @@
 <?php
-/**
+/*
  * Name: Emoticon Filter
  * Author: Shish <webmaster@shishnet.org>
  * License: GPLv2

contrib/et/main.php

@@ -1,5 +1,5 @@
 <?php
-/**
+/*
  * Name: System Info
  * Author: Shish <webmaster@shishnet.org>
  * License: GPLv2

contrib/favorites/main.php

@@ -1,9 +1,16 @@
 <?php
-/**
+/*
  * Name: Favorites
  * Author: Daniel Marschall <info@daniel-marschall.de>
  * License: GPLv2
  * Description: Allow users to favorite images
+ * Documentation:
+ *  Gives users a "favorite this image" button that they can press
+ *  <p>Favorites for a user can then be retrieved by searching for
+ *  "favorited_by=UserName"
+ *  <p>Popular images can be searched for by eg. "favorites>5"
+ *  <p>Favorite info can be added to an image's filename or tooltip
+ *  using the $favorites placeholder
  */
 
 class FavoriteSetEvent extends Event {

contrib/featured/main.php

@@ -1,5 +1,5 @@
 <?php
-/**
+/*
  * Name: Featured Image
  * Author: Shish <webmaster@shishnet.org>
  * License: GPLv2

contrib/handle_archive/main.php

@@ -1,5 +1,5 @@
 <?php
-/**
+/*
  * Name: Archive File Handler
  * Author: Shish <webmaster@shishnet.org>
  * Description: Allow users to upload archives (zip, etc)

contrib/handle_flash/main.php

@@ -1,5 +1,5 @@
 <?php
-/**
+/*
  * Name: Flash File Handler
  * Author: Shish <webmaster@shishnet.org>
  * Description: Handle Flash files

contrib/handle_ico/main.php

@@ -1,5 +1,5 @@
 <?php
-/**
+/*
  * Name: ICO File Handler
  * Author: Shish <webmaster@shishnet.org>
  * Description: Handle windows icons

contrib/handle_mp3/main.php

@@ -1,5 +1,5 @@
 <?php
-/**
+/*
  * Name: MP3 File Handler
  * Author: Shish <webmaster@shishnet.org>
  * Description: Handle MP3 files

contrib/handle_svg/main.php

@@ -1,5 +1,5 @@
 <?php
-/**
+/*
  * Name: SVG File Handler
  * Author: Shish <webmaster@shishnet.org>
  * Description: Handle SVG files

contrib/home/main.php

@@ -1,5 +1,5 @@
 <?php
-/**
+/*
 * Name: Home Page
 * Author: Bzchan <bzchan@animemahou.com>
 * License: GPLv2

contrib/image_hash_ban/main.php

@@ -1,13 +1,12 @@
 <?php
-/**
+/*
  * Name: Image Hash Ban
  * Author: ATravelingGeek <atg@atravelinggeek.com>
  * 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
+ * Version 0.1, October 21, 2007
- * October 21, 2007
  */
 
  // RemoveImageHashBanEvent {{{

contrib/ipban/main.php

@@ -1,5 +1,5 @@
 <?php
-/**
+/*
  * Name: IP Ban
  * Author: Shish <webmaster@shishnet.org>
  * License: GPLv2

contrib/link_image/main.php

@@ -1,5 +1,5 @@
 <?php
-/**
+/*
  * Name: Link to Image
  * Author: Artanis <artanis.00@gmail.com>
  * Description: Show various forms of link to each image, for copy & paste

contrib/news/main.php

@@ -1,5 +1,5 @@
 <?php
-/**
+/*
  * Name: News
  * Author: Shish <webmaster@shishnet.org>
  * License: GPLv2

contrib/numeric_score/main.php

@@ -1,5 +1,5 @@
 <?php
-/**
+/*
  * Name: Image Scores (Numeric)
  * Author: Shish <webmaster@shishnet.org>
  * License: GPLv2

contrib/pm/main.php

@@ -1,5 +1,5 @@
 <?php
-/**
+/*
  * Name: Private Messaging
  * Author: Shish <webmaster@shishnet.org>
  * License: GPLv2

contrib/random_image/main.php

@@ -1,5 +1,5 @@
 <?php
-/**
+/*
  * Name: Random Image
  * Author: Shish <webmaster@shishnet.org>
  * License: GPLv2

contrib/rating/main.php

@@ -1,5 +1,5 @@
 <?php
-/**
+/*
  * Name: Image Ratings
  * Author: Shish <webmaster@shishnet.org>
  * License: GPLv2

contrib/regen_thumb/main.php

@@ -1,5 +1,5 @@
 <?php
-/**
+/*
  * Name: Regen Thumb
  * Author: Shish <webmaster@shishnet.org>
  * License: GPLv2

contrib/res_limit/main.php

@@ -1,5 +1,5 @@
 <?php
-/**
+/*
  * Name: Resolution Limiter
  * Author: Shish <webmaster@shishnet.org>
  * License: GPLv2

contrib/rss_comments/main.php

@@ -1,5 +1,5 @@
 <?php
-/**
+/*
  * Name: RSS for Comments
  * Author: Shish <webmaster@shishnet.org>
  * License: GPLv2

contrib/rss_images/main.php

@@ -1,5 +1,5 @@
 <?php
-/**
+/*
  * Name: RSS for Images
  * Author: Shish <webmaster@shishnet.org>
  * License: GPLv2

contrib/site_description/main.php

@@ -1,5 +1,5 @@
 <?php
-/**
+/*
  * Name: Site Description
  * Author: Shish <webmaster@shishnet.org>
  * License: GPLv2

contrib/sitemap/main.php

@@ -1,5 +1,5 @@
 <?php
-/**
+/*
  * Name: XML Sitemap
  * Author: Sein Kraft <mail@seinkraft.info>
  * License: GPLv2

contrib/tag_history/main.php

@@ -1,5 +1,5 @@
 <?php
-/**
+/*
  * Name: Tag History
  * Author: Bzchan <bzchan@animemahou.com>
  * Description: Keep a record of tag changes

contrib/wiki/main.php

@@ -1,5 +1,5 @@
 <?php
-/**
+/*
  * Name: Simple Wiki
  * Author: Shish <webmaster@shishnet.org>
  * License: GPLv2

contrib/word_filter/main.php

@@ -1,5 +1,5 @@
 <?php
-/**
+/*
  * Name: Word Filter
  * Author: Shish <webmaster@shishnet.org>
  * License: GPLv2

contrib/zoom/main.php

@@ -1,5 +1,5 @@
 <?php
-/**
+/*
  * Name: Image Zoom
  * Author: Shish <webmaster@shishnet.org>
  * License: GPLv2