Skip to content

Commit f9ce237

Browse files
SteveLLambSteveLLamb
authored
Update for HTML (#15)
* Update for HTML * update wording * bump tooling for conformance * bump tooling * roll to pub
1 parent 284b123 commit f9ce237

File tree

4 files changed

+31
-21
lines changed

4 files changed

+31
-21
lines changed

‎.github/workflows/main.yml

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
name: Build SMPTE document
22

3-
on: [push, pull_request]
3+
on:
4+
push:
5+
pull_request:
6+
release:
7+
types: [published]
48

59
env:
610
AWS_REGION: us-east-1
@@ -11,7 +15,12 @@ env:
1115
jobs:
1216
build:
1317
runs-on: ubuntu-latest
14-
if: (github.event_name == 'push' && github.ref == 'refs/heads/main') || github.event_name == 'pull_request'
18+
if: >
19+
github.repository_owner == 'SMPTE' && (
20+
(github.event_name == 'push' && github.ref == 'refs/heads/main')
21+
|| github.event_name == 'pull_request'
22+
|| github.event_name == 'release'
23+
)
1524
# These permissions are needed to interact with GitHub's OIDC Token endpoint.
1625
permissions:
1726
id-token: write
@@ -24,14 +33,13 @@ jobs:
2433
uses: actions/checkout@v3
2534
with:
2635
fetch-depth: 0
27-
ref: ${{ github.event.pull_request.head.sha }}
2836
submodules: true
2937

3038
- name: Set repository name
3139
run: echo "REPOSITORY_NAME=${GITHUB_REPOSITORY#*/}" >> $GITHUB_ENV
3240

3341
- 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
42+
run: CUR_BRANCH=$(git rev-parse --abbrev-ref HEAD); for i in `git branch -a | grep remote | grep -v "remotes/pull" | grep -v HEAD | grep -v ${CUR_BRANCH}`; do git branch --track ${i#remotes/origin/} $i; done
3543

3644
- name: Configure AWS Credentials
3745
uses: aws-actions/configure-aws-credentials@v1-node16
@@ -44,7 +52,7 @@ jobs:
4452
if: github.repository != 'SMPTE/html-pub'
4553
with:
4654
AWS_S3_REGION: ${{env.AWS_REGION}}
47-
AWS_S3_BUCKET: ${{env.AWS_S3_BUCKET}}
55+
AWS_S3_BUCKET: ${{env.AWS_S3_BUCKET}}
4856
AWS_S3_KEY_PREFIX: "${{env.REPOSITORY_NAME}}/"
4957
CANONICAL_LINK_PREFIX: ${{env.CANONICAL_LINK_PREFIX}}
5058
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
@@ -54,7 +62,7 @@ jobs:
5462
if: github.repository == 'SMPTE/html-pub'
5563
with:
5664
AWS_S3_REGION: ${{env.AWS_REGION}}
57-
AWS_S3_BUCKET: ${{env.AWS_S3_BUCKET}}
65+
AWS_S3_BUCKET: ${{env.AWS_S3_BUCKET}}
5866
AWS_S3_KEY_PREFIX: "${{env.REPOSITORY_NAME}}/"
5967
CANONICAL_LINK_PREFIX: ${{env.CANONICAL_LINK_PREFIX}}
60-
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
68+
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

‎README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,11 @@
33
_This repository is *public*._
44

55
* [Latest version](https://doc.smpte-doc.org/ag-05/main/)
6-
* [Redline against the latest edition](https://doc.smpte-doc.org/ag-05/main/pub-rl.html)
6+
* [Latest version (all artifacts)](https://doc.smpte-doc.org/ag-05/main/pub-artifacts.html)
77

88
Please consult [CONTRIBUTING.md](./CONTRIBUTING.md), [CONFIDENTIALITY.md](./CONFIDENTIALITY.md), [LICENSE.md](./LICENSE.md) and
99
[PATENTS.md](./PATENTS.md) for important notices.
10+
11+
## Reporting issues
12+
13+
Issues should be reported at <https://github.com/SMPTE/ag-05/issues>.

‎doc/main.html

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
<!DOCTYPE html>
2-
<html>
3-
2+
<html lang="en">
43
<head itemscope="itemscope" itemtype="http://smpte.org/standards/documents">
54
<meta charset="utf-8" />
65
<meta http-equiv="x-ua-compatible" content="ie=edge" />
76
<meta name="viewport" content="width=device-width, initial-scale=1" />
8-
<script src="../tooling/smpte.js"></script>
7+
<script type="module" src="../tooling/smpte.js"></script>
98
<meta itemprop="pubType" content="AG" />
109
<meta itemprop="pubNumber" content="05" />
11-
<meta itemprop="pubState" content="draft" />
12-
<meta itemprop="pubDateTime" content="2023-04-09" />
10+
<meta itemprop="pubState" content="pub" />
11+
<meta itemprop="pubStage" content="PUB">
12+
<meta itemprop="pubDateTime" content="2025-03-25" />
1313
<title>XML in Engineering Documents</title>
1414
</head>
1515

@@ -88,7 +88,7 @@ <h4>Name Syntax</h4>
8888
</p>
8989

9090
<pre>
91-
NS = %s"<a>http://www.smpte-ra.org/ns/</a>" PUBNUM "/" REVISION [SHORTNAME]
91+
NS = %s"http://www.smpte-ra.org/ns/" PUBNUM "/" REVISION [SHORTNAME]
9292
SHORTNAME = 1*4("/" 1*(ALPHA / DIGIT / "-" / "_" / ".") )
9393
PUBNUM = 1*(DIGIT) ["-" 1*(DIGIT)]
9494
REVISION = STABLEREV / EXPREV
@@ -257,7 +257,7 @@ <h3>Using XML Schema</h3>
257257
<section id="sec-precdence">
258258
<h3>Precedence</h3>
259259
<p>
260-
Engineering Documents may specify a policy in case of a conflict between prose and XML Schema. In absence of such policy, the precedence rules specified in the Conformance section of <a href="#bib-smpte-ag-04-st"></a>, or <a href="#bib-smpte-ag-04-eg"></a> respectively, applies.
260+
Engineering Documents may specify a policy in case of a conflict between prose and XML Schema. In absence of such policy, the precedence rules specified in the Conformance section of a Standard (ST), or Engineering Guideline (EG) respectively, applies. See <a href="#bib-ag-27"></a> for specific wording.
261261
</p>
262262
</section>
263263

@@ -367,7 +367,7 @@ <h2>XML Element Header</h2>
367367

368368
<pre>
369369
&lt;!--
370-
[[TEXT OF XML DOCUMENT LICENSE OF <a href="#sec-document-license"></a> IN AG-05]]
370+
[[TEXT OF XML DOCUMENT LICENSE IN AG-05 ABOVE]]
371371
--&gt;
372372

373373
&lt;!--
@@ -427,10 +427,8 @@ <h2>Sample XML Namespace Definition Document (informative)</h2>
427427
<a>https://html.spec.whatwg.org/</a></li>
428428
<li>IETF <cite id="bib-ietf-guide">Guidelines for the Use of Formal Languages in IETF Specifications</cite>
429429
<a>https://www.ietf.org/about/groups/iesg/statements/formal-languages-use/</a></li>
430-
<li><cite id="bib-smpte-ag-04-st">SMPTE AG-04-ST</cite>, Standards Template
431-
<a>https://www.smpte.org/about/policies-and-governance</a></li>
432-
<li><cite id="bib-smpte-ag-04-eg">SMPTE AG-04-EG</cite>, Engineering Guideline Template
433-
<a>https://www.smpte.org/about/policies-and-governance</a></li>
430+
<li><cite id="bib-ag-27">SMPTE AG-27</cite>, HTML Pub: Template (Base HTML Repo with Tooling)
431+
<a>https://github.com/SMPTE/html-pub-template</a></li>
434432
</ul>
435433
</section>
436434

‎tooling

Submodule tooling updated 57 files

0 commit comments

Comments
 (0)