1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-04-04 22:14:37 +02:00

Автоматизация создания документации

This commit is contained in:
Anton Titovets 2024-04-23 14:31:48 +03:00
parent d3ef40603c
commit cc388b0619
3 changed files with 32 additions and 17 deletions

View File

@ -7,6 +7,8 @@
Перем СПодкаталогами; Перем СПодкаталогами;
Перем КаталогДокументации; Перем КаталогДокументации;
Перем СписокОбластей; Перем СписокОбластей;
Перем ТекущаяОбласть;
Перем СчетчикОбласти;
Процедура ПриСозданииОбъекта() Процедура ПриСозданииОбъекта()
@ -14,6 +16,8 @@
СПодкаталогами = Истина; СПодкаталогами = Истина;
КаталогДокументации = ".\docs"; КаталогДокументации = ".\docs";
СписокОбластей = Новый СписокЗначений(); СписокОбластей = Новый СписокЗначений();
ТекущаяОбласть = "";
СчетчикОбласти = 0;
ПроверитьСоздатьКаталог(КаталогДокументации); ПроверитьСоздатьКаталог(КаталогДокументации);
СоздатьФайлыДокументации(); СоздатьФайлыДокументации();
@ -43,10 +47,17 @@
КонецПроцедуры КонецПроцедуры
Процедура СоздатьСтраницуДокументации(СтруктураМетода) Процедура СоздатьСтраницуДокументации(СтруктураМетода, Счетчик = 1)
Область = СтруктураМетода["Область"];
Если ТекущаяОбласть <> Область Тогда
ТекущаяОбласть = Область;
СчетчикОбласти = 1;
КонецЕсли;
ТранслитированноеИмя = ТранслитироватьСтроку(СтруктураМетода["Заголовок"]); ТранслитированноеИмя = ТранслитироватьСтроку(СтруктураМетода["Заголовок"]);
СинонимОбласти = Синонимайзер(СтруктураМетода["Область"]); СинонимОбласти = Синонимайзер(Область);
ТранслитированнаяОбласть = ТранслитироватьСтроку(СинонимОбласти); ТранслитированнаяОбласть = ТранслитироватьСтроку(СинонимОбласти);
КаталогБиблиотеки = КаталогДокументации + "\" + СтруктураМетода["Каталог"]; КаталогБиблиотеки = КаталогДокументации + "\" + СтруктураМетода["Каталог"];
@ -59,6 +70,7 @@
Макет = Макет.ПолучитьТекст(); Макет = Макет.ПолучитьТекст();
Макет = СтрЗаменить(Макет, "@Счетчик" , Строка(СчетчикОбласти));
Макет = СтрЗаменить(Макет, "@Заголовок" , СтруктураМетода["Заголовок"]); Макет = СтрЗаменить(Макет, "@Заголовок" , СтруктураМетода["Заголовок"]);
Макет = СтрЗаменить(Макет, "@Описание" , СтруктураМетода["Описание"]); Макет = СтрЗаменить(Макет, "@Описание" , СтруктураМетода["Описание"]);
Макет = СтрЗаменить(Макет, "@Объявление" , СтруктураМетода["Объявление"]); Макет = СтрЗаменить(Макет, "@Объявление" , СтруктураМетода["Объявление"]);
@ -95,6 +107,8 @@
НовыйДокумент.УстановитьТекст(Макет); НовыйДокумент.УстановитьТекст(Макет);
НовыйДокумент.Записать(КаталогОбласти + "\" + ТранслитированноеИмя + ".md"); НовыйДокумент.Записать(КаталогОбласти + "\" + ТранслитированноеИмя + ".md");
СчетчикОбласти = СчетчикОбласти + 1;
КонецПроцедуры КонецПроцедуры
#КонецОбласти #КонецОбласти
@ -295,12 +309,13 @@
МассивЭлементовПараметра[Н] = СокрЛП(МассивЭлементовПараметра[Н]); МассивЭлементовПараметра[Н] = СокрЛП(МассивЭлементовПараметра[Н]);
КонецЦикла; КонецЦикла;
Если КоличествоЭлементов < 4 Тогда
Возврат;
КонецЕсли;
Имя1С = МассивЭлементовПараметра[0]; Имя1С = МассивЭлементовПараметра[0];
Имя = "--" + МассивЭлементовПараметра[3];
Если КоличествоЭлементов >= 4 Тогда
Имя = "--" + МассивЭлементовПараметра[3];
Иначе
Имя = "";
Конецесли;
Типы = МассивЭлементовПараметра[1]; Типы = МассивЭлементовПараметра[1];
Описание = ?(КоличествоЭлементов >= 5, МассивЭлементовПараметра[4], МассивЭлементовПараметра[2]); Описание = ?(КоличествоЭлементов >= 5, МассивЭлементовПараметра[4], МассивЭлементовПараметра[2]);

View File

@ -1,5 +1,5 @@
--- ---
sidebar_position: sidebar_position: @Счетчик
--- ---
# @Заголовок # @Заголовок

View File

@ -170,11 +170,11 @@
// Изменяет состав существующего сообщения // Изменяет состав существующего сообщения
// //
// Параметры: // Параметры:
// Токен - Строка - Токен бота - token // Токен - Строка - Токен бота - token
// Канал - Строка - Идентификатор канала - channel // Канал - Строка - Идентификатор канала - channel
// Отметка - Строка - Временная отметка сообщения - stamp // Отметка - Строка - Временная отметка сообщения - stamp
// Текст - Строка - Новый текст сообщения - text // Текст - Строка - Новый текст сообщения - text
// МассивБлоков - Массив Из Структура - Массив описаний блоков - blocks - JSON массива описаний блоков // МассивБлоков - Массив Из Структура - Массив описаний блоков - blocks - JSON массива описаний блоков
// //
// Возвращаемое значение: // Возвращаемое значение:
// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack // Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack
@ -635,8 +635,8 @@
// Закрывает существующий диалог // Закрывает существующий диалог
// //
// Параметры: // Параметры:
// Токен - Строка - Токен бота // Токен - Строка - Токен бота - token
// Диалог - Строка - ID диалога // Диалог - Строка - ID диалога - conv
// //
// Возвращаемое значение: // Возвращаемое значение:
// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack // Соответствие Из КлючИЗначение - сериализованный JSON ответа от Slack
@ -656,8 +656,8 @@
// Формирует блок с картинкой для добавления в массив блоков сообщения // Формирует блок с картинкой для добавления в массив блоков сообщения
// //
// Параметры: // Параметры:
// URL - Строка - URL картинки // URL - Строка - URL картинки - picture
// АльтернативныйТекст - Строка - Альтернативный текст картинки // АльтернативныйТекст - Строка - Альтернативный текст картинки - alt
// //
// Возвращаемое значение: // Возвращаемое значение:
// Соответствие Из КлючИЗначение - Блок картинки // Соответствие Из КлючИЗначение - Блок картинки