From 7a60e6fae56db18021e4808a4c991e3c4ca3d765 Mon Sep 17 00:00:00 2001
From: Shish <shish@shishnet.org>
Date: Tue, 5 Jan 2010 10:11:53 +0000
Subject: [PATCH] lots of extension docs

---
 ext/admin/main.php        | 26 ++++++++++++++++++++++++++
 ext/alias_editor/main.php | 10 ++++++++++
 ext/bbcode/main.php       | 23 +++++++++++++++++++++++
 ext/ext_manager/main.php  |  4 ++++
 ext/ext_manager/theme.php |  3 +++
 ext/handle_404/main.php   |  7 +++++++
 ext/image/main.php        |  6 ++++++
 ext/setup/main.php        |  5 +++++
 ext/tag_edit/main.php     |  6 ++++++
 ext/tag_list/main.php     |  5 +++++
 ext/upgrade/main.php      |  5 +++++
 ext/upload/main.php       |  6 ++++++
 ext/user/main.php         |  6 ++++++
 ext/view/main.php         |  6 ++++++
 14 files changed, 118 insertions(+)

diff --git a/ext/admin/main.php b/ext/admin/main.php
index 83779d98..7a035a39 100644
--- a/ext/admin/main.php
+++ b/ext/admin/main.php
@@ -1,4 +1,30 @@
 <?php
+/**
+ * Name: Admin Controls
+ * Author: Shish <webmaster@shishnet.org>
+ * Link: http://code.shishnet.org/shimmie2/
+ * License: GPLv2
+ * Description: Various things to make admins' lives easier
+ * Documentation:
+ *  <p>Lowercase all tags:
+ *  <br>Set all tags to lowercase for consistency
+ *  <p>Recount tag use:
+ *  <br>If the counts of images per tag get messed up somehow, this will reset them
+ *  <p>Purge unused tags:
+ *  <br>Get rid of all the tags that don't have any images associated with
+ *  them (normally they were created as typos or spam); this is mostly for
+ *  neatness, the performance gain is tiny...
+ *  <p>Convert to InnoDB:
+ *  <br>Convert your database tables to InnoDB, thus allowing shimmie to
+ *  take advantage of useful InnoDB-only features (this should be done
+ *  automatically, this button only exists as a backup). This only applies
+ *  to MySQL -- all other databases come with useful features enabled
+ *  as standard.
+ *  <p>Database dump:
+ *  <br>Download the contents of the database in plain text format, useful
+ *  for backups.
+ */
+
 /**
  * Sent when the admin page is ready to be added to
  */
diff --git a/ext/alias_editor/main.php b/ext/alias_editor/main.php
index cbc6e6b5..fb9135c4 100644
--- a/ext/alias_editor/main.php
+++ b/ext/alias_editor/main.php
@@ -1,4 +1,14 @@
 <?php
+/**
+ * Name: Alias Editor
+ * Author: Shish <webmaster@shishnet.org>
+ * Link: http://code.shishnet.org/shimmie2/
+ * License: GPLv2
+ * Description: Edit the alias list
+ * Documentation:
+ *  The list is visible at $site/alias/list; only site admins can edit it,
+ *  other people can view and download it
+ */
 
 class AddAliasEvent extends Event {
 	var $oldtag;
diff --git a/ext/bbcode/main.php b/ext/bbcode/main.php
index c00c7332..bddda8c5 100644
--- a/ext/bbcode/main.php
+++ b/ext/bbcode/main.php
@@ -1,4 +1,27 @@
 <?php
+/**
+ * Name: BBCode
+ * Author: Shish <webmaster@shishnet.org>
+ * Link: http://code.shishnet.org/shimmie2/
+ * License: GPLv2
+ * Description: Turns BBCode into HTML
+ * Documentation:
+ *  Supported tags:
+ *  <ul>
+ *    <li>[img]url[/img]
+ *    <li>[url]<a href="http://code.shishnet.org/shimmie2/">http://code.shishnet.org/</a>[/url]
+ *    <li>[email]<a href="mailto:webmaster@shishnet.org">webmaster@shishnet.org</a>[/email]
+ *    <li>[b]<b>bold</b>[/b]
+ *    <li>[i]<i>italic</i>[/i]
+ *    <li>[u]<u>underline</u>[/u]
+ *    <li>[s]<s>strikethrough</s>[/s]
+ *    <li>[[wiki article]]
+ *    <li>[[wiki article|with some text]]
+ *    <li>[quote]text[/quote]
+ *    <li>[quote=Username]text[/quote]
+ *    <li>&gt;&gt;123 (link to image #123)
+ *  </ul>
+ */
 
 class BBCode extends FormatterExtension {
 	public function format($text) {
diff --git a/ext/ext_manager/main.php b/ext/ext_manager/main.php
index 47a10d80..a7d11017 100644
--- a/ext/ext_manager/main.php
+++ b/ext/ext_manager/main.php
@@ -5,6 +5,10 @@
  * Link: http://code.shishnet.org/shimmie2/
  * License: GPLv2
  * Description: A thing for point & click extension management
+ * Documentation:
+ *   Allows the admin to view a list of all extensions and enable or
+ *   disable them; also allows users to view the list of activated
+ *   extensions and read their documentation
  */
 
 /** @private */
diff --git a/ext/ext_manager/theme.php b/ext/ext_manager/theme.php
index ea17c74d..27ae0846 100644
--- a/ext/ext_manager/theme.php
+++ b/ext/ext_manager/theme.php
@@ -121,7 +121,10 @@ class ExtManagerTheme extends Themelet {
 			<div style='margin: auto; text-align: left; width: 512px;'>
 				$author
 				$version
+				$link
 				<p>$doc
+				<hr>
+				<p><a href='".make_link("ext_manager")."'>Back to the list</a>
 			</div>";
 
 		$page->set_title("Documentation for ".html_escape($info->name));
diff --git a/ext/handle_404/main.php b/ext/handle_404/main.php
index cffab0e6..4830ff3d 100644
--- a/ext/handle_404/main.php
+++ b/ext/handle_404/main.php
@@ -1,4 +1,11 @@
 <?php
+/**
+ * Name: 404 Detector
+ * Author: Shish <webmaster@shishnet.org>
+ * Link: http://code.shishnet.org/shimmie2/
+ * License: GPLv2
+ * Description: Shows an error message when the user views a page with no content
+ */
 
 class Handle404 implements Extension {
 	public function receive_event(Event $event) {
diff --git a/ext/image/main.php b/ext/image/main.php
index 213c0ca2..f7628ba3 100644
--- a/ext/image/main.php
+++ b/ext/image/main.php
@@ -1,4 +1,10 @@
 <?php
+/*
+ * Name: Image Manager
+ * Author: Shish
+ * Description: Handle the image database
+ */
+
 /*
  * ImageAdditionEvent:
  *   $user  -- the user adding the image
diff --git a/ext/setup/main.php b/ext/setup/main.php
index 7390a1f0..d96d36f5 100644
--- a/ext/setup/main.php
+++ b/ext/setup/main.php
@@ -1,4 +1,9 @@
 <?php
+/*
+ * Name: Board Config
+ * Author: Shish
+ * Description: Allows the site admin to configure the board to his or her taste
+ */
 
 /* ConfigSaveEvent {{{
  *
diff --git a/ext/tag_edit/main.php b/ext/tag_edit/main.php
index a439dc51..f0f86811 100644
--- a/ext/tag_edit/main.php
+++ b/ext/tag_edit/main.php
@@ -1,4 +1,10 @@
 <?php
+/*
+ * Name: Tag Editor
+ * Author: Shish
+ * Description: Allow images to have tags assigned to them
+ */
+
 /*
  * SourceSetEvent:
  *   $image_id
diff --git a/ext/tag_list/main.php b/ext/tag_list/main.php
index 2d33191a..f9216a7d 100644
--- a/ext/tag_list/main.php
+++ b/ext/tag_list/main.php
@@ -1,4 +1,9 @@
 <?php
+/*
+ * Name: Tag List
+ * Author: Shish
+ * Description: Show the tags in various ways
+ */
 
 class TagList implements Extension {
 	var $theme = null;
diff --git a/ext/upgrade/main.php b/ext/upgrade/main.php
index 1d33c8d3..1c99af56 100644
--- a/ext/upgrade/main.php
+++ b/ext/upgrade/main.php
@@ -1,4 +1,9 @@
 <?php
+/*
+ * Name: Database Upgrader
+ * Author: Shish
+ * Description: Keeps things happy behind the scenes
+ */
 
 class Upgrade implements Extension {
 	public function receive_event(Event $event) {
diff --git a/ext/upload/main.php b/ext/upload/main.php
index d6c1990b..f62571b5 100644
--- a/ext/upload/main.php
+++ b/ext/upload/main.php
@@ -1,4 +1,10 @@
 <?php
+/*
+ * Name: Uploader
+ * Author: Shish
+ * Description: Allows people to upload files to the website
+ */
+
 /*
  * DataUploadEvent:
  *   $user     -- the user uploading the data
diff --git a/ext/user/main.php b/ext/user/main.php
index 1db4fe7d..e7fd3b6a 100644
--- a/ext/user/main.php
+++ b/ext/user/main.php
@@ -1,4 +1,10 @@
 <?php
+/*
+ * Name: User Management
+ * Author: Shish
+ * Description: Allows people to sign up to the website
+ */
+
 require_once "lib/recaptchalib.php";
 
 class UserBlockBuildingEvent extends Event {
diff --git a/ext/view/main.php b/ext/view/main.php
index b61c0512..ab0aef81 100644
--- a/ext/view/main.php
+++ b/ext/view/main.php
@@ -1,4 +1,10 @@
 <?php
+/*
+ * Name: Image Viewer
+ * Author: Shish
+ * Description: Allows users too see uploaded images
+ */
+
 /*
  * DisplayingImageEvent:
  *   $image -- the image being displayed