!!!Система отслеживания версий семейств (в разработке)

Система параметров для отслеживания изменений в семействах Revit, интеграция с плагином RLM и защита от редактирования.

Основные компоненты

Отображаемые параметры: Отображаются в проекте, защищены от редактирования.
Скрытые параметры: Управляются плагином, хранят исходные данные.
Плагин RLM: Автоматизирует обновление, проверку целостности и аудит изменений

Параметры версии# Скрытые параметры (защищенные)#

Скрытые параметры с префиксом ITEMsys_ хранят реальные данные и защищены от редактирования.

Принцип работы

Скрытые параметры используются для хранения данных, таких как версия, дата, автор и описание. Их нельзя изменить напрямую из проекта, что предотвращает случайные изменения.

Список скрытых параметров#

Параметр	Тип	Описание
`ITEMsys_VersionNumberLock`	Text	Номер версии
`ITEMsys_VersionDateLock`	Text	Дата версии
`ITEMsys_VersionAuthorLock`	Text	Автор версии
`ITEMsys_VersionChangesLock`	Text	Описание изменений

Отображаемые параметры#

Отображаемые параметры ссылаются на скрытые через формулы, обеспечивая безопасный доступ к данным.

Формулы

Например, VersionNumber = _VersionNumberLock. Изменение отображаемых параметров не повлияет на скрытые.

Список отображаемых параметров#

Параметр	Тип	Формула	Описание
`VersionNumber`	Text	`= _VersionNumberLock`	Номер версии для отображения
`VersionDate`	Text	`= _VersionDateLock`	Дата версии для отображения
`VersionAuthor`	Text	`= _VersionAuthorLock`	Автор версии для отображения
`VersionChanges`	Text	`= _VersionChangesLock`	Описание изменений для отображения

Итог

Защита данных: Скрытые параметры ( ITEMsys_ ) недоступны для редактирования, что предотвращает случайные изменения .
Гибкость: Отображаемые параметры могут быть использованы в шаблонах, запросах или отчетах, сохраняя реальные данные в безопасности .
Согласованность: Формулы гарантируют, что отображаемые данные всегда соответствуют скрытым.

Важно (в разработке)

Изменение скрытых параметров возможно только через специальные процедуры (например, скрипты или интерфейс плагина), а не напрямую.

1. VersionNumber (Номер версии)#

Примечание

Используем семантическое версионирование вместо простых "v1", "v2":

Major: Крупные изменения (несовместимые с проектами).
Minor: Добавление функционала (совместимо).
Patch: Исправления ошибок.
Пример:#
1.0.0: Начальная версия.
1.1.0: Добавлен параметр материала.
1.1.1: Исправлена геометрия.

2. VersionDate (Дата версии)#

Примечание

Формат: yyyy-MM-dd.
Источник: Задаётся плагином через DateTime.Now.
Пример: 2025-01-01.

3. VersionAuthor (Автор версии)#

Примечание

Данные: Имя пользователя берется из Revit через app.Username .
Пример: Если вы вошли как Piminov, это значение попадет в параметр VersionAuthor.

Интеграция с плагином RLM (в разработке)# Процесс обновления#

Пример

Плагин проверяет VersionLock для блокировки редактирования.
Обновляет скрытые параметры (ITEMsys_VersionNumber, ITEMsys_VersionDate).

Управление версиями семейств Revit#

Для организации версий семейств используйте следующие правила:

1. Папка Versions/#

Информация

Создаётся отдельная папка для хранения всех версий семейств.
Структура:

Revit_Library/
└── Versions/
    └── "Имя семейства"/
        ├── 1.0.0.rfa
        ├── 1.1.0.rfa
        └── ...

Примечание

Для каждого семейства создайте подпапку с точным именем файла (без расширения).
В подпапке храните версии с именами в формате Major.Minor.Patch.rfa (например, 1.1.0.rfa).

2. Журнал изменений ChangeLog.txt (в разработке)#

Информация

В каждой подпапке Versions/"Имя семейства" создается файл ChangeLog.txt.

[!example]
Пример содержимого:

"Имя семейства"
1.0.0 - 2025-02-21 - Piminov - Начальная версия
1.1.0 - 2025-02-25 - Piminov - Добавлен параметр материала
1.1.1 - 2025-02-27 - Pimonov - Исправлена геометрия стекла

3. Правила работы#

Готово

Не изменяйте имена файлов версий (они являются уникальными идентификаторами).
Обновляйте ChangeLog.txt при каждом выпуске новой версии.
Используйте семантическое версионирование:
- Major — несовместимые изменения.
- Minor — добавление функционала.
- Patch — исправления ошибок.

[!warning]
Избегайте хранения версий в основной библиотеке (только в папке Versions/). Это предотвращает загрязнение рабочих проектов.

Пример полной структуры#

Пример

Revit_Library/
├── Families/                  # Основная библиотека
│   └── "Имя семейства".rfa
└── Versions/
    └── "Имя семейства"/
        ├── 1.0.0.rfa
        ├── 1.1.0.rfa
        └── ChangeLog.txt

Имя не меняется. Описание метаданные. Поменять формат даты на ISO. ITEMsys_ использовать для параметров автоматизации (изменения плагином или скриптом)