[pull] master from bia-tech:master

features/ПростыеКоманды.feature

@@ -14,15 +14,15 @@
 Сценарий: Получение версии продукта
     Когда Я выполняю команду "oscript" c параметрами "src/main.os version"
     Тогда Я сообщаю вывод команды "oscript"
-    И Вывод команды "oscript" содержит "1.0"
+    И Вывод команды "oscript" содержит "1.0.4"
     И Вывод команды "oscript" не содержит "AutodocGen v"
     И Код возврата команды "oscript" равен 0
 
 Сценарий: Получение помощи продукта
     Когда Я выполняю команду "oscript" c параметрами "src/main.os help"
     Тогда Вывод команды "oscript" содержит 
     """
-    AutodocGen v1.0
+    AutodocGen v1.0.4
     Возможные команды:
     help      - Выводит справку по командам
     version   - Выводит версию приложения
@@ -34,7 +34,7 @@
     Когда Я выполняю команду "oscript" c параметрами "src/main.os"
     Тогда Вывод команды "oscript" содержит
     """
-    AutodocGen v1.0
+    AutodocGen v1.0.4
     Возможные команды:
     help      - Выводит справку по командам
     version   - Выводит версию приложения

installlocalhost.bat

@@ -1,6 +1,4 @@
 @ECHO OFF
 del "*.ospx"
-opm build . -mf ./packagedef -out .
-opm install -f autodocgen-1.0.ospx
-
-pause
+call opm build . -mf ./packagedef -out .
+call opm install -f ./autodocgen-1.0.4.ospx

packagedef

@@ -15,5 +15,4 @@
 		.ЗависитОт("1commands", "1.3.2")
 		.ВключитьФайл("src")
 		.ВключитьФайл("features")
-		.ВключитьФайл("src/package-loader.os")
 		.ИсполняемыйФайл("src/main.os", ИмяПродукта);

readme.md

@@ -1,32 +1,33 @@
 # AutodocGen
 
-Инструмент генерации документации на основании информации файлов исходных кодов конфигурации 1С:Предприятие.
+Инструмент генерации документации на основании файлов исходных кодов конфигурации 1С:Предприятие.
 
 ## Об инструменте
 
 Инструмент позволяет
 
-- автоматически сформировать документацию на основании исходных файлов конфигурации 1С:Предприяти
+- автоматически сформировать документацию на основании исходных файлов конфигурации 1С:Предприятие
 - выполнить проверку на возможность корректного разбора информации, выступающей исходными данными для документации
-- опубликовать сгенерированную документациию
+- опубликовать сгенерированную документацию
 
 ## Установка
 
-Процесс установки стандартен
+Процесс установки стандартен:
 
 - либо `opm install autodocgen`
-- либо, если в opm приложения почему-то нет, то скачать архив, распаковать и выполнить (для windows) `installlocalhost.bat`
+- либо, если по разным причинам первый способ не подходит, то скачать архив из релизов, распаковать и выполнить (для windows) `installlocalhost.bat`
 
 ## Использование
 
 Основные возможности есть в справке. Отдельно стоит обратить внимание на конфигурационный файл.
 
 Конфигурационный файл соответствует структуре единого конфигурационного файла, ниже приведен пример
 
+```json
     {
         "GLOBAL": {
             "КаталогИсходныхФайлов": "src\\configuration",
-            "version": "1.0"
+            "version": "1.0.4"
         },
         "AutodocGen":{
             "НастройкиConluence": {
@@ -46,36 +47,55 @@
             "ПоследнийОбработанныйКоммит": ""
         }
     }
+```
 
-Располагать конфигурационный файл стоит в корне репозитория под именем `v8config.json`
+Располагать конфигурационный файл нужно в корне репозитория под именем `v8config.json`.
 
 ## Поддерживаемые варианты генерации автодокументации
 
 Как видно из пример конфигурационного файла, поддерживаются 2 формата (ключ `-format`)
 
-- `confluence` - генерирование страниц в указанном пространстве [confluence](https://ru.atlassian.com/software/confluence)
+- `confluence` - генерация страниц в указанном пространстве [confluence](https://ru.atlassian.com/software/confluence)
 - `html` - генерация структуры каталогов в соответствии с подсистемами и файлов-страниц в каталогах.
 
 Для добавления новых стоит воспользоваться шаблоном [src/Классы/ШаблонГенераторДокументации.os-template](src/Классы/ШаблонГенераторДокументации.os-template)
 
 ## Подготовка конфигурации
 
-Для генерирования документации, конфигурация должна соответствовать требованиям
+Для генерации документации конфигурация должна соответствовать требованиям:
 
 - Все модули должны иметь определенную структуру областей (в соответствии с требованиями 1С)
 - В документацию добавляются только экспортные методы, находящиеся в разделе `ПрограммныйИнтерфейс`
 - Описание методов должно соответствовать требованиям оформления кода
 - Поддерживаются общие модуи и модули менеджеров объектов
-- Все модули / объекты, которые попадают под правила автодокументирования должны располагаться в соответствующих подсистемах. Принятая структура:
+- Все модули / объекты, которые попадают под правила автодокументирования, должны располагаться в соответствующих подсистемах. Принятая структура:
 
 ```
 
     Подсистемы конфигурации
     |
-    +-- КорневаяПодсистема (не выводится в интерфейс пользователя)
+    +-- МояКорневаяПодсистема (не выводится в интерфейс пользователя)
         |
         +-- Раздел
             |
             +-- Подсистема
+                |
+                +-- ОбъектМетаданных
+
+```
+
+## Примеры
+
+### В формате Confluence
+
+![confluence](pict/confluence1.png)
+
+![confluence](pict/confluence2.png)
+
+![confluence](pict/confluence3.png)
+
+### В Формате HTML
+
+![html](pict/html1.PNG)
 
-```
+![html](pict/html2.PNG)

src/Классы/ГенераторДокументации_confluence.os

@@ -558,6 +558,11 @@
 	Для Каждого ОписаниеКонстанты Из МассивОписанийКонстант Цикл
 
 		РазборПодсистемы = СтрРазделить(ОписаниеКонстанты.Подсистема, ".");
+		Если РазборПодсистемы.Количество() < 2 Тогда
+
+			Продолжить;
+
+		КонецЕсли;
 
 		МассивПодсистем.Добавить(ОписаниеКонстанты.Подсистема);
 
@@ -619,6 +624,7 @@
 	СимволыЗамены.Добавить(Символ(8211), "&ndash;");
 	СимволыЗамены.Добавить(Символ(8212), "&mdash;");
 	СимволыЗамены.Добавить(Символы.ПС, "\n");
+	СимволыЗамены.Добавить(Символ(13), "\n");
 	СимволыЗамены.Добавить(Символы.Таб, "    ");
 
 	Если ДляCDATA Тогда
@@ -719,4 +725,4 @@
 
 	Возврат Шаблоны;
 
-КонецФункции
+КонецФункции