Skip to content

Commit

Permalink
[Docs] Fixed links
Browse files Browse the repository at this point in the history
  • Loading branch information
melanchall committed May 1, 2024
1 parent 64c087a commit 26659ef
Show file tree
Hide file tree
Showing 10 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion Docs/articles/dev/Support.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion Docs/articles/file-reading-writing/MIDI-file-reading.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion Docs/articles/music-theory/Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion DryWetMidi/Core/Chunks/MidiChunk.cs
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ namespace Melanchall.DryWetMidi.Core
/// <see cref="UnknownChunk.Data"/> property will hold chunk's data and <see cref="ChunkId"/> will hold the ID of a chunk.
/// </para>
/// <para>
/// See <see href="https://www.midi.org/specifications/file-format-specifications/standard-midi-files"/> for detailed MIDI file specification.
/// See <see href="https://midi.org/standard-midi-files-specification"/> for detailed MIDI file specification.
/// </para>
/// </remarks>
public abstract class MidiChunk
Expand Down
2 changes: 1 addition & 1 deletion DryWetMidi/Core/Chunks/TrackChunk.cs
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ namespace Melanchall.DryWetMidi.Core
/// </summary>
/// <remarks>
/// <para>
/// See <see href="https://www.midi.org/specifications/file-format-specifications/standard-midi-files"/> for detailed MIDI file specification.
/// See <see href="https://midi.org/standard-midi-files-specification"/> for detailed MIDI file specification.
/// </para>
/// </remarks>
public sealed class TrackChunk : MidiChunk
Expand Down
2 changes: 1 addition & 1 deletion DryWetMidi/Core/Chunks/UnknownChunk.cs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ namespace Melanchall.DryWetMidi.Core
/// Chunks DryWetMIDI doesn't know about will be read as an instances of the <see cref="UnknownChunk"/>.
/// </para>
/// <para>
/// See <see href="https://www.midi.org/specifications/file-format-specifications/standard-midi-files"/> for detailed MIDI file specification.
/// See <see href="https://midi.org/standard-midi-files-specification"/> for detailed MIDI file specification.
/// </para>
/// </remarks>
public sealed class UnknownChunk : MidiChunk
Expand Down
2 changes: 1 addition & 1 deletion DryWetMidi/Core/Events/Base/MetaEvent.cs
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
/// See <see href="xref:a_custom_meta_event">Custom meta events</see> article to learn more.
/// </para>
/// <para>
/// See <see href="https://www.midi.org/specifications/file-format-specifications/standard-midi-files"/> for detailed MIDI file specification.
/// See <see href="https://midi.org/standard-midi-files-specification"/> for detailed MIDI file specification.
/// </para>
/// </remarks>
public abstract class MetaEvent : MidiEvent
Expand Down
2 changes: 1 addition & 1 deletion DryWetMidi/Core/Events/Base/MidiEvent.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ namespace Melanchall.DryWetMidi.Core
/// </summary>
/// <remarks>
/// <para>
/// See <see href="https://www.midi.org/specifications/file-format-specifications/standard-midi-files"/> for detailed MIDI file specification.
/// See <see href="https://midi.org/standard-midi-files-specification"/> for detailed MIDI file specification.
/// </para>
/// </remarks>
public abstract class MidiEvent
Expand Down
2 changes: 1 addition & 1 deletion DryWetMidi/Core/MidiFile.cs
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ namespace Melanchall.DryWetMidi.Core
/// (<see cref="Write(string, bool, MidiFileFormat, WritingSettings)"/> or
/// <see cref="Write(Stream, MidiFileFormat, WritingSettings)"/>).</para>
/// <para>
/// See <see href="https://www.midi.org/specifications/file-format-specifications/standard-midi-files"/> for detailed MIDI file specification.
/// See <see href="https://midi.org/standard-midi-files-specification"/> for detailed MIDI file specification.
/// </para>
/// </remarks>
/// <seealso cref="ReadingSettings"/>
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 26659ef

Please sign in to comment.