diff options
author | joey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071> | 2006-11-22 02:28:42 +0000 |
---|---|---|
committer | joey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071> | 2006-11-22 02:28:42 +0000 |
commit | a405b46c3b6020e1fa3631bfe5fd982f315c977f (patch) | |
tree | e3c073a2ac07f9fb6686d105f542bae1815a145d /doc/plugins | |
parent | 538a7a487b2872a82721322dd1333c2e0381b8c7 (diff) | |
download | ikiwiki-a405b46c3b6020e1fa3631bfe5fd982f315c977f.tar ikiwiki-a405b46c3b6020e1fa3631bfe5fd982f315c977f.tar.gz |
* Add toggle plugin.
* Introduce the nicebundle. This is a kind of plugin, that just enables
many other plugins. It's an easy way to boost ikiwiki from its default,
basic wiki, to a full-featured wiki, without manually picking the right
set of plugins. New plugins will be added to the nicebundle from time to
time.
Diffstat (limited to 'doc/plugins')
-rw-r--r-- | doc/plugins/nicebundle.mdwn | 27 | ||||
-rw-r--r-- | doc/plugins/passwordauth.mdwn | 1 | ||||
-rw-r--r-- | doc/plugins/toggle.mdwn | 32 | ||||
-rw-r--r-- | doc/plugins/type/bundle.mdwn | 1 |
4 files changed, 61 insertions, 0 deletions
diff --git a/doc/plugins/nicebundle.mdwn b/doc/plugins/nicebundle.mdwn new file mode 100644 index 000000000..eeca30b3e --- /dev/null +++ b/doc/plugins/nicebundle.mdwn @@ -0,0 +1,27 @@ +[[template id=plugin name=nicebundle included=1 author="[[Joey]]"]] +[[tag type/bundle]] + +This plugin enables a bunch of other plugins -- basically all the ones that +are not too intrusive, work well with little configuration, and are nice to +have on any capable wiki. The plugins in this bundle are not enabled by +default in ikiwiki, so that by default ikiwiki is limited to a few [[core]] +wiki features. If you want a more capable wiki, enable this plugin bundle. + +Currently included: + +* [[brokenlinks]] +* [[img]] +* [[map]] +* [[meta]] +* [[orphans]] +* [[pagecount]] +* [[pagestats]] +* [[shortcut]] +* [[smiley]] +* [[tag]] +* [[template]] +* [[toc]] +* [[toggle]] +* [[otl]] + +New plugins will be added to this bundle from time to time. diff --git a/doc/plugins/passwordauth.mdwn b/doc/plugins/passwordauth.mdwn index aded8829f..dacdffac6 100644 --- a/doc/plugins/passwordauth.mdwn +++ b/doc/plugins/passwordauth.mdwn @@ -1,5 +1,6 @@ [[template id=plugin name=passwordauth core=1 included=1 author="[[Joey]]"]] [[tag type/auth]] +[[tag type/core]] This plugin lets ikiwiki prompt for a user name and password when logging into the wiki. It also handles registering users, mailing passwords, and diff --git a/doc/plugins/toggle.mdwn b/doc/plugins/toggle.mdwn new file mode 100644 index 000000000..b59004e6e --- /dev/null +++ b/doc/plugins/toggle.mdwn @@ -0,0 +1,32 @@ +[[template id=plugin name=toggle included=1 author="[[Joey]]"]] +[[tag type/chrome]] + +With this plugin you can create links on pages that, when clicked, toggle +display of other parts of the page. + +It uses javascript to accomplish this; browsers without javascript will +always see the full page content. + +Example use: + + \[[toggle id="ipsum" text="show"]] + + \[[toggleable id="ipsum" text=""" + Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do + eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim + ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut + aliquip ex ea commodo consequat. + + [[toggle id="ipsum" text="hide"]] + """]] + +Clicking on "more" will toggle the display of the togglable text. + +Note that you can include wiki markup in the toggleable text, +including even additional toggles, as shown in the above example. + +Also, the toggle and the togglable definitions do not need to be next to +each other, but can be located anywhere on the page. There can also be +mutiple toggles that all toggle a single togglable. + +The id has a default value of "default", so can be omitted in simple cases. diff --git a/doc/plugins/type/bundle.mdwn b/doc/plugins/type/bundle.mdwn new file mode 100644 index 000000000..0bf049ece --- /dev/null +++ b/doc/plugins/type/bundle.mdwn @@ -0,0 +1 @@ +These plugins enable whole bundles of other plugins. |