aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins
diff options
context:
space:
mode:
authorjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-10-15 19:33:52 +0000
committerjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-10-15 19:33:52 +0000
commitb973ed82699903c23b3feeb5e73e1ebd6f587f43 (patch)
treeaf25dcd50842673244ced0b7d97ad01dcf10f13f /doc/plugins
parent8544d52fe9e5d344bb0b5e70985aabc0e35b4920 (diff)
downloadikiwiki-b973ed82699903c23b3feeb5e73e1ebd6f587f43.tar
ikiwiki-b973ed82699903c23b3feeb5e73e1ebd6f587f43.tar.gz
* Add no_override parameter to hook().
* Add a shortcut plugin, inspired by Victor Moral's contributed shortcuts plugin, but featuring a more ikiwiki-ish syntax and with shortcuts that can be configured using a page in wiki.
Diffstat (limited to 'doc/plugins')
-rw-r--r--doc/plugins/contrib/googlemaps.mdwn1
-rw-r--r--doc/plugins/contrib/img.mdwn1
-rw-r--r--doc/plugins/contrib/linguas.mdwn1
-rw-r--r--doc/plugins/contrib/shortcuts.mdwn5
-rw-r--r--doc/plugins/contrib/shortcuts/discussion.mdwn3
-rw-r--r--doc/plugins/shortcut.mdwn12
-rw-r--r--doc/plugins/write.mdwn5
7 files changed, 28 insertions, 0 deletions
diff --git a/doc/plugins/contrib/googlemaps.mdwn b/doc/plugins/contrib/googlemaps.mdwn
index 2ea4e4fa4..56d2d6031 100644
--- a/doc/plugins/contrib/googlemaps.mdwn
+++ b/doc/plugins/contrib/googlemaps.mdwn
@@ -1,5 +1,6 @@
[[template id=plugin name=googlemaps author="Christian Mock"]]
[[tag special-purpose]]
+[[meta title"googlemaps (third-party plugin)"]]
`googlemaps` is a plugin that allows using the [Google Maps API][2]
from ikiwiki.
diff --git a/doc/plugins/contrib/img.mdwn b/doc/plugins/contrib/img.mdwn
index f2133a38b..72b8579e0 100644
--- a/doc/plugins/contrib/img.mdwn
+++ b/doc/plugins/contrib/img.mdwn
@@ -1,5 +1,6 @@
[[template id=plugin name=img author="Christian Mock"]]
[[tag chrome]]
+[[meta title"img (third-party plugin)"]]
`img` is an enhanced image handling plugin.
diff --git a/doc/plugins/contrib/linguas.mdwn b/doc/plugins/contrib/linguas.mdwn
index cf7a458c7..c90e11a54 100644
--- a/doc/plugins/contrib/linguas.mdwn
+++ b/doc/plugins/contrib/linguas.mdwn
@@ -1,4 +1,5 @@
[[template id=plugin name=linguas author="Jordà Polo"]]
+[[meta title"linguas (third-party plugin)"]]
Linguas
=======
diff --git a/doc/plugins/contrib/shortcuts.mdwn b/doc/plugins/contrib/shortcuts.mdwn
index eb13bb106..81c2cf8dc 100644
--- a/doc/plugins/contrib/shortcuts.mdwn
+++ b/doc/plugins/contrib/shortcuts.mdwn
@@ -1,5 +1,10 @@
[[template id=plugin name=shortcuts included=0 author="[[VictorMoral]]"]]
[[tag type/format]]
+[[meta title"shortcuts (third-party plugin)"]]
+
+Note: This plugin is different than the "shortcut" plugin now included in
+ikiwiki. I'm leaving it here in case people prefer how this one works.
+--[[Joey]]
*shortcuts* is a plugin for make external links easy in a ikiwiki page.
It filter the raw source code, searching *wafl expresions* and replacing it
diff --git a/doc/plugins/contrib/shortcuts/discussion.mdwn b/doc/plugins/contrib/shortcuts/discussion.mdwn
index 367d1b9a3..70f962f1d 100644
--- a/doc/plugins/contrib/shortcuts/discussion.mdwn
+++ b/doc/plugins/contrib/shortcuts/discussion.mdwn
@@ -22,3 +22,6 @@ standard across wikis, this approach seems cleaner and easier to learn for
ikiwiki users.
--[[Joey]]
+
+Update: I've added a "shortcut" plugin that works as described above.
+--[[Joey]]
diff --git a/doc/plugins/shortcut.mdwn b/doc/plugins/shortcut.mdwn
new file mode 100644
index 000000000..33180b120
--- /dev/null
+++ b/doc/plugins/shortcut.mdwn
@@ -0,0 +1,12 @@
+[[template id=plugin name=shortcut included=1 author="[[Joey]]"]]
+[[tag type/format]]
+
+This plugin allows external links to commonly linked to sites to be made
+more easily using shortcuts. Some examples of using shortcuts include:
+
+ \[[google foo]]
+ \[[wikipedia War of 1812]]
+ \[[debbug 12345]]
+
+The available shortcuts are defined on the [[shortcuts]] page in
+the wiki.
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index 18aa34dca..1beafa395 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -210,6 +210,11 @@ ikiwiki program.
Hook into ikiwiki's processing. See the discussion of hooks above.
+Note that in addition to the named parameters described above, a parameter
+named no_override is supported, If it's set to a true value, then this hook
+will not override any existing hook with the same id. This is useful if
+the id can be controled by the user.
+
#### `debug($)`
Logs a debugging message. These are supressed unless verbose mode is turned