README.md 1.05 KB
Newer Older
Benjamin Rokseth's avatar
Benjamin Rokseth committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
## README.pm

# About

This plugin is for special handling of rotating collections.
It currently lets you:
- permanently set homebranch of all items in a rotating collection

# Setup

To enable Koha plugins:

* enable syspref UseKohaPlugins
* in koha-conf.xml (section <config>):

```
 <pluginsdir>__PLUGINS_DIR__</pluginsdir>
 <enable_plugins>1</enable_plugins>
```

Note: if <plugindir> is not set, it will default to /var/lib/koha/$intance/plugins

# Install

A new plugin must be zip-packed `pluginname.kpz` and contain the correct tree

```
./Koha/
  Plugin/
    Deichman/            # Optional subfolder to organize plugins
      NameOfPlugin.pm    # The plugin, containing required methods new, install, uninstall, configure, etc.
      NameOfPlugin/      # Subfolder with optional files, accessible to module as current folder, and in templates as [% PLUGIN_PATH %]
        configure.tt
        report-step1.tt
        tool-step1.tt
        etc.
```

Plugin can then be uploaded in /cgi-bin/koha/plugins/plugins-home.pl

Optional configuration can be done from there