diff options
author | Frederic Guillot <fred@kanboard.net> | 2016-11-29 20:22:41 -0500 |
---|---|---|
committer | Frederic Guillot <fred@kanboard.net> | 2016-11-29 20:26:18 -0500 |
commit | 978a3c70fee3baecb5d25da551db7e2fc23c55f7 (patch) | |
tree | c5105efbd6b14812093599212b8d50165a007dc4 /doc | |
parent | fdc4e04e870b82fe93eb0f03b4f54faf8252ba6c (diff) |
Simplify .htaccess and rename command line script
Diffstat (limited to 'doc')
-rw-r--r-- | doc/cli.markdown | 36 | ||||
-rw-r--r-- | doc/cronjob.markdown | 2 | ||||
-rwxr-xr-x | doc/es_ES/cli.markdown | 56 | ||||
-rwxr-xr-x | doc/es_ES/cronjob.markdown | 6 | ||||
-rw-r--r-- | doc/es_ES/installation.markdown | 1 | ||||
-rw-r--r-- | doc/es_ES/translations.markdown | 4 | ||||
-rw-r--r-- | doc/fr_FR/installation.markdown | 1 | ||||
-rw-r--r-- | doc/installation.markdown | 1 | ||||
-rw-r--r-- | doc/ru_RU/cli.markdown | 162 | ||||
-rw-r--r-- | doc/ru_RU/cronjob.markdown | 15 | ||||
-rw-r--r-- | doc/ru_RU/installation.markdown | 1 | ||||
-rw-r--r-- | doc/ru_RU/translations.markdown | 87 | ||||
-rw-r--r-- | doc/translations.markdown | 4 | ||||
-rw-r--r-- | doc/worker.markdown | 4 |
14 files changed, 81 insertions, 299 deletions
diff --git a/doc/cli.markdown b/doc/cli.markdown index 37cc7ee8..49c19df0 100644 --- a/doc/cli.markdown +++ b/doc/cli.markdown @@ -10,7 +10,7 @@ Usage ----- - Open a terminal and go to your Kanboard directory (example: `cd /var/www/kanboard`) -- Run the command `./kanboard` +- Run the command `./cli` or `php cli` ```bash Kanboard version master @@ -63,13 +63,13 @@ Available commands Usage: ```bash -./kanboard export:tasks <project_id> <start_date> <end_date> +./cli export:tasks <project_id> <start_date> <end_date> ``` Example: ```bash -./kanboard export:tasks 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv +./cli export:tasks 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv ``` CSV data are sent to `stdout`. @@ -79,13 +79,13 @@ CSV data are sent to `stdout`. Usage: ```bash -./kanboard export:subtasks <project_id> <start_date> <end_date> +./cli export:subtasks <project_id> <start_date> <end_date> ``` Example: ```bash -./kanboard export:subtasks 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv +./cli export:subtasks 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv ``` ### Task transitions CSV export @@ -93,13 +93,13 @@ Example: Usage: ```bash -./kanboard export:transitions <project_id> <start_date> <end_date> +./cli export:transitions <project_id> <start_date> <end_date> ``` Example: ```bash -./kanboard export:transitions 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv +./cli export:transitions 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv ``` ### Export daily summaries data in CSV @@ -107,13 +107,13 @@ Example: The exported data will be printed on the standard output: ```bash -./kanboard export:daily-project-column-stats <project_id> <start_date> <end_date> +./cli export:daily-project-column-stats <project_id> <start_date> <end_date> ``` Example: ```bash -./kanboard export:daily-project-column-stats 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv +./cli export:daily-project-column-stats 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv ``` ### Send notifications for overdue tasks @@ -121,7 +121,7 @@ Example: Emails will be sent to all users with notifications enabled. ```bash -./kanboard notification:overdue-tasks +./cli notification:overdue-tasks ``` Optional parameters: @@ -147,7 +147,7 @@ You can also display the overdue tasks with the flag `--show`: This command calculate the statistics of each project: ```bash -./kanboard projects:daily-stats +./cli projects:daily-stats Run calculation for Project #0 Run calculation for Project #1 Run calculation for Project #10 @@ -158,14 +158,14 @@ Run calculation for Project #10 This command send a "daily cronjob event" to all open tasks of each project. ```bash -./kanboard trigger:tasks +./cli trigger:tasks Trigger task event: project_id=2, nb_tasks=1 ``` ### Reset user password ```bash -./kanboard user:reset-password my_user +./cli user:reset-password my_user ``` You will be prompted for a password and confirmation. Characters are not printed to the screen. @@ -173,13 +173,13 @@ You will be prompted for a password and confirmation. Characters are not printed ### Remove two-factor authentication for a user ```bash -./kanboard user:reset-2fa my_user +./cli user:reset-2fa my_user ``` ### Install a plugin ```bash -./kanboard plugin:install https://github.com/kanboard/plugin-github-auth/releases/download/v1.0.1/GithubAuth-1.0.1.zip +./cli plugin:install https://github.com/kanboard/plugin-github-auth/releases/download/v1.0.1/GithubAuth-1.0.1.zip ``` Note: Installed files will have the same permissions as the current user @@ -187,13 +187,13 @@ Note: Installed files will have the same permissions as the current user ### Remove a plugin ```bash -./kanboard plugin:uninstall Budget +./cli plugin:uninstall Budget ``` ### Upgrade all plugins ```bash -./kanboard plugin:upgrade +./cli plugin:upgrade * Updating plugin: Budget Planning * Plugin up to date: Github Authentication ``` @@ -201,5 +201,5 @@ Note: Installed files will have the same permissions as the current user ### Run Background worker ```bash -./kanboard worker +./cli worker ``` diff --git a/doc/cronjob.markdown b/doc/cronjob.markdown index 780f0025..743aac95 100644 --- a/doc/cronjob.markdown +++ b/doc/cronjob.markdown @@ -25,7 +25,7 @@ sudo crontab -u www-data -e Example to execute the daily cronjob at 8am: ```bash -0 8 * * * cd /path/to/kanboard && ./kanboard cronjob >/dev/null 2>&1 +0 8 * * * cd /path/to/kanboard && ./cli cronjob >/dev/null 2>&1 ``` Note: the cronjob process must have write access to the database in case you are using Sqlite. diff --git a/doc/es_ES/cli.markdown b/doc/es_ES/cli.markdown index 3f19b39d..ec46bdd6 100755 --- a/doc/es_ES/cli.markdown +++ b/doc/es_ES/cli.markdown @@ -10,7 +10,7 @@ Uso ----- - Abre una terminal y ve a tu directorio de kanboard (ejemplo : `cd /var/www/kanboard`) -- Corre el comando `./kanboard` +- Corre el comando `./cli` / `php cli` ```bash Kanboard version master @@ -33,10 +33,10 @@ Available commands: list Lista de comandos worker Execute queue worker export - export:daily-project-column-stats Diariamente estadsticas de exportacin de CSV (nmero de tareas por columna y por da ) + export:daily-project-column-stats Diariamente estad�sticas de exportaci�n de CSV (n�mero de tareas por columna y por d�a ) export:subtasks Exportar a CSV las subtareas export:tasks Exportar a CSV las tareas - export:transitions Exportar a CSV tareas de transicin + export:transitions Exportar a CSV tareas de transici�n locale locale:compare Comparar aplicacion de traducciones con el locale fr_FR locale:sync Sincronizar todas las traducciones basadas en el locale fr_FR @@ -51,7 +51,7 @@ Available commands: trigger trigger:tasks Disparadores de eventos calendarizados para todas las tareas user - user:reset-2fa Eliminar la autenticacin two-factor para un usuario + user:reset-2fa Eliminar la autenticaci�n two-factor para un usuario user:reset-password Cambiar el passwor del usuario ``` @@ -63,13 +63,13 @@ Comandos disponibles Uso: ```bash -./kanboard export:tasks <project_id> <start_date> <end_date> +./cli export:tasks <project_id> <start_date> <end_date> ``` Ejemplo: ```bash -./kanboard export:tasks 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv +./cli export:tasks 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv ``` CSV los datos son enviados a `stdout`. @@ -79,41 +79,41 @@ CSV los datos son enviados a `stdout`. Uso: ```bash -./kanboard export:subtasks <project_id> <start_date> <end_date> +./cli export:subtasks <project_id> <start_date> <end_date> ``` Ejemplo: ```bash -./kanboard export:subtasks 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv +./cli export:subtasks 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv ``` -### Exportacin a CSV de tareas de transicin +### Exportaci�n a CSV de tareas de transici�n Uso: ```bash -./kanboard export:transitions <project_id> <start_date> <end_date> +./cli export:transitions <project_id> <start_date> <end_date> ``` Ejemplo: ```bash -./kanboard export:transitions 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv +./cli export:transitions 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv ``` ### Exportar diariamente resumenes de datos en CSV -Los datos exportados se pueden imprimir en la salida estndar: +Los datos exportados se pueden imprimir en la salida est�ndar: ```bash -./kanboard export:daily-project-column-stats <project_id> <start_date> <end_date> +./cli export:daily-project-column-stats <project_id> <start_date> <end_date> ``` Ejemplo: ```bash -./kanboard export:daily-project-column-stats 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv +./cli export:daily-project-column-stats 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv ``` ### Envio de notificaciones para tareas atrasadas @@ -121,7 +121,7 @@ Ejemplo: Los Emails se enviaran a todos los usuarios con las notificaciones habilitadas. ```bash -./kanboard notification:overdue-tasks +./cli notification:overdue-tasks ``` Parametros opcionales: @@ -130,10 +130,10 @@ Parametros opcionales: - `--group`: Grupo tareas atrasadas todo para un usuario (desde todos los proyectos) en un email - `--manager`: Enviar todas las tareas atrasadas a un project manager(s) en un email -Tambin puede mostrar las tareas atrasadas con la bandera `--show`: +Tambi�n puede mostrar las tareas atrasadas con la bandera `--show`: ```bash -./kanboard notification:overdue-tasks --show +./cli notification:overdue-tasks --show +-----+---------+------------+------------+--------------+----------+ | Id | Title | Due date | Project Id | Project name | Assignee | +-----+---------+------------+------------+--------------+----------+ @@ -147,7 +147,7 @@ Tambin puede mostrar las tareas atrasadas con la bandera `--show`: Este comando calcula las estadisticas por cada proyecto: ```bash -./kanboard projects:daily-stats +./cli projects:daily-stats Run calculation for Project #0 Run calculation for Project #1 Run calculation for Project #10 @@ -158,42 +158,42 @@ Run calculation for Project #10 Este comando envia a "daily cronjob event" a todas las tareas abiertas de cada proyecto. ```bash -./kanboard trigger:tasks +./cli trigger:tasks Trigger task event: project_id=2, nb_tasks=1 ``` ### Resetear el password del usuario ```bash -./kanboard user:reset-password my_user +./cli user:reset-password my_user ``` -Se le pedir una contrasea y la confirmacin. Los caracteres no se imprimen en la pantalla. +Se le pedir� una contrase�a y la confirmaci�n. Los caracteres no se imprimen en la pantalla. -### Eliminar la autenticacin two-factor para un usuario +### Eliminar la autenticaci�n two-factor para un usuario ```bash -./kanboard user:reset-2fa my_user +./cli user:reset-2fa my_user ``` ### Instalar un plugin ```bash -./kanboard plugin:install https://github.com/kanboard/plugin-github-auth/releases/download/v1.0.1/GithubAuth-1.0.1.zip +./cli plugin:install https://github.com/kanboard/plugin-github-auth/releases/download/v1.0.1/GithubAuth-1.0.1.zip ``` -Nota: Los archivos instalados tendrn los mismos permisos que el usuario actual +Nota: Los archivos instalados tendr�n los mismos permisos que el usuario actual ### Eliminar un usuario ```bash -./kanboard plugin:uninstall Budget +./cli plugin:uninstall Budget ``` ### Upgrade todos los plugins ```bash -./kanboard plugin:upgrade +./cli plugin:upgrade * Updating plugin: Budget Planning * Plugin up to date: Github Authentication ``` @@ -201,5 +201,5 @@ Nota: Los archivos instalados tendrn los mismos permisos que el usuario actual ### Run Background worker ```bash -./kanboard worker +./cli worker ``` diff --git a/doc/es_ES/cronjob.markdown b/doc/es_ES/cronjob.markdown index f8f9ebc8..b7dc5cee 100755 --- a/doc/es_ES/cronjob.markdown +++ b/doc/es_ES/cronjob.markdown @@ -1,4 +1,4 @@ -Programacin de Jobs en background +Programaci�n de Jobs en background ================================== Para trabajar correctamente,Kanboard requiere que se corra un job en background diariamente. @@ -10,7 +10,7 @@ Este job es necesario para estas caracteristicas: - Enviar notificaciones de tareas atrasadas. - Ejecutar automaticamente acciones conectadas a el evento "Daily background job for tasks" -Configuracin de plataformas Unix y Linux +Configuraci�n de plataformas Unix y Linux ----------------------------------------- Hay varias maneras de definir una tarea programada en sistemas operativos Unix/Linux , este ejemplo es para Ubuntu 14.04 . @@ -25,7 +25,7 @@ sudo crontab -u www-data -e Ejemplo para ejecutar diariamente cronjob a las 8am: ```bash -0 8 * * * cd /path/to/kanboard && ./kanboard cronjob >/dev/null 2>&1 +0 8 * * * cd /path/to/kanboard && ./cli cronjob >/dev/null 2>&1 ``` Nota : El proceso del cronjob debe tener acceso a escritura de la base de datos en caso de usar Sqlite. diff --git a/doc/es_ES/installation.markdown b/doc/es_ES/installation.markdown index 9491d591..f3dfc495 100644 --- a/doc/es_ES/installation.markdown +++ b/doc/es_ES/installation.markdown @@ -44,6 +44,7 @@ Si desea instalar Kanboard fuera de la raíz de documentos del servidor web, es ```bash . ├── assets -> ../kanboard/assets +├── cli -> ../kanboard/cli ├── doc -> ../kanboard/doc ├── favicon.ico -> ../kanboard/favicon.ico ├── index.php -> ../kanboard/index.php diff --git a/doc/es_ES/translations.markdown b/doc/es_ES/translations.markdown index 074d9ae3..66fd2a4c 100644 --- a/doc/es_ES/translations.markdown +++ b/doc/es_ES/translations.markdown @@ -50,7 +50,7 @@ How to find missing translations in the applications? From a terminal, run the following command: ```bash -./kanboard locale:compare +./cli locale:compare ``` All missing and unused translations are displayed on the screen. @@ -62,7 +62,7 @@ How to synchronize translation files? From a Unix shell run this command: ```bash -./kanboard locale:sync +./cli locale:sync ``` The French translation is used a reference to other locales. diff --git a/doc/fr_FR/installation.markdown b/doc/fr_FR/installation.markdown index 4f7569ab..9e4cb47a 100644 --- a/doc/fr_FR/installation.markdown +++ b/doc/fr_FR/installation.markdown @@ -42,6 +42,7 @@ Si vous souhaitez installer Kanboard en dehors du document root de votre serveur ```bash . ├── assets -> ../kanboard/assets +├── cli -> ../kanboard/cli ├── doc -> ../kanboard/doc ├── favicon.ico -> ../kanboard/favicon.ico ├── index.php -> ../kanboard/index.php diff --git a/doc/installation.markdown b/doc/installation.markdown index 67b010a9..713195dd 100644 --- a/doc/installation.markdown +++ b/doc/installation.markdown @@ -42,6 +42,7 @@ If you would like to install Kanboard outside of the web server document root, y ```bash . ├── assets -> ../kanboard/assets +├── cli -> ../kanboard/cli ├── doc -> ../kanboard/doc ├── favicon.ico -> ../kanboard/favicon.ico ├── index.php -> ../kanboard/index.php diff --git a/doc/ru_RU/cli.markdown b/doc/ru_RU/cli.markdown index 9c7b56a7..01417936 100644 --- a/doc/ru_RU/cli.markdown +++ b/doc/ru_RU/cli.markdown @@ -1,31 +1,15 @@ Интерфейс командной строки ========================== - - Канборд обеспечивает простой интерфейс командной строки, которым можно воспользоваться только из Unix терминала. Эта возможность доступна только с локальной машины. - - Интерфейс командной строки полезен для выполнения команд вне процессов веб сервера. - - Использование[¶](#usage "Ссылка на этот заголовок") --------------------------------------------------- - - - Откройте терминал и перейдите в директорию Канборд (например: `cd /var/www/kanboard`) - - - -- Выполните команду `./kanboard` - - - -<!-- --> - +- Выполните команду `./cli` Kanboard version master @@ -107,130 +91,67 @@ user:reset-password Change user password - Доступные команды[¶](#available-commands "Ссылка на этот заголовок") -------------------------------------------------------------------- - - ### Экспорт задач в формате CSV[¶](#tasks-csv-export "Ссылка на этот заголовок") - - Применение: - - - ./kanboard export:tasks <project_id> <start_date> <end_date> - - + ./cli export:tasks <project_id> <start_date> <end_date> Пример: - - - ./kanboard export:tasks 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv - - + ./cli export:tasks 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv Данные CSV передаются в `stdout`. - - ### Экспорт подзадач в формате CSV[¶](#subtasks-csv-export "Ссылка на этот заголовок") - - Применение: - - - ./kanboard export:subtasks <project_id> <start_date> <end_date> - - + ./cli export:subtasks <project_id> <start_date> <end_date> Пример: - - - ./kanboard export:subtasks 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv - - + ./cli export:subtasks 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv ### Экспорт перемещения задач в формате CSV[¶](#task-transitions-csv-export "Ссылка на этот заголовок") - - Применение: - - - ./kanboard export:transitions <project_id> <start_date> <end_date> - - + ./cli export:transitions <project_id> <start_date> <end_date> Пример: - - - ./kanboard export:transitions 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv - - + ./cli export:transitions 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv ### Экспорт ежедневных сведений в формате CSV[¶](#export-daily-summaries-data-in-csv "Ссылка на этот заголовок") - - Экспортированные данные будут выведены в стандартный вывод: - - - ./kanboard export:daily-project-column-stats <project_id> <start_date> <end_date> - - + ./cli export:daily-project-column-stats <project_id> <start_date> <end_date> Пример: - - - ./kanboard export:daily-project-column-stats 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv - - + ./cli export:daily-project-column-stats 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv ### Отправка уведомлений для просроченных задач[¶](#send-notifications-for-overdue-tasks "Ссылка на этот заголовок") - - Email сообщения будут отправлены всем пользователям, у которых включено оповещение. - - - ./kanboard notification:overdue-tasks - - + ./cli notification:overdue-tasks Необязательные параметры: - - - `--show`: Показывать отправку уведомлений - - - - `--group`: Группировать все просроченные задачи для одного пользователя (со всех проектов) на один email - - - - `--manager`: Посылать все просроченные задачи менеджеру (менеджерам) проекта в одном email сообщении - - Вы можете просмотреть просроченные задачи с помощью параметра `--show`: - - ```bash -./kanboard notification:overdue-tasks --show +./cli notification:overdue-tasks --show +-----+---------+------------+------------+--------------+----------+ | Id | Title | Due date | Project Id | Project name | Assignee | +-----+---------+------------+------------+--------------+----------+ @@ -239,93 +160,46 @@ Email сообщения будут отправлены всем пользов +-----+---------+------------+------------+--------------+----------+ ``` - ### Запуск ежедневной калькуляции статистики[¶](#run-daily-project-stats-calculation "Ссылка на этот заголовок") - - Эта команда считает статистику для каждого проекта: - - - ./kanboard projects:daily-stats - + ./cli projects:daily-stats Run calculation for Project #0 - Run calculation for Project #1 - Run calculation for Project #10 - - ### Триггеры для задач[¶](#trigger-for-tasks) - - Эта команда посылает “событие для ежедневных фоновых заданий” для всех открытых задач в каждом проекте. - - - ./kanboard trigger:tasks - + ./cli trigger:tasks Trigger task event: project_id=2, nb_tasks=1 - - ### Сброс пароля пользователя[¶](#reset-user-password "Ссылка на этот заголовок") - - - ./kanboard user:reset-password my_user - - + ./cli user:reset-password my_user Будет запрошен пароль и подтверждение. Символы не отображаются на экране. - - ### Удаление двухуровневой аутентификации для пользователя[¶](#remove-two-factor-authentication-for-a-user "Ссылка на этот заголовок") - - - ./kanboard user:reset-2fa my_user - - + ./cli user:reset-2fa my_user ### Установка плагина[¶](#install-a-plugin "Ссылка на этот заголовок") - - - ./kanboard plugin:install https://github.com/kanboard/plugin-github-auth/releases/download/v1.0.1/GithubAuth-1.0.1.zip - - + ./cli plugin:install https://github.com/kanboard/plugin-github-auth/releases/download/v1.0.1/GithubAuth-1.0.1.zip Заметка: Установленные файлы будут иметь теже права, что и у текущего пользователя - - ### Удаление плагина[¶](#remove-a-plugin "Ссылка на этот заголовок") - - - ./kanboard plugin:uninstall Budget - - + ./cli plugin:uninstall Budget ### Обновление всех плагинов[¶](#upgrade-all-plugins "Ссылка на этот заголовок") - - - ./kanboard plugin:upgrade - + ./cli plugin:upgrade * Updating plugin: Budget Planning - * Plugin up to date: Github Authentication - - - - - [Русская документация Kanboard](http://kanboard.ru/doc/) - diff --git a/doc/ru_RU/cronjob.markdown b/doc/ru_RU/cronjob.markdown index 62f8e886..f6d3a2af 100644 --- a/doc/ru_RU/cronjob.markdown +++ b/doc/ru_RU/cronjob.markdown @@ -1,7 +1,6 @@ Ежедневные фоновые задачи ========================= - Для корректной работы, Канборд должен запускать ежедневные фоновые задачи. На Unix платформах этот процесс выполнятся в `cron`. Фоновые задачи необходимы для следующих возможностей: @@ -16,26 +15,14 @@ Для создания фоновых задач под операционной системой Unix/Linux используются разные решения. Здесь приведен пример для Ubuntu 14.04. Для других систем процедура похожа. - Отредактируйте crontab под пользователем вашего веб сервера: - sudo crontab -u www-data -e - Пример запуска ежедневной фоновой задачи в 8 утра: - - 0 8 * * * cd /path/to/kanboard && ./kanboard cronjob >/dev/null 2>&1 - + 0 8 * * * cd /path/to/kanboard && ./cli cronjob >/dev/null 2>&1 Примечание: процес выполнения фоновых задач должен иметь права доступа к вашей базе данных в случае если вы используете Sqlite. Обычно, достаточно запускать фоновую задачу под пользователем веб сервера. - - - - - - [Русская документация Kanboard](http://kanboard.ru/doc/) - diff --git a/doc/ru_RU/installation.markdown b/doc/ru_RU/installation.markdown index e59e43d2..ff989b19 100644 --- a/doc/ru_RU/installation.markdown +++ b/doc/ru_RU/installation.markdown @@ -75,6 +75,7 @@ ├── assets -> ../kanboard/assets ├── doc -> ../kanboard/doc + ├── cli -> ../kanboard/cli ├── favicon.ico -> ../kanboard/favicon.ico ├── index.php -> ../kanboard/index.php ├── jsonrpc.php -> ../kanboard/jsonrpc.php diff --git a/doc/ru_RU/translations.markdown b/doc/ru_RU/translations.markdown index f4bcafc0..0b9c6752 100644 --- a/doc/ru_RU/translations.markdown +++ b/doc/ru_RU/translations.markdown @@ -1,61 +1,25 @@ Переводы на другие языки (локализация) ====================================== - - Как перевести Канборд на новый язык?[¶](#how-to-translate-kanboard-to-a-new-language "Ссылка на этот заголовок") ---------------------------------------------------------------------------------------------------------------- - - - Переводы хранятся в директории `app/Locale` - - - - В этой директории есть поддиректории для разных языков, например, для русского имеется `ru_RU`, для французского - `fr_FR` и т.д. - - - - Переводы находятся в PHP файле, который возвращает массив с парой ключ-значение - - - - Ключ - оригинальный текст на английском и значение - перевод на соответсвующем языке - - - - **Французские переводы всегда в актуальном состоянии** - - - - Всегда используйте последнюю версию (branch master) - - ### Создание нового перевода[¶](#create-a-new-translation "Ссылка на этот заголовок") 1. Создайте новую директорию: `app/Locale/xx_XX`, например `app/Locale/fr_CA` для канадского фрацузского - - - 2. Создайте новый файл для перевода: `app/Locale/xx_XX/translations.php` - - - 3. Используйте как образец содержимое французского перевода (локализации) и замените значения - - - 4. Внесите изменения в файл `app/Model/Language.php` - - - 5. Проверьте добавленный язык на локальной версии Канборда - - - 6. Пошлите [pull-request на Github](https://help.github.com/articles/using-pull-requests/) @@ -63,93 +27,46 @@ Как обновить имеющийся перевод?[¶](#how-to-update-an-existing-translation "Ссылка на этот заголовок") ----------------------------------------------------------------------------------------------------- - - 1. Откройте файл перевода `app/Locale/xx_XX/translations.php` - - - 2. Отсутсвующие переводы закоментированы - `//` и значения пустые, нужно заполнить значения и удалить коментарий - - - 3. Проверьте внесенные изменения на локальной версии Канборда и пошлите [pull-request](https://help.github.com/articles/using-pull-requests/) - Как добавить новый текст перевода в приложение?[¶](#how-to-add-new-translated-text-in-the-application "Ссылка на этот заголовок") --------------------------------------------------------------------------------------------------------------------------------- - - Переводы отображаются с помощью функций в исходном коде: - - `t()`: показывает текст с HTML escaping - - - - `e()`: показывает текст без HTML escaping - Всегда используйте английскую версию исходного кода. - - - Текстовые строки используют функцию `sprintf()` для замены элементов: - - - `%s` используется для замены строки - - - - `%d` используется для замены цифры - Ознакомится с доступными форматами вы можете в [документации PHP](http://php.net/sprintf). - - Как найти отсутствующие переводы в приложении?[¶](#how-to-find-missing-translations-in-the-applications "Ссылка на этот заголовок") ----------------------------------------------------------------------------------------------------------------------------------- - - Из терминала запустите следующую команду: - - - ./kanboard locale:compare - - + ./cli locale:compare Все отсутствующие и неиспользуемые переводы будут показаны на экране. Добавьте их во французскую локализацию и синхронизируйте с другими локализациями (смотрите ниже) - - Как синхронизировать файлы переводов?[¶](#how-to-synchronize-translation-files "Ссылка на этот заголовок") ---------------------------------------------------------------------------------------------------------- - - В оболочке Unix запустите следующую команду: - - - ./kanboard locale:sync - - + ./cli locale:sync Французский перевод используется для ссылки на другие локализации. - - - - - [Русская документация Kanboard](http://kanboard.ru/doc/) - diff --git a/doc/translations.markdown b/doc/translations.markdown index 074d9ae3..66fd2a4c 100644 --- a/doc/translations.markdown +++ b/doc/translations.markdown @@ -50,7 +50,7 @@ How to find missing translations in the applications? From a terminal, run the following command: ```bash -./kanboard locale:compare +./cli locale:compare ``` All missing and unused translations are displayed on the screen. @@ -62,7 +62,7 @@ How to synchronize translation files? From a Unix shell run this command: ```bash -./kanboard locale:sync +./cli locale:sync ``` The French translation is used a reference to other locales. diff --git a/doc/worker.markdown b/doc/worker.markdown index 8516068b..89becacd 100644 --- a/doc/worker.markdown +++ b/doc/worker.markdown @@ -19,7 +19,7 @@ This feature is optional and require the installation of a queue daemon on your - To install Beanstalk, you can simply use the package manager of your Linux distribution - Install the [Kanboard plugin for Beanstalk](https://kanboard.net/plugin/beanstalk) -- Start the worker with the Kanboard command line tool: `./kanboard worker` +- Start the worker with the Kanboard command line tool: `./cli worker` ### RabbitMQ @@ -27,7 +27,7 @@ This feature is optional and require the installation of a queue daemon on your - Follow the official documentation of RabbitMQ for the installation and the configuration - Install the [Kanboard plugin for RabbitMQ](https://kanboard.net/plugin/rabbitmq) -- Start the worker with the Kanboard command line tool: `./kanboard worker` +- Start the worker with the Kanboard command line tool: `./cli worker` ### Notes |