#ORAIS-141

PRECOMMIT. Доработка документации.

README.md

@@ -35,18 +35,18 @@
 В комплекте присутствуют следующие сценарии обработки файлов:
 
 - `ДобавлениеПробеловПередКлючевымиСловами` - добавляет отсутствующие пробелы перед ключевыми словами в файлах модулей. На данный момент обрабатывается только ключевое слово `Экспорт`.
-- `ДобавлениеТестовВРасширение` - добавляет отсутствующие сценарии в расширение с unit-тестами для всех экспортных методов (обрабатываются общие модули, модули менеджеров, модули объектов, модули наборов записей). Поддерживаются только исходные файлы в формате EDT.
+- `ДобавлениеТестовВРасширение` - добавляет отсутствующие сценарии в расширение с unit-тестами. [См. подробнее](/docs/ДобавлениеТестовВРасширение.md)
 - `ЗапретИспользованияПерейти` - проверяет модуль на использование методов `Перейти`.
 - `ИсправлениеНеКаноническогоНаписания` - исправляет неканоничное написание ключевых слов в модулях.
 - `КорректировкаXMLФорм` - исправляет дубли индексов элементов в файлах описаний форм (могут образоваться при объединениях). Поддерживаются как файлы в формате выгрузки конфигуратора (`Form.xml`), так и в формате EDT (`Form.form`).
 - `ОбработкаЮнитТестов` - обновляет метод-загрузчик сценариев в общих модулях расширения с unit-тестами (по умолчанию отключен).
-- `ОтключениеПолнотекстовогоПоиска` - отключает полнотекстовый поиск в файлах описаний метаданных. Имеет настройку для исключения файлов из обработки. Для исключения необходимо указать относительный путь в репозитории до файла описания объекта метаданных. Можно выключать из обработки отдельные реквизиты, для этого надо задать массив реквизитов в конфигурационном файле.
+- `ОтключениеПолнотекстовогоПоиска` - отключает полнотекстовый поиск в файлах описаний метаданных. [См. подробнее](/docs/ОтключениеПолнотекстовогоПоиска.md)
 - `ПроверкаДублейПроцедурИФункций` - проверяет уникальность названий процедур и функций в модулях.
 - `ПроверкаКорректностиДирективКомпиляции` - проверяет корректность написания директив компиляции в модулях.
 - `ПроверкаКорректностиОбластей` - проверяет корректность "скобок" областей в модулях (парность и последовательность).
-- `ПроверкаНецензурныхСлов` - проверяет наличие нецензурных слов в модулях. Файл-словарь указывается в настройках. Пример файла [НецензурныеСлова.txt](/НецензурныеСлова.txt).
+- `ПроверкаНецензурныхСлов` - проверяет наличие нецензурных слов в модулях. [См. подробнее](/docs/ПроверкаНецензурныхСлов.md)
 - `РазборОбычныхФормНаИсходники` - раскладывает файлы обычных форм (`Form.bin`) на исходные файлы с помощью инструмента `v8unpack`.
-- `РазборОтчетОбработокРасширений` - раскладывает средствами платформы файлы внешних отчетов, обработок и расширений на исходные файлы и помещает в каталог исходных файлов репозитория в подкаталоги, соответствующие расширениям этих файлов. Например, внешний отчет `ВнешнийОтчет1.erf` будет разложен в каталог `src\erf\ВнешнийОтчет1`.
+- `РазборОтчетОбработокРасширений` - раскладывает средствами платформы файлы внешних отчетов, обработок и расширений на исходные файлы. [См. подробнее](/docs/РазборОтчетОбработокРасширений.md)
 - `СинхронизацияОбъектовМетаданныхИФайлов` - анализирует наличие файлов и объектов конфигурации. Поддерживается только файл описания конфигурации в формате выгрузки конфигуратора (`Configuration.xml`).
 - `СортировкаДереваМетаданных` - упорядочивает объекты метаданных верхнего уровня по алфавиту в файле описания конфигурации (кроме подсистем). Поддерживается как файл в формате выгрузки конфигуратора (`Configuration.xml`), так и в формате EDT (`Configuration.mdo`).
 - `УдалениеДублейМетаданных` - удаляет дубли объектов метаданных в файле описания конфигурации (могут образоваться при объединениях). Поддерживается как файл в формате выгрузки конфигуратора (`Configuration.xml`), так и в формате EDT (`Configuration.mdo`)..

docs/ДобавлениеТестовВРасширение.md

@@ -0,0 +1,14 @@
+# Сценарий `ДобавлениеТестовВРасширение`
+
+Добавляет отсутствующие сценарии тестов в расширение с unit-тестами для всех экспортных методов.
+
+Обрабатываются:
+
+- общие модули
+- модули менеджеров
+- модули объектов
+- модули наборов записей
+
+Поддерживаются только исходные файлы в формате EDT.
+
+Публичный репозиторий тестового расширения и документация по нему находятся в разработке.

docs/ОтключениеПолнотекстовогоПоиска.md

@@ -0,0 +1,23 @@
+# Сценарий `ОтключениеПолнотекстовогоПоиска`
+
+Отключает полнотекстовый поиск в файлах описаний метаданных.
+
+Имеет настройку в конфигурационном файле `v8config.json` для исключения файлов из обработки. Для этого необходимо указать относительный путь в репозитории до файла описания объекта метаданных. Можно выключить из обработки отдельные реквизиты, перечислив их массивом.
+
+```JSON
+{
+    "Precommt4onecСценарии": {
+        "НастройкиСценариев": {
+            "ОтключениеПолнотекстовогоПоиска": {
+                "МетаданныеДляИсключения": {
+                    "src\\_example.xml": [
+                        "Номер",
+                        "ТабличнаяЧасть1.Реквизит"
+                    ],
+                    "src\\_example2.xml": []
+                }
+            }
+        }
+    }
+}
+```

docs/ПроверкаНецензурныхСлов.md

@@ -0,0 +1,20 @@
+# Сценарий `ПроверкаНецензурныхСлов`
+
+Проверяет наличие нецензурных слов в модулях.
+
+Файл-словарь указывается в настройках.
+
+```JSON
+{
+    "Precommt4onecСценарии": {
+        "НастройкиСценариев": {
+             "ПроверкаНецензурныхСлов": {
+                "ФайлСНецензурнымиСловами": "НецензурныеСлова.txt"
+        }
+    }
+}
+```
+
+Слова в нем должны быть расположены по одному в строке, регистр символов не учитывается. 
+
+Пример файла [НецензурныеСлова.txt](/НецензурныеСлова.txt).

docs/РазборОтчетОбработокРасширений.md

@@ -0,0 +1,5 @@
+# Сценарий `РазборОтчетОбработокРасширений`
+
+Раскладывает средствами платформы файлы внешних отчетов, обработок и расширений на исходные файлы.
+
+Полученные исходники и помещаются в каталог исходных файлов репозитория в подкаталоги, соответствующие расширениям этих файлов. Например, внешний отчет `ВнешнийОтчет1.erf` будет разложен в каталог `src\erf\ВнешнийОтчет1`.