Зачем это надо
Каждый, кто сталкивался с разработкой и сопровождением достаточно сложных систем, знает, насколько ценно бывает знать и хранить информацию об изменениях, их причинах и истории. Также возникает необходимость держать где-то информацию для техподдержки с описанием принципов работы и/или информацию для пользователей. На текущий момент из инструментов есть встроенный хелп 1С и конфигурация СППР. И то и другое достаточно неудобно по ряду причин.
Например, встроенный хелп невозможно редактировать, не внося изменения в конфигурацию, со всеми вытекающими.
В СППР неудобная синхронизация. Ну масса неудобств и неоднозначностей в использовании.
В результате, даже если в начале времени и желания на создание описаний хватает – то очень скоро из-за неудобства люди начинают «забывать» вносить туда информацию и ценность такой системы резко падает. Данная система не зависит от обновлений и не требует специальных знаний.
Цели
- Создание функционального описания конфигурации в единообразном стиле
- Доступность описания
- Привычный вид описания (википедия прочно вошла в жизнь каждого)
- Простота корректировки описания
- Простота организации структуры, перекрестных ссылок, взаимосвязей объектов
- Описание структуры объектов и их взаимосвязей в конфигурации
- ...
Возможности
- Редактирование статей вики из 1С
- Категоризация статей - возможно иметь произвольное дерево категорий в Вики. Статья может принадлежать любому количеству категорий
- Автоматическое построение взаимосвязей
- Единообразие статей за счет использоавния шаблонов
- Описание объектов строятся на основании структуры метаданных конфигурации
- Ведение полной истории изменений каждой статьи с указанием авторства, возможность отмены правок
Примеры описаний
Требования
Версия платформы 1С >= 8.2.17; специальных разрешений модальности/синхронных вызовов не требуется
Сайт под управлением MediaWiki версии 1.26 и старше с установленным расширением Semantic MediaWiki
Инструкция по установке сайта с необходимыми расширениями
Интеграция
Скачать конфигурацию с подсистемой, либо клонировать репозиторий из проекта на Bitbucket и загрузить конфигурацию из файлов
Сравнить, объединить с целевой конфигурацией.
Добавить код вызова подсистемы в модули
Использование
Редактирование текстов происходит в обработке Вики. Редактор
Для настроек и администрирования используется обработка Вики. Администрирование
Тестировалось
На версиях платформы 8.2.19.83, 8.3.6.2332, 8.3.10.2505 ОС Windows
См. также
Статья по Semantic Mediawiki на хабре
Порядок обновления подсистемы
История версий
0.4.4.2
+ Редактор. Добавление/изменение/удаление изображений в редакторах
+ Общее. Добавление/изменение/удаление изображений, загруженных на сайт Вики
* Интерфейсные правки
0.3.4.5
* Общее. Все изменяемые алгоритмы вынесены в выбираемые адаптеры. Возможность назначения используемых адаптеров.
- Общее. Требование использования модальных окон. Унификация вызовов диалогов по асинхронным вызовам, эмуляция асинхронных вызовов для платформы 8.2
0.3.4.4
+ Общее. Выделение выбранных категорий, включая родителей в деревьях выбора категорий
+ Настройки. Возможность указать таймаут соединения (время ожидания ответа).
+ Настройки. Выбор использования фильтра по подсистемам при выборе объекта метаданных.
+ Общее. Значительно уменьшено время записи страницы (примерно в 3.5 раза).
+ Общее. Добавлена типизация используемых семантических свойств.
- Администрирование. Удалена возможность очистки кэша - неизвестное время выполнения на больших количествах страниц. Необходимо использовать обновление ссылок.
- Ошибка получения обработки адаптера диалога в толстом клиенте обычном приложении.
- Ошибка трансляции содержания при наличии пустых форматированных строк.
- Удалено построение обратной связи (объект используется в) объектов. Связано с превышением допустимого размера страницы при наличии нескольких реквизитов составных типов в объекте.
0.3.4.3
+ Администрирование. Управление баннерами категорий.
+ Администрирование. Очистка кэша страниц сайта
+ Администрирование. Обновление ссылок на страницах сайта
+ Общее. Длительные операции выполняются в фоновых заданиях.
- Ошибка ограничения доступа к обработке обновления
0.3.4.2
* Общее. Составные типы реквизитов при возможности сворачиваются до ссылок на категории объектов.
+ Общее. Возможность описания констант, планов счетов, планов обмена, планов видов характеристик.
+ Администрирование. Управление пользователями сайта - создание, изменение ролей пользователей на сайте Вики
+ Администрирование. Обновление страниц - контроль версии конструктора , использовавшегося при построении страниц, обновление состава и структур страниц сайта
- Ошибка получения описания реквизита при его переименовании в конфигурации.
0.2.4.6
Стабильная опубликованная версия
