* Copied in some smileys from Moin Moin.
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",
return "skeleton plugin result";
} # }}}
+sub filter ($) { #{{{
+ my $content=shift;
+
+ IkiWiki::debug("skeleton plugin running as filter");
+
+ return $content;
+} # }}}
+
sub delete (@) { #{{{
my @files=@_;
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);
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]].
--- /dev/null
+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.
* 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
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.
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]].
--- /dev/null
+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. :-)
## 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]]
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
## 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
## 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
* [[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
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]]
sipb-www / ikiwiki.git / commitdiff
