1.1 |
Overview |
| |
|
This document provides an introduction to the art of
producing SEDRIS transmittals.
|
| |
1.2
| Prerequisites |
| |
|
It is recommended that the following documents from the SEDRIS Technology
Documentation Set (see Section 1.2) be reviewed prior to reading
this document.
- Part 3: SEDRIS Basics
- Part 4, Volume 1: Technical Overview
- Part 4, Volume 2: The SEDRIS Data Representation Model
- Part 4, Volume 12: Application Programmer's Interface Overview
|
| |
1.3 |
For Additional Information on SEDRIS |
| |
|
This document is part of a larger set of overview and technical documents
on SEDRIS, the Technology Documentation Set. The Technology Documentation
Set describes the why, what, and how of SEDRIS.
The Technology Documentation Set, listed below, is available at the
SEDRIS web site (www.sedris.org).
An overview of the contents of each "part" of the documentation
set is provided in Part 1. A detailed description of the individual
"volumes" contained in Part 4 is provided in Volume 1.
- Part 1: Introduction to SEDRIS and the Technology Documentation Set
- Part 2: SEDRIS and The Synthetic Environment Domain
- Part 3: SEDRIS Basics
- Part 4: Technical Reference Set
- Part 5: Tools and Utilities User's Guide Set
- Volume 1: Browser User's Guide
- Volume 2: Checker User's Guide
- Volume 3: Depth User's Guide
- Volume 4: Feature Viewer User's Guide
- Volume 5: Model Viewer User's Guide
- Volume 6: Netscape Plug-In User's Guide
- Volume 7: Ocean Profile User's Guide
- Volume 8: SEE-IT User's Guide
- Volume 9: Side-By-Side Viewer User's Guide
- Volume 10: Wind Map User's Guide
- Volume 11:
API Implementations and Format Conversions User's Guide
- Part 6: Procedures and Processes Manual
|
|
1.4 |
Document Conventions and Notations |
| |
|
Throughout the SEDRIS Technology Documentation Set, special conventions and
notations are implemented in the written text of documents to distinguish
between and add emphasis to various computer-related or SEDRIS-specific
terms. The table below defines these conventions and notations.
|
| |
|
CONVENTION
|
EXAMPLES
|
DEFINITIONS
|
Reverse video |
|
window buttons/selections/choices/etc. |
<Key or Class> |
- <Shift>
-
- <Colour Data>
|
- keys on the keyboard
-
- SEDRIS DRM class names
|
|
src / lib / api_impl / ...
- gmake env
-
- "false"
|
- directory, file, transmittal, library names
-
- command line input
-
- variable names, values, and coding examples
|
italics |
- www.sedris.org
-
- gmake
- .
-
- Part 1: Intro to
-
- not always
|
- Internet addresses
- .
- software, window, mode, function, option, etc. names
-
- document/section titles
-
- for emphasis
|
"quotes" |
"generic" |
highlight or call attention to |
|
|