From c04de0d5828770142137d21b718033cdb4996da0 Mon Sep 17 00:00:00 2001 From: Miika Alonen Date: Sun, 10 Dec 2023 22:00:32 +0200 Subject: [PATCH] Moved doc files to same structure as in index --- src/Documentation.ts | 42 +++++++++---------- src/documentation/{ => basics}/interaction.ts | 4 +- .../{ => learning}/audio_engine/amplitude.ts | 4 +- .../audio_engine/audio_basics.ts | 4 +- .../{ => learning}/audio_engine/distortion.ts | 4 +- .../audio_engine/reverb_delay.ts | 4 +- .../{ => learning}/audio_engine/sampler.ts | 4 +- .../{ => learning/audio_engine}/synths.ts | 4 +- src/documentation/{ => learning}/midi.ts | 4 +- src/documentation/{ => learning}/osc.ts | 4 +- .../{ => learning}/samples/loading_samples.ts | 4 +- .../{ => learning}/samples/sample_banks.ts | 4 +- .../{ => learning}/samples/sample_list.ts | 4 +- .../{ => learning}/time/cyclical_time.ts | 4 +- .../{ => learning}/time/linear_time.ts | 4 +- .../{ => learning/time}/long_forms.ts | 4 +- .../{ => learning}/time/pulses.svg | 0 src/documentation/{ => learning}/time/time.ts | 4 +- .../{ => learning}/time/times.svg | 0 src/documentation/{ => patterns}/chaining.ts | 4 +- src/documentation/{ => patterns}/functions.ts | 4 +- src/documentation/{ => patterns}/lfos.ts | 4 +- src/documentation/{ => patterns}/patterns.ts | 4 +- .../{ => patterns}/probabilities.ts | 4 +- src/documentation/{ => patterns}/variables.ts | 4 +- .../patterns/ziffers/ziffers_scales.ts | 6 +-- .../patterns/ziffers/ziffers_syncing.ts | 0 27 files changed, 68 insertions(+), 68 deletions(-) rename src/documentation/{ => basics}/interaction.ts (98%) rename src/documentation/{ => learning}/audio_engine/amplitude.ts (96%) rename src/documentation/{ => learning}/audio_engine/audio_basics.ts (98%) rename src/documentation/{ => learning}/audio_engine/distortion.ts (91%) rename src/documentation/{ => learning}/audio_engine/reverb_delay.ts (97%) rename src/documentation/{ => learning}/audio_engine/sampler.ts (97%) rename src/documentation/{ => learning/audio_engine}/synths.ts (99%) rename src/documentation/{ => learning}/midi.ts (98%) rename src/documentation/{ => learning}/osc.ts (96%) rename src/documentation/{ => learning}/samples/loading_samples.ts (95%) rename src/documentation/{ => learning}/samples/sample_banks.ts (93%) rename src/documentation/{ => learning}/samples/sample_list.ts (98%) rename src/documentation/{ => learning}/time/cyclical_time.ts (98%) rename src/documentation/{ => learning}/time/linear_time.ts (98%) rename src/documentation/{ => learning/time}/long_forms.ts (98%) rename src/documentation/{ => learning}/time/pulses.svg (100%) rename src/documentation/{ => learning}/time/time.ts (92%) rename src/documentation/{ => learning}/time/times.svg (100%) rename src/documentation/{ => patterns}/chaining.ts (98%) rename src/documentation/{ => patterns}/functions.ts (95%) rename src/documentation/{ => patterns}/lfos.ts (96%) rename src/documentation/{ => patterns}/patterns.ts (98%) rename src/documentation/{ => patterns}/probabilities.ts (97%) rename src/documentation/{ => patterns}/variables.ts (96%) create mode 100644 src/documentation/patterns/ziffers/ziffers_syncing.ts diff --git a/src/Documentation.ts b/src/Documentation.ts index 808bcd8..c64d25b 100644 --- a/src/Documentation.ts +++ b/src/Documentation.ts @@ -1,13 +1,13 @@ import { type Editor } from "./main"; // Basics import { introduction } from "./documentation/basics/welcome"; -import { loading_samples } from "./documentation/samples/loading_samples"; -import { amplitude } from "./documentation/audio_engine/amplitude"; -import { reverb } from "./documentation/audio_engine/reverb_delay"; -import { sampler } from "./documentation/audio_engine/sampler"; -import { sample_banks } from "./documentation/samples/sample_banks"; -import { audio_basics } from "./documentation/audio_engine/audio_basics"; -import { sample_list } from "./documentation/samples/sample_list"; +import { loading_samples } from "./documentation/learning/samples/loading_samples"; +import { amplitude } from "./documentation/learning/audio_engine/amplitude"; +import { reverb } from "./documentation/learning/audio_engine/reverb_delay"; +import { sampler } from "./documentation/learning/audio_engine/sampler"; +import { sample_banks } from "./documentation/learning/samples/sample_banks"; +import { audio_basics } from "./documentation/learning/audio_engine/audio_basics"; +import { sample_list } from "./documentation/learning/samples/sample_list"; import { software_interface } from "./documentation/basics/interface"; import { shortcuts } from "./documentation/basics/keyboard"; import { code } from "./documentation/basics/code"; @@ -17,20 +17,20 @@ import { oscilloscope } from "./documentation/more/oscilloscope"; import { synchronisation } from "./documentation/more/synchronisation"; import { about } from "./documentation/more/about"; import { bonus } from "./documentation/more/bonus"; -import { chaining } from "./documentation/chaining"; -import { interaction } from "./documentation/interaction"; -import { time } from "./documentation/time/time"; -import { linear_time } from "./documentation/time/linear_time"; -import { cyclical_time } from "./documentation/time/cyclical_time"; -import { long_forms } from "./documentation/long_forms"; -import { midi } from "./documentation/midi"; -import { osc } from "./documentation/osc"; +import { chaining } from "./documentation/patterns/chaining"; +import { interaction } from "./documentation/basics/interaction"; +import { time } from "./documentation/learning/time/time"; +import { linear_time } from "./documentation/learning/time/linear_time"; +import { cyclical_time } from "./documentation/learning/time/cyclical_time"; +import { long_forms } from "./documentation/learning/time/long_forms"; +import { midi } from "./documentation/learning/midi"; +import { osc } from "./documentation/learning/osc"; import { sound } from "./documentation/engine"; -import { patterns } from "./documentation/patterns"; -import { functions } from "./documentation/functions"; -import { variables } from "./documentation/variables"; -import { probabilities } from "./documentation/probabilities"; -import { lfos } from "./documentation/lfos"; +import { patterns } from "./documentation/patterns/patterns"; +import { functions } from "./documentation/patterns/functions"; +import { variables } from "./documentation/patterns/variables"; +import { probabilities } from "./documentation/patterns/probabilities"; +import { lfos } from "./documentation/patterns/lfos"; import { ziffers_basics } from "./documentation/patterns/ziffers/ziffers_basics"; import { ziffers_scales } from "./documentation/patterns/ziffers/ziffers_scales"; import { ziffers_rhythm } from "./documentation/patterns/ziffers/ziffers_rhythm"; @@ -38,7 +38,7 @@ import { ziffers_algorithmic } from "./documentation/patterns/ziffers/ziffers_al import { ziffers_tonnetz } from "./documentation/patterns/ziffers/ziffers_tonnetz"; -import { synths } from "./documentation/synths"; +import { synths } from "./documentation/learning/audio_engine/synths"; // Setting up the Markdown converter with syntax highlighting import showdown from "showdown"; diff --git a/src/documentation/interaction.ts b/src/documentation/basics/interaction.ts similarity index 98% rename from src/documentation/interaction.ts rename to src/documentation/basics/interaction.ts index d62b2f3..49748d4 100644 --- a/src/documentation/interaction.ts +++ b/src/documentation/basics/interaction.ts @@ -1,5 +1,5 @@ -import { type Editor } from "../main"; -import { makeExampleFactory } from "../Documentation"; +import { type Editor } from "../../main"; +import { makeExampleFactory } from "../../Documentation"; // @ts-ignore export const interaction = (application: Editor): string => { diff --git a/src/documentation/audio_engine/amplitude.ts b/src/documentation/learning/audio_engine/amplitude.ts similarity index 96% rename from src/documentation/audio_engine/amplitude.ts rename to src/documentation/learning/audio_engine/amplitude.ts index ad415a2..3d0aec2 100644 --- a/src/documentation/audio_engine/amplitude.ts +++ b/src/documentation/learning/audio_engine/amplitude.ts @@ -1,5 +1,5 @@ -import { type Editor } from "../../main"; -import { makeExampleFactory } from "../../Documentation"; +import { type Editor } from "../../../main"; +import { makeExampleFactory } from "../../../Documentation"; export const amplitude = (application: Editor): string => { // @ts-ignore diff --git a/src/documentation/audio_engine/audio_basics.ts b/src/documentation/learning/audio_engine/audio_basics.ts similarity index 98% rename from src/documentation/audio_engine/audio_basics.ts rename to src/documentation/learning/audio_engine/audio_basics.ts index fa8d5e9..f38d5d9 100644 --- a/src/documentation/audio_engine/audio_basics.ts +++ b/src/documentation/learning/audio_engine/audio_basics.ts @@ -1,5 +1,5 @@ -import { type Editor } from "../../main"; -import { makeExampleFactory } from "../../Documentation"; +import { type Editor } from "../../../main"; +import { makeExampleFactory } from "../../../Documentation"; export const audio_basics = (application: Editor): string => { // @ts-ignore diff --git a/src/documentation/audio_engine/distortion.ts b/src/documentation/learning/audio_engine/distortion.ts similarity index 91% rename from src/documentation/audio_engine/distortion.ts rename to src/documentation/learning/audio_engine/distortion.ts index 567141b..c6f8d36 100644 --- a/src/documentation/audio_engine/distortion.ts +++ b/src/documentation/learning/audio_engine/distortion.ts @@ -1,5 +1,5 @@ -import { type Editor } from "../../main"; -import { makeExampleFactory } from "../../Documentation"; +import { type Editor } from "../../../main"; +import { makeExampleFactory } from "../../../Documentation"; export const distortion = (application: Editor): string => { // @ts-ignore diff --git a/src/documentation/audio_engine/reverb_delay.ts b/src/documentation/learning/audio_engine/reverb_delay.ts similarity index 97% rename from src/documentation/audio_engine/reverb_delay.ts rename to src/documentation/learning/audio_engine/reverb_delay.ts index 3015ef7..8ef6ccd 100644 --- a/src/documentation/audio_engine/reverb_delay.ts +++ b/src/documentation/learning/audio_engine/reverb_delay.ts @@ -1,5 +1,5 @@ -import { type Editor } from "../../main"; -import { makeExampleFactory } from "../../Documentation"; +import { type Editor } from "../../../main"; +import { makeExampleFactory } from "../../../Documentation"; export const reverb = (application: Editor): string => { // @ts-ignore diff --git a/src/documentation/audio_engine/sampler.ts b/src/documentation/learning/audio_engine/sampler.ts similarity index 97% rename from src/documentation/audio_engine/sampler.ts rename to src/documentation/learning/audio_engine/sampler.ts index 884b212..ad79f85 100644 --- a/src/documentation/audio_engine/sampler.ts +++ b/src/documentation/learning/audio_engine/sampler.ts @@ -1,5 +1,5 @@ -import { type Editor } from "../../main"; -import { makeExampleFactory } from "../../Documentation"; +import { type Editor } from "../../../main"; +import { makeExampleFactory } from "../../../Documentation"; export const sampler = (application: Editor): string => { // @ts-ignore diff --git a/src/documentation/synths.ts b/src/documentation/learning/audio_engine/synths.ts similarity index 99% rename from src/documentation/synths.ts rename to src/documentation/learning/audio_engine/synths.ts index fec806b..220fc50 100644 --- a/src/documentation/synths.ts +++ b/src/documentation/learning/audio_engine/synths.ts @@ -1,5 +1,5 @@ -import { type Editor } from "../main"; -import { makeExampleFactory } from "../Documentation"; +import { type Editor } from "../../../main"; +import { makeExampleFactory } from "../../../Documentation"; export const synths = (application: Editor): string => { const makeExample = makeExampleFactory(application); diff --git a/src/documentation/midi.ts b/src/documentation/learning/midi.ts similarity index 98% rename from src/documentation/midi.ts rename to src/documentation/learning/midi.ts index 7945390..ebfde28 100644 --- a/src/documentation/midi.ts +++ b/src/documentation/learning/midi.ts @@ -1,5 +1,5 @@ -import { type Editor } from "../main"; -import { makeExampleFactory, key_shortcut } from "../Documentation"; +import { type Editor } from "../../main"; +import { makeExampleFactory, key_shortcut } from "../../Documentation"; export const midi = (application: Editor): string => { const makeExample = makeExampleFactory(application); diff --git a/src/documentation/osc.ts b/src/documentation/learning/osc.ts similarity index 96% rename from src/documentation/osc.ts rename to src/documentation/learning/osc.ts index f0fa381..af56bc7 100644 --- a/src/documentation/osc.ts +++ b/src/documentation/learning/osc.ts @@ -1,5 +1,5 @@ -import { type Editor } from "../main"; -import { makeExampleFactory } from "../Documentation"; +import { type Editor } from "../../main"; +import { makeExampleFactory } from "../../Documentation"; export const osc = (application: Editor): string => { // @ts-ignore diff --git a/src/documentation/samples/loading_samples.ts b/src/documentation/learning/samples/loading_samples.ts similarity index 95% rename from src/documentation/samples/loading_samples.ts rename to src/documentation/learning/samples/loading_samples.ts index e6c54f5..404da7a 100644 --- a/src/documentation/samples/loading_samples.ts +++ b/src/documentation/learning/samples/loading_samples.ts @@ -1,5 +1,5 @@ -import { type Editor } from "../../main"; -import { makeExampleFactory } from "../../Documentation"; +import { type Editor } from "../../../main"; +import { makeExampleFactory } from "../../../Documentation"; export const loading_samples = (application: Editor): string => { // @ts-ignore diff --git a/src/documentation/samples/sample_banks.ts b/src/documentation/learning/samples/sample_banks.ts similarity index 93% rename from src/documentation/samples/sample_banks.ts rename to src/documentation/learning/samples/sample_banks.ts index d5b8199..2e7701d 100644 --- a/src/documentation/samples/sample_banks.ts +++ b/src/documentation/learning/samples/sample_banks.ts @@ -1,5 +1,5 @@ -import { type Editor } from "../../main"; -import { makeExampleFactory } from "../../Documentation"; +import { type Editor } from "../../../main"; +import { makeExampleFactory } from "../../../Documentation"; export const sample_banks = (application: Editor): string => { // @ts-ignore diff --git a/src/documentation/samples/sample_list.ts b/src/documentation/learning/samples/sample_list.ts similarity index 98% rename from src/documentation/samples/sample_list.ts rename to src/documentation/learning/samples/sample_list.ts index b8ba417..0175196 100644 --- a/src/documentation/samples/sample_list.ts +++ b/src/documentation/learning/samples/sample_list.ts @@ -1,5 +1,5 @@ -import { type Editor } from "../../main"; -import { makeExampleFactory } from "../../Documentation"; +import { type Editor } from "../../../main"; +import { makeExampleFactory } from "../../../Documentation"; export const samples_to_markdown = ( application: Editor, diff --git a/src/documentation/time/cyclical_time.ts b/src/documentation/learning/time/cyclical_time.ts similarity index 98% rename from src/documentation/time/cyclical_time.ts rename to src/documentation/learning/time/cyclical_time.ts index 0a8d240..16adc34 100644 --- a/src/documentation/time/cyclical_time.ts +++ b/src/documentation/learning/time/cyclical_time.ts @@ -1,5 +1,5 @@ -import { type Editor } from "../../main"; -import { makeExampleFactory } from "../../Documentation"; +import { type Editor } from "../../../main"; +import { makeExampleFactory } from "../../../Documentation"; export const cyclical_time = (app: Editor): string => { // @ts-ignore diff --git a/src/documentation/time/linear_time.ts b/src/documentation/learning/time/linear_time.ts similarity index 98% rename from src/documentation/time/linear_time.ts rename to src/documentation/learning/time/linear_time.ts index 2a76255..771813f 100644 --- a/src/documentation/time/linear_time.ts +++ b/src/documentation/learning/time/linear_time.ts @@ -1,5 +1,5 @@ -import { type Editor } from "../../main"; -import { makeExampleFactory } from "../../Documentation"; +import { type Editor } from "../../../main"; +import { makeExampleFactory } from "../../../Documentation"; import pulses from "./pulses.svg"; export const linear_time = (app: Editor): string => { diff --git a/src/documentation/long_forms.ts b/src/documentation/learning/time/long_forms.ts similarity index 98% rename from src/documentation/long_forms.ts rename to src/documentation/learning/time/long_forms.ts index 243e010..cd46bc9 100644 --- a/src/documentation/long_forms.ts +++ b/src/documentation/learning/time/long_forms.ts @@ -1,5 +1,5 @@ -import { type Editor } from "../main"; -import { makeExampleFactory } from "../Documentation"; +import { type Editor } from "../../../main"; +import { makeExampleFactory } from "../../../Documentation"; export const long_forms = (app: Editor): string => { // @ts-ignore diff --git a/src/documentation/time/pulses.svg b/src/documentation/learning/time/pulses.svg similarity index 100% rename from src/documentation/time/pulses.svg rename to src/documentation/learning/time/pulses.svg diff --git a/src/documentation/time/time.ts b/src/documentation/learning/time/time.ts similarity index 92% rename from src/documentation/time/time.ts rename to src/documentation/learning/time/time.ts index 538b8a2..43454da 100644 --- a/src/documentation/time/time.ts +++ b/src/documentation/learning/time/time.ts @@ -1,5 +1,5 @@ -import { makeExampleFactory } from "../../Documentation"; -import { type Editor } from "../../main"; +import { makeExampleFactory } from "../../../Documentation"; +import { type Editor } from "../../../main"; import times from "./times.svg"; export const time = (application: Editor): string => { diff --git a/src/documentation/time/times.svg b/src/documentation/learning/time/times.svg similarity index 100% rename from src/documentation/time/times.svg rename to src/documentation/learning/time/times.svg diff --git a/src/documentation/chaining.ts b/src/documentation/patterns/chaining.ts similarity index 98% rename from src/documentation/chaining.ts rename to src/documentation/patterns/chaining.ts index 0da67be..3fec4ca 100644 --- a/src/documentation/chaining.ts +++ b/src/documentation/patterns/chaining.ts @@ -1,5 +1,5 @@ -import { makeExampleFactory } from "../Documentation"; -import { type Editor } from "../main"; +import { makeExampleFactory } from "../../Documentation"; +import { type Editor } from "../../main"; export const chaining = (application: Editor): string => { const makeExample = makeExampleFactory(application); diff --git a/src/documentation/functions.ts b/src/documentation/patterns/functions.ts similarity index 95% rename from src/documentation/functions.ts rename to src/documentation/patterns/functions.ts index cc7af8a..f93bd33 100644 --- a/src/documentation/functions.ts +++ b/src/documentation/patterns/functions.ts @@ -1,5 +1,5 @@ -import { type Editor } from "../main"; -import { makeExampleFactory } from "../Documentation"; +import { type Editor } from "../../main"; +import { makeExampleFactory } from "../../Documentation"; export const functions = (application: Editor): string => { const makeExample = makeExampleFactory(application); diff --git a/src/documentation/lfos.ts b/src/documentation/patterns/lfos.ts similarity index 96% rename from src/documentation/lfos.ts rename to src/documentation/patterns/lfos.ts index 7bf8269..04910f9 100644 --- a/src/documentation/lfos.ts +++ b/src/documentation/patterns/lfos.ts @@ -1,5 +1,5 @@ -import { type Editor } from "../main"; -import { makeExampleFactory } from "../Documentation"; +import { type Editor } from "../../main"; +import { makeExampleFactory } from "../../Documentation"; export const lfos = (application: Editor): string => { const makeExample = makeExampleFactory(application); diff --git a/src/documentation/patterns.ts b/src/documentation/patterns/patterns.ts similarity index 98% rename from src/documentation/patterns.ts rename to src/documentation/patterns/patterns.ts index 3d9e45e..9aeb618 100644 --- a/src/documentation/patterns.ts +++ b/src/documentation/patterns/patterns.ts @@ -1,5 +1,5 @@ -import { type Editor } from "../main"; -import { makeExampleFactory } from "../Documentation"; +import { type Editor } from "../../main"; +import { makeExampleFactory } from "../../Documentation"; export const patterns = (application: Editor): string => { const makeExample = makeExampleFactory(application); diff --git a/src/documentation/probabilities.ts b/src/documentation/patterns/probabilities.ts similarity index 97% rename from src/documentation/probabilities.ts rename to src/documentation/patterns/probabilities.ts index b719c58..0437f44 100644 --- a/src/documentation/probabilities.ts +++ b/src/documentation/patterns/probabilities.ts @@ -1,5 +1,5 @@ -import { type Editor } from "../main"; -import { makeExampleFactory } from "../Documentation"; +import { type Editor } from "../../main"; +import { makeExampleFactory } from "../../Documentation"; export const probabilities = (application: Editor): string => { const makeExample = makeExampleFactory(application); diff --git a/src/documentation/variables.ts b/src/documentation/patterns/variables.ts similarity index 96% rename from src/documentation/variables.ts rename to src/documentation/patterns/variables.ts index 6ad4e25..489d816 100644 --- a/src/documentation/variables.ts +++ b/src/documentation/patterns/variables.ts @@ -1,5 +1,5 @@ -import { type Editor } from "../main"; -import { makeExampleFactory } from "../Documentation"; +import { type Editor } from "../../main"; +import { makeExampleFactory } from "../../Documentation"; export const variables = (application: Editor): string => { const makeExample = makeExampleFactory(application); diff --git a/src/documentation/patterns/ziffers/ziffers_scales.ts b/src/documentation/patterns/ziffers/ziffers_scales.ts index 6afef9f..2096c22 100644 --- a/src/documentation/patterns/ziffers/ziffers_scales.ts +++ b/src/documentation/patterns/ziffers/ziffers_scales.ts @@ -6,7 +6,7 @@ export const ziffers_scales = (application: Editor): string => { return ` # Scales - Ziffers supports all the keys and scales. Keys can be defined by using [scientific pitch notation](https://en.wikipedia.org/wiki/Scientific_pitch_notation), for example F3. Western style (1490 scales) can be with scale names named after greek modes and extended by [William Zeitler](https://ianring.com/musictheory/scales/traditions/zeitler). You will never really run out of scales to play with using Ziffers. Here is a short list of some possible scales that you can play with: + Ziffers supports all the keys and scales. Keys can be defined by using [scientific pitch notation](https://en.wikipedia.org/wiki/Scientific_pitch_notation), for example F3. Western style (1490 scales) can be with scale names named after greek modes and extended by William Zeitler. You will never really run out of scales to play with using Ziffers. Here is a short list of some possible scales that you can play with: | Scale name | Intervals | |------------|------------------------| @@ -20,7 +20,7 @@ export const ziffers_scales = (application: Editor): string => { | Soryllic | 11122122| | Modimic | 412122 | | Ionalian | 1312122 | - | ... | And it goes on for **1490** scales | + | ... | And it goes on for **1490** scales (See full list here). | ${makeExample( "What the hell is the Modimic scale?", @@ -33,7 +33,7 @@ export const ziffers_scales = (application: Editor): string => { `, true, )} - + You can also use more traditional western names: | Scale name | Intervals | diff --git a/src/documentation/patterns/ziffers/ziffers_syncing.ts b/src/documentation/patterns/ziffers/ziffers_syncing.ts new file mode 100644 index 0000000..e69de29