CORDRA™ Document Conventions
Document Information
Status: Draft
Version: V1.00.20050101
Revision Date: 2005-01-01
Type: Specification/Convention
CORDRA ID:
H
[2000.01/428F0A2CD65A44BD8330C91D062515E9]
Metadata ID:
H
[2000.01/3A3C9F892EC949AB8DD0100834EA2F47]
Abstract
This document describes the structure, conventions and format of all
CORDRA documents.
Contents
Introduction
All CORDRA documents (including Application Profile Documents
and Recommended Practice Documents) SHALL follow a common set
of editorial and document conventions.
Top
Scope
These document conventions SHALL apply to all CORDRA documents, i.e.,
all documents that define the CORDRA System, the CORDRA System instance or
implementation of the CORDRA system, or a definition, instance or
implementation of Federated CORDRA.
These document conventions MAY be applied to CORDRA documents for an
individual CORDRA instance or implementation.
Top
Document Information
All documents SHALL include a common set of document information
(metadata) including:
-
status: The document status.
The value SHALL be taken from the
H
CORDRA System Vocabulary: Document Status.
-
version number: The version number for the document.
The format SHALL be Vvv.pp, where
vv is the major release value and
pp is the minor release value. The
initial character V is required. The
major release value SHALL be from the value space 0 through 99,
encoded using the characters 0-9. At least one character SHALL be
present in the major release value. The minor release value SHALL be
from the value space 0 to 99, encoded using the characters 0-9. Two
characters SHALL be present in the minor release value. The major and
minor release values SHALL be separated by a period ("."). The
version number MAY contain additional characters after the minor
release value. These characters SHALL be separated from the minor
release value by a period ("."). The syntax and semantics of any
characters following the minor release value are not specified.
-
revision date: A date-time value of the for the publication
of the revision of the listed version of the document.
The format SHALL be YYYY-MM-DD, where
YYYY,
MM, and DD are
the year, month and date respectively, encoded as characters. The
year SHALL be a four-digit year from the value space 0001 through 9999
encoded using the characters 0-9. The month SHALL be a two-digit
month from the value space 01 through 12 encoded using the characters
0-9. The day SHALL be a two-digit day from the value space 01 through
31 (depending on the value of the month) encoded using the characters
0-9. The year SHALL be separated from the month by a dash (-). The month SHALL be separated from the day
by a dash (-). The character encoding
SHALL conform to ISO 8601:2000. The value space SHALL be the
Gregorian calendar.
-
type: The document type.
The value SHALL be taken from the
H
CORDRA System Vocabulary: Document Type.
-
CORDRA ID: The ID (handle) assigned by the CORDRA Naming
Authority for the document.
-
Metadata ID: The ID (handle) assigned by the CORDRA Naming
Authority for a IEEE LOM metadata instance for the document.
Top
Document Metadata
All document shall have an associated collection of LOM metadata.
The requirements for the metadata are described in the
H
CORDRA Document Metadata.
Top
Editorial Conventions
All documents SHALL include the following elements:
-
abstract: an overview of the document
-
table of contents, hyperlinked to the major sections of the document
-
scope: describing the applicability of the document to the different
parts of CORDRA
-
references: references for all other documents cited within the
document. References SHALL be divided into normative and informative
references.
-
change log: list of versions, identifiers, dates and change summary.
Cross references to all CORDRA documents SHALL by via their CORDRA
IDs. Cross
references SHOULD link to the most appropriate version.
Cross references to other CORDRA documents SHOULD appear in italics.
Terms from the
H
CORDRA Glossary SHOULD appear in
italics.
Top
Conformance Conventions
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in any CORDRA document SHALL be interpreted as described in
RFC 2119.
These capitalized key words are used to unambiguously specify requirements.
Top
Document Versioning
Each document SHALL be assigned a version number. The version number SHALL change with each publication and official release of the document.
A document or document version that has status draft has not
been officially released. The document MAY be edited without changes
to the version number.
Top
References
Normative References
-
IEEE LOM 2002, IEEE Standard for Learning Object Metadata,
IEEE Standards Department, Institute of Electrical and Electronic Engineers,
Inc. (2002). IEEE-SA Standard 1484.12.1-2002.
-
H
CORDRA Document Metadata
-
ISO/IEC 8601:2000, Data elements and interchange formats -- Information
interchange -- Representation of dates and times, ISO/IEC, 2000.
-
RFC 2119,
Key words for use in RFCs to Indicate Requirement Levels,
IETF, 1997.
Top
Change Log
| Version | ID | Date | Change Summary |
| 1.00 |
H |
20041018 |
Initial release |
| 20050101 |
Editorial changes |
Top
