OMITemplateModder

OMI Notification Template Modder for Kanboard

'Notification Template Modder' plugin for Kanboard, to allow modification of all 'notification' templates which includes email templates.

Author

• Dwayne Pivac @ OMI NZ
• License MIT

Requirements

• Kanboard 1.2
• PHP 8.2.0
  

It is possible this works with other versions of Kanboard and PHP, but these are the version this was built and tested on.

How to install this plugin

All Kanboard plugins are found in the plugins directory. In general you just put your plugin there and that's about it!

CLI

In a terminal window ( or command for Windoze ) browse/cd to your Kanboard plugins directory and issue this command

git clone ( best method )

git clone https://vcs.nz/ominz/OMITemplateModder.git

wget

zip ( Windoze )

wget https://vcs.nz/ominz/OMITemplateModder/archive/main.zip

unzip main.zip

del main.zip

tar ( Nix )

wget https://vcs.nz/ominz/OMITemplateModder/archive/main.tar.gz

tar -xzf main.tar.gz

rm main.tar.gz

GUI

Download either zip file :

• https://vcs.nz/ominz/OMITemplateModder/archive/main.zip
• https://vcs.nz/ominz/OMITemplateModder/archive/main.tar.gz

and uncompress/unzip/untar into your Kanboard plugins directory

Updating

The only trick to updating is to make sure you don't overwrite your modified templates, under Templates/notification
Best way is to copy or move the directory away, and then move or copy it back again after updating.

If you installed the plugin via git clone then you can just do git pull which will only get the updated code, and your templates will not be touched.

How to use

You will see a new link appear under /settings : "Notification Templates"

To begin with there should be no templates to modify. Instead you should see a list of templates that you can add, from your core app. Each with a "Create from Core" link. Click this link to add the template to the plugin so it can be modified.

You can always copy files manually from the core app directory app/Template/notification into the plugins corresponding directory Template/notification.

This plugin will alert you to any templates missing or any extras. This may occur if the Kanboard version was different to the one this plugin was built on (1.2).

This plugin will also show a red asterisk on the template files that are different ( have been modified ) to the ones in the app.

Maintainers

• Dwayne <dwayne at omi dot nz>
• OMI Ltd. <adm at omi dot nz>