Plugin Manager Readme

Prerequesites

TaskFreak! v0.6.2 installed.

Installation (users)

1. a) Upload the zipped plugin from your harddrive using any browser (or)
   b) Copy the unzipped plugin folder into /plugins/install using ftp
2. Log into TaskFreak, select from the menu manage > plugins
3. If the plugin has been detected successfully, click on the install icon
4. All further instructions will appear on the screen (confirm installation)

Configuration (authors)

config.php:

• Title: Title of plugin
• Description: Plugin description
• Version: Release version
• Author: Your name
• Size: Approx size of the plugin


• Date: Release date (optional)
• Readme: Detailed information (optional)
• Changelog: ChangeLog (optional)
• Icon: Icon (optional)


• SQL: Table creating query (optional)

the modify directory:

• Files under the modify folder must be in the same relative subfolder as the original ones in TaskFreak
• These files contain the hardcore changes to the existing files using ---[find]--- and ---[replace]---
• Please make sure you are using unix linebreaks, check with your file editor. Wrong linebreaks will work only with single lines
• For a working example check other available plugins from Dracon Forum
• Please make as little modifications directly to the system as you can, create new files instead, this will ensure better compatibility with other plugins

the rest:

• All other files and folders will be copied into /plugins/data/installed/your_plugin_title directory

Distribution

• Entirely up to you
• But for the upload facility via browser Plugin Manager requires simple .zip format of the plugin's root folder inclusive with all the contents inside

Plugin installation

• All new files will be copied into their respective folder
• If a new table is required and the SQL file is provided, Plugin Manager will create the table using prefix set in TaskFreak's config file
• All new files in the modify directory will attempt to rewrite the original files, backups will be made in the backup folder
• The installation files will be removed

Plugin uninstallation

• All new files will be deleted
• Created SQL table(s) can be dropped (optional)
• Modifications to original files will be reverted or replaced by the backup files (replace not implemented yet)

Permissions

If you are copying plugins via ftp you will need to chmod 777 the plugins folder, you can change it back after installing the plugins
If you are uploading plugins via browser, you still need writing permissions for your http server, what can be achieved either by chmod 700 and chown to www-data(or_whatever_your_web_user_is_called) or chmod 775 and chgroup.

Work out what's the best for you and if you have any suggestions, please use the forum to share your knowledge with others