From 26659efee2c3af205271ce889b9407dc09248eeb Mon Sep 17 00:00:00 2001 From: Maxim Dobroselsky Date: Wed, 1 May 2024 12:11:21 +0300 Subject: [PATCH] [Docs] Fixed links --- Docs/articles/dev/Support.md | 2 +- Docs/articles/file-reading-writing/MIDI-file-reading.md | 2 +- Docs/articles/music-theory/Overview.md | 2 +- DryWetMidi/Core/Chunks/MidiChunk.cs | 2 +- DryWetMidi/Core/Chunks/TrackChunk.cs | 2 +- DryWetMidi/Core/Chunks/UnknownChunk.cs | 2 +- DryWetMidi/Core/Events/Base/MetaEvent.cs | 2 +- DryWetMidi/Core/Events/Base/MidiEvent.cs | 2 +- DryWetMidi/Core/MidiFile.cs | 2 +- README.md | 2 +- 10 files changed, 10 insertions(+), 10 deletions(-) diff --git a/Docs/articles/dev/Support.md b/Docs/articles/dev/Support.md index 10138311e..f6b778f16 100644 --- a/Docs/articles/dev/Support.md +++ b/Docs/articles/dev/Support.md @@ -16,7 +16,7 @@ Things to pay attention for are: 3. Provide your code (as text, not as a screenshot!) and point me to the place there where the error occurred or where you need to do something. 4. What is your operating system? 5. What version of the library do you use? -6. Use proper MIDI terminology. Official MIDI specification can be found on the [midi.org](https://www.midi.org/specifications/midi1-specifications/midi-1-0-core-specifications/midi-1-0-detailed-specification-2). +6. Use proper MIDI terminology. Official MIDI specification can be found on the [midi.org](https://midi.org/midi-1-0-detailed-specification). 7. Use formatting for your messages (especially for code blocks): * on GitHub use [Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax); * on emails use formatting provided by your mail client. diff --git a/Docs/articles/file-reading-writing/MIDI-file-reading.md b/Docs/articles/file-reading-writing/MIDI-file-reading.md index dd312f953..4005103ab 100644 --- a/Docs/articles/file-reading-writing/MIDI-file-reading.md +++ b/Docs/articles/file-reading-writing/MIDI-file-reading.md @@ -25,7 +25,7 @@ var file = MidiFile.Read("Some great song.mid", new ReadingSettings ## Reading corrupted files -DryWetMIDI allows to read MIDI files with various violations of [SMF](https://www.midi.org/specifications/file-format-specifications/standard-midi-files) standard. Example below shows how to read a MIDI file with different errors: +DryWetMIDI allows to read MIDI files with various violations of [SMF](https://midi.org/standard-midi-files-specification) standard. Example below shows how to read a MIDI file with different errors: ```csharp var file = MidiFile.Read("Some great song.mid", new ReadingSettings diff --git a/Docs/articles/music-theory/Overview.md b/Docs/articles/music-theory/Overview.md index 8271ca825..430bfa2e5 100644 --- a/Docs/articles/music-theory/Overview.md +++ b/Docs/articles/music-theory/Overview.md @@ -13,6 +13,6 @@ DryWetMIDI provides types and methods to work with music theory objects like sca * [Chord progression](Chord-progression.md); * [Scale](Scale.md). -Note that DryWetMIDI uses [Scientific Pitch Notation](https://en.wikipedia.org/wiki/Scientific_pitch_notation) so **middle C** note is C4 one. [Octave.Middle](xref:Melanchall.DryWetMidi.MusicTheory.Octave.Middle) returns that 4th octave. You can read interesting discussion about different notations here: [MIDI Octave and Note Numbering Standard](https://www.midi.org/forum/830-midi-octave-and-note-numbering-standard). +Note that DryWetMIDI uses [Scientific Pitch Notation](https://en.wikipedia.org/wiki/Scientific_pitch_notation) so **middle C** note is C4 one. [Octave.Middle](xref:Melanchall.DryWetMidi.MusicTheory.Octave.Middle) returns that 4th octave. You can read interesting discussion about different notations here: [MIDI Octave and Note Numbering Standard](https://midi.org/community/midi-specifications/midi-octave-and-note-numbering-standard). All corresponding classes have `Parse` and `TryParse` method so you can get an instance of a class from string. For example, you can parse `"C#"` string to C# note. \ No newline at end of file diff --git a/DryWetMidi/Core/Chunks/MidiChunk.cs b/DryWetMidi/Core/Chunks/MidiChunk.cs index f7c02bbf1..407abcf01 100644 --- a/DryWetMidi/Core/Chunks/MidiChunk.cs +++ b/DryWetMidi/Core/Chunks/MidiChunk.cs @@ -29,7 +29,7 @@ namespace Melanchall.DryWetMidi.Core /// property will hold chunk's data and will hold the ID of a chunk. /// /// - /// See for detailed MIDI file specification. + /// See for detailed MIDI file specification. /// /// public abstract class MidiChunk diff --git a/DryWetMidi/Core/Chunks/TrackChunk.cs b/DryWetMidi/Core/Chunks/TrackChunk.cs index 245a33ad6..fbb4ecd32 100644 --- a/DryWetMidi/Core/Chunks/TrackChunk.cs +++ b/DryWetMidi/Core/Chunks/TrackChunk.cs @@ -11,7 +11,7 @@ namespace Melanchall.DryWetMidi.Core /// /// /// - /// See for detailed MIDI file specification. + /// See for detailed MIDI file specification. /// /// public sealed class TrackChunk : MidiChunk diff --git a/DryWetMidi/Core/Chunks/UnknownChunk.cs b/DryWetMidi/Core/Chunks/UnknownChunk.cs index 3f9a44ae0..6ff960043 100644 --- a/DryWetMidi/Core/Chunks/UnknownChunk.cs +++ b/DryWetMidi/Core/Chunks/UnknownChunk.cs @@ -12,7 +12,7 @@ namespace Melanchall.DryWetMidi.Core /// Chunks DryWetMIDI doesn't know about will be read as an instances of the . /// /// - /// See for detailed MIDI file specification. + /// See for detailed MIDI file specification. /// /// public sealed class UnknownChunk : MidiChunk diff --git a/DryWetMidi/Core/Events/Base/MetaEvent.cs b/DryWetMidi/Core/Events/Base/MetaEvent.cs index 1a6cb5f01..cd005ae97 100644 --- a/DryWetMidi/Core/Events/Base/MetaEvent.cs +++ b/DryWetMidi/Core/Events/Base/MetaEvent.cs @@ -19,7 +19,7 @@ /// See Custom meta events article to learn more. /// /// - /// See for detailed MIDI file specification. + /// See for detailed MIDI file specification. /// /// public abstract class MetaEvent : MidiEvent diff --git a/DryWetMidi/Core/Events/Base/MidiEvent.cs b/DryWetMidi/Core/Events/Base/MidiEvent.cs index 438096774..55c4f57f8 100644 --- a/DryWetMidi/Core/Events/Base/MidiEvent.cs +++ b/DryWetMidi/Core/Events/Base/MidiEvent.cs @@ -8,7 +8,7 @@ namespace Melanchall.DryWetMidi.Core /// /// /// - /// See for detailed MIDI file specification. + /// See for detailed MIDI file specification. /// /// public abstract class MidiEvent diff --git a/DryWetMidi/Core/MidiFile.cs b/DryWetMidi/Core/MidiFile.cs index fe506c3d2..7b9dc5bc7 100644 --- a/DryWetMidi/Core/MidiFile.cs +++ b/DryWetMidi/Core/MidiFile.cs @@ -32,7 +32,7 @@ namespace Melanchall.DryWetMidi.Core /// ( or /// ). /// - /// See for detailed MIDI file specification. + /// See for detailed MIDI file specification. /// /// /// diff --git a/README.md b/README.md index b26aafa52..162480fa2 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ DryWetMIDI is the .NET library to work with MIDI data and MIDI devices. It allows: -* Read, write and create [Standard MIDI Files (SMF)](https://www.midi.org/specifications/file-format-specifications/standard-midi-files). It is also possible to read [RMID](https://www.loc.gov/preservation/digital/formats/fdd/fdd000120.shtml) files where SMF wrapped to RIFF chunk. You can easily catch specific error when reading or writing MIDI file since all possible errors in a MIDI file are presented as separate exception classes. +* Read, write and create [Standard MIDI Files (SMF)](https://midi.org/standard-midi-files-specification). It is also possible to read [RMID](https://www.loc.gov/preservation/digital/formats/fdd/fdd000120.shtml) files where SMF wrapped to RIFF chunk. You can easily catch specific error when reading or writing MIDI file since all possible errors in a MIDI file are presented as separate exception classes. * [Send](https://melanchall.github.io/drywetmidi/articles/devices/Output-device.html) MIDI events to/[receive](https://melanchall.github.io/drywetmidi/articles/devices/Input-device.html) them from MIDI devices, [play](https://melanchall.github.io/drywetmidi/articles/playback/Overview.html) MIDI data and [record](https://melanchall.github.io/drywetmidi/articles/recording/Overview.html) it. This APIs support Windows and macOS. * Finely adjust process of reading and writing. It allows, for example, to read corrupted files and repair them, or build MIDI file validators. * Implement [custom meta events](https://melanchall.github.io/drywetmidi/articles/custom-data-structures/Custom-meta-events.html) and [custom chunks](https://melanchall.github.io/drywetmidi/articles/custom-data-structures/Custom-chunks.html) that can be written to and read from MIDI files.