Skip to content

Commit 314bbca

Browse files
SteveLLambSteveLLamb
committed
Closes #380, closes #382 
1 parent 1775238 commit 314bbca

1 file changed

Lines changed: 133 additions & 24 deletions

File tree

‎doc/main.html‎

Lines changed: 133 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<meta itemprop="pubType" content="AG">
1010
<meta itemprop="pubNumber" content="26">
1111
<!-- <meta itemprop="pubPart" content="XX"> -->
12-
<meta itemprop="pubState" content="pub">
12+
<meta itemprop="pubState" content="draft">
1313
<!-- meta itemprop="pubStage" content="WD"> -->
1414
<meta itemprop="pubConfidential" content="no">
1515
<!--< meta itemprop="pubTC" content="XX"> -->
@@ -37,10 +37,26 @@
3737
<ul>
3838
<li>
3939
<cite id="bib-HTML-5">HTML Standard</cite>, Living Standard
40-
<a>https://html.spec.whatwg.org/multipage/</a></li>
40+
<a>https://html.spec.whatwg.org/multipage/</a></li>
41+
<li><cite id="bib-smpte-standards-operations-manual">SMPTE Standards Operations Manual</cite>
42+
<a>https://doc.smpte-doc.org/standards-operations-manual/main/</a></li>
43+
<li><cite id="bib-smpte-ag-02">SMPTE AG 02</cite>, Document Naming and Packaging
44+
<a>https://doc.smpte-doc.org/ag-02/main/</a></li>
45+
<li><cite id="bib-smpte-ag-07">SMPTE AG 07</cite>, Document Flowcharts
46+
<a>https://doc.smpte-doc.org/ag-07/main/</a></li>
47+
<li><cite id="bib-smpte-ag-31">SMPTE AG 31</cite>, GitHub Operating Guidelines
48+
<a>https://doc.smpte-doc.org/ag-31/main/</a></li>
4149
</ul>
4250
</section>
4351

52+
<section id="sec-terms-and-definitions">
53+
<ul id="terms-ext-defs">
54+
<li><a href="#bib-smpte-standards-operations-manual"></a></li>
55+
<li><a href="#bib-smpte-ag-31"></a></li>
56+
</ul>
57+
58+
</section>
59+
4460
<section id="sec-quick-start">
4561
<h2>Quick start</h2>
4662

@@ -983,7 +999,7 @@ <h4>Lists</h4>
983999
<section id="sec-figure-element">
9841000
<h4>Figures</h4>
9851001

986-
<p>A figure can be inserted using a <code>figure</code> element with the following requirements:</p>
1002+
<p>A figure can be inserted using a <code>figure</code> element, using the image format as defined in <a href="#bib-smpte-ag-02"></a>, with the following requirements. </p>
9871003

9881004
<p>The <code>figure</code> element shall contain:</p>
9891005
<ul>
@@ -1001,7 +1017,7 @@ <h4>Figures</h4>
10011017
<div class="example">
10021018
<pre>
10031019
&lt;figure id=&quot;figure-sample-image&quot;&gt;
1004-
&lt;img src=&quot;media/sample.png&quot;&gt;
1020+
&lt;img src=&quot;media/sample.svg&quot;&gt;
10051021
&lt;figcaption&gt;Example of a figure&lt;/figcaption&gt;
10061022
&lt;/figure&gt;
10071023
</pre>
@@ -2204,64 +2220,160 @@ <h3>Complex List Example</h3>
22042220
<h2>Document Status Workflow</h2>
22052221

22062222
<section id="sec-document-mapping-status">
2207-
<h3>Mapping <code>pubState</code> and <code>pubStage</code> to Document Status</h3>
2223+
<h3>Mapping <code>meta</code> tags to Document Status</h3>
22082224
<p>
2209-
<a href="#tab-document-mapping-status"></a> maps the required values of <code>content</code> for <code>pubState</code> and <code>pubStage</code> during the various stages of document development.
2225+
<a href="#tab-document-mapping-status"></a> maps the required <code>content</code> values of <code>pubState</code>, <code>pubStage</code>, and <code>pubConfidential</code> during the various stages of document development. These values represent the naming convention(s) as defined in <a href="#bib-smpte-ag-02"></a> and flowcharts as defined in <a href="#bib-smpte-ag-07"></a>
22102226
</p>
2211-
<table id="tab-document-mapping-status" class="col-2-center col-3-center">
2212-
<caption>Mapping <code>pubStage</code> and <code>pubState</code> to Document Status</caption>
2227+
<table id="tab-document-mapping-status" class="col-2-center col-3-center col-4-center">
2228+
<caption>Mapping <code>content</code> values for <code>meta</code> tags to Document Status</caption>
22132229
<thead>
22142230
<tr>
22152231
<th>Document Status</th>
2216-
<th><code>pubStage</code> <code>content</code> value</th>
2217-
<th><code>pubState</code> <code>content</code> value</th>
2232+
<th><code>pubStage</code> value</th>
2233+
<th><code>pubState</code> value</th>
2234+
<th><code>pubConfidential</code> value</th>
22182235
</tr>
22192236
</thead>
22202237
<tbody>
22212238
<tr>
2222-
<td>Undergoing initial draft or revision in DG/SG/WG</td>
2239+
<td>Initial draft or revision (Working Draft) in:
2240+
<br/>Draft Group (DG)
2241+
<br/>Study Group (SG)
2242+
<br/>Working Group (WG)</td>
22232243
<td><code>WD</code></td>
22242244
<td><code>draft</code></td>
2245+
<td><code>yes</code></td>
22252246
</tr>
22262247
<tr>
2227-
<td>Undergoing pre-FCD review</td>
2248+
<td class="center-cell" colspan="4"><em>>> Document moves to TC >></em></td>
2249+
</tr>
2250+
<tr>
2251+
<td>Pre-FCD (Final Committee Draft) review</td>
22282252
<td><code>WD</code></td>
22292253
<td><code>pub</code></td>
2254+
<td><code>yes</code></td>
2255+
</tr>
2256+
<tr>
2257+
<td class="center-cell" colspan="4"><em>>> If pre-FCD comments received, back to DG/SG/WG >></em></td>
2258+
</tr>
2259+
<tr>
2260+
<td>Pre-FCD comment resolution ongoing </td>
2261+
<td><code>CD</code></td>
2262+
<td><code>draft</code></td>
2263+
<td><code>yes</code></td>
2264+
</tr>
2265+
<tr>
2266+
<td>Pre-FCD comment resolution complete </td>
2267+
<td><code>CD</code></td>
2268+
<td><code>pub</code></td>
2269+
<td><code>yes</code></td>
2270+
</tr>
2271+
<tr>
2272+
<td class="center-cell" colspan="4"><em>>> Document moves to TC >></em></td>
2273+
</tr>
2274+
<tr>
2275+
<td>PCD (Public Committee Draft) period</td>
2276+
<td><code>CD</code></td>
2277+
<td><code>pub</code></td>
2278+
<td><code>no</code></td>
22302279
</tr>
22312280
<tr>
2232-
<td>Undergoing comment resolution from pre-FCD review (or) undergoing comment resolution from PCD period</td>
2281+
<td>PCD comment resolution ongoing (moves back to DG/SG/WG)</td>
22332282
<td><code>CD</code></td>
22342283
<td><code>draft</code></td>
2284+
<td><code>yes</code></td>
2285+
</tr>
2286+
<tr>
2287+
<td>PCD comment resolution complete</td>
2288+
<td colspan="3"><em>>> Back to Pre-FCD (Final Committee Draft) review >></em></td>
2289+
</tr>
2290+
2291+
<tr>
2292+
<td class="center-cell" colspan="4"><em>(OR)</em></td>
2293+
</tr>
2294+
<tr>
2295+
<td>Ready for FCD ballot</td>
2296+
<td><code>CD</code></td>
2297+
<td><code>pub</code></td>
2298+
<td><code>yes</code></td>
22352299
</tr>
22362300
<tr>
2237-
<td>Ready for FCD ballot (or) undergoing FCD ballot (or) ready for PCD (or) currently in PCD period</td>
2301+
<td>FCD ballot period</td>
22382302
<td><code>CD</code></td>
22392303
<td><code>pub</code></td>
2304+
<td><code>yes</code></td>
2305+
</tr>
2306+
<tr>
2307+
<td class="center-cell" colspan="4"><em>>> If FCD ballot comments received >></em></td>
22402308
</tr>
22412309
<tr>
2242-
<td>FCD ballot complete, undergoing comment resolution</td>
2310+
<td>FCD ballot comment resolution ongoing</td>
22432311
<td><code>FCD</code></td>
22442312
<td><code>draft</code></td>
2313+
<td><code>yes</code></td>
2314+
</tr>
2315+
<tr>
2316+
<td>FCD ballot comment resolution complete</td>
2317+
<td><code>FCD</code></td>
2318+
<td><code>pub</code></td>
2319+
<td><code>yes</code></td>
22452320
</tr>
22462321
<tr>
2247-
<td>FCD ballot comment resolution complete (or) undergoing pre-DP review (or) ready for DP ballot (or) undergoing DP ballot </td>
2322+
<td>Pre-DP (Draft Publication) review</td>
22482323
<td><code>FCD</code></td>
22492324
<td><code>pub</code></td>
2325+
<td><code>yes</code></td>
2326+
</tr>
2327+
<tr>
2328+
<td>Pre-DP ballot period</td>
2329+
<td><code>FCD</code></td>
2330+
<td><code>pub</code></td>
2331+
<td><code>yes</code></td>
2332+
</tr>
2333+
<tr>
2334+
<td class="center-cell" colspan="4"><em>(ELSE)</em></td>
2335+
</tr>
2336+
<tr>
2337+
<td>FCD ballot passes, no comments</td>
2338+
<td><code>DP</code></td>
2339+
<td><code>pub</code></td>
2340+
<td><code>yes</code></td>
2341+
</tr>
2342+
<tr>
2343+
<td>DP ballot passes</td>
2344+
<td><code>DP</code></td>
2345+
<td><code>pub</code></td>
2346+
<td><code>yes</code></td>
22502347
</tr>
22512348
<tr>
2252-
<td>FCD ballot complete with no comments (or) DP ballot passed (or) ready for ST Audit (or) undergoing ST audit</td>
2349+
<td>Ready for ST (Standards Committee) Audit</td>
22532350
<td><code>DP</code></td>
22542351
<td><code>pub</code></td>
2352+
<td><code>yes</code></td>
22552353
</tr>
22562354
<tr>
2257-
<td>ST audit complete (or) waiting for publication</td>
2355+
<td>ST Audit period</td>
2356+
<td><code>DP</code></td>
2357+
<td><code>pub</code></td>
2358+
<td><code>yes</code></td>
2359+
</tr>
2360+
<tr>
2361+
<td>ST Audit complete</td>
22582362
<td><code>PUB</code></td>
22592363
<td><code>draft</code></td>
2364+
<td><code>yes</code></td>
2365+
</tr>
2366+
<tr>
2367+
<td>Waiting for publication</td>
2368+
<td><code>PUB</code></td>
2369+
<td><code>draft</code></td>
2370+
<td><code>yes</code></td>
22602371
</tr>
22612372
<tr>
22622373
<td>Published</td>
22632374
<td><code>PUB</code></td>
22642375
<td><code>pub</code></td>
2376+
<td><code>no</code></td>
22652377
</tr>
22662378
</tbody>
22672379
</table>
@@ -2287,7 +2399,7 @@ <h3>GitHub Releases</h3>
22872399
The <code>latestEditionTag</code> property in the <code>.smpte-build.json</code> file shall always be equal to the name of the most recent git tag. This will trigger the tooling to create a link for <code>Redline to most recent edition</code> during any PRs and merges to the <code>main</code> branch.
22882400
</p>
22892401
<p>
2290-
The tooling will automatically generate zip files within the release details page, to be used for both :</p>
2402+
The tooling will automatically generate zip file packages within the release details page, to be used for both :</p>
22912403
<ul>
22922404
<li>TC review/balloting (named as per <a href="#bib-smpte-ag-02"></a>)</li>
22932405
<li>(and) SMPTE Document Library publishing (named by the tag)</li>
@@ -2317,7 +2429,7 @@ <h3>Sample Workflow </h3>
23172429
The below list shows a sample workflow which would be the steps for an Engineering Document going through an initial draft or revision and the balloting process.
23182430
</p>
23192431

2320-
<p class="note">Editors and Chairs should be aware of the general guidelines provided in the <a href="#bib-smpte-gh-om"></a>.
2432+
<p class="note">Editors and Chairs should be aware of the general guidelines provided in the <a href="#bib-smpte-ag-31"></a>.
23212433
</p>
23222434
<ol>
23232435

@@ -2491,12 +2603,9 @@ <h3>Sample Workflow </h3>
24912603
<li><cite id="bib-iso-directives-part2">ISO/IEC Directives, Part 2</cite>, Principles and rules for the structure and drafting
24922604
of ISO and IEC documents (Ninth edition, 2021)
24932605
<a>https://www.iso.org/sites/directives/current/part2/index.xhtml</a></li>
2494-
<li><cite id="bib-smpte-ag-02">SMPTE AG 02</cite>, Document Naming and Packaging
2495-
<a>https://doc.smpte-doc.org/ag-02/main/</a></li>
24962606
<li><cite id="bib-smpte-ag-16">SMPTE AG 16</cite>, Standards Style Guide
24972607
<a>https://doc.smpte-doc.org/ag-16/main/</a></li>
2498-
<li><cite id="bib-smpte-gh-om">SMPTE GitHub Operating Manual</cite>
2499-
<a>https://github.com/SMPTE/github-operating-manual</a></li>
2608+
25002609

25012610
</ul>
25022611
</section>

0 commit comments

Comments
 (0)