1544 Добавить в документацию описание экспортных методов основного мо…

…дуля

https://git.skbkontur.ru/Diadoc1C/DiadocModules/-/issues/1544

docs/source/Glosary.rst

@@ -0,0 +1,4 @@
+Глоссарий
+============
+
+Протоструктура  —  сущность, которая предоставляет объектную модель работы с данными электронного документа. Состав полей протоструктуры зависит от формата электронного документа.

docs/source/Methods_UM.rst

@@ -0,0 +1,57 @@
+Методы универсального модуля
+============================
+
+.. toctree::
+  :maxdepth: 1
+
+  ВыполнитьСинхронизациюКонтрагентовОрганизаций <methods/Vypolnit'SinhronizacijuKontragentovOrganizacij>
+  ДатаXML_в_Дата1С <methods/DataXML_v_Data1S>
+  ДД_Компонента_ПолучитьПустойКонтент <methods/DD_Komponenta_Poluchit'PustojKontent>
+  DD_API_ПолучитьПолномочияПодписанта <methods/DD_API_Poluchit'PolnomochijaPodpisanta>
+  ДвоичныеДанные_В_Текст <methods/DvoichnyeDannye_V_Tekst>
+  ЗаписатьСопоставлениеДокументаДД_С_Документом_1С <Zapisat'SopostavlenieDokumentaDD_S_Dokumentom_1S>
+  ЗаполнитьКонтентXDTOПоСтруктуре <methods/Zapolnit'KontentXDTOPoStrukture>
+  ИнициализацияТиповогоМодуля <methods/InicializacijaTipovogoModulja>
+  ИспользоватьПодсистемуДиадока <methods/Ispol'zovat'PodsistemuDiadoka>
+  НовыйРезультатФункции <methods/NovyjRezul'tatFunkcii>
+  ПолучитьДокументыПакета <methods/Poluchit'DokumentyPaketa>
+  ТиповойМодуль_ПолучитьКонтент <methods/TipovojModul'_Poluchit'Kontent>
+  ТиповойМодуль_СформироватьПечатнуюФорму <methods/TipovojModul'_Sformirovat'PechatnujuFormu>
+  ФункцияДокументаДляXML <methods/FunkcijaDokumentaDljaXML>
+  XML_В_XDTO <methods/XML_В_XDTO>
+  ЭДО_АвторизоватьсяПодЛогином <methods/JeDO_Avtorizovat'sjaPodLoginom>
+  ЭДО_АвторизоватьсяПодСертификатомНаСервере1С <methods/JeDO_Avtorizovat'sjaPodSertifikatomNaServere1S>
+  ЭДО_ДобавитьПравилоСопоставленияДокумента <methods/JeDO_Dobavit'PraviloSopostavlenijaDokumenta>
+  ЭДО_ДокументМенеджер_ПодготовитьИДобавитьДокументВПакет <methods/JeDO_DokumentMenedzher_Podgotovit'IDobavit'DokumentVPaket>
+  ЭДО_ЗаполнитьКонтекстСеансаДляСлужебнойУчетнойЗаписи <methods/JeDO_Zapolnit'KontekstSeansaDljaSluzhebnojUchetnojZapisi>
+  ЭДО_КонтекстСеансаКлиентСервер <methods/JeDO_KontekstSeansaKlientServer>
+  ЭДО_Модуль_ОбновитьСписокДокументов <methods/JeDO_Modul'_Obnovit'SpisokDokumentov>
+  ЭДО_Модуль_ОбработатьНовыеСобытияДокументов <methods/JeDO_Modul'_Obrabotat'NovyeSobytijaDokumentov>
+  ЭДО_Модуль_ТаблицаОрганизацийПользователя <methods/JeDO_Modul'_TablicaOrganizacijPol'zovatelja>
+  ЭДО_ОтправитьMessagePatchToPostДляВыбранныхСтрокСпискаДокументов <methods/JeDO_Otpravit'MessagePatchToPostDljaVybrannyhStrokSpiskaDokumentov>
+  ЭДО_ОтправитьПодписанныеИзвещенияОПолучении <methods/JeDO_Otpravit'PodpisannyeIzveshhenijaOPoluchenii>
+  ЭДО_ОтправитьСогласующуюПодпись <methods/JeDO_Otpravit'SoglasujushhujuPodpis'>
+  ЭДО_ПереместитьМассивДокументовВПодразделение <methods/JeDO_Peremestit'MassivDokumentovVPodrazdelenie>
+  ЭДО_ПодготовитьИОтправитьОтветНаДокумент <methods/JeDO_Podgotovit'IOtpravit'OtvetNaDokument>
+  ЭДО_ПодготовитьИОтправитьПакет <methods/JeDO_Podgotovit'IOtpravit'Paket>
+  ЭДО_ПодписатьИзвещенияОПолучении <methods/JeDO_Podpisat'IzveshhenijaOPoluchenii>
+  ЭДО_ПодразделенияОрганизацииВДиадоке <methods/JeDO_PodrazdelenijaOrganizaciiVDiadoke>
+  ЭДО_ПолучитьПечатнуюФормуДокумента <methods/JeDO_Poluchit'PechatnujuFormuDokumenta>
+  ЭДО_ПолучитьПустойКонтентОтвета <methods/JeDO_Poluchit'PustojKontentOtveta>
+  ЭДО_ПолучитьПустойКонтентОтветаДляДокумента <methods/JeDO_Poluchit'PustojKontentOtvetaDljaDokumenta>
+  ЭДО_ПолучитьРеквизитыДокумента <methods/JeDO_Poluchit'RekvizityDokumenta>
+  ЭДО_ПолучитьСохраненныеДанныеДляОтправкиОтвета <methods/JeDO_Poluchit'SohranennyeDannyeDljaOtpravkiOtveta>
+  ЭДО_ПолучитьТабличнуюЧастьИзКонтентаXML <methods/JeDO_Poluchit'TablichnujuChast'IzKontentaXML>
+  ЭДО_ПолучитьХранилищеКонтента <methods/JeDO_Poluchit'HranilishheKontenta>
+  ЭДО_Служебные_АдресЯщикаКонтрагента <methods/JeDO_Sluzhebnye_AdresJashhikaKontragenta>
+  ЭДО_Служебные_ДобавитьКолонкиВТаблицуЗначений <methods/JeDO_Sluzhebnye_Dobavit'KolonkiVTablicuZnachenij>
+  ЭДО_Служебные_ДобавитьСтрокуВТаблицуЗначений <methods/JeDO_Sluzhebnye_Dobavit'StrokuVTablicuZnachenij>
+  ЭДО_Служебные_МассивВСтроку <methods/JeDO_Sluzhebnye_MassivVStroku>
+  ЭДО_Служебные_ПолучитьРезультатЗапроса <methods/JeDO_Sluzhebnye_Poluchit'Rezul'tatZaprosa>
+  ЭДО_СохранитьИОтправитьПакет <methods/JeDO_Sohranit'IOtpravit'Paket>
+  ЭДО_СписокМаршрутовСогласованияВДиадоке <methods/JeDO_SpisokMarshrutovSoglasovanijaVDiadoke>
+  ЭДО_СписокПользователейДиадока <methods/JeDO_SpisokPol'zovatelejDiadoka>
+  ЭДО_СправочникМенеджер_ЗначениеДопРеквизита <methods/JeDO_SpravochnikMenedzher_ZnachenieDopRekvizita>
+  ЭДО_СправочникМенеджер_ПолучитьСписокЭлементов <methods/JeDO_SpravochnikMenedzher_Poluchit'SpisokJelementov>
+
+

docs/source/func/pm/Poluchit'TekstZaprosaDlyaSpiskaPaketovNaOtpravkuPoMassivuVidovPaketov.rst

@@ -1,6 +1,6 @@
 
-Получить текст запроса для списка пакетов на отправку по массиву видов пакетов
-==============================================================================
+ПолучитьТекстЗапросаДляСпискаПакетовНаОтправкуПоМассивуВидовПакетов
+====================================================================
 
 **Синтаксис:**
 

docs/source/func/pm/Poluchit'_Zapolnennyy_Obyekt_Dokumenta_1S.rst

@@ -25,12 +25,16 @@
 
 **Возвращает:**
 
-Структура
+Структура 
 
+<<<<<<< HEAD
       **Элементы структуры:**
 
       * **ОписаниеОшибки** (тип Строка или Неопределено) — содержатся ошибки при создании документа.
 
       * **ОсновнойОбъект** (ссылка на документ или Неопределено) — созданный документ 1С.
+=======
+Создание и добавление элементов структуры происходит с помощью метода ОсновнойМодуль.НовыйРезультатФункции() (см. :doc:`НовыйРезультатФункции <../../objects/NovyjRezul'tatFunkcii>`).
+>>>>>>> 0f3b62858c7cc2c05517f45be2a7f36bf7529988
 
 Пример использования: :doc:`Как обработать входящий пакет документов <../../proc/pm/Obrabotka_Vkhodyashchikh_Paketov>`

docs/source/func/pm/Prochitat'_Sopostavlenie_Nomenklatury.rst

@@ -22,8 +22,12 @@
 
 Структура
 
+<<<<<<< HEAD
       **Элементы структуры:**
 
       * **ОписаниеОшибки** (тип Строка),
 
-      * **ОсновнойОбъект** (тип Неопределено).
+      * **ОсновнойОбъект** (тип Неопределено).
+=======
+Создание и добавление элементов структуры происходит с помощью метода ОсновнойМодуль.НовыйРезультатФункции() (см. :doc:`НовыйРезультатФункции <../../objects/NovyjRezul'tatFunkcii>`).
+>>>>>>> 0f3b62858c7cc2c05517f45be2a7f36bf7529988

docs/source/func/pm/Sopostavit'_Nomenklaturu_Postavshchika.rst

@@ -20,10 +20,14 @@
 
 Структура
 
+<<<<<<< HEAD
       **Элементы структуры:**
 
       * **ОписаниеОшибки** (тип Строка),
 
       * **ОсновнойОбъект** (тип Неопределено).
+=======
+Создание и добавление элементов структуры происходит с помощью метода ОсновнойМодуль.НовыйРезультатФункции() (см. :doc:`НовыйРезультатФункции <../../objects/NovyjRezul'tatFunkcii>`).
+>>>>>>> 0f3b62858c7cc2c05517f45be2a7f36bf7529988
 
 Пример использования: :doc:`Как обработать входящий пакет документов <../../proc/pm/Obrabotka_Vkhodyashchikh_Paketov>`

docs/source/glosary/glosary.rst

@@ -0,0 +1,4 @@
+Глоссарий
+===========
+
+Протоструктура  —  сущность, которая предоставляет объектную модель работы с данными электронного документа. Состав полей протоструктуры зависит от формата электронного документа.

docs/source/index.rst

@@ -20,6 +20,7 @@
   :caption: Процедуры и функции
 
   Функции подключаемого модуля <Functions_PM>
+  Методы универсальнго модуля <Methods_UM>
 
 .. toctree::
   :maxdepth: 1
@@ -28,3 +29,9 @@
   Основные структуры <Основные структуры>
   Дополнительные структуры <Дополнительные структуры>
   Форматы документов <Форматы документов>
+
+.. toctree::
+  :maxdepth: 1
+  :caption: Глоссарий
+
+  Глоссарий <glosary/glosary>

docs/source/methods/DD_API_Poluchit'PolnomochijaPodpisanta.rst

@@ -0,0 +1,35 @@
+DD_API_ПолучитьПолномочияПодписанта
+=======================================
+
+**Синтаксис:**
+
+DD_API_ПолучитьПолномочияПодписанта
+
+**Описание:**
+
+Возвращает коллекцию полей, содержащих сведения о подписанте, организации подписанта, его должности и полномочиях.
+
+**Входные параметры:**
+
+      * **BoxID** (тип Строка) — идентификатор ящика организации в Диадоке.
+      * **ВидДокумента** (тип Строка) — идентификатор вида электронных документов. Возможные варианты: Utd, Utd820, Ucd, Ucd736, TovTorg551, AccCert552, Torg2.
+      * **ПокупательПродавец** (тип Строка) — указатель роли подписанта. Возможные варианты: Покупатель, Продавец.
+      * **ОтпечатокСертификата** (тип Строка) — хэш сертификата подписанта. Значение по умолчанию Неопределено. При установке значения по умолчанию будет использован отпечаток сертификата из текущего контекста сеанса (см. :doc:`ЭДО_КонтекстСеансаКлиентСервер <../../methods/JeDO_KontekstSeansaKlientServer>`).
+
+**Возвращает:**
+
+Структура — коллекция сведений о лице, подписывающем документы.
+
+        **Элементы структуры:**
+
+      * **Surname** (тип Строка) — фамилия подписанта.
+      * **FirstName** (тип Строка) — имя подписанта.
+      * **Patronymic** (тип Строка) — отчество подписанта.
+      * **JobTitle** (тип Строка) — должность подписанта в организации.
+      * **Inn** (тип Строка) — ИНН подписанта.
+      * **SignerType** (тип Строка) — тип подписанта. :ref:`Возможные значения<rst-markup-bz>`.
+      * **SignerOrganizationName** (тип Строка) — наименование организации подписанта.
+      * **SignerInfo** (тип Строка) — иные сведения, идентифицирующие физическое лицо.
+      * **SignerPowers** (тип Строка) — область полномочий. :ref:`Возможные значения<rst-markup-Powers>`.
+      * **SignerStatus** (тип Строка) — статус подписанта. :ref:`Возможные значения<rst-markup-Status>`.
+      * **SignerPowersBase** (тип Строка) — основания полномочий подписанта.

docs/source/methods/DD_Komponenta_Poluchit'PustojKontent.rst

@@ -0,0 +1,19 @@
+ДД_Компонента_ПолучитьПустойКонтент
+=============================================
+
+**Синтаксис:**
+
+ДД_Компонента_ПолучитьПустойКонтент
+
+**Описание:**
+
+Возвращает XDTO объект документа в терминах :doc:`протоструктуры <../../glosary/glosary>`.
+
+**Входные параметры:**
+
+      * **ИмяКонтента** (тип Строка) — идентификатор типа протоструктуры;
+      * **СоздатьВсеСвойства** (тип Булево) — Истина, если требуется проинициализировать полностью объект. Значение по умолчанию Истина.
+
+**Возвращает:**
+
+ОбъектXDTO — XDTO объект документа в терминах протоструктуры публичного API Диадока.

docs/source/methods/DataXML_v_Data1S.rst

@@ -0,0 +1,18 @@
+ДатаXML_в_Дата1С
+=============================================
+
+**Синтаксис:**
+
+ДатаXML_в_Дата1С
+
+**Описание:**
+
+Переводит дату из формата Строка в формат XML.
+
+**Входные параметры:**
+
+      * **ДатаXML** (тип Строка) — строковое представление даты (YYYY.MM.DD).
+
+**Возвращает:**
+
+Дата в формате XML.

docs/source/methods/DvoichnyeDannye_V_Tekst.rst

@@ -0,0 +1,19 @@
+ДвоичныеДанные_В_Текст
+=============================================
+
+**Синтаксис:**
+
+ДвоичныеДанные_В_Текст
+
+**Описание:**
+
+Достает из текстового файла содержимое. Корректно обрабатывает все расширения текстовых файлов. Другие типы файлов будут преобразованы в строку с набором символов.
+
+**Входные параметры:**
+
+      * **ДД** (тип ДвоичныеДанные) — двоичные данные файла.
+      * **ТипФайла** (тип Строка) — кодировка текста в открываемом файле. Необязательный параметр.
+
+**Возвращает:**
+
+Строка с текстом из документа.

docs/source/methods/FunkcijaDokumentaDljaXML.rst

@@ -0,0 +1,26 @@
+ФункцияДокументаДляXML
+=============================================
+
+**Синтаксис:**
+
+ФункцияДокументаДляXML
+
+**Описание:**
+
+Преобразует идентификатор функции электронного документа из терминов :doc:`протоструктуры <../../glosary/glosary>` в термины XML. 
+
+Пример:
+
+* Для УПД (ТипДокумента = UniversalTransferDocument) Invoice —> СЧФ, InvoiceAndBasic —> СЧФДОП; 
+* Для УКД (ТипДокумента = UniversalCorrectionDocument) Invoice —> КСЧФ, InvoiceAndBasic —> КСЧФДИС.
+
+
+**Входные параметры:**
+
+      * **ТипДокумента** (тип Строка) — название типа документа,
+
+      * **ФункцияДокумента** (тип Строка) — название функции документа.
+
+**Возвращает:**
+
+Строка с названием функции документа, значение которого указывается в XML файле.

docs/source/methods/InicializacijaTipovogoModulja.rst

@@ -0,0 +1,21 @@
+ИнициализацияТиповогоМодуля
+=============================================
+
+**Синтаксис:**
+
+ИнициализацияТиповогоМодуля
+
+**Описание:**
+
+Создает типовой модуль из макета вызывающего модуля, или из "каталога с модулем" в случае режима  :doc:`отладки <../../Описание процессов/Otladka>`.
+
+**Входные параметры:**
+
+      * **ИмяФайлаСМодулем** (тип Двоичные данные, Строка) — типовой модуль из макета или каталог, где лежит модуль в режиме  :doc:`отладки <../../Описание процессов/Otladka>`.
+      * **РежимУправляемыхФорм** (тип Булево) — Истина, если используются управляемые формы.
+      * **РежимОтладки** (тип Булево) — Истина, если типовой модуль подключается в режиме :doc:`отладки <../../Описание процессов/Otladka>`.
+      * **КаталогСМодулем** (тип Строка) — каталог вложенных обработок для отладки.
+
+**Возвращает:**
+
+ВнешняяОбработка — объект модуля.

docs/source/methods/Ispol'zovat'PodsistemuDiadoka.rst

@@ -0,0 +1,14 @@
+ИспользоватьПодсистемуДиадока
+=============================================
+
+**Синтаксис:**
+
+ИспользоватьПодсистемуДиадока
+
+**Описание:**
+
+Проверяет, используется ли подсистема хранения Диадок.
+
+**Возвращает:**
+
+Булево — Истина, если используется подсистема хранения Диадок.

docs/source/methods/JeDO_Avtorizovat'sjaPodLoginom.rst

@@ -0,0 +1,20 @@
+ЭДО_АвторизоватьсяПодЛогином
+=============================================
+
+**Синтаксис:**
+
+ЭДО_АвторизоватьсяПодЛогином
+
+**Описание:**
+
+Получает авторизационный токен по имени и паролю. Используется в регламентных заданиях.
+
+**Входные параметры:**
+
+      * **Логин** (тип Строка) – имя пользователя в сервисе Диадок,
+
+      * **Пароль** (тип Строка) – пароль пользователя в сервисе Диадок.
+
+**Возвращает:**
+
+Строка – авторизационный токен.