Skip to content

Name the RDD in the Introduction's informative statement - #441

Merged
SteveLLamb merged 1 commit into
mainfrom
feature/rdd-intro-statement
Sep 29, 2026
Merged

SteveLLamb merged 1 commit into
mainfrom
feature/rdd-intro-statement

Conversation

@SteveLLamb

Copy link
Copy Markdown
Member

RDDs are not Engineering Documents, but the generated Introduction statement called them one: "This clause is entirely informative and does not form an integral part of this Engineering Document."

Changes

  • smpte.js (insertIntroduction): the statement now reads "…this Registered Disclosure Document." for RDDs.
    • ST, RP, EG and ER are unchanged.
    • AG and OM still get no statement.
    • ENGDOC_PUBTYPES is untouched, so its other uses (draft warning, Foreword TC line, common.mjs) behave as before.
  • doc/main.html: the Introduction section now documents that this statement is generated for ST, RP, EG, ER and RDD and must not be supplied by the author.

Testing

  • Rendered test documents with an Introduction through smpte.js in headless Chrome:
    • RDD → "…integral part of this Registered Disclosure Document."
    • ST → "…integral part of this Engineering Document."
    • AG → no statement.
  • npm test and npm run validate pass.

RDDs are not Engineering Documents, so the generated Introduction statement now reads "this Registered Disclosure Document" for RDDs. ST, RP, EG and ER are unchanged; AG and OM still get no statement. Document the generated statement in the Introduction section of doc/main.html.
@github-actions

Copy link
Copy Markdown

@SteveLLamb
SteveLLamb merged commit ca2d9ba into main Sep 29, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant