* Added smiley plugin, nicely controlled and documented by the smileys page.
authorjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>
Thu, 4 May 2006 04:29:37 +0000 (04:29 +0000)
committerjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>
Thu, 4 May 2006 04:29:37 +0000 (04:29 +0000)
* Copied in some smileys from Moin Moin.

32 files changed:
IkiWiki/Plugin/skeleton.pm
IkiWiki/Render.pm
basewiki/helponformatting.mdwn
basewiki/smileys.mdwn [new file with mode: 0644]
basewiki/smileys/alert.png [new file with mode: 0644]
basewiki/smileys/angry.png [new file with mode: 0644]
basewiki/smileys/attention.png [new file with mode: 0644]
basewiki/smileys/biggrin.png [new file with mode: 0644]
basewiki/smileys/checkmark.png [new file with mode: 0644]
basewiki/smileys/devil.png [new file with mode: 0644]
basewiki/smileys/frown.png [new file with mode: 0644]
basewiki/smileys/icon-error.png [new file with mode: 0644]
basewiki/smileys/icon-info.png [new file with mode: 0644]
basewiki/smileys/idea.png [new file with mode: 0644]
basewiki/smileys/ohwell.png [new file with mode: 0644]
basewiki/smileys/redface.png [new file with mode: 0644]
basewiki/smileys/sad.png [new file with mode: 0644]
basewiki/smileys/smile.png [new file with mode: 0644]
basewiki/smileys/smile2.png [new file with mode: 0644]
basewiki/smileys/smile3.png [new file with mode: 0644]
basewiki/smileys/smile4.png [new file with mode: 0644]
basewiki/smileys/star_off.png [new file with mode: 0644]
basewiki/smileys/star_on.png [new file with mode: 0644]
basewiki/smileys/thumbs-up.png [new file with mode: 0644]
basewiki/smileys/tired.png [new file with mode: 0644]
basewiki/smileys/tongue.png [new file with mode: 0644]
debian/changelog
debian/copyright
doc/plugins.mdwn
doc/plugins/smiley.mdwn [new file with mode: 0644]
doc/plugins/write.mdwn
doc/todo/plugin.mdwn

index d6d8cc0eddf588804519895d7355941c5d1ed9df..cae4c02ece0baa0f98da892aec943dd1f84b7e1d 100644 (file)
@@ -13,6 +13,8 @@ sub import { #{{{
                call => \&checkconfig);
        IkiWiki::hook(type => "preprocess", id => "skeleton", 
                call => \&preprocess);
+       IkiWiki::hook(type => "filter", id => "skeleton", 
+               call => \&filter);
        IkiWiki::hook(type => "delete", id => "skeleton", 
                call => \&delete);
        IkiWiki::hook(type => "render", id => "skeleton", 
@@ -31,6 +33,14 @@ sub preprocess (@) { #{{{
        return "skeleton plugin result";
 } # }}}
 
+sub filter ($) { #{{{
+       my $content=shift;
+       
+       IkiWiki::debug("skeleton plugin running as filter");
+
+       return $content;
+} # }}}
+
 sub delete (@) { #{{{
        my @files=@_;
 
index a4efa0b74511a1b88faefd4e0519242e04736fe4..6f685f3b8f65ae0d3904e3b939df12fe933a4532 100644 (file)
@@ -263,9 +263,18 @@ sub render ($) { #{{{
        if ($type ne 'unknown') {
                my $content=readfile($srcfile);
                my $page=pagename($file);
+               delete $depends{$page};
+               
+               if (exists $hooks{filter}) {
+                       foreach my $id (keys %{$hooks{filter}}) {
+                               $content=$hooks{filter}{$id}{call}->(
+                                       page => $page,
+                                       content => $content
+                               );
+                       }
+               }
                
                $links{$page}=[findlinks($content, $page)];
-               delete $depends{$page};
                
                $content=linkify($content, $page);
                $content=preprocess($page, $content);
index 9f7bcd9d13803bea69956c3cbfa6aac0cfe6ba4c..a34f201445eea5f20bb313ec55af1955a4f44822 100644 (file)
@@ -54,6 +54,9 @@ To link to any other web page, or to an email address, you can just put the url
 Advanced users can use [[PreProcessorDirective]]s to do additional cool
 stuff.
 
+Also, if the smiley plugin is enabled in your wiki, you can insert
+[[smileys]] and some other useful symbols.
+
 ----
 
 This style of text formatting is called [[MarkDown]].
diff --git a/basewiki/smileys.mdwn b/basewiki/smileys.mdwn
new file mode 100644 (file)
index 0000000..2b23d2b
--- /dev/null
@@ -0,0 +1,42 @@
+This page is used to control what smileys are supported by the wiki.
+Just write the text of a smiley to display it.
+
+* \:)  [[smileys/smile.png]]
+* \:-) [[smileys/smile.png]]
+* \:D  [[smileys/biggrin.png]]
+* \B)  [[smileys/smile2.png]]
+* \:)) [[smileys/smile3.png]]
+* \:-))        [[smileys/smile3.png]]
+* \;)  [[smileys/smile4.png]]
+* \;-) [[smileys/smile4.png]]
+* \:\  [[smileys/ohwell.png]]
+* \:/  [[smileys/ohwell.png]]
+* \>:> [[smileys/devil.png]]
+* \X-( [[smileys/angry.png]]
+* \<:( [[smileys/frown.png]]
+* \:(  [[smileys/sad.png]]
+* \:-( [[smileys/sad.png]]
+* \:-? [[smileys/tongue.png]]
+* \:o  [[smileys/redface.png]]
+* \|)  [[smileys/tired.png]]
+* \|-) [[smileys/tired.png]]
+* \{OK}        [[smileys/thumbs-up.png]]
+* \{X} [[smileys/icon-error.png]]
+* \(./)        [[smileys/checkmark.png]]
+* \(!) [[smileys/idea.png]]
+* \[!] [[smileys/attention.png]]
+* \/!\ [[smileys/alert.png]]
+* \{*} [[smileys/star_on.png]]
+* \{o} [[smileys/star_off.png]]
+
+For example: {*} :-) {*}
+
+----
+
+To change the supported smileys, just edit the lists on this page.
+Note that the format is important; each list item should start with the
+text that is turned into the smiley, escaped so that users can see what
+produces it, followed by a [[WikiLink]] to the image to display.
+
+/!\ Bear in mind that the link to the imge needs to be written in a way that
+will work if it's copied to other pages on the wiki.
diff --git a/basewiki/smileys/alert.png b/basewiki/smileys/alert.png
new file mode 100644 (file)
index 0000000..5bb87e3
Binary files /dev/null and b/basewiki/smileys/alert.png differ
diff --git a/basewiki/smileys/angry.png b/basewiki/smileys/angry.png
new file mode 100644 (file)
index 0000000..05bc69f
Binary files /dev/null and b/basewiki/smileys/angry.png differ
diff --git a/basewiki/smileys/attention.png b/basewiki/smileys/attention.png
new file mode 100644 (file)
index 0000000..7e06456
Binary files /dev/null and b/basewiki/smileys/attention.png differ
diff --git a/basewiki/smileys/biggrin.png b/basewiki/smileys/biggrin.png
new file mode 100644 (file)
index 0000000..f71b42c
Binary files /dev/null and b/basewiki/smileys/biggrin.png differ
diff --git a/basewiki/smileys/checkmark.png b/basewiki/smileys/checkmark.png
new file mode 100644 (file)
index 0000000..8869caa
Binary files /dev/null and b/basewiki/smileys/checkmark.png differ
diff --git a/basewiki/smileys/devil.png b/basewiki/smileys/devil.png
new file mode 100644 (file)
index 0000000..8684c39
Binary files /dev/null and b/basewiki/smileys/devil.png differ
diff --git a/basewiki/smileys/frown.png b/basewiki/smileys/frown.png
new file mode 100644 (file)
index 0000000..2999b55
Binary files /dev/null and b/basewiki/smileys/frown.png differ
diff --git a/basewiki/smileys/icon-error.png b/basewiki/smileys/icon-error.png
new file mode 100644 (file)
index 0000000..53b1055
Binary files /dev/null and b/basewiki/smileys/icon-error.png differ
diff --git a/basewiki/smileys/icon-info.png b/basewiki/smileys/icon-info.png
new file mode 100644 (file)
index 0000000..c08b08d
Binary files /dev/null and b/basewiki/smileys/icon-info.png differ
diff --git a/basewiki/smileys/idea.png b/basewiki/smileys/idea.png
new file mode 100644 (file)
index 0000000..37bc02d
Binary files /dev/null and b/basewiki/smileys/idea.png differ
diff --git a/basewiki/smileys/ohwell.png b/basewiki/smileys/ohwell.png
new file mode 100644 (file)
index 0000000..a83adfb
Binary files /dev/null and b/basewiki/smileys/ohwell.png differ
diff --git a/basewiki/smileys/redface.png b/basewiki/smileys/redface.png
new file mode 100644 (file)
index 0000000..9a87392
Binary files /dev/null and b/basewiki/smileys/redface.png differ
diff --git a/basewiki/smileys/sad.png b/basewiki/smileys/sad.png
new file mode 100644 (file)
index 0000000..68d9966
Binary files /dev/null and b/basewiki/smileys/sad.png differ
diff --git a/basewiki/smileys/smile.png b/basewiki/smileys/smile.png
new file mode 100644 (file)
index 0000000..b51b3ff
Binary files /dev/null and b/basewiki/smileys/smile.png differ
diff --git a/basewiki/smileys/smile2.png b/basewiki/smileys/smile2.png
new file mode 100644 (file)
index 0000000..43ea05f
Binary files /dev/null and b/basewiki/smileys/smile2.png differ
diff --git a/basewiki/smileys/smile3.png b/basewiki/smileys/smile3.png
new file mode 100644 (file)
index 0000000..c690ccc
Binary files /dev/null and b/basewiki/smileys/smile3.png differ
diff --git a/basewiki/smileys/smile4.png b/basewiki/smileys/smile4.png
new file mode 100644 (file)
index 0000000..f8f5b52
Binary files /dev/null and b/basewiki/smileys/smile4.png differ
diff --git a/basewiki/smileys/star_off.png b/basewiki/smileys/star_off.png
new file mode 100644 (file)
index 0000000..c5535c3
Binary files /dev/null and b/basewiki/smileys/star_off.png differ
diff --git a/basewiki/smileys/star_on.png b/basewiki/smileys/star_on.png
new file mode 100644 (file)
index 0000000..ec5c030
Binary files /dev/null and b/basewiki/smileys/star_on.png differ
diff --git a/basewiki/smileys/thumbs-up.png b/basewiki/smileys/thumbs-up.png
new file mode 100644 (file)
index 0000000..1faabac
Binary files /dev/null and b/basewiki/smileys/thumbs-up.png differ
diff --git a/basewiki/smileys/tired.png b/basewiki/smileys/tired.png
new file mode 100644 (file)
index 0000000..a3d5c56
Binary files /dev/null and b/basewiki/smileys/tired.png differ
diff --git a/basewiki/smileys/tongue.png b/basewiki/smileys/tongue.png
new file mode 100644 (file)
index 0000000..6510540
Binary files /dev/null and b/basewiki/smileys/tongue.png differ
index 02e78816dd0230715716faa4f100b0cab573af1f..3e65b39ae46dbd1b8068c4ef9c830ec49b246ad2 100644 (file)
@@ -39,6 +39,8 @@ ikiwiki (1.1) UNRELEASED; urgency=low
   * Add some basic docs about writing RCS modules.
   * Broke search capability out into a plugin, removed the --hyperestraier
     switch.
+  * Added smiley plugin, nicely controlled and documented by the smileys page.
+  * Copied in some smileys from Moin Moin.
 
  -- Joey Hess <joeyh@debian.org>  Tue,  2 May 2006 14:13:59 -0400
 
index 0992a2a2d6fd2ceedd34ce853e733cb52197251b..4260584e1fe0cb784e2a515eee5ef36abd2e4618 100644 (file)
@@ -1,5 +1,10 @@
 ikiwiki is copyright 2006 by Joey Hess <joey@kitenet.net>. It is licensed
 under the terms of the GPL.
 
+The smiley icons were copied from Moin Moin, which has these copyrights:
+       Copyright (c) 2000 - 2004 by J├╝rgen Hermann <jh@web.de>
+       Copyright (C) 1999, 2000 Martin Pool <mbp@humbug.org.au>
+Moin Moin is licensed under the terms of GPL version 2 or later.
+
 On Debian systems, the complete text of the GPL can be found in
 /usr/share/common-licenses/GPL.
index 8981ecd5a503cc7d46a4d46440f995daae6fe707..57ec8afb99db50cf9046357e5e361fe07eaa42f2 100644 (file)
@@ -1,7 +1,8 @@
 There's documentation if you want to [[write]] your own plugins, or you can install and use plugins contributed by others. 
 
 The ikiwiki package includes some standard plugins that are installed and
-by default. These include [[inline]], [[pagecount]], and [[brokenlinks]], and [[search]]. Of these, [[inline]] is enabled by default.
+by default. These include [[inline]], [[pagecount]], [[brokenlinks]],
+[[smiley]], and [[search]]. Of these, [[inline]] is enabled by default.
 
 To enable other plugins, use the `--plugin` switch described in [[usage]],
 or the equivalent line in [[ikiwiki.setup]].
diff --git a/doc/plugins/smiley.mdwn b/doc/plugins/smiley.mdwn
new file mode 100644 (file)
index 0000000..f9e4800
--- /dev/null
@@ -0,0 +1,6 @@
+This plugin makes it easy to insert smileys and other special symbols into
+pages in the wiki. The symbols are all listed on the [[smileys]] page,
+which serves as both configuration for the plugin and a list of available
+smileys.
+
+This plugin is included in ikiwiki, but is not enabled by default. :-)
index a4e800c5870cabbf1223ea7171dc1992949695db..d881554cab36721199a2e29ba78e8558237d9f7d 100644 (file)
@@ -17,8 +17,14 @@ being edited.
 
 ## Registering plugins
 
-Plugins should, when imported, call IkiWiki::hook to hook into
-ikiwiki's processing. The function uses named parameters, and use varies depending on the type of plugin being registered. Note that a plugin can call the function more than once to register multiple hooks. All calls to IkiWiki::hook should be passed a "type" parameter, which gives the type of hook, a "id" paramter, which should be a unique string for this plugin, and a "call" parameter, which is a reference to a function to call for the hook.
+Plugins should, when imported, call IkiWiki::hook to hook into ikiwiki's
+processing. The function uses named parameters, and use varies depending on
+the type of plugin being registered. Note that a plugin can call the
+function more than once to register multiple hooks. All calls to
+IkiWiki::hook should be passed a "type" parameter, which gives the type of
+hook, a "id" paramter, which should be a unique string for this plugin, and
+a "call" parameter, which is a reference to a function to call for the
+hook.
 
 ## Writing a [[PreProcessorDirective]]
 
@@ -26,7 +32,8 @@ This is probably the most common use of a plugin.
 
         IkiWiki::hook(type => "preprocess", id => "foo", call => \&preprocess);
 
-Replace "foo" with the command name that will be used inside brackers for the preprocessor directive.
+Replace "foo" with the command name that will be used inside brackers for
+the preprocessor directive.
 
 Each time the directive is processed, the referenced function (`preprocess` in the example above) is called, and is passed named parameters. A
 "page" parameter gives the name of the page that embedded the preprocessor directive. All parameters included in the directive are included
@@ -49,37 +56,54 @@ preprocessor time. Text output by a preprocessor directive will be passed throug
 
 ## Other types of hooks
 
-Beyond PreProcessorDirectives, Other types of hooks that can be used by plugins include:
+Beyond PreProcessorDirectives, Other types of hooks that can be used by
+plugins include:
 
 ### checkconfig
 
-        IkiWiki::hook(type => "checkconfig", id => "foo", call => \&checkconfig);
+       IkiWiki::hook(type => "checkconfig", id => "foo", call => \&checkconfig);
 
-This is useful if the plugin needs to check for, or modify ikiwiki's configuration. It's called early in the ikiwiki startup process. The function is passed no values. It's ok for the function to call IkiWiki::error if something isn't configured right.
+This is useful if the plugin needs to check for, or modify ikiwiki's
+configuration. It's called early in the ikiwiki startup process. The
+function is passed no values. It's ok for the function to call
+IkiWiki::error if something isn't configured right.
+
+### filter
+
+       IkiWiki::hook(type => "filter", id => "foo", call => \&filter);
+
+Runs on the raw source of a page, before anything else touches it, and can
+make arbitrary changes. The function is passed named parameters `page` and
+`content` should return the filtered content.
 
 ### delete
 
-        IkiWiki::hook(type => "delete", id => "foo", call => \&dele);
+       IkiWiki::hook(type => "delete", id => "foo", call => \&dele);
 
-Each time a page or pages is removed from the wiki, the referenced function is called, and passed the names of the source files that were removed.
+Each time a page or pages is removed from the wiki, the referenced function
+is called, and passed the names of the source files that were removed.
 
 ### render
 
-        IkiWiki::hook(type => "render", id => "foo", call => \&render);
+       IkiWiki::hook(type => "render", id => "foo", call => \&render);
 
-Each time ikiwiki renders a change or addition (but not deletion) of a page to the wiki, the referenced function is called, and passed the name of the source file that was rendered.
+Each time ikiwiki renders a change or addition (but not deletion) of a page
+to the wiki, the referenced function is called, and passed the name of the
+source file that was rendered.
 
 ### cgi
 
-        IkiWiki::hook(type => "cgi", id => "foo", call => \&cgi);
+       IkiWiki::hook(type => "cgi", id => "foo", call => \&cgi);
 
-Use this to hook into ikiwiki's cgi script. Each registered cgi hook is called
-in turn, and passed a CGI object. The hook should examine the parameters, and if it will handle this CGI request, output a page and terminate the program.
+Use this to hook into ikiwiki's cgi script. Each registered cgi hook is
+called in turn, and passed a CGI object. The hook should examine the
+parameters, and if it will handle this CGI request, output a page and
+terminate the program.
 
 ## Wiki configuration
 
-A plugin can access the wiki's configuration via the `%IkiWiki::config` hash.
-The best way to understand the contents of the hash is to look at
+A plugin can access the wiki's configuration via the `%IkiWiki::config`
+hash. The best way to understand the contents of the hash is to look at
 [[ikiwiki.setup]], which sets the hash content to configure the wiki.
 
 ## Wiki data
@@ -104,7 +128,10 @@ use the following hashes, using a page name as the key:
 
 ## Page templates
 
-Plugins are mostly limited to changing the content of pages, to change the look and feel of the wiki it's generally better to use a stylesheet and [[templates]]. However, there are some hooks in the templates that plugins can use to add stuff to the wiki's UI:
+Plugins are mostly limited to changing the content of pages, to change the
+look and feel of the wiki it's generally better to use a stylesheet and
+[[templates]]. However, there are some hooks in the templates that plugins
+can use to add stuff to the wiki's UI:
 
 ### Adding content to the page header
 
index a8389a0c230479d6888789df492b2a69702a0e78..38bdcf37b3a2b60d0d2ccca3f3134efc84b10d5f 100644 (file)
@@ -5,7 +5,15 @@ Suggestions of ideas for plugins:
 * [[todo/sigs]] ?
 * [[pageindexes]]
 * Wiki stats, such as total number of links, most linked to pages
-* Support [[RecentChanges]] as a regular page containing a plugin that updates each time there is a change, and statically builds the recent changes list. (Would this be too expensive/inflexible? There might be other ways to do it as a plugin, like making all links to RecentChanges link to the cgi and have the cgi render it on demand.)
+
+* Support [[RecentChanges]] as a regular page containing a plugin that
+  updates each time there is a change, and statically builds the recent
+  changes list. (Would this be too expensive/inflexible? There might be
+  other ways to do it as a plugin, like making all links to RecentChanges
+  link to the cgi and have the cgi render it on demand.) Or using an iframe
+  to inline the cgi, although firefox seems to render that nastily with
+  nested scroll bars.
+
 * Support for smileys or other symbols. I appreciate the support for check
   marks, etc in other wikis. Needs some free smiley files.
 * For PlaceWiki I want to be able to do some custom plugins, including one
@@ -15,4 +23,4 @@ Suggestions of ideas for plugins:
   content. It also needs to update pages when related pages are added,
   so it needs to register dependencies pre-emptively between pages,
   or something. It's possible that this is a special case of backlinks and
-  is best implemented by making backlinks a plugin somehow. --[[Joey]]
\ No newline at end of file
+  is best implemented by making backlinks a plugin somehow. --[[Joey]]