AS1024/Kanboard-Prod
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
Frederic Guillot
2016-06-01 20:21:26 -04:00
parent b0a31b168f
commit ca87b1b60f
5 changed files with 19 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
doc/plugin-hooks.markdown
View File

@@ -160,6 +160,7 @@ List of template hooks:
| `template:config:integrations` | Integration page in global settings | | `template:config:integrations` | Integration page in global settings |
| `template:dashboard:sidebar` | Sidebar on dashboard page | | `template:dashboard:sidebar` | Sidebar on dashboard page |
| `template:export:sidebar` | Sidebar on export pages | | `template:export:sidebar` | Sidebar on export pages |
| `template:import:sidebar` | Sidebar on import pages |
| `template:layout:head` | Page layout `<head/>` tag | | `template:layout:head` | Page layout `<head/>` tag |
| `template:layout:top` | Page layout top header | | `template:layout:top` | Page layout top header |
| `template:layout:bottom` | Page layout footer | | `template:layout:bottom` | Page layout footer |

18
doc/plugin-metadata.markdown
View File

@@ -13,28 +13,28 @@ Attach metadata to tasks and remove them
```php ```php
// Return a dictionary of metadata (keys/values) for the $task_id // Return a dictionary of metadata (keys/values) for the $task_id
$this->taskMetadata->getAll($task_id); $this->taskMetadataModel->getAll($task_id);
// Get a value only for a task // Get a value only for a task
$this->taskMetadata->get($task_id, 'my_plugin_variable', 'default_value'); $this->taskMetadataModel->get($task_id, 'my_plugin_variable', 'default_value');
// Return true if the metadata my_plugin_variable exists // Return true if the metadata my_plugin_variable exists
$this->taskMetadata->exists($task_id, 'my_plugin_variable'); $this->taskMetadataModel->exists($task_id, 'my_plugin_variable');
// Create or update metadata for the task // Create or update metadata for the task
$this->taskMetadata->save($task_id, ['my_plugin_variable' => 'something']); $this->taskMetadataModel->save($task_id, ['my_plugin_variable' => 'something']);
// Remove a metadata from a project // Remove a metadata from a project
$this->projectMetadata->remove($project_id, my_plugin_variable); $this->projectMetadataModel->remove($project_id, my_plugin_variable);
``` ```
Metadata types Metadata types
-------------- --------------
- TaskMetadata: `$this->taskMetadata` - TaskMetadata: `$this->taskMetadataModel`
- ProjectMetadata: `$this->projectMetadata` - ProjectMetadata: `$this->projectMetadataModel`
- UserMetadata: `$this->userMetadata` - UserMetadata: `$this->userMetadataModel`
- Settings/Config: `$this->config` - Settings/Config: `$this->configModel`
Notes Notes
----- -----

4
doc/plugin-notifications.markdown
View File

@@ -13,8 +13,8 @@ Register a new notification type
In your plugin registration file call the method `setType()`: In your plugin registration file call the method `setType()`:
```php ```php
$this->userNotificationType->setType('irc', t('IRC'), '\Kanboard\Plugin\IRC\Notification\IrcHandler'); $this->userNotificationTypeModel->setType('irc', t('IRC'), '\Kanboard\Plugin\IRC\Notification\IrcHandler');
$this->projectNotificationType->setType('irc', t('IRC'), '\Kanboard\Plugin\IRC\Notification\IrcHandler'); $this->projectNotificationTypeModel->setType('irc', t('IRC'), '\Kanboard\Plugin\IRC\Notification\IrcHandler');
``` ```
Your handler can be registered for user or project notification. You don't necessarily need to support both. Your handler can be registered for user or project notification. You don't necessarily need to support both.

2
doc/plugin-registration.markdown
View File

@@ -88,7 +88,7 @@ Plugin can be translated in the same way as the rest of the application. You mus
```php ```php
public function onStartup() public function onStartup()
{ {
Translator::load($this->language->getCurrentLanguage(), __DIR__.'/Locale'); Translator::load($this->languageModel->getCurrentLanguage(), __DIR__.'/Locale');
} }
``` ```

6
doc/requirements.markdown
View File

@@ -74,6 +74,12 @@ Kanboard is pre-configured to work with Apache (URL rewriting).
| ldap | Only for LDAP authentication | | ldap | Only for LDAP authentication |
| Zend OPcache | Recommended | | Zend OPcache | Recommended |
### Optional PHP extensions
| PHP Extensions required | Note |
|----------------------------|--------------------------------------------|
| zip | Used to install plugins from Kanboard |
### Recommendations ### Recommendations
- Modern Linux or Unix operating system. - Modern Linux or Unix operating system.