linked-rolls 0.69.0 → 0.71.0

package/lib/shared/utils.d.ts

@@ -1,4 +1,8 @@
 export type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+/**
+ * An object that says by its type which kind of entity it is.
+ * @category Format types
+ */
 export type WithType<T extends string> = {
     /**
      * The type discriminator for this object.
@@ -6,6 +10,10 @@ export type WithType<T extends string> = {
      */
     readonly type: T;
 };
+/**
+ * An object the edition identifies, so that others can refer to it.
+ * @category Format types
+ */
 export type WithId = {
     /**
      * A unique identifier for this object.
@@ -16,6 +24,10 @@ export type WithId = {
 export declare const isDateString: (value: unknown) => value is string;
 /** The items by the key each of them gives, every group in the order its first item came in. */
 export declare const groupBy: <T>(items: readonly T[], keyOf: (item: T) => string) => Map<string, T[]>;
+/**
+ * An object that may carry a note in free text.
+ * @category Format types
+ */
 export type WithNote = {
     /**
      * A free-text note providing additional context.

package/lib/spec/context.json

@@ -65,6 +65,10 @@
                 "used": {
                     "@id": "crm:P16_used_specific_object",
                     "@type": "@id"
+                },
+                "applies": {
+                    "@id": "crminf:J3_applied",
+                    "@type": "@id"
                 }
             }
         },
@@ -118,7 +122,10 @@
             "@type": "xsd:date"
         },
         "collationTolerance": null,
-        "referenceCopy": null,
+        "referenceCopy": {
+            "@id": "reo:referenceCopy",
+            "@type": "@id"
+        },
         "annotation": null,
         "roll": "lrmoo:R3i_realises",
         "catalogueNumber": "dcterms:identifier",

package/lib/systems/ReproducingSystem.d.ts

@@ -6,6 +6,7 @@ import { MetersPerMinute, Millimeters, Seconds } from "../model/Quantity.js";
  * A note or expression of a version with the dimensions of its carriers
  * averaged in and the editorial assumptions applied, which is all a
  * performance needs to know of a symbol.
+ * @category Systems and emulation
  */
 export type NegotiatedEvent = Omit<Note | Expression, 'carriers'> & Pick<HoleChain, 'horizontal' | 'vertical'>;
 interface PerformedRollFeature<T> {
@@ -18,21 +19,41 @@ interface PerformedNoteEvent<T> extends PerformedRollFeature<T> {
     pitch: number;
     velocity: number;
 }
+/**
+ * A note struck, at the velocity the performance gives it.
+ * @category Systems and emulation
+ */
 export interface PerformedNoteOnEvent extends PerformedNoteEvent<'noteOn'> {
 }
+/**
+ * A note released.
+ * @category Systems and emulation
+ */
 export interface PerformedNoteOffEvent extends PerformedNoteEvent<'noteOff'> {
 }
 /**
  * One step of a pedal. A pedal driven by a bellows takes time to travel,
  * so a single command results in a run of these; `performs` is the
  * command whose reading the step follows from.
+ * @category Systems and emulation
  */
 export interface PerformedPedalEvent extends PerformedRollFeature<'damper' | 'hammerRail'> {
     /** 0 with the pedal up and 127 with it fully down. */
     value: number;
 }
+/**
+ * What a performance does at a moment: a note struck or released, or a
+ * step of a pedal.
+ * @category Systems and emulation
+ */
 export type AnyPerformedRollFeature = PerformedNoteOnEvent | PerformedNoteOffEvent | PerformedPedalEvent;
-interface CurveSamples {
+/**
+ * A curve sampled along the roll: where each sample lies on the paper,
+ * when it passes the tracker bar, and how far the bellows or the pedal
+ * has travelled there.
+ * @category Systems and emulation
+ */
+export interface CurveSamples {
     readonly name: string;
     /** Paper position of each sample, in mm from the beginning of the roll. */
     readonly place: Float64Array;
@@ -53,7 +74,10 @@ interface CurveSamples {
      */
     readonly travel: Float64Array;
 }
-/** The dynamics of one part of the keyboard, with the velocity the travel maps onto. */
+/**
+ * The dynamics of one part of the keyboard, with the velocity the travel maps onto.
+ * @category Systems and emulation
+ */
 export type DynamicsCurve = CurveSamples & {
     readonly kind: 'dynamics';
     readonly velocity: Float64Array;
@@ -66,11 +90,24 @@ export type DynamicsCurve = CurveSamples & {
      */
     readonly instrument: string;
 };
+/**
+ * How far one pedal has travelled along the roll, 0 with it up and 1
+ * with it down.
+ * @category Systems and emulation
+ */
 export type PedalCurve = CurveSamples & {
     readonly kind: 'pedal';
 };
+/**
+ * A curve a performance yields: the dynamics of one half of the
+ * keyboard, or the travel of a pedal.
+ * @category Systems and emulation
+ */
 export type EmulatedCurve = DynamicsCurve | PedalCurve;
-/** What the edition records about the roll that a mechanism may want to know. */
+/**
+ * What the edition records about the roll that a mechanism may want to know.
+ * @category Systems and emulation
+ */
 export type RollProperties = {
     /** Diameter of the punches, where the copies record it. */
     punchDiameter?: Millimeters;
@@ -114,6 +151,11 @@ export type RollProperties = {
      */
     toOwnPaper?: number;
 };
+/**
+ * What a reproducing system made of the events of a version: the events
+ * it performed, and the curves of its dynamics and pedals.
+ * @category Systems and emulation
+ */
 export type Performance = {
     readonly events: readonly AnyPerformedRollFeature[];
     readonly curves: readonly EmulatedCurve[];
@@ -124,6 +166,7 @@ export type Performance = {
  * Implementations live outside the core of this library, so that it does
  * not depend on any one instrument's model; `linked-rolls/welte-t100` is
  * the first.
+ * @category Systems and emulation
  */
 export interface ReproducingSystem<Options extends object> {
     readonly name: string;

package/lib/systems/TrackerBar.d.ts

@@ -4,11 +4,13 @@ import { Millimeters, SpeedMeasure, Track } from "../model/Quantity.js";
 /**
  * What a tracker bar position does: sound a note, or operate one of
  * the expression valves on the bass or the treble side.
+ * @category Systems and emulation
  */
 export type TrackRole = 'bass-expression' | 'note' | 'treble-expression';
 /**
  * A contiguous block of tracker bar positions serving one role.
  * Both bounds are inclusive.
+ * @category Systems and emulation
  */
 export interface TrackArea {
     readonly role: TrackRole;
@@ -18,11 +20,13 @@ export interface TrackArea {
 /**
  * How a scale words a function: as a command that turns it on, one that
  * cancels it, or one that holds it for as long as it lasts.
+ * @category Systems and emulation
  */
 export type Spelling = 'on' | 'off' | 'held';
 /**
  * What a word of a scale operates, rather than the word itself, so that
  * two scales can be compared at all.
+ * @category Systems and emulation
  */
 export interface Operation {
     /** The function operated, named the same wherever a scale has it. */
@@ -36,8 +40,21 @@ export interface Operation {
      */
     sided: boolean;
 }
+/**
+ * What a position in the note block reads: a note of one pitch.
+ * @category Systems and emulation
+ */
 export type NoteMeaning = Pick<Note, 'type' | 'pitch'>;
+/**
+ * What an expression position reads: an expression type, on the side of
+ * the keyboard the position serves.
+ * @category Systems and emulation
+ */
 export type ExpressionMeaning = Pick<Expression, 'type' | 'expressionType' | 'scope'>;
+/**
+ * What a position of the bar reads: a note or an expression.
+ * @category Systems and emulation
+ */
 export type TrackMeaning = NoteMeaning | ExpressionMeaning;
 /**
  * Describes a tracker bar. Track numbers are 1-based and count from
@@ -48,6 +65,7 @@ export type TrackMeaning = NoteMeaning | ExpressionMeaning;
  * Anything that needs to know where the note block ends, which side
  * an expression belongs to, or how a track maps to a pitch, should
  * ask the tracker bar rather than repeat the boundaries.
+ * @category Systems and emulation
  */
 export interface TrackerBar {
     /**
@@ -129,13 +147,23 @@ export interface TrackerBar {
  * What a position says, as a key. Two bars read the same thing exactly
  * where their keys agree, which is what lets a symbol cross from one
  * system to another and what decides whether two symbols collate.
+ * @category Systems and emulation
  */
 export declare const keyOf: (meaning: TrackMeaning) => string;
-/** The roll system a tracker bar belongs to, as the roll metadata states it. */
+/**
+ * The roll system a tracker bar belongs to, as the roll metadata states it.
+ * @category Vocabulary
+ */
 export declare const systemOf: (bar: TrackerBar) => Concept;
-/** The identifier of a system the type vocabulary knows, from the IRI naming it. */
+/**
+ * The identifier of a system the type vocabulary knows, from the IRI naming it.
+ * @category Vocabulary
+ */
 export declare const systemIdIn: (id: string | undefined) => string | undefined;
-/** The identifier of a system the type vocabulary knows, from its concept. */
+/**
+ * The identifier of a system the type vocabulary knows, from its concept.
+ * @category Vocabulary
+ */
 export declare const systemIdOf: (system: Concept | undefined) => string | undefined;
 /**
  * Where a roll's own content ends, as far as its perforations say.
@@ -144,12 +172,16 @@ export declare const systemIdOf: (system: Concept | undefined) => string | undef
  * the rewind is *punched*, not when the rewind pneumatic takes hold. The second
  * is a matter of valve lift and belongs to whatever performs the roll. Keeping
  * them apart is what lets collation and counting ask this without an emulator.
+ * @category Systems and emulation
  */
 export type RollEnd = {
     readonly at: Millimeters;
     readonly because: 'rewind';
 };
-/** Anything carrying a place on the roll and a position on the bar. */
+/**
+ * Anything carrying a place on the roll and a position on the bar.
+ * @category Systems and emulation
+ */
 export type PlacedOnBar = {
     readonly horizontal: {
         readonly from: Millimeters;
@@ -163,6 +195,7 @@ export type PlacedOnBar = {
  * Where a feature lies across the bar: one place, or a run of them where
  * `to` is given. Structural, so a feature's `vertical` passes as it is and
  * this module need know nothing about features.
+ * @category Systems and emulation
  */
 export type OnBar = {
     readonly from: Track;
@@ -172,6 +205,7 @@ export type OnBar = {
  * A tracker bar as written down, with its positions as plain numbers
  * in the bar's own 1-based numbering; `describeTrackerBar` gives them
  * their type.
+ * @category Systems and emulation
  */
 export interface TrackerBarSpec {
     id: string;
@@ -211,11 +245,18 @@ export interface TrackerBarSpec {
     /** How the system spells a single added accent; see `TrackerBar.accents`. */
     accents?: readonly (readonly string[])[];
 }
+/**
+ * The tracker bar a description gives, its positions typed and its
+ * readings worked out. Throws where the description names no rewind
+ * position, or names expression types its bar does not read.
+ * @category Systems and emulation
+ */
 export declare const describeTrackerBar: (spec: TrackerBarSpec) => TrackerBar;
 /**
  * Puts a position of one bar onto the position of another that reads
  * the same thing, or nowhere when the other bar does not read it. This
  * is how a copy read in one system's numbering is put into another's,
  * as the migration does for a Licensee copy stored on T-100 tracks.
+ * @category Systems and emulation
  */
 export declare const translationBetween: (from: TrackerBar, to: TrackerBar) => (position: Track) => Track | undefined;

package/lib/systems/TrackerBar.js

@@ -3,16 +3,26 @@ import { mm, track } from "../model/Quantity.js";
  * What a position says, as a key. Two bars read the same thing exactly
  * where their keys agree, which is what lets a symbol cross from one
  * system to another and what decides whether two symbols collate.
+ * @category Systems and emulation
  */
 export const keyOf = (meaning) => meaning.type === 'note'
     ? `note ${meaning.pitch}`
     : `expression ${meaning.scope} ${meaning.expressionType}`;
 const SYSTEM_IRI = 'https://w3id.org/reo/type/system/';
-/** The roll system a tracker bar belongs to, as the roll metadata states it. */
+/**
+ * The roll system a tracker bar belongs to, as the roll metadata states it.
+ * @category Vocabulary
+ */
 export const systemOf = (bar) => ({ id: SYSTEM_IRI + bar.id, name: bar.name, sameAs: [] });
-/** The identifier of a system the type vocabulary knows, from the IRI naming it. */
+/**
+ * The identifier of a system the type vocabulary knows, from the IRI naming it.
+ * @category Vocabulary
+ */
 export const systemIdIn = (id) => id?.startsWith(SYSTEM_IRI) ? id.slice(SYSTEM_IRI.length) : undefined;
-/** The identifier of a system the type vocabulary knows, from its concept. */
+/**
+ * The identifier of a system the type vocabulary knows, from its concept.
+ * @category Vocabulary
+ */
 export const systemIdOf = (system) => systemIdIn(system?.id);
 const areasOf = ({ notes, trackCount }) => [
     { role: 'bass-expression', from: track(1), to: track(notes.from - 1) },
@@ -32,6 +42,12 @@ const positionsBetween = (span) => {
     const [first, last] = [Math.min(...ends), Math.max(...ends)];
     return Array.from({ length: last - first + 1 }, (_, step) => track(first + step));
 };
+/**
+ * The tracker bar a description gives, its positions typed and its
+ * readings worked out. Throws where the description names no rewind
+ * position, or names expression types its bar does not read.
+ * @category Systems and emulation
+ */
 export const describeTrackerBar = (spec) => {
     const areas = areasOf(spec);
     const areaAt = (position) => areas.find(area => position >= area.from && position <= area.to)?.role;
@@ -108,6 +124,7 @@ export const describeTrackerBar = (spec) => {
  * the same thing, or nowhere when the other bar does not read it. This
  * is how a copy read in one system's numbering is put into another's,
  * as the migration does for a Licensee copy stored on T-100 tracks.
+ * @category Systems and emulation
  */
 export const translationBetween = (from, to) => (position) => {
     const meaning = from.meaningOf(position);

package/lib/systems/index.d.ts

@@ -1,12 +1,19 @@
 import { Concept } from "../model/Agent.js";
 import { TrackerBar } from "./TrackerBar.js";
-/** The tracker bars the library knows, the T-100 first as the usual one. */
+/**
+ * The tracker bars the library knows, the T-100 first as the usual one.
+ * @category Systems and emulation
+ */
 export declare const trackerBars: readonly TrackerBar[];
-/** The bar of a system the type vocabulary knows, from its concept. */
+/**
+ * The bar of a system the type vocabulary knows, from its concept.
+ * @category Systems and emulation
+ */
 export declare const trackerBarOf: (system: Concept | undefined) => TrackerBar | undefined;
 /**
  * The bar a copy is read by where it names no system of its own: every
  * copy was read by the T-100's before the systems were told apart, and
  * `reservationsAbout` reports a copy that still relies on this.
+ * @category Systems and emulation
  */
 export declare const defaultTrackerBar: TrackerBar;

package/lib/systems/index.js

@@ -2,9 +2,15 @@ import { systemIdOf } from "./TrackerBar.js";
 import { welteT100 } from "./welteT100/bar.js";
 import { welteLicensee } from "./welteLicensee/bar.js";
 import { welteT98 } from "./welteT98/bar.js";
-/** The tracker bars the library knows, the T-100 first as the usual one. */
+/**
+ * The tracker bars the library knows, the T-100 first as the usual one.
+ * @category Systems and emulation
+ */
 export const trackerBars = [welteT100, welteLicensee, welteT98];
-/** The bar of a system the type vocabulary knows, from its concept. */
+/**
+ * The bar of a system the type vocabulary knows, from its concept.
+ * @category Systems and emulation
+ */
 export const trackerBarOf = (system) => {
     const id = systemIdOf(system);
     return trackerBars.find(bar => bar.id === id);
@@ -13,5 +19,6 @@ export const trackerBarOf = (system) => {
  * The bar a copy is read by where it names no system of its own: every
  * copy was read by the T-100's before the systems were told apart, and
  * `reservationsAbout` reports a copy that still relies on this.
+ * @category Systems and emulation
  */
 export const defaultTrackerBar = welteT100;

package/lib/systems/velocity.d.ts

@@ -19,6 +19,7 @@
  * suction-to-velocity relation "essentially logarithmic" (pp. 215 f.). The
  * default should change only once a red/green comparison has been run both ways
  * and the difference measured, and then for both systems at once.
+ * @category Systems and emulation
  */
 export type VelocityMap = {
     piano: number;

package/lib/systems/velocity.js

@@ -19,6 +19,7 @@
  * suction-to-velocity relation "essentially logarithmic" (pp. 215 f.). The
  * default should change only once a red/green comparison has been run both ways
  * and the difference measured, and then for both systems at once.
+ * @category Systems and emulation
  */
 /** midi2exp's three velocities, which is what the T-100's published results used. */
 export const defaultVelocityMap = { piano: 35, mezzoforte: 60, forte: 90 };

package/lib/systems/welte.d.ts

@@ -10,7 +10,10 @@ import { type VelocityMap } from "./velocity.js";
  * performance is read off the emulator is one; what differs is in front of it,
  * and each system says that in the `Mechanism` it hands to `performWelte`.
  */
-/** The options every Welte system takes. */
+/**
+ * The options every Welte system takes.
+ * @category Systems and emulation
+ */
 export type WelteOptions = {
     /**
      * The take-up spool, which sets the time axis: it is held at a constant
@@ -54,13 +57,22 @@ export declare const sameParameters: (a: Parameters, b: Parameters) => boolean;
  * `brushing` their fall is slowed until the quick runs of latch changes
  * in the SUPRA corpus dip without damping, at the price that lifts
  * shorter than about 265 ms brush as well.
+ * @category Systems and emulation
  */
 export declare const pedalPresets: {
     damping: Readonly<Record<string, number>>;
     brushing: Readonly<Record<string, number>>;
 };
+/**
+ * The name of one of the readings of the pedal mechanism, `damping` or
+ * `brushing`.
+ * @category Systems and emulation
+ */
 export type PedalPreset = keyof typeof pedalPresets;
-/** The preset a set of pedal constants is, if it is one. */
+/**
+ * The preset a set of pedal constants is, if it is one.
+ * @category Systems and emulation
+ */
 export declare const pedalPresetOf: (pedals: Parameters) => PedalPreset | undefined;
 /**
  * Between the edition's shared place axis and this version's own paper.
@@ -80,7 +92,10 @@ export type Paper = {
     readonly paperOfRow: (row: number) => Millimeters;
     readonly paperOfPlace: (place: Millimeters) => Millimeters;
 };
-/** When the spool brings a place on the roll to the tracker bar. */
+/**
+ * When the spool brings a place on the roll to the tracker bar.
+ * @category Systems and emulation
+ */
 export declare const secondsAt: (spool: Spool, place: Millimeters) => Seconds;
 /** The speed the spool starts the paper at. */
 export declare const startingSpeedOf: (spool: Spool) => MetersPerMinute;

package/lib/systems/welte.js

@@ -14,12 +14,16 @@ export const sameParameters = (a, b) => Object.keys(a).length === Object.keys(b)
  * `brushing` their fall is slowed until the quick runs of latch changes
  * in the SUPRA corpus dip without damping, at the price that lifts
  * shorter than about 265 ms brush as well.
+ * @category Systems and emulation
  */
 export const pedalPresets = {
     damping: pedalDefaults,
     brushing: pedalBrushing
 };
-/** The preset a set of pedal constants is, if it is one. */
+/**
+ * The preset a set of pedal constants is, if it is one.
+ * @category Systems and emulation
+ */
 export const pedalPresetOf = (pedals) => Object.keys(pedalPresets).find(name => sameParameters(pedalPresets[name], pedals));
 /** Paper the grid runs on past the last hole, so that a final pedal release completes. */
 const RUN_OUT = mm(100);
@@ -31,7 +35,10 @@ const paperOf = (toOwnPaper) => ({
     paperOfRow: row => mm(row / ROWS_PER_MM),
     paperOfPlace: place => mm(place * toOwnPaper)
 });
-/** When the spool brings a place on the roll to the tracker bar. */
+/**
+ * When the spool brings a place on the roll to the tracker bar.
+ * @category Systems and emulation
+ */
 export const secondsAt = (spool, place) => seconds(paperSeconds(spool, inCentimeters(place)));
 /** The speed the spool starts the paper at. */
 export const startingSpeedOf = (spool) => metersPerMinute(paperSpeed(spool, 0) * 60 / 100);

package/lib/systems/welteLicensee/bar.d.ts

@@ -7,5 +7,6 @@ import { TrackerBar } from "../TrackerBar.js";
  * tracks, so the note block and the treble valves sit two positions
  * lower. The layout is the one Stanford's midi2exp reads, checked
  * valve by valve on roll 225 against the T-100 copies.
+ * @category Systems and emulation
  */
 export declare const welteLicensee: TrackerBar;

package/lib/systems/welteLicensee/bar.js

@@ -9,6 +9,7 @@ import { welteT100Accents, welteT100Operations } from "../welteT100/bar.js";
  * tracks, so the note block and the treble valves sit two positions
  * lower. The layout is the one Stanford's midi2exp reads, checked
  * valve by valve on roll 225 against the T-100 copies.
+ * @category Systems and emulation
  */
 export const welteLicensee = describeTrackerBar({
     id: 'welte-licensee',

package/lib/systems/welteLicensee/system.d.ts

@@ -1,5 +1,10 @@
 import { ReproducingSystem } from "../ReproducingSystem.js";
 import { type WelteT100Options } from "../welteT100/system.js";
+/**
+ * The Licensee takes the options of the T-100, whose mechanism it
+ * shares; see `WelteOptions`.
+ * @category Systems and emulation
+ */
 export type WelteLicenseeOptions = WelteT100Options;
 /**
  * The one instrument on offer, and it is not a Licensee instrument.
@@ -13,15 +18,26 @@ export type WelteLicenseeOptions = WelteT100Options;
  *
  * So a Licensee playback is a Freiburg reading of American paper, and the
  * union has one arm to keep that visible. Nothing should be published from it.
+ * @category Systems and emulation
  */
 export declare const instruments: {
     unfitted: {
         'welte-t100-consensus': import("welte-mignon-emulator/t100").Instrument;
     };
 };
+/**
+ * The one instrument on offer for the Licensee by name: the T-100
+ * consensus, named as unfitted.
+ * @category Systems and emulation
+ */
 export type WelteLicenseeInstrumentName = {
     unfitted: 'welte-t100-consensus';
 };
+/**
+ * The names of the instruments on offer for the Licensee, of which
+ * there is one.
+ * @category Systems and emulation
+ */
 export declare const instrumentNames: readonly WelteLicenseeInstrumentName[];
 /**
  * Welte's own spool is carried over with the constants. Phillips (p. 181) says
@@ -34,6 +50,7 @@ export declare const instrumentNames: readonly WelteLicenseeInstrumentName[];
  * that roll's tempo (`spoolFor`). Either way only its geometry is used, and
  * that is better varied than trusted: it scales every conductance by k and
  * every time constant by 1/k, and touches nothing dimensionless.
+ * @category Systems and emulation
  */
 export declare const defaultWelteLicenseeOptions: WelteLicenseeOptions;
 /**
@@ -48,5 +65,6 @@ export declare const defaultWelteLicenseeOptions: WelteLicenseeOptions;
  * curve produced here names itself as such. The spool sets no tempo of its
  * own: a version runs at the speed stated for its copies, or at that of the
  * roll it was re-cut from times the length ratio.
+ * @category Systems and emulation
  */
 export declare const welteLicenseeSystem: ReproducingSystem<WelteLicenseeOptions>;

package/lib/systems/welteLicensee/system.js

@@ -1,3 +1,12 @@
+/**
+ * The Welte-Mignon (Licensee), the American re-cut of the T-100 rolls, as
+ * a reproducing system (`welteLicenseeSystem`). It is played by the
+ * T-100's mechanism on the T-100's constants, since no Licensee
+ * instrument has been fitted, and every curve it produces says so. It
+ * needs the optional peer dependency welte-mignon-emulator.
+ *
+ * @module linked-rolls/welte-licensee
+ */
 import { CONSENSUS } from "welte-mignon-emulator/t100";
 import { track } from "../../model/Quantity.js";
 import { welteLicensee } from "./bar.js";
@@ -14,8 +23,14 @@ import { defaultWelteT100Options, instrumentNameOf, nuanceOf, performAs } from "
  *
  * So a Licensee playback is a Freiburg reading of American paper, and the
  * union has one arm to keep that visible. Nothing should be published from it.
+ * @category Systems and emulation
  */
 export const instruments = { unfitted: { 'welte-t100-consensus': CONSENSUS } };
+/**
+ * The names of the instruments on offer for the Licensee, of which
+ * there is one.
+ * @category Systems and emulation
+ */
 export const instrumentNames = [
     { unfitted: 'welte-t100-consensus' }
 ];
@@ -30,6 +45,7 @@ export const instrumentNames = [
  * that roll's tempo (`spoolFor`). Either way only its geometry is used, and
  * that is better varied than trusted: it scales every conductance by k and
  * every time constant by 1/k, and touches nothing dimensionless.
+ * @category Systems and emulation
  */
 export const defaultWelteLicenseeOptions = {
     ...defaultWelteT100Options,
@@ -57,6 +73,7 @@ const licenseeInstrument = (nuance) => instrumentNameOf(nuance) === 'consensus'
  * curve produced here names itself as such. The spool sets no tempo of its
  * own: a version runs at the speed stated for its copies, or at that of the
  * roll it was re-cut from times the length ratio.
+ * @category Systems and emulation
  */
 export const welteLicenseeSystem = {
     name: 'Welte-Mignon (Licensee)',

package/lib/systems/welteT100/bar.d.ts

@@ -1,8 +1,13 @@
 import { Operation, TrackerBar } from "../TrackerBar.js";
 /**
  * The commands of the Welte-Mignon T-100, as its tracker bar reads them.
+ * @category Systems and emulation
  */
 export declare const welteT100ExpressionTypes: readonly ['SustainPedalOn', 'SustainPedalOff', 'SoftPedalOn', 'SoftPedalOff', 'MezzoforteOff', 'MezzoforteOn', 'SlowCrescendoOn', 'SlowCrescendoOff', 'ForzandoOn', 'ForzandoOff', 'MotorOff', 'MotorOn', 'Rewind', 'ElectricCutOff'];
+/**
+ * A command of the Welte-Mignon T-100.
+ * @category Systems and emulation
+ */
 export type WelteT100ExpressionType = typeof welteT100ExpressionTypes[number];
 /**
  * What each T-100 command operates, so that it can be set against the
@@ -23,11 +28,13 @@ export type WelteT100ExpressionType = typeof welteT100ExpressionTypes[number];
  * being an automatic mercury contact (Skala-Rolle 98 §12) and its rewind
  * riding on the bass sforzando-piano line. A red command of those kinds
  * has no counterpart and stays a plain deletion.
+ * @category Systems and emulation
  */
 export declare const welteT100Operations: Readonly<Partial<Record<WelteT100ExpressionType, Operation>>>;
 /**
  * A single added accent on the T-100: a valve latched on and off again
  * straight away.
+ * @category Systems and emulation
  */
 export declare const welteT100Accents: readonly (readonly WelteT100ExpressionType[])[];
 /**
@@ -37,5 +44,6 @@ export declare const welteT100Accents: readonly (readonly WelteT100ExpressionTyp
  * The expression valves are duplicated, bass below the note block and
  * treble above it, in mirrored order. The rolls run at three metres a
  * minute (Phillips 2016, p. 113; Bärtsch 2020 gives 3 or 2.9).
+ * @category Systems and emulation
  */
 export declare const welteT100: TrackerBar;

package/lib/systems/welteT100/bar.js

@@ -2,6 +2,7 @@ import { describeTrackerBar } from "../TrackerBar.js";
 import { metersPerMinute, mm } from "../../model/Quantity.js";
 /**
  * The commands of the Welte-Mignon T-100, as its tracker bar reads them.
+ * @category Systems and emulation
  */
 export const welteT100ExpressionTypes = [
     'SustainPedalOn',
@@ -38,6 +39,7 @@ export const welteT100ExpressionTypes = [
  * being an automatic mercury contact (Skala-Rolle 98 §12) and its rewind
  * riding on the bass sforzando-piano line. A red command of those kinds
  * has no counterpart and stays a plain deletion.
+ * @category Systems and emulation
  */
 export const welteT100Operations = {
     MezzoforteOn: { operates: 'mezzoforte', spelling: 'on', sided: true },
@@ -54,6 +56,7 @@ export const welteT100Operations = {
 /**
  * A single added accent on the T-100: a valve latched on and off again
  * straight away.
+ * @category Systems and emulation
  */
 export const welteT100Accents = [
     ['SlowCrescendoOn', 'SlowCrescendoOff'],
@@ -66,6 +69,7 @@ export const welteT100Accents = [
  * The expression valves are duplicated, bass below the note block and
  * treble above it, in mirrored order. The rolls run at three metres a
  * minute (Phillips 2016, p. 113; Bärtsch 2020 gives 3 or 2.9).
+ * @category Systems and emulation
  */
 export const welteT100 = describeTrackerBar({
     id: 'welte-t100',