-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathmain.html
More file actions
2349 lines (1913 loc) · 95.8 KB
/
Copy pathmain.html
File metadata and controls
2349 lines (1913 loc) · 95.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!doctype html>
<html>
<head itemscope="itemscope" itemtype="http://smpte.org/standards/documents">
<meta charset="utf-8" />
<meta http-equiv="x-ua-compatible" content="ie=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<script type="module" src="../smpte.js"></script>
<meta itemprop="pubType" content="AG" />
<meta itemprop="pubNumber" content="26" />
<!-- <meta itemprop="pubPart" content="XX" /> -->
<meta itemprop="pubState" content="draft" />
<!-- meta itemprop="pubStage" content="WD" / -->
<meta itemprop="pubConfidential" content="no" />
<!--< meta itemprop="pubTC" content="XX" /> -->
<meta itemprop="pubSuiteTitle" content="HTML Pub" />
<meta itemprop="pubDateTime" content="2025-02-26" />
<!-- <meta itemprop="pubRevisionOf" content="SMPTE ST XXXX-Y:ZZZZ" /> -->
<title>Tooling and documentation for HTML documents</title>
</head>
<body>
<section id="sec-introduction">
<p>Authoring SMPTE documents consist of two aspects:</p>
<ul>
<li>structure and syntax of the document; and</li>
<li>managing revisions using GitHub.</li>
</ul>
</section>
<section id="sec-scope">
<p>This Administrative Guideline describes the process for authoring SMPTE documents using HTML.</p>
</section>
<section id="sec-normative-references">
<ul>
<li>
<cite id="bib-HTML-5">HTML Standard</cite>, Living Standard.
<a>https://html.spec.whatwg.org/multipage/</a></li>
</ul>
</section>
<section id="sec-quick-start">
<h2>Quick start</h2>
<ol>
<li>
<a href="https://git-scm.com/">Install the git source control system</a>
</li>
<li>
Install a text editor and local web server. Visual Studio Code (<a>https://code.visualstudio.com/</a>) combined with the
<code>ms-vscode.live-server</code> extension
(<a>https://marketplace.visualstudio.com/items?itemName=ms-vscode.live-server</a>) is one option.
</li>
<li>
Clone the HTML publication template:
<pre>git clone --recurse-submodules https://github.com/SMPTE/html-pub-template.git</pre>
</li>
<li>
(Advanced) Add the pre-commit hook specified at <a href="#sec-tooling-git-hooks"></a> by following the instructions at
<a>https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks</a>.
</li>
<li>
If working on a project that has a repository, update the <code>origin</code> remote to that repository:
<pre>git remote set-url origin <HTTPS URL of the project repository found on GitHub></pre>
For example:
<pre>git remote set-url origin https://github.com/SMPTE/stxxx-y-private.git</pre>
</li>
<li>
Start editing the main prose element at <code>doc/main.html</code>.
</li>
</ol>
</section>
<section id="sec-directory-layout">
<h2>Directory layout</h2>
<p>A document consists of multiple files arranged in the following directory structure:</p>
<ul>
<li><code>doc/main.html</code>: main element of the document (see <a href="#sec-main-element"></a>).</li>
<li><code>doc/media/</code>: directory containing media referenced by the main element (see <a href="#sec-figure-element"></a>).</li>
<li><code>doc/elements/</code>: directory containing non-prose elements of the document (see <a
href="#sec-elements-section"></a>).</li>
<li><code>doc/snippets/</code>: directory containing snippets embedded in the main element (see <a href="#sec-snippets-element"></a>).</li>
<li><code>tooling/</code>: directory consisting of the tools necessary to render SMPTE documents (see <a href="#sec-tooling"></a>).</li>
<li><code>.smpte-build.json</code>: JSON file used to configure the HTML rendering process (see <a href="#sec-building"></a>).</li>
<li><code>.gitignore</code>: Prevents build and operating system artifacts from being tracked by Git.</li>
<li><code>.github/workflows/main.yml</code>: Allows automated HTML rendering and redlining in GitHub (see <a href="#sec-gh-integration"></a>).</li>
</ul>
</section>
<section id="sec-main-element">
<h2>Main element</h2>
<section id="sec-structure">
<h3>General</h3>
<p>The main element shall be an HTML document represented using the XML syntax, as specified at <a
href="#bib-HTML-5"></a>.</p>
<p>The basic structure of the main element is illustrated at <a href="#fig-structure-doc"></a>.</p>
<figure id="fig-structure-doc">
<pre data-include="snippets/skeleton.html"></pre>
<figcaption>Basic structure of the main element.</figcaption>
</figure>
<p>The <code>smpte.js</code> script contains the code that renders the HTML document provided by the author into an HTML
document appropriate for publication. This rendering happens automatically when loading the document in a web browser.</p>
</section>
<section id="sec-head-element">
<h3><code>head</code> element</h3>
<section id="sec-general">
<h4>General</h4>
<p>The <code>head</code> element shall contain the following:</p>
<ul>
<li><code>itemscope</code> attribute equal to <code>itemscope</code>;</li>
<li><code>itemtype</code> attribute equal to <code>http://smpte.org/standards/documents</code>;</li>
<li><code><meta charset="utf-8" /></code>;</li>
<li><code><meta http-equiv="x-ua-compatible" content="ie=edge" /></code>;</li>
<li><code><meta name="viewport" content="width=device-width, initial-scale=1" /></code></li>
<li>a <code>script</code> element whose <code>src</code> attribute links to the <code>smpte.js</code> module in the
<code>tooling</code> directory.</li>
</ul>
<p>The <code>title</code> element shall be equal to the title of the document, excluding:</p>
<ul>
<li>the name of the publisher, e.g., SMPTE;</li>
<li>the document type, e.g., ST;</li>
<li>the document number, e.g., 428-1;</li>
<li>the title of the suite if the document is part of a suite.</li>
</ul>
<p class="example">The <code>title</code> of SMPTE ST 429-2 is <i>DCP Operational Constraints</i>.</p>
<p>In addition to the <code>title</code> element, the <code>head</code> element contains SMPTE publication metadata in
the form of <code>meta</code> elements as specified below.</p>
<p>The <code>head</code> element may contain additional <code>script</code> elements that import JavaScript libraries for
document layout, e.g. <a href="https://www.mathjax.org/">MathJax</a></p>
<div class="example">
<pre><script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
<script type="text/javascript" id="MathJax-script"
async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-svg.js">
</script></pre>
</div>
</section>
<section id="sec-pubType">
<h4><code>pubType</code></h4>
<p>The <code>head</code> element shall contain exactly one <code>meta</code> element with an <code>itemprop</code> attribute
equal to <code>pubType</code>.</p>
<p>The element shall have a <code>content</code> attribute equal to one of the following values:</p>
<ul>
<li><code>AG</code>, if the document is an Administrative Guideline;</li>
<li><code>OM</code>, if the document is an Operations Manual;</li>
<li><code>ST</code>, if the document is a Standard;</li>
<li><code>RP</code>, if the document is a Recommended Practice; or</li>
<li><code>EG</code>, if the document is an Engineering Guideline.</li>
</ul>
</section>
<section id="sec-pubNumber">
<h4><code>pubNumber</code></h4>
<p>The <code>head</code> element shall contain zero or one <code>meta</code> element with an <code>itemprop</code> attribute
equal to <code>pubNumber</code>.</p>
<p>The element shall be present if:</p>
<ul>
<li><code>pubState</code> is <code>pub</code>; or</li>
<li><code>pubPart</code> is specified; or</li>
<li><code>pubVersion</code> is specified.</li>
</ul>
<p>The <code>content</code> attribute of the element shall be equal to the document number, which is a sequence of
digits.</p>
</section>
<section id="sec-pubPart">
<h4><code>pubPart</code></h4>
<p>The <code>head</code> element shall contain exactly one <code>meta</code> element with an <code>itemprop</code> attribute
equal to <code>pubPart</code> if the document is part of a suite, and none otherwise.</p>
<p>The element shall have a <code>content</code> attribute equal to the document part number, which is a sequence of
digits.</p>
</section>
<section id="sec-pubSuiteTitle">
<h4><code>pubSuiteTitle</code></h4>
<p>The <code>head</code> element shall contain exactly one <code>meta</code> element with an <code>itemprop</code> attribute
equal to <code>pubSuiteTitle</code> if the document is part of a suite, and none otherwise.</p>
<p>The element shall have a <code>content</code> attribute equal to the title of the document suite.</p>
</section>
<section id="sec-pubVersion">
<h4><code>pubVersion</code></h4>
<p>The <code>head</code> element shall contain zero or one <code>meta</code> element with an <code>itemprop</code> attribute
equal to <code>pubVersion</code>.</p>
<p>The element shall have a <code>content</code> attribute. The value of
this attribute overrides the document version that is automatically
generated by the tooling for Engineering Document and the
<code>pubStage</code> is <code>PUB</code>.</p>
<p>This element shall be present if and only if the document version
does not follow current practice.</p>
</section>
<section id="sec-pubState">
<h4><code>pubState</code></h4>
<p>The <code>head</code> element shall contain one <code>meta</code> element with an <code>itemprop</code> attribute
equal to <code>pubState</code>.</p>
<p>The element shall have a <code>content</code> attribute equal to one of the following values:</p>
<ul>
<li><code>draft</code>, if the document is a draft.</li>
<li><code>pub</code>, if the document is published.</li>
</ul>
<p>
For further explanation of determining the value of the document's <code>pubState</code>, see <a href="#sec-document-mapping-status"></a>
</p>
</section>
<section id="sec-pubStage">
<h4><code>pubStage</code></h4>
<p>The <code>head</code> element shall contain zero or one <code>meta</code> element with an <code>itemprop</code> attribute
equal to <code>pubStage</code>.</p>
<p>The element shall be present if the document is an Engineering Document.</p>
<p>The element shall have a <code>content</code> attribute equal to one of the following values:</p>
<ul>
<li><code>WD</code>, if the document is a Working Draft;</li>
<li><code>CD</code>, if the document is a Committee Draft;</li>
<li><code>FCD</code>, if the document is a Final Committee Draft;</li>
<li><code>DP</code>, if the document is a Draft Publication; or</li>
<li><code>PUB</code>, if the document is a Published.</li>
</ul>
<p>
For further explanation of determining the value of the document's <code>pubStage</code>, see <a href="#sec-document-mapping-status"></a>
</p>
</section>
<section id="sec-pubRevisionOf">
<h4><code>pubRevisionOf</code></h4>
<p>The <code>head</code> element shall contain zero or one <code>meta</code> element with an <code>itemprop</code> attribute
equal to <code>pubRevisionOf</code>.</p>
<p>The element shall have a <code>content</code> attribute equal to the identifier of the document that the document
revises.</p>
</section>
<section id="sec-pubTC">
<h4><code>pubTC</code></h4>
<p>The <code>head</code> element shall contain zero or one <code>meta</code> element with an <code>itemprop</code> attribute
equal to <code>pubTC</code>.</p>
<p>The element shall be present if the document is an Engineering Document.</p>
<p>The element shall have a <code>content</code> attribute equal to the identifier of the TC responsible for the
document.</p>
</section>
<section id="sec-pubConfidential">
<h4><code>pubConfidential</code></h4>
<p>The <code>head</code> element shall contain zero or one
<code>meta</code> element with an <code>itemprop</code> attribute equal
to <code>pubConfidential</code>.</p>
<p>If present, the element shall have a <code>content</code> attribute
equal to one of the following values:</p>
<dl>
<dt><code>yes</code></dt>
<dd>The Engineering Document is SMPTE confidential.</dd>
<dt><code>no</code></dt>
<dd>The Engineering Document is not SMPTE confidential.</dd>
</dl>
<p>The element shall not be present unless the document is an
Engineering Document.</p>
<p>Unless specified otherwise, an Engineering Document that is not at
publication stage is confidential.</p>
</section>
<section id="sec-pubDateTime">
<h4><code>pubDateTime</code></h4>
<p>The <code>head</code> element shall contain zero or one <code>meta</code> element with an <code>itemprop</code> attribute
equal to <code>pubDateTime</code>.</p>
<p>The element shall be present if <code>pubState</code> is <code>pub</code>.</p>
<p>The element shall have a <code>content</code> attribute that conforms to the pattern <code>YYYY-MM-DD</code>, where
<code>YYYY</code>, <code>MM</code> and <code>DD</code> are the year, month and day of the most recent approval date of the
document.</p>
<p>See AG-02 for a definition of approval date.</p>
</section>
<section id="sec-effectiveDateTime">
<h4><code>effectiveDateTime</code></h4>
<p>The <code>head</code> element shall contain zero or one <code>meta</code> element with an <code>itemprop</code> attribute
equal to <code>effectiveDateTime</code>.</p>
<p>The element shall be present if the document is an Operations Manual and the <code>pubState</code> is
<code>pub</code>.</p>
<p>The element shall have a <code>content</code> attribute that conforms to the pattern <code>YYYY-MM-DD</code>, where
<code>YYYY</code>, <code>MM</code> and <code>DD</code> are the year, month and day that the document becomes effective.</p>
</section>
<section id="sec-additional-script-elements">
<h4>Additional <code>script</code> elements</h4>
</section>
</section>
<section id="sec-body-element">
<h3><code>body</code> element</h3>
<section id="sec-body-general">
<h4>Overall structure</h4>
<p>The <code>body</code> element shall consist of an ordered sequence of <code>section</code> elements, as specified at <a
href="#tab-body-structure"></a>.</p>
<table id="tab-body-structure" class="col-2-center">
<caption>Ordered sequence of <code>section</code> elements comprising the <code>body</code> element.</caption>
<thead>
<tr>
<th>Section Name</th>
<th>Cardinality</th>
</tr>
</thead>
<tbody>
<tr>
<td><a>Foreword</a></td>
<td>0 or 1</td>
</tr>
<tr>
<td><a>Introduction</a></td>
<td>0 or 1</td>
</tr>
<tr>
<td><a>Scope</a></td>
<td>Exactly 1</td>
<tr>
<td><a>Conformance</a></td>
<td>0 or 1</td>
</tr>
<tr>
<td><a>Normative references</a></td>
<td>0 or 1</td>
<tr>
<td><a>Terms and definitions</a></td>
<td>0 or 1</td>
</tr>
<tr>
<td><a>Prose section</a></td>
<td>0 or more</td>
</tr>
<tr>
<td><a>Annex section</a></td>
<td>0 or more</td>
</tr>
<tr>
<td><a>Additional elements section</a></td>
<td>0 or 1</td>
</tr>
<tr>
<td><a>Bibliography</a></td>
<td>0 or 1</td>
</tr>
</tbody>
</table>
<p>From the author-supplied <code>section</code> elements specified at <a href="#tab-body-structure"></a>, the tooling
generates a document structure that conforms to SMPTE editorial requirements. For example:</p>
<ul>
<li>clauses are numbered automatically;</li>
<li>headings of <code>section</code> elements other than <a>Prose sections</a> and <a>Annex sections</a> are
automatically generated;</li>
<li>boilerplate is added, including the SMPTE masthead.</li>
</ul>
</section>
<section id="sec-foreword-section">
<h4>Foreword section</h4>
<p>The <dfn>Foreword</dfn> section contains author-supplied prose, e.g. list of substantive changes since the last edition,
that is added to the SMPTE boilerplate text.</p>
<p>The absence of this section indicates that no author-supplied prose was provided.</p>
<p>The <code>id</code> attribute shall be present on the <code>section</code> element and equal to
<code>sec-foreword</code>.</p>
<p>The heading shall not be present.</p>
<div class="example">
<pre><section id="sec-foreword">
<p>This is the additional information relevant to the document.</p>
</section>
</pre>
</div>
</section>
<section id="sec-introduction-section">
<h4>Introduction section</h4>
<p>The <dfn>Introduction</dfn> section contains author-supplied prose that forms the introduction of the document.</p>
<p>The absence of this section indicates that the document has no introduction.</p>
<p>The <code>id</code> attribute shall be present on the <code>section</code> element and equal to
<code>sec-introduction</code>.</p>
<p>The heading shall not be present.</p>
<div class="example">
<pre><section id="sec-introduction">
<p>This is the introduction.</p>
</section>
</pre>
</div>
</section>
<section id="sec-scope-section">
<h4>Scope section</h4>
<p>The <dfn>Scope</dfn> section contains author-supplied prose that forms the scope of the document.</p>
<p>The <code>id</code> attribute shall be present on the <code>section</code> element and equal to
<code>sec-scope</code>.</p>
<p>The heading shall not be present.</p>
<div class="example">
<pre><section id="sec-scope">
<p>This is the scope.</p>
</section></pre>
</div>
</section>
<section id="sec-conformance-section">
<h4>Conformance section</h4>
<p>The <dfn>Conformance</dfn> section contains author-supplied, conformance-related prose that is added to the SMPTE
boilerplate text.</p>
<p>The absence of this section indicates that no author-supplied, conformance-related prose is provided.</p>
<p>The <code>id</code> attribute shall be present on the <code>section</code> element and equal to
<code>sec-conformance</code>.</p>
<p>The heading shall not be present.</p>
<div class="example">
<pre><section id="sec-conformance">
<p>These are additional conformance requirements and definitions.</p>
</section>
</pre>
</div>
<p>This section is prohibited unless the document is a Standard or Recommended Practice.</p>
</section>
<section id="sec-norm-refs-section">
<h4>Normative references section</h4>
<p>The <dfn>Normative references</dfn> section collects normative references cited in the document.</p>
<p>The <code>id</code> attribute shall be present on the <code>section</code> element and equal to
<code>sec-normative-references</code>.</p>
<p>The heading shall not be present.</p>
<p>The absence of this section indicates that no normative references are cited by the document.</p>
<p>If present, the section shall contain a single <code>ul</code> element where each <code>li</code>
element is a normative reference, such that:</p>
<ul>
<li>Each <code>li</code> element shall contain one <code>cite</code> element, with value that contains the text that will
be used when citing the reference in the prose.</li>
<li>The <code>cite</code> element shall contain an <code>id</code> attribute with value prefixed by
<code>bib-</code>.</li>
<li>Each <code>li</code> element may contain additional title information.
<li>Each <code>li</code> element may contain one <code>a</code> element that contains a location where the reference can
be retrieved.</li>
</ul>
<p>Undated references should always be used (to designate using the latest version), except for when needed, as per <a href="#bib-iso-directives-part2"></a>.
<p class="note">For SMPTE documents, see <a href="#bib-ag-29"></a> for the specification of persistent link URIs for both "latest" and specific versions of a document referenced.</p>
<div class="example">
<pre><section id="sec-normative-references">
<ul>
<li>
<cite id="bib-HTML-5">HTML Standard</cite>, Living Standard.
<a>https://html.spec.whatwg.org/multipage/</a></li>
</li>
</ul>
</section></pre>
</div>
</section>
<section id="sec-terms-definitions-clause">
<h4>Terms and definitions section</h4>
<p>The <dfn>Terms and definitions</dfn> section collects terms, abbreviations and symbols that are not defined inline the
clauses of the document, as described in <a href="#sec-dfn-element"></a>.</p>
<p>The <code>id</code> attribute shall be present on the <code>section</code> element and equal to
<code>sec-terms-and-definitions</code>.</p>
<p>The heading shall not be present.</p>
<p>The absence of this section indicates that all terms and abbreviations are defined inline the clauses of the
document.</p>
<p>If present, the <code>section</code> contains one or both of the following elements:</p>
<ul>
<li>a <code>ul</code> element that cites external definitions, subject to the following constraints:
<ul>
<li>The <code>id</code> attribute of the <code>ul</code> element shall be equal to <code>terms-ext-defs</code>.</li>
<li>Each <code>li</code> element contains a citation link to a normative reference (see <a
href="#sec-norm-refs-section"></a>), whose definitions are included by reference.</li>
</ul>
</li>
<li>a <code>dl</code> element that contains individual definitions and abbreviations, subject to the following
constraints:
<ul>
<li>The <code>id</code> attribute of the <code>dl</code> element shall be equal to <code>terms-int-defs</code>.</li>
<li>Each <code>dt</code> element contains a single term, abbreviation or symbol. Zero or more additional <code>dt</code> elements
can follow the first <code>dt</code> element, in which case all the terms, abbreviations and symbols in the immediately
preceding <code>dt</code> elements are synonyms.</li>
<li>The first <code>dd</code> element immediately following the last <code>dt</code> element, if present, shall be
a definition.</li>
<li>The next <code>dd</code> element, if present, shall contain a single reference to a bibliographic entry,
in which case the entry is the source of the definition of the term.</li>
<li>The remaining <code>dd</code> elements, if present,
shall have a <code>class</code> attribute that contains the value <code>note</code>, in which case the
elements are notes to the entry.</li>
</ul>
</li>
</ul>
<div class="example">
<pre>
<section id="sec-terms-and-definitions">
<ul id="terms-ext-defs">
<li><a href="#bib-HTML-5"></a></li>
</ul>
<dl id="terms-int-defs">
<dt><dfn>key number</dfn></dt>
<dd>number that is printed with ink or exposed onto the film at the time of
manufacture at regular intervals, typically one foot.</dd>
<dd><a href="#bib-key-number-spec"></a></dd>
<dd class="note">Key number shall not be confused with key frame.</dd>
</dl>
</section>
</pre>
</div>
<p class="note">The boilerplate of the section will be generated automatically.</p>
</section>
<section id="sec-prose-section">
<h4>Prose section(s)</h4>
<p>Each <dfn>Prose section</dfn> contains author-supplied technical prose.</p>
<p>A <a>Prose section</a> may contain other nested <a>Prose sections</a>. If any child of a <a>Prose section</a> is a
<a>Prose section</a>, then all children shall be <a>Prose sections</a>.</p>
<p>The <code>id</code> attribute shall be present and its value should be prefixed with <code>sec-</code>.</p>
<p>The <code>class</code> attribute of a <a>Prose section</a> shall not contain the <code>annex</code> class.</p>
<p>A section heading element of the appropriate level shall be present, starting with level 2 (<code>h2</code>) for all
<a>Prose sections</a> that are children of the <code>body</code> element.</p>
<p><a>Prose sections</a> are automatically numbered, so neither the heading element nor its <code>id</code> attribute should
contain numbering information.</p>
<div class="example">
<pre><section id="sec-prose-clause">
<h2>Prose Clause</h2>
<section id="sec-prose-sub-clause">
<h3>Prose Sub Clause</h3>
<p>Some technical content</p>
</section>
<section id="sec-next-prose-sub-clause">
<h3>Next Prose Sub Clause</h3>
<p>Some technical content</p>
</section>
</section>
</pre>
</div>
</section>
<section id="sec-annex-section">
<h4>Annex section(s)</h4>
<p>An <dfn>Annex section</dfn> contains an author-supplied technical annex.</p>
<p>The requirements for an <a>Annex section</a> are the same as those of a <a>Prose section</a>, with the exception that the
<a>Annex section</a> shall contain the <code>class</code> attribute with value of <code>annex</code>.</p>
<p>An <a>Annex section</a> shall not contain nested <a>annex sections</a>.</p>
<div class="example">
<pre><section class="annex" id="sec-additional-info">
<h2>Additional Info</h2>
<section id="sec-additional-info-sub-section">
<h3>Additional Info Sub Section</h3>
<p>Some technical content</p>
</section>
<section id="sec-additional-info-sub-section-more">
<h3>Additional Info Sub Section More</h3>
<p>Some technical content</p>
</section>
</section>
</pre>
</div>
</section>
<section id="sec-elements-section">
<h4>Additional elements section</h4>
<p>The <dfn>additional elements section</dfn> collects the non-prose elements of the document.</p>
<p>The <code>id</code> attribute shall be present on the <code>section</code> element and equal to
<code>sec-elements</code>.</p>
<p>The heading of the section shall not be present.</p>
<p>If present, the section shall:</p>
<ul>
<li>come immediately before the <a>Bibliography</a> section; and</li>
<li>contain a single ordered list <code>ol</code> where each element <code>li</code> contains exactly one <code>a</code>
that links to an element of the document.</li>
</ul>
<p>Each <code>a</code> element shall have:</p>
<ul>
<li>an <code>id</code> attribute whose value is prefixed with <code>element-</code>;</li>
<li>a <code>title</code> attribute that provides a short description of the element;</li>
<li>a <code>href</code> attribute that links to the element, as detailed below; and</li>
<li>a <code>class</code> attribute that contains the token <code>informative</code> if the element is informative.</li>
</ul>
<p>
Each additional element shall be managed in one of the following ways:
</p>
<ul>
<li>as a file in the <code>doc/elements</code> directory, in which case the
<code>href</code> attribute shall be relative path to the file, e.g.
<code>elements/element.txt</code> (<a href="#element-sample-text"></a>); or</li>
<li>in a separate SMPTE repository, in which case the
<code>href</code> attribute shall be the absolute URL to a version of the repo, e.g.
<code>https://github.com/SMPTE/html-pub/tree/631ed7a0312fa183c356a7b742129ce46f92736f</code> (<a
href="#element-url"></a>).</li>
</ul>
<p>Non-SMPTE repositories and SMPTE repositories that are not an integral part of the document shall be cited using a
bibliographic reference.</p>
<div class="example">
<pre><section id="sec-elements">
<ol>
<li>
<a id="element-sample-text" title="Description of the element" href="./elements/form.docx"></a>
</li>
</ol>
</section></pre>
</div>
</section>
<section id="sec-bibliography-section">
<h4>Bibliography section</h4>
<p>The <dfn>Bibliography</dfn> section contains author-supplied bibliographic references.</p>
<p>The <code>id</code> attribute shall be present on the <code>section</code> element and equal to
<code>sec-bibliography</code>.</p>
<p>The heading shall not be present.</p>
<p>The absence of this section indicates that no bibliographic references are cited by the document.</p>
<p>If present, the section shall contain a single <code>ul</code> element that conform to the same requirement as the
<code>ul</code> element of the <a>normative references</a> section.</p>
<div class="example">
<pre><section id="sec-bibliography">
<ul>
<li>
<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)
<a>https://www.iso.org/sites/directives/current/part2/index.xhtml</a></li>
</li>
</ul>
</section></pre>
</div>
</section>
</section>
<section id="sec-other-elements">
<h3>Other elements</h3>
<section id="sec-section-linking">
<h4>Referencing clauses</h4>
<p>When referencing a clause, an <code>a</code> element with its <code>href</code> attribute referencing a
<code>section</code> element shall be used. The text of the link will be automatically set to section number.</p>
<div class="example">
<code><a href="#sec-scope"></a></code> is rendered as <a
href="#sec-scope"></a> and <code><a href="#sec-section-linking"></a></code> is rendered as <a
href="#sec-section-linking">.</a>
</div>
</section>
<section id="sec-normative-linking">
<h4>Citing normative references</h4>
<p>When citing a normative reference, an <code>a</code> element with its <code>href</code> attribute referencing a
<code>cite</code> element from the <a>normative references</a> section shall be used. The text of the link will be
automatically set to the contents of the
<code>cite</code> element.</p>
<p class="example">
<code><a href="#bib-HTML-5"></a></code> is rendered as <a href="#bib-HTML-5"></a>.
</p>
</section>
<section id="sec-elements-linking">
<h4>Citing non-prose elements</h4>
<p>When citing an non-prose element of the document, an <code>a</code> element with its <code>href</code> referencing an <code>a</code> element from the <a>additional elements section</a> shall be used. The text of the link will be automatically set to the letter of the element in element list.</p>
<div class="example">
<code><a href="#element-sample-text"></a></code> is rendered as <a href="#element-sample-text"></a>.
</div>
</section>
<section id="sec-bibliographic-linking">
<h4>Citing bibliographic references</h4>
<p>When citing a bibliographic reference in the prose, an <code>a</code> element with its <code>href</code> attribute
referencing a <code>cite</code> element from the <a>Bibliography</a> section shall be used. The text of the link will be
automatically set to the contents of the <code>cite</code> element.</p>
<p class="example">
<code><a href="#bib-iso-directives-part2"></a></code> is rendered as <a href="#bib-iso-directives-part2"></a>.
</p>
</section>
<section id="sec-external-links">
<h4>External links</h4>
<p>Links to external resources shall be written by wrapping the URL in an <code>a</code> element</p>
<p class="example">
<code><a>https://www.iso.org/sites/directives/current/part2/index.xhtml</a></code> is rendered as
<a>https://www.iso.org/sites/directives/current/part2/index.xhtml</a>.
</p>
<p class="note">An <code>href</code> attribute will automatically be generated.
</section>
<section id="sec-dfn-element">
<h4>Inline terms</h4>
<p>A <dfn data-lt="alternate1|alternate2">term</dfn> can be defined by wrapping it in a <code>dfn</code> element.</p>
<p class="example">
<code><dfn data-lt="alternate1|alternate2">term</dfn></code>
</p>
<p>The optional <code>data-lt</code> attribute specify alternate forms of the <a>term</a>, each separated by a
<code>|</code> character.</p>
<p>An optional <code>id</code> attribute can be specified; otherwise one will be generated automatically.</p>
<div class="example">
<p>The definition above can be referenced using one of the following forms:</p>
<ul>
<li><code><a>term</a></code>, which is rendered as <a>term</a></li>
<li><code><a>alternate1</a></code>, which is rendered as <a>alternate1</a></li>
<li><code><a>alternate2</a></code>, which is rendered as <a>alternate2</a></li>
</ul>
</div>
</section>
<section id="sec-dl-element">
<h4>Lists of key-value pairs</h4>
<p>A <code>dl</code> element can be used for key-value pairs lists.</p>
<p>Since styling is automatically applied to <code>dl</code> elements, author should not specify additional formatting,
either in the form of CSS styles or using markup such as the <code>b</code> element.</p>
<p>At least one <code>dd</code> shall be present for each <code>dt</code> element.</p>
<div class="example">
<pre>
<dl>
<dt>imperative forms</dt>
<dd>"see"</dd>
<dt>non-imperative forms</dt>
<dd>"according to"</dd>
<dd>"as defined in"</dd>
<dd>"as specified in"</dd>
<dd>"details as given in"</dd>
<dd>"in accordance with"</dd>
</dl></pre>
<p>is rendered as:</p>
<dl>
<dt>imperative forms<dt>
<dd>"see"</dd>
<dt>non-imperative forms</dt>
<dd>"according to"</dd>
<dd>"as defined in"</dd>
<dd>"as specified in"</dd>
<dd>"details as given in"</dd>
<dd>"in accordance with"</dd>
</dl>
</div>
</section>
<section id="sec-list-element">
<h4>Lists</h4>
<p>A list can be inserted using either an <code>ol</code> or <code>ul</code> element. The <code>ul</code> (unordered list) element should be used when the order of listed items is not meaningful or important. The <code>ol</code> (ordered list) element should be only used when the order of listed items is meaningful and/or important to the list and/or document.</p>
<p>
General guidelines for lists:
</p>
<ul>
<li>An <code>ol</code> or <code>ul</code> element shall contain one (1) or more <code>li</code> element(s). </li>
<li>A <code>li</code> element may contain one (1) or more nested <code>ol</code> or <code>ul</code> element(s).</li>
<li>An <code>ol</code> element should not be nested within an <code>ul</code> element. </li>
</ul>
<div class="example">
<pre>
<ol>
<li>First list item</li>
<li>Second list item</li>
</ol></pre>
<p>is rendered as:</p>
<ol>
<li>First list item</li>
<li>Second list item</li>
</ol>
</div>
<p>
For more examples of various list layouts and optional list types, see <a href="#sec-list-examples"></a>
</p>
</section>
<section id="sec-figure-element">
<h4>Figures</h4>
<p>A figure can be inserted using a <code>figure</code> element with the following requirements:</p>
<p>The <code>figure</code> element shall contain:</p>
<ul>
<li>an <code>id</code> attribute whose value starts with <code>figure-</code></li>
<li>one <code>img</code> or <code>pre</code> element</li>
<li>one <code>figcaption</code> element following the <code>img</code> or <code>pre</code> element</li>
</ul>
<p>If an <code>img</code> element is present, then its <code>src</code>
attribute shall be present and be a relative path starting with the
string <code>media/</code>.</p>
<p>Figures are automatically numbered.</p>
<div class="example">
<pre>
<figure id="figure-sample-image">
<img src="media/sample.png">
<figcaption>Example of a figure</figcaption>
</figure>
</pre>
<p>is rendered as</p>
<figure id="figure-sample-image">
<img class="figure" src="media/sample.png">
<figcaption>Example of a figure</figcaption>
</figure>
</div>
<p>When referencing a figure in the prose, an <code>a</code> element with its <code>href</code> attribute referencing the
<code>figure</code> element shall be used. The text of the link will be automatically set to the number of the figure.</p>
<div class="example">
<code><a href="#figure-sample-image"></a></code> is rendered as <a href="#figure-sample-image"></a>.
</div>
</section>
<section id="sec-table-element">
<h4>Tables</h4>
<p>Tables can be inserted by using a <code>table</code> element.</p>
<p>The <code>table</code> element shall contain:</p>
<ul>
<li>an <code>id</code> attribute whose value starts with <code>tab-</code></li>
<li>one <code>caption</code> element as the first child of the <code>table</code> element</li>
<li>one <code>thead</code> element, containing one <code>tr</code> element, with <code>th</code> element(s) as needed for
each column header</li>
<li>one or more <code>tbody</code> element, with <code>tr</code> element(s) as needed for each row</li>
</ul>
<p>Unless all columns are uniform in contents, the relative width of
each column should be specified by setting the CSS <code>width</code>
property as a percentage value on each <code>th</code> element.</p>
<p class="note">Page breaks are avoided within a <code>tbody</code>
element when generating PDF. Care should be taken for especially long
tables to ensure rendering is as expected. For data in tables spanning
multiple pages, other options should be considered and used.</p>
<div class="example">
<pre>
<table id="tab-sample-tabledata">
<caption>Sample Table</caption>
<thead>
<tr>
<th style="width: 30%">Sample Number</th>
<th style="width: 70%">Sample Name</th>
</tr>
</thead>
<tbody>