# 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

`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.zip)
* [https://vcs.nz/ominz/OMITemplateModder/archive/main.tar.gz](https://vcs.nz/ominz/OMITemplateModder/archive/main.tar.gz)

and uncompress/unzip/untar into your Kanboard `plugins` directory  

## How to use

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

Follow this link and you should see a list of available templates that you can modify.  
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).  
Easy to fix, just make sure the files in your Kanboard `app/Template/notification` directory match the ones in the plugin `Template/notification` directory.  

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>