У меня есть требование включить (точно) механизм отслеживания моих требований в исходную документацию (в DITA). Например, требование IFU1234 указывает, что мы должны включить информацию об утилизации и переработке продукта. Я думал, что могу украсть тег 'draft-comment', чтобы указать номер моего требования в соответствующей теме. Затем у меня была бы возможность опубликовать PDF-файл с этими комментариями, чтобы показать, что я выполнил все свои требования в своем документе. А затем опубликовать окончательный PDF-файл без комментариев. Допустимо ли использование элемента draft-comment? Видите ли вы другой элемент, который больше подходит для моего варианта использования? (У нас, кстати, нет CMS.) Спасибо,
метаданные в контенте диты
Ответы (2)
Я согласен с Хулио: метаданные в прологе темы, вероятно, наиболее подходят, хотя вы можете использовать элемент данных практически в любом контексте.
Обратите внимание, что для DITA 1.3 мы добавляем новый домен «управление выпуском», который предоставляет явную разметку для использования в прологах карт и тем для сбора истории изменений, включая разметку, предназначенную для определения источника изменения, например проблемы в отслеживании проблем. система или формальное требование. Похоже на то, что вы ищете.
Если вы хотите иметь возможность отображать информацию о требованиях в некоторых выходных данных таким же образом, как черновик комментария может быть показан или скрыт, это будет довольно простой настройкой XSLT или PDF, например, использовать параметр времени выполнения DRAFT для отображения связанных требования каким-либо подходящим способом.
person
DrMacro
schedule
31.03.2014
Домен управления выпуском, который вы описываете, кажется именно тем, что мне нужно (но я не могу дождаться выпуска 1.3;)). Не могли бы вы рассказать о довольно простой настройке XSLT или PDF? Для меня настройки в новинку, я только настраиваю свой первый проект DITA.
- person annette.b; 01.04.2014
Я бы не стал использовать <draft-comment> таким образом. Что бы я сделал, так это использовать <othermeta> с требованием имени и содержанием, установленным в соответствии с требованиями, которым оно удовлетворяет. Затем я бы добавил обработку для вывода требования в одной версии вывода и использовал @outputclass на карте, чтобы отключить обработку.
person
JulioV
schedule
31.03.2014
Вы забыли пометить примеры тегов как код? Ответ немного сложен для чтения, и я подозреваю, что это потому, что вы предложили использовать элемент othermeta с именем атрибута (установленным в соответствии с требованиями) и содержимым, верно? Но эти элементы не отображаются в вашем ответе. Я бы все равно предложил это или элемент данных. Кстати, оба из них можно найти в элементе метаданных внутри пролога после заголовка темы.
- person Anders; 31.03.2014
Спасибо Хулио и Андерсу. Как и Андерс, мне пришлось дважды прочитать ваш ответ (я не являюсь носителем английского языка), но я думаю, что понял. Я попробую @outputclass (думал, что его можно использовать только для вывода HTML).
- person annette.b; 01.04.2014
