Skip to content

Commit

Permalink
WIP: Add tables of contents to docs
Browse files Browse the repository at this point in the history
ref #336
  • Loading branch information
frostburn committed Jun 26, 2024
1 parent c2aab91 commit 4a43006
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions documentation/dsl.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,31 @@
# SonicWeave DSL
This document describes the SonicWeave domain-specific language for manipulating musical frequencies, ratios and equal temperaments.

# Table of Contents
1. [Basic example](#basic-example): Ratios
* [Absolute pitch notation](#absolute-pitch-notation)
* [Cents](#cents)
* [Equal temperaments](#equal-temperaments)
* [Relative pitch notation](#relative-pitch-notation)
2. [Domains](#domains): Linear vs. logarithmic
* [Breaking changes](#breaking-change-compared-to-scale-workshop-2)
3. [Adding colors to notes](#adding-colors-to-notes)
4. [Code comments](#code-comments)
5. [Accidentals](#accidentals)
* [Double accidentals](#double-accidentals)
6. [Relative Pythagorean notation](#relative-pythagorean-notation)
* [Pythagorean absolute notation](#pythagorean-absolute-notation)
7. [FJS inflections](#fjs-inflections)
8. [Enumerated chord](#enumerated-chords)
* [Harmonic segments](#harmonic-segments)
* [Reflected enumerations](#reflected-enumerations)
9. [Scale title](#scale-title)
10. [Ups and downs notation](#ups-and-downs-notation)
* [Lifts and drops](#lifts-and-drops)
11. [Helper functions](#helper-functions)
12. [Next steps](#next-steps)
* [Intermediate DSL](https://github.com/xenharmonic-devs/sonic-weave/blob/main/documentation/intermediate-dsl.md)

## Basic example

SonicWeave is related to [Scala .scl](https://www.huygens-fokker.org/scala/scl_format.html) and a successor of Scale Workshop 2. It is intended for constructing microtonal scales that repeat at the octave (or some other period).
Expand Down

0 comments on commit 4a43006

Please sign in to comment.