Skip to content

Metadata & npm scripts for publication#34

Open
gesa wants to merge 1 commit intoWinterTC55:mainfrom
gesa:final-draft-first-edition
Open

Metadata & npm scripts for publication#34
gesa wants to merge 1 commit intoWinterTC55:mainfrom
gesa:final-draft-first-edition

Conversation

@gesa
Copy link
Copy Markdown
Contributor

@gesa gesa commented Apr 29, 2026

Also I'm crying "uncle" on organisation/organization. There is no right way. every way is wrong. If you're bored some time, ask me about latin and greek etymology of words and when they end in ise, yse, or ize depending on which regional english dictionary you are using. I will run away screaming and you will no longer be bored.

Important details:

  • all ecmarkup-generated files will end up in ./out now
  • npm scripts:
    • build for local dev when you aren't using watch
    • web to build a web-deployable version
    • printable to build a printable version of the HTML
    • pdf to generate a PDF from that printable HTML
  • deleted extraneous stylesheets and scripts—ecmarkup makes sure they're there
  • added draft metadata. when we're ready to cut a tag, i'll update the metadata on a branch.
    • n.b. i have a local fork of ecmarkup that generates TRs, status: draft-tr and status: technical-report will cause unexpected results using the current published version of ecmarkup. I will attempt to get my ecmarkup PRs merged in the next month or so.

Draft PDF: TR-runtime-keys.pdf

Also I'm crying "uncle" on organisation/organization. There is no right way. every way is wrong. If you're bored some time, ask me about latin and greek etymology of words and when they end in ise, yse, or ize depending on which regional english dictionary you are using. I will run away screaming and it will entertain you.
Comment thread spec.html
<p>Each runtime key entry includes the following metadata:</p>
<ul>
<li><strong>Organization</strong> (required): The organisation or individual responsible for the runtime</li>
<li><strong>Organization</strong> (required): The organization or individual responsible for the runtime</li>
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yay, this one's better anyways because "z" can't have a "s" sound, and it's said with a "z" sound :-D

Copy link
Copy Markdown
Collaborator

@Ethan-Arrowood Ethan-Arrowood left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm! one nit, and one question on the metadata. but otherwise love the new scripts

Comment thread package.json
Comment on lines +22 to +27
"prebuild": "rm -rf out && mkdir -p out",
"build": "node build.mjs && ecmarkup spec-injected.html out/index.html",
"watch": "concurrently 'node --watch-path=./runtime-keys.json --watch-path=./spec.html build.mjs' 'ecmarkup --watch --verbose --lint-spec spec-injected.html out/index.html'",
"web": "npm run build -- --assets external --assets-dir out",
"printable": "npm run web -- --verbose --printable --lint-spec",
"pdf": "npm run printable && prince-books --script ./node_modules/ecmarkup/js/print.js out/index.html -o out/TR-runtime-keys.pdf"
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"prebuild": "rm -rf out && mkdir -p out",
"build": "node build.mjs && ecmarkup spec-injected.html out/index.html",
"watch": "concurrently 'node --watch-path=./runtime-keys.json --watch-path=./spec.html build.mjs' 'ecmarkup --watch --verbose --lint-spec spec-injected.html out/index.html'",
"web": "npm run build -- --assets external --assets-dir out",
"printable": "npm run web -- --verbose --printable --lint-spec",
"pdf": "npm run printable && prince-books --script ./node_modules/ecmarkup/js/print.js out/index.html -o out/TR-runtime-keys.pdf"
"prebuild": "rm -rf out && mkdir -p out",
"build": "node build.mjs && ecmarkup spec-injected.html out/index.html",
"watch": "concurrently 'node --watch-path=./runtime-keys.json --watch-path=./spec.html build.mjs' 'ecmarkup --watch --verbose --lint-spec spec-injected.html out/index.html'",
"web": "npm run build -- --assets external --assets-dir out",
"printable": "npm run web -- --verbose --printable --lint-spec",
"pdf": "npm run printable && prince-books --script ./node_modules/ecmarkup/js/print.js out/index.html -o out/TR-runtime-keys.pdf"

nit: use consistent spacing (tabs prefered)

Comment thread spec.html
date: 2026-04-28
committee: 55
location: https://github.com/WinterTC55/runtime-keys
contributors: WinterTC55
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this meant to be the organization/team name or is this meant to list actual human individuals who contributed?

Comment thread spec.html
<p>Each runtime key entry includes the following metadata:</p>
<ul>
<li><strong>Organization</strong> (required): The organisation or individual responsible for the runtime</li>
<li><strong>Organization</strong> (required): The organization or individual responsible for the runtime</li>
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Z" is a cooler letter anyways 🤷‍♂️

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.

4 participants