urosm
/
ikiwiki
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
ikiwiki/doc/plugins/install.mdwn

22 lines
1.1 KiB
Plaintext
Raw Normal View History

Migrate doc/plugins via prefix_directives This is a partial commit of: egrep -rl '\[\[[a-z]+ ' doc | xargs --max-args 1 ./ikiwiki-transition prefix_directives
2008-07-21 13:31:57 +02:00
[[!meta title="Installing third party plugins"]]
improved docs, add a tutorial for writing plugins
2007-08-13 19:22:15 +02:00
Most ikiwiki plugins are perl modules and should be installed somewhere in
the perl module search path. See the @INC list at the end of the output of
`perl -V` for a list of the directories in that path. All plugins are in
the IkiWiki::Plugin namespace, so they go in a IkiWiki/Plugin subdirectory
inside the perl search path. For example, if your perl looks in
`/usr/local/lib/site_perl` for modules, you can locally install ikiwiki
plugins to `/usr/local/lib/site_perl/IkiWiki/Plugin`
Simplify libdirs: libdirs must be plural, libdir must be a single string This makes the documentation read more sensibly, and matches how we handle underlaydirs and underlaydir.
2014-12-09 21:02:03 +01:00
You can use the `libdirs` and/or `libdir` configuration options to add
directories to the
improved docs, add a tutorial for writing plugins
2007-08-13 19:22:15 +02:00
search path. For example, if you set `libdir` to `/home/you/.ikiwiki/`,
Simplify libdirs: libdirs must be plural, libdir must be a single string This makes the documentation read more sensibly, and matches how we handle underlaydirs and underlaydir.
2014-12-09 21:02:03 +01:00
then ikiwiki will look for plugins in `/home/you/.ikiwiki/IkiWiki/Plugin`.
improved docs, add a tutorial for writing plugins
2007-08-13 19:22:15 +02:00
Ikiwiki also supports plugins that are external programs. These are
typically written in some other language than perl. Ikiwiki searches for
Simplify libdirs: libdirs must be plural, libdir must be a single string This makes the documentation read more sensibly, and matches how we handle underlaydirs and underlaydir.
2014-12-09 21:02:03 +01:00
these in `/usr/lib/ikiwiki/plugins` by default. If `libdirs` or `libdir` are
set, it will also look under those directories, for example in
`/home/you/.ikiwiki/plugins`.
improved docs, add a tutorial for writing plugins
2007-08-13 19:22:15 +02:00
Note that this type of plugin has to be executable for ikiwiki to use it.