Configuration Control for Product Documentation

A Way of Integrating STEP & SGML

Page 8

Annex 3

A Typical Example

An example of the processes that are being examined here is:

Authoring Process

An designer (author) add specifications (pressure, operating temperatures, etc.) to the product design of a pump. An SGML_STRING is added as one of the specifications:

<SGML_STRING declaration_form="DESCRIPTION">

The <INSERT><QUERY component="pump.01" attribute="name"></INSERT>is designed to produce maximum efficiency (pressure=

<INSERT><QUERY component="pump.01" attribute="pressure_pascals"
</INSERT> pascals) at an operating temperature between 
<INSERT><QUERY component="pump.01" attribute="temperature_minimum">
</INSERT>%degree;C and <INSERT component="pump.01" attribute="temperature_maximum"> </SGML_STRING>(16)
%degree;C.
 

Publishing Process

The author of the operating manual (publisher), when including the SGML_STRING needs to make adjustments to the string, e.g., for cultural, national, lingual, etc., differences. For example, the changes might need to include conversions into pounds per sq. in. and into degrees Fahrenheit:

<SGML_STRING declaration_form ="DESCRIPTION">
The pump 
<INSERT component="pump.01">name</INSERT>
is designed to give maximum efficiency (pressure=<INSERT component="pump.001" attribute="pressure_psi">
psi) at an operating temperature between 
<INSERT component ="pump.01" attribute="temperature_minimum_farenheit">
%degree;F and 
<QUERY component ="pump.01"attribute="temperature_maximum_farenheit">
%degree;F.
</SGML_STRING>(17)
- material
- properties
- maintenance....document

Example of the WHOLE
STEP product model:

The following is an instance of the model of a component from Part xxx, describing a pump.

ENTITY COMPONENT;
ID     : "PUMP.01";
NAME    : "Intake pump";
design_info  : LIST[0:?]OF information_type;
operation_info : LIST[0:?]OF information_type;
maintenance_info : LIST[0:?]OF information_type;
pressure_out  : PRESSURE;
temp_min  : TEMPERATURE;
temp_max  : TEMPERATURE;
END_ENTITY; 
ENTITY TEMPERATURE;
value  : REAL;
unit  : temperature_type;
END_ENTUTY; 
TYPE temperature_type 
ENUMERATION OF ("centigrade", "fahrenheit");
END_TYPE;
ENTITY PRESSURE;
value   : REAL;
unit  : pressure_type;  
END_ENTITY;
TYPE pressure_type
ENUMERATION OF (pascal, psi); 
END_TYPE;

This needs a bit of TLC from an EXPRESS expert.

STEP Framework MODEL

SCHEMA Publishing_Frameworks;
ENTITY system_manual;
ABSTRACT SUPERTYPE;
type  : manual_type;
ID    : SGML_ID;
NAME   : STRING;
DECL   : SGML_DECLARATION := "SYSTEM"PROLOG  : SGML_PROLOG;
front   : LIST[0:?]OF front_type;
body   : LIST[1:?]OF body_type;
back  : LIST[0:?]OF back_type;
END_ENITY;
TYPE manual_type ENUMERATION OF (maintenance_type, operation_type);
END_TYPE;
TYPE maintenance_type ENUMERATION OF (periodic, daily, weekly, yearly);
END_TYPE;
ENTITY weekly_maintenance_manual;
SUBTYPE OF (system_manual);
type  := maintenance_type.weeklyID    := "MM-week-999";
NAME   := "Weekly Maintenance Manual"PROLOG.DTD := "+//STEP part 2xx//DTD maintenance v.01//EN"END_ENTITY;
TYPE front_type;
ENUMERATION OF (admin, preface, TOC, figlist, ...);
END_TYPE;
ENTITY admin owner  : SGML_STRING;
author  : SGML_STRING;
status  : FACT;
content : LIST[0:?]OF information_type;
END_ENTITY;
ENTITY TOC; --- Table of Contentstitle  : SGML_STRING;
contents : LIST[0:?]OF TOC_entry_type;
END_ENTITY;
TYPE body_typeENUMERATION OF (chapter, section, information_object);
END_ENTITY;
ENTITY chapter_;
ID   : SGML_ID;
TITLE  : SGML_STRING;
SECTION : LIST[1:?]OF section_type;
CONTENT : LIST[0:?]OF information_type; 
END_ENTITY;

STEP Information Types

TYPE information_type ENUMERATION OF (procedure, process, structure, principle, concept, facts, classification)

END_TYPE;
ENTITY procedure;
title    : SGML_STRING;
key_type   : SELECT(procedure_table_type, decision_table_type,     
worksheet_type, checklist_type,        expanded_procedure_table_type,
flow_chart_type);
support_types : LIST(0:?) OF (diagram_type, example_type,      
transitional_type);
END_ENTITY;
ENTITY procedure_table_type;
content : SGML_STRING;
END_ENTITY;
ENTITY decision_table_type;
content : SGML_STRING;
END_ENTITY;

SGML Information Types

<!ENTITY % KEY_type   "proc_table_type | decision_table_type |
worksheet_type  | checklist_type      |
expanded_proc_table_type |
flow_chart_type"
<!ENTITY % SUPP_type  "diagram_type | example_type |
transitional_type">
<!ELEMENT PROCEDURE   (TITLE, (%KEY_type;), (%SUPP_type;)*)   >
<!ELEMENT proc_table_type ( intro_para, (step, action)+) >
<!ELEMENT intro_para (para_content_model)   >
<!ELEMENT step  (#PCDATA)     >
<!ELEMENT action  ((para|phrase)|(choice|example)*) >

Previous Page | Next Page | Table of Contents