Перенос старого руководства
Источник: старое руководство TMA Platform.
Старый сайт остаётся источником исторических знаний, но его страницы нельзя переносить в новую документацию без проверки. Руководство создавалось в разные годы, содержит устаревшие Win32-сценарии, старые сигнатуры API, разделы с известными ошибками и материалы, относящиеся только к прежнему редактору.
Правило переноса
Каждая страница проходит три проверки:
- Символ, функция, свойство или объект существует в текущем исходном коде.
- Сигнатура и поведение подтверждены реализацией или рабочим приложением.
- Пример переписан в современном стиле и проверен на актуальной версии платформы.
После проверки материал включается в тематическую главу новой документации. Ссылка на старую страницу не считается документацией актуального поведения.
Карта разделов
| Старый раздел | Новое место | Решение |
|---|---|---|
| Статьи / Быстрый старт | development/quick-start.md |
Переписать под текущий редактор |
| Similar Pascal | будущий раздел language/ |
Перенести синтаксис после проверки парсера |
| Similar C | будущий раздел language/ |
Объединить с описанием языка |
| SQL | будущий раздел database/ |
Перенести диалект, параметры и ограничения |
| API | development/runtime-api.md и тематические главы |
Проверять каждый экспорт по коду |
| Объекты пользовательского интерфейса | development/forms-references.md |
Разделить Win32 и web-поведение |
| Администрирование | будущий раздел administration/ |
Актуализировать установку, БД и права |
| Анализ / Многомерный анализ | будущий раздел analysis/ |
Проверить на текущем модуле анализа |
| Версии платформы | changelog | Не переносить как пользовательское руководство |
| Баги | issue tracker / архив | Не включать в актуальную документацию |
| Видео | архив | Сохранить только ролики с актуальным UI |
Текущий статус
- Быстрый старт прикладника — перенесён и переписан.
- Модель приложения — описана заново по текущей архитектуре.
- Формы и справочники — перенесены на уровне актуальных сценариев.
- Runtime API — создана актуальная обзорная глава.
- HTTP API — перенесён и полностью обновлён с учётом статусов и cookies.
- Транзакции — описаны отдельно с автоматическими
COMMITиROLLBACK. - Выгрузка и загрузка приложений — описаны для нового файлового архива.
- SideMenu — описан как актуальный компонент формы.
Очерёдность дальнейшего переноса
- Базовый язык: типы, переменные, процедуры, функции, условия и циклы.
- Исключения,
Raise,Tryи транзакции. - SQL и работа с dataset.
- Полный каталог runtime API по группам.
- Контролы форм и события.
- Метаданные приложения и модулей.
- Файлы, XML, JSON, кодировки и Base64.
- Права доступа и администрирование.
- Анализ и отчёты.
При переносе приоритет имеет реальное поведение текущей платформы. Если старое руководство расходится с кодом, в новой документации фиксируется текущее поведение, а расхождение оформляется как задача на совместимость или исправление.