Skip to content

Commit f5391bf

Browse files
SteveLLambpalemieux
SteveLLamb
and
palemieux
authored
HTML rendering of document (#3)
* add template * first draft html render * add figure * update tooling from template, add figure * add intro section * roll up tooling * roll up tooling 2 * roll up tooling 3 * update PNG to larger for readability * update diagram to SVG, add source Visio * rollup changes from tooling and index.html * update figure and caption for readability * roll in draft watermarking * bump tooling and doc * push comment on figure to bottom * Fix SVG upload media type * bump tooling for SVGs Co-authored-by: Pierre-Anthony Lemieux <[email protected]>
1 parent b8afa04 commit f5391bf

13 files changed

+338
-12
lines changed

‎.github/workflows/main.yml

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
name: Build SMPTE document
2+
3+
on: [push, pull_request]
4+
5+
env:
6+
AWS_REGION: us-east-1
7+
AWS_S3_BUCKET: html-doc-pub
8+
AWS_ROLE: arn:aws:iam::189079736792:role/gh-actions-html-pub
9+
CANONICAL_LINK_PREFIX: https://doc.smpte-doc.org/
10+
11+
jobs:
12+
build:
13+
runs-on: ubuntu-latest
14+
if: (github.event_name == 'push' && github.ref == 'refs/heads/main') || github.event_name == 'pull_request'
15+
# These permissions are needed to interact with GitHub's OIDC Token endpoint.
16+
permissions:
17+
id-token: write
18+
contents: write
19+
pull-requests: write
20+
21+
steps:
22+
23+
- name: Checkout repo
24+
uses: actions/checkout@v3
25+
with:
26+
fetch-depth: 0
27+
ref: ${{ github.event.pull_request.head.sha }}
28+
submodules: true
29+
30+
- name: Set repository name
31+
run: echo "REPOSITORY_NAME=${GITHUB_REPOSITORY#*/}" >> $GITHUB_ENV
32+
33+
- name: Check out all branches with the exception of the current branch
34+
run: CUR_BRANCH=$(git rev-parse --abbrev-ref HEAD); for i in `git branch -a | grep remote | grep -v HEAD | grep -v ${CUR_BRANCH}`; do git branch --track ${i#remotes/origin/} $i; done
35+
36+
- name: Configure AWS Credentials
37+
uses: aws-actions/configure-aws-credentials@v1-node16
38+
with:
39+
role-to-assume: ${{ env.AWS_ROLE }}
40+
aws-region: ${{ env.AWS_REGION }}
41+
42+
- name: Build and deploy document (local)
43+
uses: ./tooling/workflows
44+
if: github.repository != 'SMPTE/html-pub'
45+
with:
46+
AWS_S3_REGION: ${{env.AWS_REGION}}
47+
AWS_S3_BUCKET: ${{env.AWS_S3_BUCKET}}
48+
AWS_S3_KEY_PREFIX: "${{env.REPOSITORY_NAME}}/"
49+
CANONICAL_LINK_PREFIX: ${{env.CANONICAL_LINK_PREFIX}}
50+
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
51+
52+
- name: Build and deploy document (HTML Pub repo)
53+
uses: ./workflows
54+
if: github.repository == 'SMPTE/html-pub'
55+
with:
56+
AWS_S3_REGION: ${{env.AWS_REGION}}
57+
AWS_S3_BUCKET: ${{env.AWS_S3_BUCKET}}
58+
AWS_S3_KEY_PREFIX: "${{env.REPOSITORY_NAME}}/"
59+
CANONICAL_LINK_PREFIX: ${{env.CANONICAL_LINK_PREFIX}}
60+
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

‎.gitignore

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# SMPTE HTML Publication artifacts
2+
/build
3+
/package.json
4+
/package-lock.json
5+
6+
# MacOS
7+
.DS_Store
8+
._*
9+
10+
# Unix
11+
*~
12+
13+
# Windows
14+
Thumbs.db
15+
.vscode
16+
17+
# npm
18+
/node_modules

‎.gitmodules

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
[submodule "tooling"]
2+
path = tooling
3+
url = https://github.com/SMPTE/html-pub.git
4+
branch = main

‎.smpte-build.json

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"latestEditionTag": null
3+
}

‎CONFIDENTIALITY.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1-
This respository is not SMPTE Confidential Information and is not subject to the confidentiality policy specified by the SMPTE Standards Operations Manual.
1+
# CONFIDENTIALITY
2+
3+
This repository is not SMPTE Confidential Information and is not subject to the
4+
confidentiality policy specified by the SMPTE Standards Operations Manual.

‎CONTRIBUTING.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,10 @@
1-
Contributions to this repository are governed by the [SMPTE Standards Operations Manual](https://www.smpte.org/about/policies-and-governance) and are considered as submissions of documents to Technology Committee for consideration for standardization. Contributors that are not Members of the Standards Community are considered Guests for the purpose of such contributions.
1+
# CONTRIBUTING
2+
3+
Please be aware that all contributions to this material are being conducted in accordance with the SMPTE Standards Operations
4+
Manual, which is accessible on the SMPTE website with the Society Bylaws: https://www.smpte.org/about/policies-and-governance.
5+
6+
Your comments and contributions, whether as a member or guest, are governed by these provisions and any comment or contribution made
7+
by you indicates your acknowledgement that you understand and are complying with the full form of the Operations Manual. Please take
8+
careful note of the sections requiring contributors to inform the Committee of personal knowledge of any claims under any issued
9+
patent or any patent application that likely would be infringed by an implementation of this material. This general reminder is not
10+
a substitute for a contributor’s responsibility to fully read, understand, and comply with the full Standards Operations Manual.

‎LICENSE.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1-
Copyright © by the Society of Motion Picture and Television Engineers. All rights reserved. No part of this material may be reproduced, by any means whatsoever, without the prior written permission of the Society of Motion Picture and Television Engineers.
1+
# LICENSE
2+
3+
Copyright © by the Society of Motion Picture and Television Engineers. All rights reserved. No part of this material may be
4+
reproduced, by any means whatsoever, without the prior written permission of the Society of Motion Picture and Television Engineers.

‎PATENT.md ‎PATENTS.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1-
Attention is drawn to the possibility that some of the elements of this material may be the subject of patent rights. SMPTE shall not be held responsible for identifying any or all such patent rights.
1+
# PATENTS
2+
3+
Attention is drawn to the possibility that some of the elements of this material may be the subject of patent rights. SMPTE shall
4+
not be held responsible for identifying any or all such patent rights.

‎README.md

+4-8
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,9 @@
1-
# SMPTE AG 22, SMPTE Administrative Guideline -- Public Committee Draft (Public CD) Process
1+
# SMPTE _AG-22_ - _Public Committee Draft (Public CD) Process_
22

33
_This repository is *public*._
44

5-
Latest edition: [SMPTE AG 22:2020](https://f.hubspotusercontent00.net/hubfs/5253154/ag-22-2020.pdf)
5+
* [Latest version](https://doc.smpte-doc.org/ag-22/main/)
6+
* [Redline against the latest edition](https://doc.smpte-doc.org/ag-22/main/pub-rl.html)
67

78
Please consult [CONTRIBUTING.md](./CONTRIBUTING.md), [CONFIDENTIALITY.md](./CONFIDENTIALITY.md), [LICENSE.md](./LICENSE.md) and
8-
[PATENTS.md](./PATENTS.md) for important notices.
9-
10-
## Feedback
11-
12-
Please provide feedback at [GitHub issues](https://github.com/SMPTE/ag-22/issues) (preferred) or to
13-
[[email protected] ](mailto:[email protected]).
9+
[PATENTS.md](./PATENTS.md) for important notices.

‎doc/main.html

+225
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,225 @@
1+
<!DOCTYPE html>
2+
<html>
3+
4+
<head itemscope="itemscope" itemtype="http://smpte.org/standards/documents">
5+
<meta charset="utf-8" />
6+
<meta http-equiv="x-ua-compatible" content="ie=edge" />
7+
<meta name="viewport" content="width=device-width, initial-scale=1" />
8+
<script src="../tooling/smpte.js"></script>
9+
<meta itemprop="pubType" content="AG" />
10+
<meta itemprop="pubNumber" content="22" />
11+
<meta itemprop="pubState" content="draft" />
12+
<meta itemprop="pubDateTime" content="20XX-XX-XX" />
13+
<title>Public Committee Draft (Public CD) Process</title>
14+
</head>
15+
16+
<body>
17+
18+
<section id="sec-introduction">
19+
<h2>Introduction</h2>
20+
<p>Review of an engineering document by the public, beyond the members of the SMPTE Standards Community, can help determine if it meets industry needs and satisfies interoperability requirements. Such a review ideally takes place before the engineering document reaches Final Committee Draft, after which making substantial changes becomes increasingly complex.</p>
21+
</section>
22+
23+
<section id="sec-scope">
24+
<p>This Administrative Guideline specifies the process for Public Committee Drafts (<a>Public CD</a>), which are Committee Drafts made available to the public for review.</p>
25+
26+
<p class="note">A <a>Public CD</a> was referred to as a Technical Specification between 2018 and 2019.</p>
27+
</section>
28+
29+
<section id="sec-normative-references">
30+
31+
<ul>
32+
<li><cite id="bib-smpte-standards-operations-manual">SMPTE Standards Operations Manual</cite>
33+
<a>https://www.smpte.org/about/policies-and-governance</a></li>
34+
</ul>
35+
</section>
36+
37+
<section id="sec-terms-and-definitions">
38+
39+
<ul id="terms-ext-defs" itemscope="itemscope" itemtype="http://smpte.org/standards/external-definitions">
40+
<li><a itemprop="external" href="#bib-smpte-standards-operations-manual"></a></li>
41+
</ul>
42+
43+
<dl id="terms-int-defs">
44+
<dt><dfn>Public CD</dfn></dt>
45+
<dd>Committee Draft made available to the public for review
46+
</dd>
47+
</dl>
48+
49+
</section>
50+
51+
<section id="sec-public-cd-development">
52+
<h2>Public CD Development</h2>
53+
54+
<section id="sec-general">
55+
<h3>General (Informative)</h3>
56+
57+
<p>The development of a <a>Public CD</a> is conducted according to the SMPTE <a href="#bib-smpte-standards-operations-manual"></a>, including, but not limited to:</p>
58+
<ul>
59+
<li>the decision to make a Committee Draft available to the public rests with the Standards Vice President (<a href="#bib-smpte-standards-operations-manual"></a>, Section 9.3.1);</li>
60+
<li>contributions to a <a>Public CD</a> are subject to intellectual property and confidentiality policy specified
61+
in <a href="#bib-smpte-standards-operations-manual"></a>, Section 9;</li>
62+
<li>decisions are based on consensus, as defined in <a href="#bib-smpte-standards-operations-manual"></a>, Section 4.1;</li>
63+
<li>the Project Group can return the <a>Public CD</a> to the Technology Committee Chair for FCD ballot at
64+
any time (<a href="#bib-smpte-standards-operations-manual"></a>, Section 6.5).</li>
65+
</ul>
66+
<p><a href="#sec-process-flowchart"></a> illustrates an example of the <a>Public CD</a> process, as specified by this document.</p>
67+
68+
</section>
69+
70+
<section id="sec-project-proposal">
71+
<h3>Project Proposal</h3>
72+
73+
<p>A Project Proposal should indicate whether a deliverable is intended to become a <a>Public CD</a>.</p>
74+
75+
</section>
76+
77+
<section id="sec-creation">
78+
<h3>Creation</h3>
79+
80+
<p>Any Committee Draft may be made available as a <a>Public CD</a> if it meets the following criteria:</p>
81+
<ul>
82+
<li>the Committee Draft has not been previously made available as a <a>Public CD</a> and subsequently terminated, as specified in <a href="#sec-termination"></a>.</li>
83+
<li>by Consensus and usually following a recommendation of a Project Group, the TC has recommended to the Standards Vice President that the Committee Draft be made available as a <a>Public CD</a>.</li>
84+
</ul>
85+
<p>The TC recommendation should include a brief text appropriate for a public announcement of the <a>Public CD</a>.</p>
86+
<p>When seeking the TC recommendation, the TC chair should use the notice specified in <a href="#sec-tc-recommendation"></a>.</p>
87+
88+
</section>
89+
90+
<section id="sec-availability">
91+
<h3>Availability</h3>
92+
93+
<p>The <a>Public CD</a> shall be made available to the public in a form approved by the Director of Standards Development and shall be accompanied by the notices specified in <a href="#sec-availability-notices"></a>.</p>
94+
95+
</section>
96+
97+
<section id="sec-comment-period">
98+
<h3>Comment Period</h3>
99+
100+
<p>A Project Group should, but is under no obligation to, address comments received from the public on a <a>Public CD</a>.</p>
101+
<p>The review period of a <a>Public CD</a> starts upon availability, as defined in <a href="#sec-availability"></a>, and ends when either:</p>
102+
<ul>
103+
<li>the document begins its FCD ballot (<a href="#bib-smpte-standards-operations-manual"></a>, Section 6.6), at which point the notice specified in <a href="#sec-notice-of-fcd"></a> shall be displayed prominently alongside the <a>Public CD</a>; or</li>
104+
<li>the <a>Public CD</a> is terminated.</li>
105+
</ul>
106+
107+
108+
</section>
109+
110+
<section id="sec-revision">
111+
<h3>Revision</h3>
112+
113+
<p>A <a>Public CD</a> may be revised at any time.</p>
114+
<p>To revise a <a>Public CD</a>, the Committee Draft shall be revised.</p>
115+
<p>Revising a Committee Draft returns the document to Working Draft status and the process at <a href="#bib-smpte-standards-operations-manual"></a>, Section 6.5 is followed to elevate the revised Working Draft to Committee Draft.</p>
116+
<p>The revised Committee Draft may follow the process of <a href="#sec-creation"></a> to be made available as a <a>Public CD</a>.</p>
117+
118+
</section>
119+
120+
<section id="sec-termination">
121+
<h3>Termination</h3>
122+
123+
<p>A <a>Public CD</a> shall be terminated if any one of the following criteria is satisfied:</p>
124+
<ul>
125+
<li>the engineering document is published (see <a href="#bib-smpte-standards-operations-manual"></a>, Section 6.11)</li>
126+
<li>the Committee Draft of the document is revised</li>
127+
<li>more than 1095 days have elapsed since the document was initially made available as a <a>Public CD</a>, unless the Standards Vice President elects to extend the period upon recommendation of the TC</li>
128+
<li>the Project authorizing the engineering document is terminated</li>
129+
</ul>
130+
<p>Upon termination of a <a>Public CD</a>, its public access to shall be immediately terminated.</p>
131+
132+
</section>
133+
134+
</section>
135+
136+
<section class="annex" id="sec-process-flowchart">
137+
<h2>Process Flowchart (Informative)</h2>
138+
139+
<p><a href="#figure-process-flowchart"></a> illustrates an example of the Public CD process.</p>
140+
141+
<figure id="figure-process-flowchart">
142+
<img class="figure" src="media/figure-process-flowchart.svg">
143+
<figcaption>Example of the <a>Public CD</a> Process</figcaption>
144+
</figure>
145+
146+
<p class="note">A second <a>Public CD</a> (PCD2) is made available after addressing comments received on the first <a>Public CD</a> (PCD1).</p>
147+
148+
</section>
149+
150+
<section class="annex" id="sec-tc-recommendation">
151+
<h2>TC Recommendation</h2>
152+
153+
<pre>
154+
As specified in SMPTE Administrative Guideline AG-22, the TC recommends that the Committee Draft of
155+
&lt;-document number-&gt; be made available as a <a>Public CD</a> with the following announcement:
156+
157+
&lt;-brief text appropriate for a public announcement of the <a>Public CD</a>-&gt;
158+
159+
The members of the TC are reminded of their obligations to notify the TC Chair if they are aware, based
160+
on their actual personal knowledge, of patents or patent applications that might contain Essential Claims
161+
to a technology being proposed for inclusion in the <a>Public CD</a>.
162+
</pre>
163+
164+
</section>
165+
166+
<section class="annex" id="sec-availability-notices">
167+
<h2>Availability Notices</h2>
168+
169+
<section id="sec-contributor-license-agreement-cla-notice">
170+
<h3>Contributor License Agreement (CLA) notice</h3>
171+
172+
<pre>
173+
Please be aware that all contributions to this material are being conducted in accordance with the SMPTE
174+
Standards Operations Manual, which is accessible on the SMPTE website with the Society Bylaws:
175+
176+
https://www.smpte.org/about/policies-and-governance
177+
178+
Your comments and contributions, whether as a member or guest, are governed by these provisions and
179+
any comment or contribution made by you indicates your acknowledgement that you understand and are
180+
complying with the full form of the Operations Manual. Please take careful note of the sections requiring
181+
contributors to inform the Committee of personal knowledge of any claims under any issued patent or any
182+
patent application that likely would be infringed by an implementation of this material. This general
183+
reminder is not a substitute for a contributor’s responsibility to fully read, understand, and comply with the
184+
full Standards Operations Manual
185+
</pre>
186+
187+
</section>
188+
189+
<section id="sec-copyright-notice">
190+
<h3>Copyright notice</h3>
191+
192+
<pre>
193+
Copyright © by the Society of Motion Picture and Television Engineers. All rights reserved. No part of this
194+
material may be reproduced, by any means whatsoever, without the prior written permission of the
195+
Society of Motion Picture and Television Engineers
196+
</pre>
197+
198+
</section>
199+
200+
<section id="sec-patent-notice">
201+
<h3>Patent notice</h3>
202+
203+
<pre>
204+
Attention is drawn to the possibility that some of the elements of this material may be the subject of patent
205+
rights. SMPTE shall not be held responsible for identifying any or all such patent rights.
206+
</pre>
207+
208+
</section>
209+
210+
</section>
211+
212+
<section class="annex" id="sec-notice-of-fcd">
213+
<h2>Notice of FCD</h2>
214+
215+
<pre>
216+
This Committee Draft was made available by the Society of Motion Picture and Television Engineers for a
217+
public review period, which ended on &lt;-start date of the FCD ballot-&gt;. The document is now being
218+
processed for publication. Note that the published document may ultimately differ from this Committee
219+
Draft.
220+
</pre>
221+
222+
</section>
223+
224+
</body>
225+
</html>

‎doc/media/figure-process-flowchart.svg

+1
Loading

‎doc/media/figure-process-flowchart.vsd

41.5 KB
Binary file not shown.

‎tooling

Submodule tooling added at f8df4e8

0 commit comments

Comments
 (0)