summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJoey Hess <joey@gnu.kitenet.net>2008-12-23 16:34:19 -0500
committerJoey Hess <joey@gnu.kitenet.net>2008-12-23 16:34:19 -0500
commit678d467a4080dd549f2b6f276f963eac384e1b4f (patch)
tree927da00c8155f979f9f98f9bdb52cc668d84ca52 /doc
parent7e7739bdd90ed528cfdb659feb342abfb2893178 (diff)
finalise version 3.00 of the plugin api
Diffstat (limited to 'doc')
-rw-r--r--doc/plugins/write.mdwn4
-rw-r--r--doc/plugins/write/tutorial.mdwn2
-rw-r--r--doc/roadmap.mdwn12
-rw-r--r--doc/todo/firm_up_plugin_interface.mdwn2
4 files changed, 12 insertions, 8 deletions
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index b6fa96f91..cb7571289 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -19,7 +19,7 @@ that can be fleshed out to make a useful plugin.
`IkiWiki::Plugin::pagecount` is another simple example. All perl plugins
should `use IkiWiki` to import the ikiwiki plugin interface. It's a good
idea to include the version number of the plugin interface that your plugin
-expects: `use IkiWiki 2.00`.
+expects: `use IkiWiki 3.00`.
An external plugin is an executable program. It can be written in any
language. Its interface to ikiwiki is via XML RPC, which it reads from
@@ -431,7 +431,7 @@ describes the plugin as a whole. For example:
To import the ikiwiki plugin interface:
- use IkiWiki '2.00';
+ use IkiWiki '3.00';
This will import several variables and functions into your plugin's
namespace. These variables and functions are the ones most plugins need,
diff --git a/doc/plugins/write/tutorial.mdwn b/doc/plugins/write/tutorial.mdwn
index e1b34b800..5345f71f2 100644
--- a/doc/plugins/write/tutorial.mdwn
+++ b/doc/plugins/write/tutorial.mdwn
@@ -27,7 +27,7 @@ important one is the IkiWiki module.
use warnings;
use strict;
- use IkiWiki 2.00;
+ use IkiWiki 3.00;
Ok, boilerplate is out of the way. Now to add the one function that ikiwiki
expects to find in any module: `import`. The import function is called when
diff --git a/doc/roadmap.mdwn b/doc/roadmap.mdwn
index c85c6de5b..b2ff626ed 100644
--- a/doc/roadmap.mdwn
+++ b/doc/roadmap.mdwn
@@ -36,12 +36,14 @@ really bad bugs will be applied going forward.
# 3.0
-Version 3.0 is an opportunity to make significant transitions, and also adds
-many new features.
+Version 3.0 is an opportunity to make significant transitions.
+Read [[tips/upgrade_to_3.0]] for the steps you will need to
+follow when upgrading your wiki to this version.
-* See [[tips/upgrade_to_3.0]] for the steps you will need to follow
- when upgrading to this version.
-* Finalise a new version of the plugin API, exporting additional commonly
+The highlights of the changes in version 3.0 include:
+
+
+* A new version of the plugin API, exporting additional commonly
used functions from IkiWiki.pm. See [[todo/firm_up_plugin_interface]]
It will include a vast number of new features, bugfixes, and other
diff --git a/doc/todo/firm_up_plugin_interface.mdwn b/doc/todo/firm_up_plugin_interface.mdwn
index c2e190884..c7553f7dd 100644
--- a/doc/todo/firm_up_plugin_interface.mdwn
+++ b/doc/todo/firm_up_plugin_interface.mdwn
@@ -92,3 +92,5 @@ Probably needs to evolve more and be more widely used before being exported.
* %IkiWiki::pagecase (aggregate)
* %IkiWiki::backlinks (pagestats)
+
+[[done]] (until 4.0)..