From 1e5b8c7badfa654199f8bbb5d4aa12ea108cb96b Mon Sep 17 00:00:00 2001 From: Steve LLamb <38917682+SteveLLamb@users.noreply.github.com> Date: Tue, 25 Feb 2025 14:55:25 -0800 Subject: [PATCH 1/8] pass update for HTML --- doc/main.html | 74 ++++++++++++++++++++++++++++----------------------- tooling | 2 +- 2 files changed, 42 insertions(+), 34 deletions(-) diff --git a/doc/main.html b/doc/main.html index b7529a4..4f1f5dc 100644 --- a/doc/main.html +++ b/doc/main.html @@ -35,12 +35,15 @@ +

+ A Comment Resolution Record is required when there are additional FCD Ballot(s). This should be the electronic comment resolution records kept on the SMPTE SKN Balloting App. In some situations the Project Group may wish to keep other records. See for guidance. +

+
@@ -496,10 +496,12 @@

FCD Ballot Comment Resolution Package

  • If the document has one or more Element(s), the Element(s) or instructions for acquiring the Element(s) shall be included.
    • -
  • - A Comment Resolution Record is required. This should be the electronic comment resolution records kept on the SMPTE web site. In some situations the Project Group may wish to keep other records. See for guidance. -
    • + + +

    + A Comment Resolution Record is required. This should be the electronic comment resolution records kept on the SMPTE SKN Balloting App. In some situations the Project Group may wish to keep other records. See for guidance. +

    When Comment Resolution has been successfully completed, a Pre-DP Review follows. Comment resolution may include one or more Disposition Votes. See for guidance.

    @@ -523,10 +525,11 @@

    Pre-Draft Publication Vote Review Document Package

  • If the document has one or more Element(s), the Element(s) or instructions for acquiring the Element(s) shall be included.
    • -
  • - A Comment Resolution Record is required. This should be the electronic comment resolution records kept on the SMPTE web site. In some situations the Project Group may wish to keep other records. See for guidance. -
    • + +

    + A Comment Resolution Record is required. This should be the electronic comment resolution records kept on the SMPTE SKN Balloting App. In some situations the Project Group may wish to keep other records. See for guidance. +

    @@ -547,10 +550,11 @@

    Draft Publication Vote Document Package

  • If the document has one or more Element(s), the Element(s) or instructions for acquiring the Element(s) shall be included.
    • -
  • - A Comment Resolution Record is required. This should be the electronic comment resolution records kept on the SMPTE web site. In some situations the Project Group may wish to keep other records. See for guidance. -
    • + +

    + A Comment Resolution Record is required. This should be the electronic comment resolution records kept on the SMPTE SKN Balloting App. In some situations the Project Group may wish to keep other records. See for guidance. +

    After a successful DP vote the Draft Publication Vote Package documents shall not be edited by the Project Group participants or the Technology Committee Chair(s) with the exception of changing the document status. If new editorial issues are found, these should be documented and given to SMPTE HQ (see ).

    @@ -568,10 +572,11 @@

    ST Audit Document Package

  • If the document has one or more Element(s), the Element(s) or instructions for acquiring the Element(s) shall be included.
    • -
  • - A Comment Resolution Record is required. This should be the electronic comment resolution records kept on the SMPTE web site. If the Project Group kept other records, these must be included. See for guidance. -
    • + +

    + A Comment Resolution Record is required. This should be the electronic comment resolution records kept on the SMPTE SKN Balloting App. If the Project Group kept other records, these must be included. See for guidance. +

    @@ -586,6 +591,9 @@

    SMPTE HQ Editing Publication Document Package

  • If the document has one or more Element(s), the Element(s) or instructions for acquiring the Element(s) shall be included.
    • +
  • + A manifest.json file as defined in . +
  • Any original artwork, figures, drawings or similar material that will be needed to prepare the document and its elements for publication and long-term maintenance. These documents shall be in the formats described in of this Administrative Guideline. @@ -612,8 +620,8 @@

    Registered Disclosure Documents (Informative)

      -
    • SMPTE AG-04, Engineering Document Templates - https://www.smpte.org/about/policies-and-governance
      • +
    • SMPTE AG-27, HTML Pub Template + https://github.com/SMPTE/html-pub-template
    • W3C XML 1.0 (latest edition) https://www.w3.org/TR/xml/
    • IANA diff --git a/tooling b/tooling index 45ea6c2..89f7c12 160000 --- a/tooling +++ b/tooling @@ -1 +1 @@ -Subproject commit 45ea6c201c8e3730caebb0c9ed143f612fcb9fd4 +Subproject commit 89f7c12354d56f8369b74be908ff9521471d4a56 From 153cd49f11edd8aa1ef881f922988561492ad2ab Mon Sep 17 00:00:00 2001 From: Steve LLamb <38917682+SteveLLamb@users.noreply.github.com> Date: Tue, 25 Feb 2025 15:20:17 -0800 Subject: [PATCH 2/8] tweak to paper removing --- doc/main.html | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/doc/main.html b/doc/main.html index 4f1f5dc..7229ae4 100644 --- a/doc/main.html +++ b/doc/main.html @@ -90,15 +90,13 @@

      Style Guidelines

      Document editing

      -

      All new Engineering Documents shall use .

      +

      All Engineering Documents shall use and .

      Prior to being submitted for pre-FCD ballot review, draft Engineering Documents may use other editing formats, as selected by the Project Group.

      -
      + -
      -

      Revisions

      - For a revision of an Engineering Document, the Project Group should start with the Publication Master, which should be HTML format. If not already published in HTML, the Publication Master can usually can be obtained from SMPTE HQ. If this is the case, the Project Group should recreate the original document, as closely as possible to published, in HTML format as per , prior to any revision work to be done. This will ensure the tooling can create a proper redline document during the balloting process. If this cannot be done, the document may be created as a "new" document as per the HTML guidelines, but this will not create redlines in the tooling. + For a revision of an Engineering Document, if not already published in HTML, the Publication Master can usually can be obtained from SMPTE HQ. The Project Group should recreate the original document, as closely as possible to published, in HTML format as per , prior to any revision work to be done. This will ensure the tooling can create a proper redline document during the balloting process.

      Care should be given when updating the tooling from prior HTML published versions, as major changes in said tooling may have occured. However, such changes may be required, such as general boiler plate verbiage, template update, and/or validation tools.

      Since the HTML pipeline has been introduced, amendments are no longer able to be generated, only full revisions. As such, amendments shall no longer be utilized.

      @@ -112,7 +110,7 @@

      Publication Formats and Elements

      Publication Formats Overview

      - SMPTE Engineering Documents may be published on paper or in various electronic formats and may comprise one or more separate elements. An Engineering Document always shall include a single prose element and may include other elements such as XML, spreadsheets, media files, and so forth. The collection of elements, regardless of formats employed, is the "Engineering Document" as a whole, and all elements shall be clearly identified in the prose element (see ). Any change to any element constitutes a change to the Engineering Document. The Project Group and the Technology Committee shall determine the number of elements for publication. The Director of Engineering shall determine the distribution media for all published documents. The format of publication shall alter neither the relevance of, nor the processes that otherwise are required for approval of, an Engineering Document. + SMPTE Engineering Documents shall be published in HTML and may comprise one or more separate elements. An Engineering Document always shall include a single prose element and may include other elements such as XML, spreadsheets, media files, and so forth. The collection of elements, regardless of formats employed, is the "Engineering Document" as a whole, and all elements shall be clearly identified in the prose element (see ). Any change to any element constitutes a change to the Engineering Document. The Project Group and the Technology Committee shall determine the number of elements for publication. The Director of Engineering shall determine the distribution media for all published documents. The format of publication shall alter neither the relevance of, nor the processes that otherwise are required for approval of, an Engineering Document.

      Engineering Document Elements may be packaged as one or more Elements using ZIP to facilitate the organization and distribution of the component files. From e740ee5907d48d70ae512aca47ca3b5c29ed0db4 Mon Sep 17 00:00:00 2001 From: Steve LLamb <38917682+SteveLLamb@users.noreply.github.com> Date: Tue, 25 Feb 2025 15:20:41 -0800 Subject: [PATCH 3/8] updates per feedback --- doc/main.html | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/main.html b/doc/main.html index 7229ae4..b2eba92 100644 --- a/doc/main.html +++ b/doc/main.html @@ -39,6 +39,8 @@ https://doc.smpte-doc.org/ag-03/main/

    • SMPTE AG-26, HTML Publication Workflow https://doc.smpte-doc.org/html-pub/main/
      • +
    • SMPTE AG-27, HTML Pub Template + https://github.com/SMPTE/html-pub-template
    • SMPTE AG-28, Document Repo Spec https://doc.smpte-doc.org/document-repo-spec/main/
    • ISO/IEC Directives, Part 2, Principles and rules for the structure and drafting of ISO and IEC documents @@ -618,8 +620,7 @@

      Registered Disclosure Documents (Informative)

        -
      • SMPTE AG-27, HTML Pub Template - https://github.com/SMPTE/html-pub-template
        • +
      • W3C XML 1.0 (latest edition) https://www.w3.org/TR/xml/
      • IANA From 7d037cb4847968fa6ee2b9ed0573a902a13d6c06 Mon Sep 17 00:00:00 2001 From: Steve LLamb <38917682+SteveLLamb@users.noreply.github.com> Date: Wed, 26 Feb 2025 10:02:33 -0800 Subject: [PATCH 4/8] update README --- README.md | 6 +++++- doc/main.html | 6 +++--- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index dd40df4..30981da 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,11 @@ _This repository is *public*._ * [Latest version](https://doc.smpte-doc.org/ag-02/main/) -* [Redline against the latest edition](https://doc.smpte-doc.org/ag-02/main/pub-rl.html) +* [Latest version (all artifacts)](https://doc.smpte-doc.org/ag-02/main/pub-artifacts.html) Please consult [CONTRIBUTING.md](./CONTRIBUTING.md), [CONFIDENTIALITY.md](./CONFIDENTIALITY.md), [LICENSE.md](./LICENSE.md) and [PATENTS.md](./PATENTS.md) for important notices. + +## Reporting issues + +Issues should be reported at . \ No newline at end of file diff --git a/doc/main.html b/doc/main.html index b2eba92..71af04f 100644 --- a/doc/main.html +++ b/doc/main.html @@ -37,11 +37,11 @@ https://www.smpte.org/about/policies-and-governance
      • SMPTE AG-03, Normative References https://doc.smpte-doc.org/ag-03/main/
        • -
      • SMPTE AG-26, HTML Publication Workflow +
      • SMPTE AG-26, HTML Pub: Tooling and documentation for HTML documents https://doc.smpte-doc.org/html-pub/main/
        • -
      • SMPTE AG-27, HTML Pub Template +
      • SMPTE AG-27, HTML Pub: Template (Base HTML Repo with Tooling) https://github.com/SMPTE/html-pub-template
        • -
      • SMPTE AG-28, Document Repo Spec +
      • SMPTE AG-28, Document Library: Repo Spec (Structure) https://doc.smpte-doc.org/document-repo-spec/main/
      • ISO/IEC Directives, Part 2, Principles and rules for the structure and drafting of ISO and IEC documents https://www.iso.org/sites/directives/current/part2/index.xhtml
        • From f5ebe373c621bf9d4aae27b7f582d056611a353d Mon Sep 17 00:00:00 2001 From: Steve LLamb <38917682+SteveLLamb@users.noreply.github.com> Date: Wed, 26 Feb 2025 11:51:01 -0800 Subject: [PATCH 5/8] bump date --- doc/main.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/main.html b/doc/main.html index 71af04f..35e68ce 100644 --- a/doc/main.html +++ b/doc/main.html @@ -8,7 +8,7 @@ - + Document Naming and Packaging From 4c47816d32a428d43f9a40fcc5128cf7af4fdfe6 Mon Sep 17 00:00:00 2001 From: Steve LLamb <38917682+SteveLLamb@users.noreply.github.com> Date: Wed, 26 Feb 2025 12:12:42 -0800 Subject: [PATCH 6/8] roll build --- .smpte-build.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.smpte-build.json b/.smpte-build.json index 8322f19..fe15ebe 100644 --- a/.smpte-build.json +++ b/.smpte-build.json @@ -1,3 +1,3 @@ { - "latestEditionTag": "pub-2023-04-09" + "latestEditionTag": "20240612-pub" } From e25579092043e8fba0ebd4fd99d53f335a89bc57 Mon Sep 17 00:00:00 2001 From: Steve LLamb <38917682+SteveLLamb@users.noreply.github.com> Date: Thu, 27 Feb 2025 13:37:14 -0800 Subject: [PATCH 7/8] bump tooling for conformance --- tooling | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tooling b/tooling index 89f7c12..9fa6c8e 160000 --- a/tooling +++ b/tooling @@ -1 +1 @@ -Subproject commit 89f7c12354d56f8369b74be908ff9521471d4a56 +Subproject commit 9fa6c8eef8b2b5fd5f7322fdc91a3164a23a8f83 From 021e35f7054f1cf2a2337d20736f8bbb39b25c57 Mon Sep 17 00:00:00 2001 From: Steve LLamb <38917682+SteveLLamb@users.noreply.github.com> Date: Fri, 28 Feb 2025 08:30:06 -0800 Subject: [PATCH 8/8] bump tooling --- tooling | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tooling b/tooling index 9fa6c8e..6c89a6a 160000 --- a/tooling +++ b/tooling @@ -1 +1 @@ -Subproject commit 9fa6c8eef8b2b5fd5f7322fdc91a3164a23a8f83 +Subproject commit 6c89a6a9a385596b9b109c7ea1c5b1f15e452abb