Skip to content
Merged
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
2 changes: 2 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ jobs:
AWS_S3_KEY_PREFIX: "${{env.REPOSITORY_NAME}}/"
CANONICAL_LINK_PREFIX: ${{env.CANONICAL_LINK_PREFIX}}
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
PUBLIC_REPO_PAT: ${{secrets.PUBLIC_REPO_PAT}}

- name: Build and deploy document (HTML Pub repo)
uses: ./workflows
Expand All @@ -66,6 +67,7 @@ jobs:
AWS_S3_KEY_PREFIX: "${{env.REPOSITORY_NAME}}/"
CANONICAL_LINK_PREFIX: ${{env.CANONICAL_LINK_PREFIX}}
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
PUBLIC_REPO_PAT: ${{secrets.PUBLIC_REPO_PAT}}

- name: Notify template repo to update submodule
if: github.event_name == 'release' && github.repository == 'SMPTE/html-pub'
Expand Down
28 changes: 14 additions & 14 deletions doc/main.html
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ <h2>Instructions for Project Details</h2>
<section id="sec-title-table-1">
<h3>Title (Table 1)</h3>
<p>The title of your project should be short and descriptive title starting with the TC parent group. This appears on all project lists.</p>
<p class="note">As soon as you have chosen your title, replace the text AG-06 New Project Form with that title and save this file with a filename of the form:</p>
<p class="note">As soon as you have chosen your title, replace the text "AG-06 New Project Form" with that title and save this file with a filename of the form:</p>
<pre>
&lt;TC>[-&lt;update&gt;]-&lt;type&gt;[-&lt;number&gt;][-&lt;part&gt;][&lt;element&gt;]-&lt;description&gt;[(&lt;note&gt;)]
</pre>
Expand All @@ -62,9 +62,9 @@ <h3>Title (Table 1)</h3>
<dt>&lt;update&gt;</dt>
<dd>is the word <b>Revision</b> or <b>Amendment</b> or is absent</dd>
<dt>&lt;description&gt;</dt>
<dd>is a brief indicator of subject, such as an abbreviated name of the project, constructed using only alpha characters, digits, space (“ “) and "-"•</dd>
<dd>is a brief indicator of subject, such as an abbreviated name of the project, constructed using only alpha characters, digits, space (" ") and "-"•</dd>
<dt>&lt;note&gt;</dt>
<dd>is an optional string that can be used to annotate the project, e.g. <b>coordination</b>. The &lt;note&gt; shall be constructed using only alpha characters, digits, “-“</dd>
<dd>is an optional string that can be used to annotate the project, e.g. <b>coordination</b>. The &lt;note&gt; shall be constructed using only alpha characters, digits, "-"</dd>
</dl>
<ul>
<li>Required but unknown fields should be replaced with <code>XX</code> until known</li>
Expand All @@ -79,7 +79,7 @@ <h3>Title (Table 1)</h3>

<section id="sec-proponents-table-2">
<h3>Proponents (Table 2)</h3>
<p>The <a href="#bib-smpte-standards-operations-manual"></a> §6.3 requires <em>one or more Proponents, who are SMPTE Standards Members agreeing to be actively involved in the Project</em>. Proponents are individuals and not organizations. The first listed proponent will become the publicly visible main contact for the project. The proponents field is not publicly visible but can be seen by Standards Community members. Please extend the table as needed.</p>
<p>The <a href="#bib-smpte-standards-operations-manual"></a> §6.3 requires <em>one or more Proponents, who are SMPTE Standards Members agreeing to be actively involved in the Project</em>. Proponents are individuals and not organizations. The first listed proponent will become the publicly visible main contact for the project. The proponent's field is not publicly visible but can be seen by Standards Community members. Please extend the table as needed.</p>

</section>

Expand All @@ -90,19 +90,19 @@ <h3>Details (Tables 3 and 4)</h3>
<h4>Notes for Table 3</h4>
<dl>
<dt>Description</dt>
<dd>A short description of the projects purpose and objectives. This text is aimed at the public who will read it and thus should be able to understand the Project in general terms. There may be extra requirements for this field for the Public CD Process (<a href="#bib-smpte-ag-22"></a>)</dd>
<dd>A short description of the project's purpose and objectives. This text is aimed at the public who will read it and thus should be able to understand the Project in general terms. There may be extra requirements for this field for the Public CD Process (<a href="#bib-smpte-ag-22"></a>)</dd>
<dt>Problem to be solved</dt>
<dd>A short statement about the problem to be solved. Ideally phrased in terms of requirements such that when those requirements are met, the document is complete. There may be extra requirements for this field for the Public CD Process (<a href="#bib-smpte-ag-22"></a>)</dd>
<dt>Project scope</dt>
<dd>A short description of the scope of work that will be done and optionally elements that are out of scope. A narrow scope often results in a faster, more controlled project lifecycle. An example would be <em>Revision of standard ST xxx to roll-up amendment ST-xxx-Amd-1 and to update the normative references</em>. This limited scope is intended to restrict the work to just the details in the scope without opening the document up for redesign.</dd>
<dd>A short description of the scope of work that will be done and optionally elements that are out of scope. A narrow scope often results in a faster, more controlled project lifecycle. An example would be <em>"Revision of standard ST xxx to roll-up amendment ST-xxx-Amd-1 and to update the normative references"</em>. This limited scope is intended to restrict the work to just the details in the scope without opening the document up for redesign.</dd>
<dt>Specific Tasks</dt>
<dd>A high-level list of tasks that need to be completed as the work progresses. Consider test materials, sample bitstreams, sample software, data schemas, validation criteria, problem decomposition, liaisons with other organizations etc.</dd>
<dt>Type of Output</dt>
<dd>Check one or more boxes where:
<pre>
ST Standard RP Recommended Practice
EG Engineering Guideline Rev Revision
ER Engineering Report RDD Registered Disclosure Document
ST - Standard RP - Recommended Practice
EG - Engineering Guideline Rev - Revision
ER - Engineering Report RDD - Registered Disclosure Document
</pre>
</dd>
<dt>Existing Version of Doc</dt>
Expand Down Expand Up @@ -132,14 +132,14 @@ <h4>Notes for Table 3</h4>
<h4>Notes for Table 4</h4>
<dl>
<dt>Project Group Name and Existing Group question</dt>
<dd>The submitter may make a request here for a new or existing Project Group to support the Project. It may be modified if the SVP decides that the work should go elsewhere. If the Group already exists, enter its name exactly as shown in Teams. If a new Group is required, enter the proposed name and fill out the fields below for the new group to be set up. Individual for projects with only a single person doing the work and therefore needing no Teams resources.</dd>
<dd>The submitter may make a request here for a new or existing Project Group to support the Project. It may be modified if the SVP decides that the work should go elsewhere. If the Group already exists, enter its name exactly as shown in Teams. If a new Group is required, enter the proposed name and fill out the fields below for the new group to be set up. Individual - for projects with only a single person doing the work and therefore needing no Teams resources.</dd>
<dt>Project Type</dt>
<dd>Check one of these boxes where:
<pre>
WG Working Group typically for larger projects with several subgroups doing drafting
DG Drafting Group for drafting an individual document
SG Study Group to create an Engineering Report (internal to SMPTE or for publication)
TF Task Force for study groups involving multiple TCs or active participation by
WG - Working Group typically for larger projects with several subgroups doing drafting
DG - Drafting Group for drafting an individual document
SG - Study Group to create an Engineering Report (internal to SMPTE or for publication)
TF - Task Force for study groups involving multiple TCs or active participation by
external organizations
</pre>
</dd>
Expand Down
2 changes: 1 addition & 1 deletion tooling
Submodule tooling updated 38 files
+2 −0 .github/workflows/main.yml
+66 −0 .github/workflows/pcd-cleanup-reusable.yml
+152 −0 .github/workflows/pcd-update-reusable.yml
+1 −1 .smpte-build.json
+105 −72 css/smpte.css
+539 −496 doc/main.html
+10 −5 doc/snippets/tab-sample-tabledata-centercell.txt
+7 −7 doc/snippets/tab-sample-tabledata-colcenter.txt
+294 −14 js/validate.mjs
+5 −1 json/schema/build-configuration.json
+100 −22 scripts/build.mjs
+72 −0 scripts/derive-public-repo.mjs
+85 −0 scripts/derive-release-tag.mjs
+9 −2 scripts/validate.mjs
+123 −22 smpte.js
+1 −0 test/resources/html/snippets/example.txt
+1 −0 test/resources/html/snippets/illegal-chars.txt
+1 −1 test/resources/html/validation/bibliography-valid.html
+51 −0 test/resources/html/validation/footnote-invalid.html
+56 −0 test/resources/html/validation/footnote-valid.html
+19 −0 test/resources/html/validation/illegal-characters-attr-invalid.html
+19 −0 test/resources/html/validation/illegal-characters-curly-quotes-invalid.html
+19 −0 test/resources/html/validation/illegal-characters-dashes-invalid.html
+26 −0 test/resources/html/validation/illegal-characters-entities-valid.html
+19 −0 test/resources/html/validation/illegal-characters-valid.html
+2 −2 test/resources/html/validation/norm-ref-valid.html
+4 −0 test/resources/html/validation/rdd-standalone-invalid.html
+30 −0 test/resources/html/validation/snippet-illegal-chars-invalid.html
+30 −0 test/resources/html/validation/snippet-invalid.html
+30 −0 test/resources/html/validation/snippet-valid.html
+24 −0 test/resources/html/validation/st-conformance-invalid.html
+24 −0 test/resources/html/validation/st-conformance-valid.html
+3 −0 test/resources/html/validation/st-valid.html
+43 −0 test/resources/html/validation/terms-note-to-entry-2-invalid.html
+3 −3 test/resources/html/validation/terms-note-to-entry-2-valid.html
+1 −1 test/resources/html/validation/terms-valid.html
+12 −6 test/src/testValidation.mjs
+126 −5 workflows/action.yml
Loading