Captions

Что это и зачем

Спецификациям, которые экспортируются в Word или PDF, нужны рисунки и таблицы, пронумерованные по главам: Fig. 2.1, Fig. 2.2, Table 2.1. В DOORS Next подпись — это отдельный артефакт под рисунком или таблицей, которую она описывает, а её номер — обычный текст. Каждый новый рисунок, каждый перемещённый раздел и каждая новая глава сбивают нумерацию, а исправлять её вручную приходится, открывая подпись за подписью.

Captions нумерует все подписи модуля за один проход. Он читает главы модуля, вычисляет номер каждой подписи к рисунку и таблице, сначала показывает их, а затем записывает, заменяя только старый номер в начале каждой подписи.

Какие проблемы решает

• Номера рисунков и таблиц перестают соответствовать главам после того, как разделы добавили, переместили или удалили.
• Два рисунка с одним номером или пропуски в нумерации обнаруживаются только в экспортированном документе.
• Часы уходят на то, чтобы открывать подпись за подписью и вручную вводить номера перед ревью или выпуском.
• Подписи с разным оформлением номера («Figure 3:», «Fig. 1.2», без номера) в одном документе.

Преимущества

• Нумерация по главам: Fig. 2.1, Fig. 2.2, Table 2.1, с отдельными счётчиками для рисунков и таблиц, которые начинаются заново в каждой главе.
• Сначала посмотреть: до любых изменений предпросмотр показывает каждую подпись с текущим и новым номером.
• Текст подписи сохраняется: заменяется только старый номер; слова и их полужирное или курсивное начертание остаются как были.
• Можно безопасно запускать повторно: подписи, у которых номер уже верный, не перезаписываются, а отчёт об изменениях в Excel хранит каждый текст до и после.

Как пользоваться

1. Обязательно: Captions работает, только если в проекте есть тип артефакта с именем Caption. Подписи — это артефакты этого типа, каждая под своим рисунком или таблицей; атрибут Caption Type (Figure или Table) необязателен.
2. Откройте модуль. В Settings нажмите Change, в New number at headings up to выберите, с какого уровня заголовка начинается новая нумерация (уровень 1: 1.1, 1.2 … затем 2.1), а в Caption text after the number — Keep the text, Only the number (remove the text) или атрибут рисунка либо таблицы, например Name. Нажмите Done.
3. В разделе Module нажмите Preview, чтобы увидеть в Captions каждую подпись с текущим номером, новым номером и новым текстом. Раскройте строку и нажмите Show in module, чтобы показать эту подпись в модуле.
4. Нажмите Number, прочитайте подтверждение и нажмите Number captions. Блок результата показывает, сколько подписей пронумеровано, добавлено, уже были верными или завершилось ошибкой, а Log скачивает отчёт об изменениях.

Полезно знать

• Запускайте Captions в наборе изменений (change set), чтобы его можно было отменить, если результат не устроит.
• Подписи до первой главы получают главу 0 (Fig. 0.1). Подпись без Caption Type нумеруется без слова, с собственным счётчиком.
• Атрибут Caption Type необязателен: без него Captions отличает рисунок от таблицы по слову в старом номере (Fig., Table) или по рисунку или таблице рядом с подписью. Рисунок или таблица без подписи получает новую подпись сразу под собой; это можно отключить в Settings.
• По умолчанию подпись выравнивается по центру, а имя её артефакта очищается, как в исходном виджете Captions; и то и другое можно отключить в Settings.
• Тип подписи, его атрибут и слова перед номерами (Fig., Table) можно изменить в настройках виджета, например для подписей на другом языке.
• Captions может также вписать текст подписи за вас: в Settings выберите атрибут рисунка или таблицы (например, его Name), и его значение будет записано после номера вместо старого текста, как в Fig. 1.2 Battery pack layout; пустое значение оставляет только номер. Выберите Only the number, чтобы убрать текст из всех подписей, или Keep the text, чтобы изменить только номера.