Skip to content

Commit 99cfde8

Browse files
committed
add documentations
1 parent df60bc3 commit 99cfde8

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

README.md

1.59 KB

Подсиcтема PAPI

Pretty API – Подсистема интеграционных инструментов.

Состав:

1. Алгоритмы Справочник "PAPI: Алгоритмы" - Позволяет решать алгоритмы. Алгоритм может содержать параметры. Параметр может быть предопределенным и вычисляемым. Выполнение алгоритма происходит с помощью модуля "PAPI: РаботаСАлгоритмами", функция РешитьАлгоритм.

Реквизиты:

  • Разрешен – Булево – Разрешает выполнение алгоритма. Если алгоритм запрещен значение реквизита ложь. При запрете выдаст ошибку с кодом "ALErr1", См. Справочник "PAPI: Шаблоны сообщений".
  • ИмяАлгоритма – Строка (200) – Ключ поиска алгоритма для программистов.
  • Комментарий – Строка – Информация по алгоритму.
  • Логировать – Булево – Указывает на необходимость записи в регистр сведений "PAPI: ЛогАлгоритмов".
  • Привилегированный – Булево – Признак запуска алгоритма в привилегированном режиме.
  • Настройки – ХранилищеЗначенией – Содержит структуру алгоритма, состоящую из кода алгоритма и параметров алгоритма.

Телеграмм канал разработчика

Pretty API – подсистемы интеграционных инструментов и сервисов, с полностью открытым кодом. Разрабатывается на платформе 8.3.24, в текущий момент в бою крутится на режиме совместимости 8.3.17.

Текущая версия PAPI 0.9.2.5

Карта репозитория

assets - Ресурсы, вспомогательные файлы.

demo - Cодержит файлы демонстранционных возможностей подсистемы.

  • dt - содержит базу demo.dt с демо данными.
  • cfe - содержит расширение ЛокализацияPAPI.cfe с дополнительными объектами, использованными в демо примерах.
  • additional - содержит различные обработки из примеров.
    • ДемоПодпискиНаСобытияДляPAPI.epf - обработка с примерами подписок на события.
    • ДемоПримерыPAPI.epf - в обработке содержатся примеры взаимодействия с Алгоритмами.
    • ДемоПримерыАлгоритмовPAPI.epf - содержит пример вызова внешнего Алгоритма.
    • ДемоПримерыМетодовPAPI.epf - содержит пример взаимодействия методов с внешней обработкой.

documentation - Cодержит документацию.

release - Cодержит релиз подсистемы PAPI.

  • additional - содержит вспомогательные обработки.
    • ПодпискиНаСобытияДляPAPI.epf - обработка с предзаполненными подписками на события.
  • cfe - содержит расширения:
    • ЛокализацияPAPI.cfe - пустое расширение, служит как вспомогательное расширение.
    • ПодсистемаPAPI_0_9_2_5.cfe - последняя версия PAPI.
    • ПодсистемаPAPI_0_9_2_4.cfe - предыдущая версия PAPI.

src - Cодержит исходники расширения ПодсистемаPAPI последней версии.

  • ПодсистемаPAPIzip - содержит файл с архивом исходников.
  • ПодсистемаPAPI - содержит файлы исходников.

Состав подсистемы PAPI:

Алгоритмы

Документация в процессе... Появится в ближайшее время.

documentation/algoritms.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
[Домой](/README.md)
2+
3+
<details>
4+
<summary>
5+
<b>1. Алгоритмы</b>
6+
</summary>
7+
Справочник "PAPI: Алгоритмы" - Позволяет решать алгоритмы. Алгоритм может содержать параметры. Параметр может быть предопределенным и вычисляемым. Выполнение алгоритма происходит с помощью модуля "PAPI: РаботаСАлгоритмами", функция РешитьАлгоритм.
8+
9+
#### Реквизиты:
10+
11+
- Разрешен – Булево – Разрешает выполнение алгоритма. Если алгоритм запрещен значение реквизита ложь. При запрете выдаст ошибку с кодом "ALErr1", См. Справочник "PAPI: Шаблоны сообщений".
12+
- ИмяАлгоритма – Строка (200) – Ключ поиска алгоритма для программистов.
13+
- Комментарий – Строка – Информация по алгоритму.
14+
- Логировать – Булево – Указывает на необходимость записи в регистр сведений "PAPI: ЛогАлгоритмов".
15+
- Привилегированный – Булево – Признак запуска алгоритма в привилегированном режиме.
16+
- Настройки – ХранилищеЗначенией – Содержит структуру алгоритма, состоящую из кода алгоритма и параметров алгоритма.
17+
</details>
18+
19+
Документация в процессе... Появится в ближайшее время.

0 commit comments

Comments
 (0)