Правила построения структуры документа (DTD-Document Type Definition)

DTD содержит правила, по которым строится логическая структура документа. Аналогичным понятием по отношению к описанию структуры документа является понятие логической структуры базы данных, описывающей типы данных и их взаимосвязь. Описываемые в DTD элементы можно разбить на две группы – элементы первой группы предназначены для разбиения документа на смысловые модули, вторая группа элементов указывает программе-обработчику на необходимость специальной обработки некоторых частей данных. Первую группу элементов назовем ассоциативным видовым уровнем, вторую группу – родовым уровнем элементов SGML.

В приведенной схеме (рис.21) элементы: техническое описание, заголовок, версия изделия, система, информация о неисправностях, диагностика неисправностей, информация о детали, очевидно, являются элементами ассоциативного видового уровня, так как группируют данные (текст, картинки, видео) по смыслу и не несут кроме этого никакой другой информации. Элементы: текст, аудио, видео, изображение, таблица, столбец таблицы, напротив, не несут в себе никакой смысловой информации о содержании, а лишь являются указаниями для программы-обработчика, о том, что необходимо сгруппировать столбцы в таблицу, проиграть видео запись и т.п., то есть эти элементы принадлежат к родовому уровню.

 

 

 

Рис. 21. Схема документа

 

Перечень и взаимосвязи элементов ассоциативного видового уровня сильно зависят от специфики изделий, на которые производится техническое руководство (электроника, машиностроение, химическое производство и т.д.). Поэтому в каждой отрасли промышленности (или на отдельном предприятии) разрабатывается свой набор элементов видового уровня, а соответственно свой набор правил построения структуры документа, так называемые «видовые» DTD. По сути, такие DTD являются предметом отраслевого (или корпоративного) стандарта на эксплуатационную документацию в электронном виде.

Элементы родового уровня напротив, не зависят от специфики изделий (таблица является таблицей и в электронике, и в машиностроении).

Размеченный документ SGML

Размеченный документ SGML представляет собой текстовый файл, либо совокупность текстовых файлов, размеченных в соответствии с некоторым DTD.

Любой размеченный документ SGML должен начинаться с объявления типа документа:

<!DOCTYPE poem SYSTEM “defs.dtd”>

где после ключевого слова DOCTYPE указывается корневой элемент документа, затем (в большинстве случаев) ставится ключевое слово SYSTEM и указывается имя файла, в котором находится DTD. После такого объявления может идти непосредственно размеченный текст:

Таблица стилей

Третьей частью документа SGML является таблица стилей, определяющая способ отображения на дисплее тех или иных элементов, определенных в DTD. К сожалению, в данной области пока нет единства решений. В различных отраслях используются различные методики описания стилей элементов. Реально в мире используются три конкурирующие спецификации, регламентирующие синтаксис и семантику языка описания стилей:

- MIL28001 FOSI- (Formatted Output Specification Instance) – стандарт американского военного ведомства, используемый в интерактивных руководствах подрядчиков министерства обороны США;

- ISO DSSSL – (Dynamic Style, Semantic and Specification Language)- стандарт ISO, который, однако, не получил пока поддержки у производителей ПО;

- W3C CSS – (Cascading Style Sheets) – рекомендация WWW консорциума. Это популярный стандарт, используемый при разработке Web-страниц. Он широко поддерживается производителями.

5.3.Технология подготовки ИЭТР

 

Технология подготовки ИЭТР включает в себя (см. рис.15): создание структуры документа на основе правил, содержащихся в DTD, и структуры изделия; автоматическое наполнение созданной структуры документа данными из хранилища конструкторской информации с использованием PDM системы.

 

 

Рис.15. Технология подготовки ИЭТР

 

Сопряжение с хранилищем может быть реализовано с помощью текстового обменного файла, соответствующего требованиям стандарта ISO 10303-21. Основой любых руководств являются технические данные об изделии: его структура, состав, описание и характеристики. Эта информация порождается и используется на протяжении всего цикла разработки изделия. Поэтому основной принцип разработки ИЭТР – интеграция конструкторских данных об изделии с исходными данными для подготовки ИЭТР в единой информационной системе и осуществление разработки ИЭТР параллельно с разработкой изделия. Данный принцип позволяет избежать затрат на повторный ввод информации, облегчает коррекцию технических руководств вследствие изменения конфигурации изделия и снижает вероятность внесения некорректных данных в ИЭТР.

Важную роль в интеграции данных об изделии и данных технического руководства играет использование стандарта STEP для хранения и передачи конструкторской информации. Конструкторские данные, переданные системе подготовки ИЭТР в этом протоколе, позволяют спроектировать структуру сопроводительной документации в соответствии со структурой изделия, передать характеристики изделия, документы, ассоциированные с узлами изделия (см. рис.22).

 

 

Рис.22. Интеграция данных об изделии

Пример подготовки ИЭТР

1.Разработка DTD.
Определяется структура документа в виде фрагмента программы

 

<!ENTITY % nodeattrs " idID #IMPLIED name CDATA #IMPLIED type CDATA #IMPLIED ref IDREF #CONREF itemid CDATA #IMPLIED config CDATA #IMPLIED "> <!ENTITY % docattrs " docview (chapter,section,navigator,none) navigator bookmark (yes,no) no "> <!ELEMENT manual - - ((para | paraalts)?,techdesc,guide+,faults+)> руководство включает в себя параграф, альтернативный параграф, знак “?” – означает, что элемент (параграф или альтернативный параграф) необязательны. Документ обязательно включает одно техническое описание, одну или более инструкцию по эксплуатации, один или более раздел по устранению неисправности.

Разработка таблицы стилей.

Определяется разметка текста, цветовая палитра, способ отображения на дисплее и др.

 

PARA { display: block; font: normal normal 12pt Arial; text-indent: 0px; text-decoration: none; text-align: left; border-style: none; color: black; background-color: white; border-color: white; margin: 0px 0px 0px 0px; padding: 0px 19px 200px 19px; border-width: 0px 0px 0px 0px; } TEXT { display: block; border-style: none; border-colo: white; margin: 1px 1px 19px 1px; padding: 1px 1px 1px 1px; border-width: 0px 0px 0px 0px; }

 

 

3.Разработка структуры документа на основе правил, регламентированных в DTD.

 

 

 

Рис.23. Структура документа

 

5.Создание документа (наполнение данными).

Принцип формирования страницы документа - композиция из совокупности элементов: текст, изображение, таблица и т.д. (рис.24)

 

 

 

Рис.24. Создание документа