Skip to content

Commit 5137fa0

Browse files
authored
Update References (#3)
* update references, closes #1 * generic AG links * removed dates from references * roll to release
1 parent 634b785 commit 5137fa0

File tree

1 file changed

+37
-33
lines changed

1 file changed

+37
-33
lines changed

doc/main.html

+37-33
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88
<script src="../tooling/smpte.js"></script>
99
<meta itemprop="pubType" content="AG" />
1010
<meta itemprop="pubNumber" content="24" />
11-
<meta itemprop="pubState" content="draft" />
12-
<meta itemprop="pubDateTime" content="20XX-XX-XX" />
11+
<meta itemprop="pubState" content="pub" />
12+
<meta itemprop="pubDateTime" content="2023-04-09" />
1313
<title>MXF UL Style Guidelines</title>
1414
</head>
1515

@@ -20,7 +20,7 @@
2020
This Administrative Guideline is a collection of guidelines and policies that are intended to help SMPTE Engineering Document authors and editors when defining Universal Labels.
2121
</p>
2222
<p>
23-
This Administrative Guideline augments the ISO Directives with information and recommendations to be used when writing SMPTE Engineering Documents.
23+
This Administrative Guideline augments the <a href="#bib-iso-directives-part2"></a> with information and recommendations to be used when writing SMPTE Engineering Documents.
2424
</p>
2525
<p>
2626
<a href="#bib-smpte-ag-02"></a> describes file names, dates and file packages for documents in development. <a href="#bib-smpte-ag-16"></a> describes the Styles that are recommended for authoring Engineering Documents.
@@ -32,25 +32,11 @@
3232
<li><cite id="bib-smpte-standards-operation-manual">SMPTE Standards Operation Manual</cite>, v3.1
3333
<a>https://f.hubspotusercontent00.net/hubfs/5253154/SMPTE%20Standards%20OM%20v3.1.pdf</a></li>
3434
<li><cite id="bib-smpte-ag-02">SMPTE AG-02</cite>, Document Naming and Packaging
35-
<a>https://smpte.github.io/ag-02/</a></li>
36-
<li><cite id="bib-smpte-ag-03">SMPTE AG-03</cite>, Permitted Normative References
37-
<a>https://smpte.github.io/ag-03/</a></li>
38-
<li><cite id="bib-smpte-ag-04-st">SMPTE AG-04-ST</cite>, Standards Template
39-
<a>https://f.hubspotusercontent00.net/hubfs/5253154/Standards%20Files/AG-04-ST-Standards-Template.docx</a></li>
40-
<li><cite id="bib-smpte-ag-04-rp">SMPTE AG-04-RP</cite>, Recommended Practice Template
41-
<a>https://f.hubspotusercontent00.net/hubfs/5253154/Standards%20Files/AG-04-RP-Recommended-Practice-Template.docx</a></li>
42-
<li><cite id="bib-smpte-ag-04-eg">SMPTE AG-04-EG</cite>, Engineering Guideline Template
43-
<a>https://f.hubspotusercontent00.net/hubfs/5253154/Standards%20Files/AG-04-EG-Engineering%20Guideline%20Template.dotx</a></li>
35+
<a>https://www.smpte.org/about/policies-and-governance</a></li>
4436
<li><cite id="bib-smpte-ag-16">SMPTE AG-16</cite>, Standards Style Guide
45-
<a>https://smpte.github.io/ag-16/</a></li>
37+
<a>https://www.smpte.org/about/policies-and-governance</a></li>
4638
<li><cite id="bib-smpte-ag-18">SMPTE AG-18</cite>, Metadata Registers Procedures
47-
<a>https://smpte.github.io/ag-18/</a></li>
48-
<li><cite id="bib=smpte-st-2009">SMPTE ST 2029:2009</cite> Uniform Resource Names for SMPTE Resources
49-
<a>https://doi.org/10.5594/SMPTE.ST2029.2009</a>
50-
</li>
51-
<li><cite id="bib-smpte-st-336">SMPTE ST 336:2017</cite> Data Encoding Protocol Using Key-Length-Value
52-
<a>https://doi.org/10.5594/SMPTE.ST336.2017</a>
53-
</li>
39+
<a>https://www.smpte.org/about/policies-and-governance</a></li>
5440
</ul>
5541
</section>
5642

@@ -70,18 +56,18 @@ <h3>Style Guidelines</h3>
7056
This document recommends UL styles that minimize errors for implementers copying ULs from MXF documents. The trend toward software processes for implementation and validation make this a priority over the original MXF style of using Word tables and long prose.
7157
</p>
7258
<p>
73-
In the current Engineering Document templates, using Arial Bold 9 point for table headings and Arial undecorated 8 point for table cells reduces the chance of unwanted line breaks without the text being unnecessarily small.
59+
In the current Engineering Document templates (<a href="#bib-smpte-ag-04-st"></a>, <a href="#bib-smpte-ag-04-eg"></a>, and <a href="#bib-smpte-ag-04-rp"></a>), using Arial Bold 9 point for table headings and Arial undecorated 8 point for table cells reduces the chance of unwanted line breaks without the text being unnecessarily small.
7460
</p>
7561
</section>
7662

7763
<section id="sec-defining-uls">
7864
<h3>Defining individual ULs</h3>
7965
<p>
80-
<a href="#table-preferred-ul"></a> shows an example of the preferred way for defining ULs in MXF documents. It is a modified version of Table 2 in SMPTE ST 2094-2.
66+
<a href="#table-preferred-ul"></a> shows an example of the preferred way for defining ULs in MXF documents. It is a modified version of Table 2 in <a href="#bib-smpte-st-2094-4"></a>.
8167
</p>
8268

8369
<table id="table-preferred-ul">
84-
<caption>Example <em>Preferred</em> Table 2 updated from SMPTE ST 2094-2 – Group Node and Set Key for DMCVT Sets</caption>
70+
<caption>Example <em>Preferred</em> Table 2 updated from <a href="#bib-smpte-st-2094-4"></a> – Group Node and Set Key for DMCVT Sets</caption>
8571
<thead>
8672
<tr>
8773
<th>Item Name</th>
@@ -145,7 +131,7 @@ <h3>Defining individual ULs</h3>
145131
Extra explanatory free-form text outside the summary table is encouraged to clearly define the semantics of the UL.
146132
</p>
147133
<p>
148-
The following example shows a UL description from SMPTE ST 382-4 (<a href="#table-sound-coding"></a>, <a href="#table-sound-coding-bytes"></a>) followed by the preferred alternative representation (<a href="#table-sound-compression"></a>, <a href="#table-aac-audio-bytes"></a>). Note that in the preferred representation, the second table is no longer part of the UL description and only serves to provide the common names of the AAC profiles. In most cases a second table is not required.
134+
The following example shows a UL description from <a href="#bib-smpte-st-381-4"></a> (<a href="#table-sound-coding"></a>, <a href="#table-sound-coding-bytes"></a>) followed by the preferred alternative representation (<a href="#table-sound-compression"></a>, <a href="#table-aac-audio-bytes"></a>). Note that in the preferred representation, the second table is no longer part of the UL description and only serves to provide the common names of the AAC profiles. In most cases a second table is not required.
149135
</p>
150136

151137
<div class="example">
@@ -472,7 +458,7 @@ <h3>Defining groups and sets</h3>
472458
<td></td>
473459
</tr>
474460
<tr>
475-
<td colspan="7">All items from the abstract SubDescriptor as specified in SMPTE ST 377-1 annex B.3 „SubDescriptor</td>
461+
<td colspan="7">All items from the abstract SubDescriptor as specified in <a href="#bib-smpte-st-377-1"></a> annex B.3 „SubDescriptor</td>
476462
</tr>
477463
<tr>
478464
<td>AAC Sampling Frequency</td>
@@ -495,10 +481,10 @@ <h3>Defining groups and sets</h3>
495481
</tbody>
496482
</table>
497483
<p>
498-
*1 ISO/IEC 13818-7 (MPEG-2 AAC) and ISO/IEC 14496-3 (MPEG-4 AAC).
484+
*1 <a href="#bib-isoiec-13818-7"></a> (MPEG-2 AAC) and <a href="#bib-isoiec-14496-3"></a> (MPEG-4 AAC).
499485
</p>
500486
<p>
501-
*2 ISO/IEC 13818-7 (MPEG-2 AAC) and ISO/IEC 14496-3 (MPEG-4 AAC) ISO/IEC 14496-3:2009/Amd 4 defines the extended code points up to 14.
487+
*2 <a href="#bib-isoiec-13818-7"></a> (MPEG-2 AAC) and <a href="#bib-isoiec-14496-3"></a> (MPEG-4 AAC) defines the extended code points up to 14.
502488
</p>
503489
<p>
504490
<strong>6.2 Key for the AAC SubDescriptor</strong>
@@ -520,7 +506,7 @@ <h3>Defining groups and sets</h3>
520506
<tbody>
521507
<tr>
522508
<td>1-7</td>
523-
<td colspan="3">Defined in the Structural Header Metadata Implementation section of SMPTE ST 377-1</td>
509+
<td colspan="3">Defined in the Structural Header Metadata Implementation section of <a href="#bib-smpte-st-377-1"></a></td>
524510
</tr>
525511
<tr>
526512
<td>8</td>
@@ -530,7 +516,7 @@ <h3>Defining groups and sets</h3>
530516
</tr>
531517
<tr>
532518
<td>9-13</td>
533-
<td colspan="3">Defined in the Structural Header Metadata Implementation section of SMPTE ST 377-1</td>
519+
<td colspan="3">Defined in the Structural Header Metadata Implementation section of <a href="#bib-smpte-st-377-1"></a></td>
534520
</tr>
535521
<tr>
536522
<td>14</td>
@@ -587,7 +573,7 @@ <h3>Defining groups and sets</h3>
587573
</table>
588574

589575
<p class="note">
590-
SMPTE ST377-1 definesthebytestructureofSetsandGroups
576+
<a href="#bib-smpte-st-377-1"></a> definesthebytestructureofSetsandGroups
591577
</p>
592578
<p class="note">
593579
AACSubDescriptor version byte is set to 1 according to SMPTE policy
@@ -620,7 +606,7 @@ <h3>Defining groups and sets</h3>
620606
<td>Set length</td>
621607
</tr>
622608
<tr>
623-
<td colspan="6">All items from the abstract SubDescriptor as specified in SMPTE ST 377-1 annex B.3</td>
609+
<td colspan="6">All items from the abstract SubDescriptor as specified in <a href="#bib-smpte-st-377-1"></a> annex B.3</td>
624610
</tr>
625611
<tr>
626612
<td>AACSamplingFrequency</td>
@@ -689,7 +675,7 @@ <h3>Referring to ULs</h3>
689675
</p>
690676
<ul>
691677
<li>
692-
Style name: S keyword (this is already defined in the SMPTE templates)
678+
Style name: S keyword (this is already defined in <a href="#bib-smpte-ag-04-st"></a>, <a href="#bib-smpte-ag-04-eg"></a>, and <a href="#bib-smpte-ag-04-rp"></a>)
693679
</li>
694680
<li>
695681
Style type: character
@@ -711,7 +697,7 @@ <h3>Referring to ULs</h3>
711697
<section id="sec-summarizing-uls">
712698
<h3>Summarizing ULs in a document</h3>
713699
<p>
714-
It may be helpful to the implementation community to know which ULs are defined in any given document. An <em>optional</em> informative Annex may be provided that includes informative sections for each of the register submissions made in the document. Each section should clearly indicate which register the XML applies to and should contain the mature submission that was entered into the register. An example from ST 382-4 is given below.
700+
It may be helpful to the implementation community to know which ULs are defined in any given document. An <em>optional</em> informative Annex may be provided that includes informative sections for each of the register submissions made in the document. Each section should clearly indicate which register the XML applies to and should contain the mature submission that was entered into the register, as defined in <a href="#bib-smpte-ag-18"></a>. An example from <a href="#bib-smpte-st-381-4"></a> is given below.
715701
</p>
716702
<p>
717703
All XML should be presented in a monospaced font and indented with spaces. Color highlighting to assist readability is optional.
@@ -783,5 +769,23 @@ <h3>B.1 Elements registered in this document</h3>
783769

784770
</section>
785771

772+
<section id="sec-bibliography">
773+
<ul>
774+
<li><cite id="bib-iso-directives-part2">ISO/IEC Directives, Part 2</cite>, Principles and rules for the structure and drafting of ISO and IEC documents (Ninth edition, 2021)
775+
<a>https://www.iso.org/sites/directives/current/part2/index.xhtml</a></li>
776+
<li><cite id="bib-smpte-ag-04-st">SMPTE AG-04-ST</cite>, Standards Template
777+
<a>https://f.hubspotusercontent00.net/hubfs/5253154/Standards%20Files/AG-04-ST-Standards-Template.docx</a></li>
778+
<li><cite id="bib-smpte-ag-04-rp">SMPTE AG-04-RP</cite>, Recommended Practice Template
779+
<a>https://f.hubspotusercontent00.net/hubfs/5253154/Standards%20Files/AG-04-RP-Recommended-Practice-Template.docx</a></li>
780+
<li><cite id="bib-smpte-ag-04-eg">SMPTE AG-04-EG</cite>, Engineering Guideline Template
781+
<a>https://f.hubspotusercontent00.net/hubfs/5253154/Standards%20Files/AG-04-EG-Engineering%20Guideline%20Template.dotx</a></li>
782+
<li><cite id="bib-smpte-st-2094-4">SMPTE ST 2094-2</cite> (latest edition), Dynamic Metadata for Color Volume Transform — KLV Encoding and MXF Mapping</li>
783+
<li><cite id="bib-smpte-st-381-4">SMPTE ST 381-4</cite> (latest edition), Mapping AAC Compressed Audio into the MXF Generic Container</li>
784+
<li><cite id="bib-smpte-st-377-1">SMPTE ST 377-1</cite> (latest edition), Material Exchange Format (MXF) — File Format Specification</li>
785+
<li><cite id="bib-isoiec-13818-7">ISO/IEC 13818-7</cite> (latest edition), Information technology — Generic coding of moving pictures and associated audio information — Part 7: Advanced Audio Coding (AAC)</li>
786+
<li><cite id="bib-isoiec-14496-3">ISO/IEC 14496-3</cite> (latest edition), Information technology — Coding of audio-visual objects — Part 3: Audio</li>
787+
</ul>
788+
</section>
789+
786790
</body>
787791
</html>

0 commit comments

Comments
 (0)