Formula Editor

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

Требованиям к тормозам, датчикам или контурам управления часто нужна формула: тормозной путь, допуск, фильтр. В DOORS Next нет редактора формул. Команды вставляют снимок экрана из Word, который потом никто не может изменить без исходного файла, или набирают формулу обычным текстом, который трудно читать.

Formula Editor позволяет писать формулу в LaTeX прямо в DOORS Next. Он рисует формулу по мере ввода и вставляет её в модуль как изображение, в новом артефакте после выбранного или в выбранном артефакте. LaTeX сохраняется вместе с артефактом, поэтому, если позже выбрать формулу, она снова откроется в редакторе.

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

• Формулы, вставленные как снимки экрана, которые никто не может изменить без файла Word, из которого они взяты.
• Формулы, набранные обычным текстом, например s = v^2/(2*mu*g), которые трудно читать на ревью и в экспорте.
• Изображения формул, которые больше не совпадают с текстом после того, как одно из них изменили вручную.
• Переход в другой инструмент и копирование изображений обратно для каждой новой или изменённой формулы.

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

• Видно во время ввода: предпросмотр рисует формулу, пока вы пишете, и показывает размер изображения.
• Можно изменить позже: LaTeX хранится в артефакте, поэтому выбранная формула открывается снова, а Update рисует новое изображение.
• Текст сохраняется: Update для артефакта с текстом добавляет формулу после текста и сохраняет слова.
• Без стороннего сайта: формулу рисует MathJax в вашем браузере; она не отправляется в онлайн-редактор.
• Ошибки с указанием места: недостающая фигурная скобка или неизвестная команда показывается под полем вместе с символом, на котором она находится.

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

1. Откройте модуль и выберите один артефакт.
2. Введите формулу в LaTeX или нажимайте кнопки под полем: дробь, корень, степень, индекс, сумма, интеграл, греческая буква, плюс-минус и матрица. More symbols показывает ещё 21. Предпросмотр показывает изображение и его размер.
3. Нажмите Insert, чтобы добавить формулу в новом артефакте после выбранного, или Update, чтобы записать её в выбранный артефакт. Прочитайте подтверждение и нажмите Insert formula или Update formula.
4. Блок результата показывает, что было сделано, а Log скачивает отчёт об изменениях.
5. Чтобы изменить формулу, выберите её в модуле. Она откроется в виджете (Editing 1531 …); измените LaTeX и нажмите Update.

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

• Работайте в наборе изменений (change set), чтобы его можно было отменить, если результат не устроит. Новый артефакт сохраняется сразу.
• Изображение — это PNG, сохранённый на сервере DOORS Next и нарисованный в двойном размере, чтобы оставаться чётким на экране и в экспорте. В Settings есть три размера: S, M и L.
• LaTeX записывается в атрибут с именем Formula, если он есть в проекте, и всегда в описание изображения, поэтому формула открывается снова и в проекте без этого атрибута.
• Новые артефакты получают тип выбранного артефакта. В Settings можно выбрать для Insert другой тип артефакта проекта; виджет запоминает его для каждого проекта. Update сохраняет тип.
• Если изображение формулы было заменено вручную, виджет сообщает об этом, а подтверждение Update предупреждает, что это изменение будет потеряно. LaTeX всегда главнее.