Интерактивные электронные технические руководства

 

    3.3 Сопровождение данных

 

    При внесении изменений структура БД должна обеспечивать автоматическое изменение  всех объектов и связей, затрагиваемых  таким изменением. Эти требования касаются:

    а) удаления, добавления или изменения  отдельных информационных объектов или их атрибутов;

    б) изменения отношений, включая создание новых связей или удаление старых связей.

 

    3.4 Переносимость данных

 

    Для обеспечения переносимости и  мобильности данных физическое хранилище  данных должно обеспечивать загрузку (ввод) данных, а также выгрузку (вывод) данных, представленных в формате ИСО 8879 и соответствующих требованиям настоящего документа, а также спецификациям стиля CSS Level 2.

 

    3.5 Обмен информацией с системой управления данными об изделии (PDM)

 

    Для актуализации содержимого базы данных ИЭТР рекомендуется использовать уже имеющуюся цифровую информацию об изделии, накопленную при его проектировании или модернизации. Как правило, эти данные хранятся в системе управления данными об изделии (PDM). Взаимодействие компьютерной системы разработки ИЭТР с системами PDM может осуществляться в соответствии с ГОСТ Р ИСО 10303-21 либо ГОСТ Р ИСО 10303-22.

 
 
 
 
 
 
 

    4. Шаблоны

 

    Для описания информационных объектов используются шаблоны (templates), регламентирующие перечень обязательных атрибутов и иерархию объектов. Каждый информационный объект должен быть описан в каком-либо шаблоне. Шаблон содержит две составляющие: набор семантических правил и перечень атрибутов. Различают три вида шаблонов: простой, шаблон последовательности и шаблон альтернатив.

    Шаблоны используются при создании логической структуры БД конкретного ИЭТР следующим образом:

    - простой шаблон указывает, что  при создании БД должен быть  создан отдельный объект с  заданными атрибутами и связями;

    - шаблон последовательности указывает,  что при создании структуры БД должно быть создано несколько объектов, связанных в указанной последовательности;

    - шаблон альтернатив указывает,  что в структуре базы данных, используемой для разработки  ИЭТР, создается несколько объектов  в соответствии со списком,  указанным в шаблоне.

    В процессе публикации конкретного ИЭТР в соответствии с сделанным выбором  в базу данных этого ИЭТР попадает только один объект.

 

    4.1 Простой шаблон

 

    Общее описание шаблонов в терминах SGML приведено  ниже.

    <!ELEMENT NODE - - (version*, link*, (NODE | NODE-ALTS |

 

                                        NODE-SEQ %primitive; )*) >

    <!ENTITY % a.node

    «id             ID                #IMPLIED

    Name         CDATA      IMPLIED

    Type          CDATA      #IMPLIED

    Itemid        CDATA      #IMPLIED

    Cdm          NAME        #FIXED 'node'

    Ref            IDREF        #CONREF

    Version     IDREF        #IMPLIED”>

    Первый  объект в модели содержания - версия (version) - используется для соотнесения  данных с вариантами конфигурации изделия.

    Второй  объект (link) задает перечень ссылок на объекты, связанные по смыслу. Используется для навигации внутри ИЭТР и прямых переходов от одного раздела к другому.

    Шаблон  содержит указание о том, что описываемый  составной информационный объект может  включать в себя другие объекты, которые  в свою очередь должны соответствовать  простому шаблону, шаблону альтернатив  или шаблону последовательности, или могут представлять собой примитивы.

    Макрос a.node описывает обязательные атрибуты описываемого объекта:

    1   Id            - уникальный идентификатор объекта. Используется для организации ссылок;

    2   Name      - название раздела документа, содержащегося в данном объекте;

    3   Itemid      - обозначение изделия, к которому относится данный раздел;

    4   Ref          - атрибут, используемый для исключения дублирования информации;

    5   Type        - тип объекта;

    6   Cdm        - атрибут, указывающий, что объект относится к простому шаблону;

    7   Version   - ссылка на объект version. Указывает, к какой версии относится данный объект.

 

    4.2 Шаблон последовательности

 

    Шаблон  последовательности является механизмом для создания интерактивных последовательностей общения с пользователем. Шаблон последовательности определяется следующим образом:

    <!ELEMENT NODE-SEQ - - ( NODE NODE-ALTS)+ >

    <!ENTITY % a.node-seq

 

              "id              ID               #IMPLIED

 

              Cdm           NAME       #FIXED 'node-seq'

 

              Ref             IDREF       #CONREF" >

    В отношении шаблона последовательности действуют следующие правила:

    - любой объект, описываемый шаблоном  последовательности, должен содержать  объекты, соответствующие простому  шаблону или шаблону альтернатив;

    - объекты отображаются для пользователя  в том порядке, в котором  они перечислены в шаблоне.

 

    4.3 Шаблон альтернатив

 

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

    

    Рисунок 2

 

    <!ELEMENT "NODE-ALTS" - - ( NODE )+ >

    <!ENTITY % a.node-alts

 

                              "id             ID                  #IMPLIED

 

                              Cdm          NAME          #FIXED 'node-alts'

 

                              Ref            IDREF          #CONREF" >

    К любому объекту, описываемому шаблоном альтернатив, относятся следующие  правила (рисунок 2):

    - составной объект может содержать  более простые объекты, соответствующие простому шаблону;

    - объекты должны принадлежать  к одному типу и находиться  на одном уровне иерархии;

    - объекты должны относиться к  разным вариантам конфигурации  или версиям изделия;

    - для каждой возможной конфигурации (версии) должен быть задан свой информационный объект.

 

     5. Примитивы общего типа

 

    Простые информационные объекты (примитивы) общего типа предназначены для хранения текстовой, графической, аудио- и видеоинформации. Примитивы общего типа делятся на три группы: служебные объекты, визуализируемые объекты, объекты диалога.

    К служебным (не визуализируемым) объектам относятся link (ссылка) и version (версия). Объект link позволяет пользователю осуществлять навигацию по базе данных, двигаясь по сети возможных переходов от раздела к разделу. Объект version (версия) используется для обозначения вариантов конфигурации или версий изделия.

    Визуализируемые объекты предназначены для составления  параграфа ИЭТР - основной смысловой  единицы технических данных, представляющей собой линейный гипертекстовый документ.

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

    В соответствии с требованиями настоящего документа, каждый объект общего типа относится к какому-либо шаблону, описанному в предыдущем разделе. К объектам общего типа (примитивам) могут быть применены различные спецификации стиля, соответствующие CSS2.

 

    5.1 Служебные объекты

 

    Служебные объекты предназначены дня структурирования данных и создания гипертекстовых связей внутри базы данных.

 

    5.1.1 Ссылка

 

    Объект link обеспечивает навигацию внутри базы данных ИЭТР и взаимосвязь объектов. Любой объект, соответствующий простому шаблону, может иметь одну или более ссылок на другие объекты. Декларация объекта link приведена ниже:

    <!ELEMENT link - - ( #PCDATA) >

    <!ATTLIST link

 

         %a.node;

 

         Xref            IDREF        #REQUIRED>

    Атрибут xref указывает на целевой объект ссылки, то есть на объект, который будет представлен пользователю, активизировавшему данную ссылку. Текстовые данные (#PCDATA), включенные в модель содержания, представляют собой необязательное текстовое описание данной ссылки.

    Пример  применения ссылки в  документе SGML:

    <text id=34 name=”Инструкция по ...”>

 

              <link xref=278> Переход  на техническое описание

 

              </link>

 

              <link xref=279> Переход  на диагностику неисправностей

 

              </link>

 

              Инструкция  по эксплуатации .........

 

              </text>

 

              .........

 

              <techdesc id=278> Техническое  описание ...... </techdesc>

 

              < faults id=279> Диагностика  неисправностей ...... </faults>

 

              .........

 

    5.1.2 Версия

 

    Объект version включен в декларацию простого шаблона, что обеспечивает возможность задания в базе данных несколько версий для одного объекта. Декларация объекта version приведена ниже:

    <!ELEMENT version - - #PCDATA)>

    <!ATTLIST version %a.node; >

    Текстовые данные (#PCDATA), включенные в модель содержания, должны представлять собой описание версии. Атрибут name должен содержать обозначение версии. Объект version используется только на этапе разработки ИЭТР. При публикации конкретного ИЭТР выбирается и переносится в БД ИЭТР только та версия, которая актуальна для данного заказчика.

    Пример  использования описания версий в документе SGML:

    <techdesc namе=”Техническое описание ...”>

 

              <version id=”Vl”  пате=”Вариант для внутреннего  рынка”>

 

              </version>

 

              <version id=”V2” пате=”Экспортный вариант”>

 

              </version>

 

              </techdesc>

    5.2 Визуализируемые объекты

    Визуализируемые объекты предназначены для построения линейных гипертекстовых документов, представляемых пользователю посредством  ЭСО в виде единого целого. Линейный документ представлен объектом para (параграф).

 

    5.2.1 Параграф

 

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

    Совокупность  примитивов, составляющих параграф, описывается  объектом primitive. Примитивы могут соответствовать простому шаблону или шаблону альтернатив. Декларации примитивов приведены ниже:

    <!ENTITY % text              “text      | text-alts”>

    <!ENTITY % list               “list       | list-alts”>

    <!ENTITY % table            “table    | table-alts”>

    <!ENTITY % graphic                  “graphic | graphic-alts”>