Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace document license with reference to AG 30 #13

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 15 additions & 7 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
name: Build SMPTE document

on: [push, pull_request]
on:
push:
pull_request:
release:
types: [published]

env:
AWS_REGION: us-east-1
Expand All @@ -11,7 +15,12 @@ env:
jobs:
build:
runs-on: ubuntu-latest
if: (github.event_name == 'push' && github.ref == 'refs/heads/main') || github.event_name == 'pull_request'
if: >
github.repository_owner == 'SMPTE' && (
(github.event_name == 'push' && github.ref == 'refs/heads/main')
|| github.event_name == 'pull_request'
|| github.event_name == 'release'
)
# These permissions are needed to interact with GitHub's OIDC Token endpoint.
permissions:
id-token: write
Expand All @@ -24,14 +33,13 @@ jobs:
uses: actions/checkout@v3
with:
fetch-depth: 0
ref: ${{ github.event.pull_request.head.sha }}
submodules: true

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

- name: Check out all branches with the exception of the current branch
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
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

- name: Configure AWS Credentials
uses: aws-actions/configure-aws-credentials@v1-node16
Expand All @@ -44,7 +52,7 @@ jobs:
if: github.repository != 'SMPTE/html-pub'
with:
AWS_S3_REGION: ${{env.AWS_REGION}}
AWS_S3_BUCKET: ${{env.AWS_S3_BUCKET}}
AWS_S3_BUCKET: ${{env.AWS_S3_BUCKET}}
AWS_S3_KEY_PREFIX: "${{env.REPOSITORY_NAME}}/"
CANONICAL_LINK_PREFIX: ${{env.CANONICAL_LINK_PREFIX}}
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
Expand All @@ -54,7 +62,7 @@ jobs:
if: github.repository == 'SMPTE/html-pub'
with:
AWS_S3_REGION: ${{env.AWS_REGION}}
AWS_S3_BUCKET: ${{env.AWS_S3_BUCKET}}
AWS_S3_BUCKET: ${{env.AWS_S3_BUCKET}}
AWS_S3_KEY_PREFIX: "${{env.REPOSITORY_NAME}}/"
CANONICAL_LINK_PREFIX: ${{env.CANONICAL_LINK_PREFIX}}
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
45 changes: 5 additions & 40 deletions doc/main.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta charset="utf-8" />
<meta http-equiv="x-ua-compatible" content="ie=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<script src="../tooling/smpte.js"></script>
<script type="module" src="../tooling/smpte.js"></script>
<meta itemprop="pubType" content="AG" />
<meta itemprop="pubNumber" content="05" />
<meta itemprop="pubState" content="draft" />
Expand All @@ -30,6 +30,7 @@
<li><cite id="bib-ietf-rfc-3986">IETF RFC 3986</cite>, "Uniform Resource Identifiers (URI): Generic Syntax", T. Berners-Lee, et al., January 2005 <a>http://www.ietf.org/rfc/rfc3986.txt</a></li>

<li><cite id="bib-ietf-rfc-7405">IETF RFC 7405</cite>, Case-Sensitive String Support in ABNF, December 2014 <a>https://www.ietf.org/rfc/rfc7405.txt</a></li>
<li><cite id="bib-ag-30">SMPTE AG 30</cite>, Software License <a>https://www.smpte.org/about/policies-and-governance</a></li>
</ul>
</section>

Expand All @@ -39,7 +40,7 @@ <h2>General</h2>
<section id="sec-license">
<h3>License</h3>
<p>
Any document that (a) is defined by an Engineering Document and (b) conforms to <a href="#bib-w3c-rec-xml-20081126"></a>, whether within the prose or as an Additional Element, shall be licensed according to <a href="#sec-document-license"></a>.
Any document that (a) is defined by an Engineering Document and (b) conforms to <a href="#bib-w3c-rec-xml-20081126"></a>, whether within the prose or as an Additional Element, is licensed according to <a href="#bib-ag-30"></a>.
</p>
</section>

Expand Down Expand Up @@ -88,7 +89,7 @@ <h4>Name Syntax</h4>
</p>

<pre>
NS = %s"<a>http://www.smpte-ra.org/ns/</a>" PUBNUM "/" REVISION [SHORTNAME]
NS = %s"http://www.smpte-ra.org/ns/" PUBNUM "/" REVISION [SHORTNAME]
SHORTNAME = 1*4("/" 1*(ALPHA / DIGIT / "-" / "_" / ".") )
PUBNUM = 1*(DIGIT) ["-" 1*(DIGIT)]
REVISION = STABLEREV / EXPREV
Expand Down Expand Up @@ -324,50 +325,14 @@ <h3>Publication</h3>
</p>
</section>
</section>

<section class="annex" id="sec-document-license">
<h2>XML Document License</h2>

<pre>
Copyright (c), Society of Motion Pictures and Television Engineers. All rights
reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
</pre>

</section>

<section class="annex" id="sec-element-header">
<h2>XML Element Header</h2>

<pre>
&lt;!--
[[TEXT OF XML DOCUMENT LICENSE OF <a href="#sec-document-license"></a> IN AG-05]]
[[INSERT TEXT OF THE SOFTWARE LICENSE FOUND IN AG 30]]
--&gt;

&lt;!--
Expand Down
2 changes: 1 addition & 1 deletion tooling
Submodule tooling updated 56 files
+13 −5 .github/workflows/main.yml
+1 −1 .smpte-build.json
+7 −0 css/smpte-errors.css
+340 −79 css/smpte.css
+1 −0 doc/elements/sample.txt
+1,394 −84 doc/main.html
+41 −0 doc/snippets/list-sample-complex.txt
+8 −0 doc/snippets/pre-commit
+7 −1 doc/snippets/skeleton.html
+27 −0 doc/snippets/tab-sample-tabledata-centercell.txt
+27 −0 doc/snippets/tab-sample-tabledata-colcenter.txt
+30 −0 doc/snippets/tab-sample-tabledata-colspan.txt
+52 −0 doc/snippets/tab-sample-tabledata-complex.txt
+27 −0 doc/snippets/tab-sample-tabledata-defaultalign.txt
+32 −0 doc/snippets/tab-sample-tabledata-multiheader.txt
+26 −0 doc/snippets/tab-sample-tabledata-rowspan.txt
+190 −1 js/common.mjs
+36 −0 js/patchPDF.js
+735 −180 js/validate.mjs
+3,295 −1,874 package-lock.json
+7 −5 package.json
+410 −75 scripts/build.mjs
+2 −2 scripts/validate.mjs
+572 −190 smpte.js
+ static/smpte-icon.png
+44 −0 test/resources/html/validation/annex-reference-valid.html
+0 −1 test/resources/html/validation/bibliography-valid.html
+0 −1 test/resources/html/validation/body-order-invalid.html
+31 −0 test/resources/html/validation/dl-valid.html
+0 −1 test/resources/html/validation/effectiveDateTime-invalid.html
+38 −0 test/resources/html/validation/elements-invalid.html
+29 −0 test/resources/html/validation/elements-valid.html
+21 −0 test/resources/html/validation/empty-anchor-invalid.html
+23 −0 test/resources/html/validation/example-valid.html
+0 −1 test/resources/html/validation/general-valid.html
+23 −0 test/resources/html/validation/note-valid.html
+30 −0 test/resources/html/validation/ol-valid.html
+0 −1 test/resources/html/validation/om-valid.html
+26 −0 test/resources/html/validation/one-subclause-invalid.html
+23 −0 test/resources/html/validation/pub-version-valid.html
+18 −0 test/resources/html/validation/pubConfidential-invalid.html
+18 −0 test/resources/html/validation/pubConfidential-valid.html
+0 −1 test/resources/html/validation/pubDateTime-invalid.html
+0 −1 test/resources/html/validation/pubState-invalid.html
+18 −0 test/resources/html/validation/pubVersion-invalid.html
+22 −0 test/resources/html/validation/st-missing-suite-title-invalid.html
+21 −0 test/resources/html/validation/st-standalone-valid.html
+23 −0 test/resources/html/validation/st-valid.html
+29 −0 test/resources/html/validation/terms-2-invalid.html
+36 −0 test/resources/html/validation/terms-2-valid.html
+36 −0 test/resources/html/validation/terms-3-invalid.html
+29 −0 test/resources/html/validation/terms-invalid.html
+42 −0 test/resources/html/validation/terms-note-to-entry-2-valid.html
+14 −3 test/resources/html/validation/terms-valid.html
+16 −8 test/src/testValidation.mjs
+31 −2 workflows/action.yml
Loading