Merge pull request #274 from GladilovDmitry/develop

Update readme.md

Author: EvilBeaver

.github/ISSUE_TEMPLATE/bug_report.md

@@ -28,4 +28,4 @@ about: если вы выявили ошибку - сообщите нам об
 
 **Дополнительный контекст**
 
-Типовая или не типовая конфиугарация ? Включен ли режим защиты от опасных действий и т.д.
+Типовая или не типовая конфигурация ? Включен ли режим защиты от опасных действий и т.д.

readme.md

@@ -23,13 +23,13 @@
     - [Подготовка нового репозитория (локального)](#подготовка-нового-репозитория-локального)
     - [Установка соответствия пользователей](#установка-соответствия-пользователей)
     - [Установка номера начальной версии хранилища 1С для синхронизации](#установка-номера-начальной-версии-хранилища-1с-для-синхронизации)
-    - [Настройка плагинов синхронизации](#настройка-плагинов-синхронизации)
   - [Синхронизация](#синхронизация)
     - [Справка по использованию команды](#справка-по-использованию-команды)
     - [Глобальные переменные окружения](#глобальные-переменные-окружения)
     - [Переменные окружения команды](#переменные-окружения-команды)
     - [Значения по умолчанию](#значения-по-умолчанию)
     - [Примеры использования](#примеры-использования)
+    - [Настройка плагинов синхронизации](#настройка-плагинов-синхронизации)
 - [Использование библиотеки `gitsync`](#использование-библиотеки-gitsync)
 - [Доработка и разработка плагинов](#доработка-и-разработка-плагинов)
 - [Механизм подписок на события](#механизм-подписок-на-события)
@@ -185,58 +185,12 @@
 
 Больше примеров: `gitsync usage set-version`
 
-<a id="markdown-настройка-плагинов-синхронизации" name="настройка-плагинов-синхронизации"></a>
-#### Настройка плагинов синхронизации
-
-> Данный пункт можно пропустить, если Вам не требуется дополнительная функциональность синхронизации
-
-Для расширения функциональности синхронизации предлагается механизм *плагинов*.
-Данный механизм реализован через подписки на события синхронизации, с возможностью переопределения стандартной обработки.
-
-Для обеспечения управления плагинами реализована подкоманда `plugins`, а так же ряд вложенных команд:
-
-1. `init` - Инициализация предустановленных плагинов
-1. `list` - Вывод списка плагинов
-1. `enable` - Активизация установленных плагинов
-1. `disable` - Деактивизация установленных плагинов
-1. `install` - Установка новых плагинов
-1. `clear` - Очистка установленных плагинов
-1. `help` - Вывод справки по выбранным плагинам
-
-Пример использования:
-
-* `gitsync plugins enable limit` - будет активирован плагин `limit`
-* `gitsync plugins list` - будет выведен список всех *активированных* плагинов
-* `gitsync plugins list -a` - будет выведен список всех *установленных* плагинов 
-
-Справка по команде: `gitsync plugins --help`
-
-Для удобства использования команда `plugins` имеет короткое название `p`.
-
-Больше примеров: `gitsync usage plugins`
-
-> Для хранения установленных плагинов и списка активных плагинов используется каталог `локальных данных приложения`
-
-Список предустановленных плагинов:
-> Для инициализации предустановленных плагинов необходимо выполнить команду `gitsync plugins init`
-
-1. `increment` - обеспечивает инкрементальную выгрузку конфигурации в исходники
-1. `sync-remote` -  добавляет функциональность синхронизации с удаленным репозиторием git (команды `git pull` и `git push`)
-1. `limit` - добавляет возможность ограничения на минимальный, максимальный номер версии хранилища, а так же на лимит на количество выгружаемых версий за один запуск
-1. `check-authors` - добавляет функциональность проверки автора версии в хранилище на наличие соответствия в файле `AUTHORS`
-1. `check-comments` - добавляет функциональность проверки на заполненность комментариев в хранилище
-1. `smart-tags` - добавляет функциональность автоматической расстановки меток в git (команда `git tag`) при изменении версии конфигурации
-1. `unpackForm` - добавляет функциональность распаковки обычных форм на исходники
-1. `tool1CD` - заменяет использование штатных механизмов 1С на приложение `tool1CD` при синхронизации
-1. `disable-support` - снимает конфигурацию с поддержки перед выгрузкой в исходники
-
-
 <a id="markdown-синхронизация" name="синхронизация"></a>
 ### Синхронизация
 
 Команда `sync` (синоним s) - выполняет синхронизацию хранилища 1С с git-репозиторием
 
-> Подробную справку по опциям и аргументам см. `gitsync sync --help`
+> Подробную справку по опциям и аргументам см. `gitsync sync --help`. Важно: описание опций команды sync при использовании плагина выводится только после активации этого плагина.
 
 <a id="markdown-справка-по-использованию-команды" name="справка-по-использованию-команды"></a>
 #### Справка по использованию команды
@@ -358,6 +312,54 @@
 
     gitsync s
     ```
+<a id="markdown-настройка-плагинов-синхронизации" name="настройка-плагинов-синхронизации"></a>
+
+#### Настройка плагинов синхронизации
+
+> Данный пункт можно пропустить, если Вам не требуется дополнительная функциональность синхронизации
+
+Для расширения функциональности синхронизации предлагается механизм *плагинов*.
+Данный механизм реализован через подписки на события синхронизации, с возможностью переопределения стандартной обработки.
+
+Для обеспечения управления плагинами реализована подкоманда `plugins`, а так же ряд вложенных команд:
+
+1. `init` - Инициализация предустановленных плагинов (установка из поставляемого пакета)
+1. `list` - Вывод списка плагинов
+1. `enable` - Активизация установленных плагинов
+1. `disable` - Деактивизация установленных плагинов
+1. `install` - Установка новых плагинов
+1. `clear` - Удаление установленных плагинов
+1. `help` - Вывод справки по выбранным плагинам
+
+Пример использования:
+
+* `gitsync plugins enable limit` - будет активирован плагин `limit`
+* `gitsync plugins enable -a` - будут активированы все предустановленные плагины
+* `gitsync plugins list` - будет выведен список всех *активированных* плагинов
+* `gitsync plugins list -a` - будет выведен список всех *установленных* плагинов 
+
+Справка по команде: `gitsync plugins --help`
+
+Для удобства использования команда `plugins` имеет короткое название `p`.
+
+Больше примеров: `gitsync usage plugins`
+
+> Для хранения установленных плагинов и списка активных плагинов используется каталог `локальных данных приложения` - для Windows это C:\Users\UserName\AppData\Local\gitsync\plugins
+
+Список предустановленных плагинов:
+> Для инициализации предустановленных плагинов необходимо выполнить команду `gitsync plugins init`. Описание используемых плагинами опций см. в справке к команде sync.
+
+1. `increment` - включает режим инкрементальной выгрузки конфигурации в исходники.  
+  Выгружается не вся конфигурация, а только те объекты, версия которых отличается от версии, имеющейся в каталоге. См. [DumpConfigToFiles](https://its.1c.ru/db/v8319doc#bookmark:adm:TI000000493:dumpconfigtofiles), опция update.
+2. `sync-remote` -  добавляет опции команды  `sync` для синхронизации с удаленным репозиторием git (команды `git pull` и `git push`)
+3. `limit` - позволяет ограничить количество выгружаемых версий за один запуск, а так же указать минимальную и/или максимальную версию хранилища для выгрузки
+4. `check-authors` - блокирует выгрузку версии, если автор версии хранилища отсутствует в файле `AUTHORS`
+5. `check-comments` - добавляет опции команды  `sync` для проверки наличия комментария у версии хранилища, а также для проверки заполнения комментария
+6. `smart-tags` - устанавливает тег равный версии конфигурации при смене версии конфигурации (не путать с версией хранилища). А также добавляет опции команды  `sync` для автоматической установки метки git (команда `git tag`) равной версии хранилища (в формате "v.номер").
+7. `unpackForm` - выполняет распаковку обычных форм на исходники. Добавляет опции команды  `sync` для переименования объектов обычных форм.
+8. `tool1CD` - заменяет использование штатных механизмов 1С на приложение `tool1CD` при выгрузке
+9. `disable-support` - снимает конфигурацию с поддержки перед выгрузкой в исходники
+10. `edtExport` - добавляет возможность выгрузки в формате EDT. Для работы плагина необходимо установить EDT.
 
 <a id="markdown-использование-библиотеки-gitsync" name="использование-библиотеки-gitsync"></a>
 ## Использование библиотеки `gitsync`