PPF Home
Plugins
Developers
   Font size:      

TODO (v1.0)

PDF
PDF

Description

This plugin manages TODO items, e.g. tasks you would like to remember later on.

The TODO plugin can be used to save short worklists, delete these worklists, or show which worklists you currently have unresolved.

Configuration

The configuration takes place in TODOConfig.xml. Message customization and language translation takes place in todo_<language>.properties.

Commands

Add a TODO item

Command: !todo
Description: Will add a new TODO item.
Auth Level: admin (customizable)
Where to give command: channel
Outputs to: channel
Example(s):

  • !todo shop Remember to go to the shop before saturday

Remove a TODO item

Command: !donetodo
Description: Will remove an existing TODO item.
Auth Level: admin (customizable)
Where to give command: channel
Outputs to: channel
Example(s):

  • !donetodo shop

Display a list of all TODO items

Command: !showtodos
Description: Will show you all existing TODO items.
Auth Level: admin (customizable)
Where to give command: channel
Outputs to: DCC Chat
Example(s):

  • !showtodos

Messages and translations

Messages

You may customize the messages that are displayed when adding or removing a TODO item. This customization (for english) takes place in todo_en.properties.


	exists = TODO already exists.  You must remove it first:
	added = Added TODO
	removed = Removed TODO	  

    

Out of the box there are also message property files for German and Finnish languages. For customizations in these languages, please refer to todo_de.properties and todo_fi.properties

The language file it will actually use during runtime is based on two factors:

  • Bot configuration
  • User preferences

During configuration of the PPF bot you choose it's language which will be the default language for the bot unless the IRC user chooses to change it for him/her only.

Translations

In addition to the native support for English, German and Finnish languages you may add your own language if you want to. For instance, if you want to add support for Norwegian, simply create a file called todo_no.properties with the following content:


	exists = Denne TODO finnes allerede.  Du kan slette den gamle med:
	added = La til TODO
	removed = Slettet TODO	  

    

For codes representing languages, please see http://ftp.ics.uci.edu/pub/ietf/http/related/iso639.txt

Change History

v1.0 First Version by DeadEd