diff --git a/plugin-registration.md b/plugin-registration.md index 16158f28..7eac829f 100644 --- a/plugin-registration.md +++ b/plugin-registration.md @@ -4,15 +4,15 @@ - [Регистрация файла](#registration-file) - [Роутинг и инициализация](#routing-initialization) - [Регистрация компонента](#component-registration) -- [Extending Twig](#extending-twig) +- [Расширение Twig](#extending-twig) - [Регистрация виджета](#widget-registration) - [Навигация и ограниченияNavigation and permissions](#navigation-permissions) - [Настройки Бекэнда](#backend-settings) - [Миграции и история версий](#migrations-version-history) -Плагины - это основа для расширения функционала CMS. Процесс регистрации плагина позволяет определить функции плагина, такие как [components](components) или менюшки и страницы бек энда. Некоторые примеры того, что можно сделать с помощью плагинов: +Плагины - это основа для расширения функционала CMS. Процесс регистрации плагина позволяет определить функции плагина, такие как [компоненты](./cms-components.md) или менюшки и страницы бек энда. Некоторые примеры того, что можно сделать с помощью плагинов: -- Определить [components](components). +- Определить [компоненты](./cms-components.md). - Определить ограничения пользователя. - Добавить в бек энд страницы, менюхи и формы. - Создать структуру базы данных и внести в нее данные. @@ -35,7 +35,7 @@ ... Plugin.php <=== Регистрационный файл плагина -Но не для всех плагинов требуется такая структура. Только те плагины, в которых используется **Plugin.php** нуждаются в такой структуре. Если же Ваш плагин предусматривается только еденичный [component](components), то тогда, структура для такого плагина должна быть гораздо проще, например: +Но не для всех плагинов требуется такая структура. Только те плагины, в которых используется **Plugin.php** нуждаются в такой структуре. Если же Ваш плагин предусматривается только еденичный [компонент](./cms-components.md), то тогда, структура для такого плагина должна быть гораздо проще, например: plugins/ acme/ <=== Имя автора @@ -43,7 +43,7 @@ components/ Plugin.php <=== Регистрационный файл плагина -> **Помните**: если вы являетесь разработчиком плагина для [Marketplace](../help/marketplace), наличие файла [updates/version.yaml](#migrations-version-history) обязательно. +> **Помните**: если вы являетесь разработчиком плагина для [Marketplace](http://octobercms.com/help/site/marketplace), наличие файла [updates/version.yaml](#migrations-version-history) обязательно. ### Символы в имени плагина @@ -133,7 +133,7 @@ ## Регистрация компонента -[Components](components) должен быть зарегистрирован в [Файле регистрации плагина](#registration-file). Это укажет CMS о компоненте и предоставит **short name** для использования. Пример регистрации компонента: +[Компонент](./cms-components.md) должен быть зарегистрирован в [Файле регистрации плагина](#registration-file). Это укажет CMS о компоненте и предоставит **short name** для использования. Пример регистрации компонента: public function registerComponents() { @@ -142,7 +142,7 @@ ]; } -Этот код регистрирует класс компонента ТуДу с именем алиаса **demoTodo** по умолчанию. Больше информации по созданию компонентов Вы можете найти на страницах [Создание компонентов](components). +Этот код регистрирует класс компонента ТуДу с именем алиаса **demoTodo** по умолчанию. Больше информации по созданию компонентов Вы можете найти на страницах [Создание компонентов](./cms-components.md). ## Расширения Twig @@ -177,7 +177,7 @@ ## Регистрация виджета -Плагины могут регистрировать [формы виджетов](../backend/widgets#form-widgets) путем переопределения метода `registerFormWidgets()` в классе регистрации плагина. Этот метод должен возвращать массив, содержащий классы виджетов в ключах, имена виджетов и контекст в значениях. Например: +Плагины могут регистрировать [формы виджетов](./backend-widgets.md#form-widgets) путем переопределения метода `registerFormWidgets()` в классе регистрации плагина. Этот метод должен возвращать массив, содержащий классы виджетов в ключах, имена виджетов и контекст в значениях. Например: public function registerFormWidgets() { @@ -189,7 +189,7 @@ ]; } -Плагины могут регистрировать [отчет виджетов](../backend/widgets#report-widgets) путем переопределения метода `registerReportWidgets()` в классе регистрации плагина. Этот метод должен возвращать массив, содержащий классы виджетов в ключах, а также имя виджета и контекст в значениях. Пример: +Плагины могут регистрировать [отчет виджетов](./backend-widgets.md#report-widgets) путем переопределения метода `registerReportWidgets()` в классе регистрации плагина. Этот метод должен возвращать массив, содержащий классы виджетов в ключах, а также имя виджета и контекст в значениях. Пример: public function registerReportWidgets() { @@ -241,9 +241,9 @@ ]; } -При регистрации навигации в бек энде, можно пользовать строки локализации для значения `ярлыков`. Локализация описана в статье [плагин локализации](localization). +При регистрации навигации в бек энде, можно пользовать строки локализации для значения `ярлыков`. Локализация описана в статье [плагин локализации](./plugin-localization.md). -В следующем примере показано, как зарегистрировать элементы доступа в бек энде. Разрешения определяются с ключом разрешения и описанием. В бек энде для пользователя, который управляет доступом это показано в виде чекбоксов. Контроллеры бек энда могут использовать ограничения, определенные плагином, для ограничения [доступа пользователей](../backend/users) к страницам или функциям. +В следующем примере показано, как зарегистрировать элементы доступа в бек энде. Разрешения определяются с ключом разрешения и описанием. В бек энде для пользователя, который управляет доступом это показано в виде чекбоксов. Контроллеры бек энда могут использовать ограничения, определенные плагином, для ограничения [доступа пользователей](./backend-users.md) к страницам или функциям. public function registerPermissions() { @@ -272,7 +272,7 @@ ]; } -А этот пример покажет Вам как создать линк на настройки модели. Настройки модели это часть настроек API, которая описывается в статье [Настройки и Конфигурация](settings). +А этот пример покажет Вам как создать линк на настройки модели. Настройки модели это часть настроек API, которая описывается в статье [Настройки и Конфигурация](./plugin-settings.md). public function registerSettings() { @@ -302,7 +302,7 @@ seed_the_database.php <=== Миграционный файл create_another_table.php <=== Миграционный файл -Файл **version.yaml** названный как *Файл версии плагина*, содержит комментарии к версии и четкий порядок вызова скриптов базы данных. Пожалуйста, прочтите [структура Базы Данных](../database/structure) для ознкомления с информацией по миграционным файлам. Также этот файл необходим если Вы собрались отправить плагин в [Marketplace](../help/marketplace). Пример файла версии плагина: +Файл **version.yaml** названный как *Файл версии плагина*, содержит комментарии к версии и четкий порядок вызова скриптов базы данных. Пожалуйста, прочтите [структура Базы Данных](./database-structure.mde) для ознкомления с информацией по миграционным файлам. Также этот файл необходим если Вы собрались отправить плагин в [Marketplace](http://octobercms.com/help/site/marketplace). Пример файла версии плагина: 1.0.1: - Первая версия