diff options
| author | Frederic Guillot <fred@kanboard.net> | 2016-01-05 21:29:34 -0500 |
|---|---|---|
| committer | Frederic Guillot <fred@kanboard.net> | 2016-01-05 21:29:34 -0500 |
| commit | a03e4d4dcb4ebce06671465c9a7bd7e51ba2ef79 (patch) | |
| tree | 04e32efab1c8f81a8ac374a79a3be8d333504fee /doc | |
| parent | 22568325c957f941ccb12751960fe99176ab0643 (diff) | |
Update documentation
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ldap-group-sync.markdown | 3 | ||||
| -rw-r--r-- | doc/plugin-authentication.markdown | 1 | ||||
| -rw-r--r-- | doc/plugin-registration.markdown | 6 | ||||
| -rw-r--r-- | doc/plugins.markdown | 1 |
4 files changed, 8 insertions, 3 deletions
diff --git a/doc/ldap-group-sync.markdown b/doc/ldap-group-sync.markdown index 9dea5acc..69678a8a 100644 --- a/doc/ldap-group-sync.markdown +++ b/doc/ldap-group-sync.markdown @@ -52,6 +52,7 @@ define('LDAP_GROUP_FILTER', '(&(objectClass=group)(sAMAccountName=%s*))'); With the filter given as example above, Kanboard will search for groups that match the query. If the end-user enter the text "My group" in the auto-complete box, Kanboard will return all groups that match the pattern: `(&(objectClass=group)(sAMAccountName=My group*))`. -Note that the special characters `*` is important here, otherwise an exact match will be done. +- Note 1: The special characters `*` is important here, otherwise an exact match will be done. +- Note 2: This feature is only compatible with LDAP authentication configured in "proxy" or "anonymous" mode [More examples of LDAP filters for Active Directory](http://social.technet.microsoft.com/wiki/contents/articles/5392.active-directory-ldap-syntax-filters.aspx) diff --git a/doc/plugin-authentication.markdown b/doc/plugin-authentication.markdown index 5fee4faf..06fdfd8d 100644 --- a/doc/plugin-authentication.markdown +++ b/doc/plugin-authentication.markdown @@ -37,3 +37,4 @@ Example of authentication plugins - [Authentication providers included in Kanboard](https://github.com/fguillot/kanboard/tree/master/app/Auth) - [Reverse-Proxy Authentication with LDAP support](https://github.com/kanboard/plugin-reverse-proxy-ldap) +- [SMS Two-Factor Authentication](https://github.com/kanboard/plugin-sms-2fa) diff --git a/doc/plugin-registration.markdown b/doc/plugin-registration.markdown index d15f98e1..f212fc2e 100644 --- a/doc/plugin-registration.markdown +++ b/doc/plugin-registration.markdown @@ -82,7 +82,7 @@ $this->user->getById(123); Plugin Translations ------------------- -Plugin can be translated in the same way the rest of the application. You must load the translations yourself when the session is created: +Plugin can be translated in the same way as the rest of the application. You must load the translations yourself when the session is created: ```php $this->on('app.bootstrap', function($container) { @@ -90,7 +90,9 @@ $this->on('app.bootstrap', function($container) { }); ``` -The translations must be stored in `plugins/Myplugin/Locale/xx_XX/translations.php`. +The translations must be stored in the file `plugins/Myplugin/Locale/xx_XX/translations.php` (replace xx_XX by the language code fr_FR, en_US...). + +Translations are stored in a dictionary, if you would like to override an existing string, you just need to use the same key in your translation file. Dependency Injection Container ------------------------------ diff --git a/doc/plugins.markdown b/doc/plugins.markdown index 791fe3bd..f3f922f3 100644 --- a/doc/plugins.markdown +++ b/doc/plugins.markdown @@ -26,6 +26,7 @@ Plugin creators should specify explicitly the compatible versions of Kanboard. I Examples of plugins ------------------- +- [SMS Two-Factor Authentication](https://github.com/kanboard/plugin-sms-2fa) - [Reverse-Proxy Authentication with LDAP support](https://github.com/kanboard/plugin-reverse-proxy-ldap) - [Slack](https://github.com/kanboard/plugin-slack) - [Hipchat](https://github.com/kanboard/plugin-hipchat) |