AG-04-EG-Engineering-Guideline-Template.docx

Draft SMPTE Engineering Guideline

Warning

This document is an unpublished, confidential work under development and shall not be referred to as a SMPTE Standard, Recommended Practice, or Engineering Guideline. It is distributed for review and comment; distribution does not constitute publication. Recipients of this document are strongly encouraged to submit, with their comments, notification of any relevant patent rights of which they are aware and to provide supporting documentation.

Information for document editors

This template is designed to focus on content and not on style. This means that editors should:

Refrain from adding styles inline unless absolutely necessary

Refrain from modifying styles unless absolutely necessary

Use the sample styles & layouts for all headings, figures, tables and math

Use the supplied auto numbering styles for headings and annexes

In the event that the content cannot be adequately expressed using this template, contact SMPTE HQ.

The blue text (like this sentence) is editing information or boilerplate. This is information used by SMPTE HQ for publication and should not be changed by the author.

The document editor must fill in the fields in black before submitting it to the Drafting Group.

The red text (like this sentence) is helpful information that is not part of the final document. This information shall be deleted prior to FCD Ballot.

The last page of this document has editing hints and a list of useful reference documents.

Project Group: <The name of the SMPTE Group for this work, this may be a TC>

Project Technology Committee: <The number and name for the parent Technology Committee>

Document type: <EG or EG (Revision)>

Document state: <WD, CD, FCD, or DP>

Project chair(s): <The SMPTE Group chair>

Document editor(s): <The document editor(s) name>

Document number: <The number of the document>

Document title: <The title of the document>

Title Page

This page will be provided by SMPTE HQ Staff.

See AG-16 clause 3.1 (Title Page), and ISO Directive Part 2 clause 11 (Title).

Proposed SMPTE Engineering Guideline This document is subject to change. Copyright  2020 SMPTE All rights reserved.

Table of Contents	Page

Foreword	4

Introduction (Optional/Conditional)	5

1	Scope	5

2	Normative References	5

3	Terms and Definitions	6

4	Technical Content	6

5	Headings and Lists	7

5.1.	Heading 2	7

5.1.1.	Heading 3	7

5.1.2.	Another Heading 3	7

6	Style Recommendations	7

6.1.	Notes	7

6.2.	Examples	7

6.3.	Equations	8

6.4.	Figures	8

6.5.	Tables	9

Annex A	<(Informative) or (Normative)> Annex Title (Optional)	10

A.1 Annex Subheading 2	10

A.1.1 Annex Subheading 3	10

Bibliography (Conditional) (Informative)	11

Foreword

See AG-16 3.2 (Foreword), and ISO Directive Part 2 clause 12 (Foreword).

SMPTE (the Society of Motion Picture and Television Engineers) is an internationally-recognized standards developing organization. Headquartered and incorporated in the United States of America, SMPTE has members in over 80 countries on six continents. SMPTE"s Engineering Documents, including Standards, Recommended Practices, and Engineering Guidelines, are prepared by SMPTE"s Technology Committees. Participation in these Committees is open to all with a bona fide interest in their work. SMPTE cooperates closely with other standards-developing organizations, including ISO, IEC and ITU.

SMPTE Engineering Documents are drafted in accordance with the rules given in its Standards Operations Manual. This SMPTE Engineering Document was prepared by Technology Committee <TC-number-and-name>.

This Engineering Guideline is purely informative and meant to provide tutorial information to the industry. It does not impose Conformance Requirements and avoids the use of Conformance Notation. - "normative text" remove from forward of EG

Engineering Guidelines frequently provide tutorial information about a Standard or Recommended Practice and when this is the case, the user should rely on the Standards and Recommended Practices referenced for interoperability information.

If this is a revision, a topical list of changes [should/shall] be included here.

Introduction (Optional/Conditional)

The introduction provides specific information or commentary about the technical content of the document, and about the reasons prompting its preparation. See AG-16 clause 3.3 (Introduction), AG-16 clause 4.2 (Conformance Terms), and ISO Directive Part 2 clause 13 (Introduction).

This section is entirely informative and does not form an integral part of this Engineering Document.

Your introductory comments.

[Editors notes: The following paragraph will be replaced with the appropriate patent information during the SMPTE Headquarters publication process.]

At the time of publication, no notice had been received by SMPTE claiming patent rights essential to the implementation of this Engineering Document. However, attention is drawn to the possibility that some of the elements of this document may be the subject of patent rights. SMPTE shall not be held responsible for identifying any or all such patent rights.

Scope

The scope clearly defines the subject of the document and the aspects covered, thereby indicating the limits of applicability of the document. See AG-16 clause 3.4 (Scope), and ISO Directive Part 2 clause 14 (Scope).

Your document's scope.

Terms and Definitions

The terms and definitions clause provide definitions necessary for the understanding of certain terms used in the document. See AG-16 clause 3.6 (Terms and Definitions). AG-16 clause 4.4 (Terms and Definitions), and ISO Directive Part 2 clause 16 (Terms and Definitions).

Select one of the following sentences and delete the others:

a) For the purposes of this document, the following terms and definitions apply:

b) For the purposes of this document, the terms and definitions given in [external reference(s)] apply.

c) For the purposes of this document, the terms and definitions given in [external reference(s)] and the following apply:

d) No terms and definitions are listed in this document.

If sentence b) or d) is selected, nothing else appears in the Clause.

If sentence a) or c) is selected, one or more terms is defined in the clauses immediately following.

Your terms and definitions follow.

Term

definition of the word above

Timed Text

TT

generically all text data sources, including Captions and Subtitles

Technical Content

Review AG-16 clause 4, AG-16 Annex A, and the main sections of the ISO Directives for helpful information.

These clauses include the technical content of the Engineering Document.

Headings and Lists

Heading 2

Heading 3

In this section, lists and headings are shown:

An auto bullet list

With a nest

And another nest

And one more

Using numbered lists

Here is a numbered list

With 3 entries

And a sub-level

With 2 entries

And a last entry

Another Heading 3

This is heading 4

And heading 5

And heading 6

Style Recommendations

Notes

See ISO Directive Part 2 clause 24 (Notes). For rules on notes to figures, see ISO Directive Part 2 clause 28.5.4. For rules on notes to tables, see ISO Directive Part 2 clause 29.5.1. The notes below are style recommendations and its content do not apply to this document.

NOTE: This is purely informational

Examples

See ISO Directive Part 2 clause 25 (Examples). The equation below is a style recommendation and its content does not apply to this document.

EXAMPLE: 5 oranges

Equations

See ISO Directive Part 2 clause 27 (Mathematical formulae). The equation below is a style recommendation and its content does not apply to this document.

The tone mapping offset, gain and gamma values shall be applied according to the equation:

(1)

where

y	is the output value
x	is the input value
g	is the value of Tone Mapping Gain
o	is the value of Tone Mapping Offset
p	is the value of Tone Mapping Gamma

Figures

See ISO Directive Part 2 clause 28 (Figures). The figure below is a style recommendation and its content does not apply to this document. A tip: Set Figure’s Text Wrapping to In line with text.

Figure 1 — Two-dimensional LUT of actual peak luminance

Tables

See ISO Directive Part 2 clause 29 (Tables). The table below is a style recommendation and its content does not apply to this document.

Table 1 — Example Metadata sets with Time Intervals

Example set	TimeIntervalStart	TimeIntervalDuration
Application Set A	0	2
Application Set B	0	3
Application Set C	5	2

<(Informative)> Annex Title (Optional)

The annex heading shall be followed by the indication “(normative)” or “(informative)”, and by the title.

See AG-16 clause 3.8 (Annexes), and ISO Directive Part 2 clause 20 (Annexes).

Annex Subheading 2

Annex Subheading 3

Subheadings and captions in the Annex shall start with the letter from the Annex heading.

Bibliography (Conditional) (Informative)

Useful documents that are not required to implement this engineering guideline. See AG-16 clause 3.9 (Bibliography), and ISO Directive Part 2 clause 21 (Bibliography).

Information for Document Editors (this page is to be deleted prior to FCD ballot)

The following documents have useful reference material for document editors.

SMPTE AG 16:2018 -- SMPTE Engineering Document Style Guidelines

International Organization for Standardization (ISO) / International Electrotechnical Commission (IEC), Directives, Part 2:2016-05, Principles and rules for the structure and drafting of ISO and IEC documents, 7.0

Warning: Only copy-and-paste plain text from other documents; otherwise this style set may be corrupted.

The following styles are available for SMPTE document editors:

Annex – For annex headings and subheadings

Headings – For clause headings and subheadings; These are red if too deep

Hyperlink – No underline as recommended

NOTE – A single note; Additional paragraphs need a tab char for proper spacing

NOTE 1 – For numbered notes; use for a group of (numbered) notes

NOTE n continued – Used for additional paragraphs in a numbered note.

S XML – For XML snippets

S pseudo code – For pseudo code or Programming language code segments

MathVariable – A single math variable

MathVariableSubscriptSuperscript – A subscript or superscript for a single math variable

SMPTE boiler plate – Prose that should not be altered or deleted.

SMPTE notes and hints – Prose that can be deleted when the document editor wishes.

Terms and Defs – Used for numbering definitions in the terms and definitions clause.

TermAcronym– Used for acronyms (under a term) in the terms and definitions clause.

Title – Section headings; these are not numbered and are included in the Table of Contents

Subtitle – Subsection headings; these are not numbered and are included in the Table of Contents

FigureCaption – Used for captions for figures

TableTitle – Used for title above a table