From 61ebf4995106c7b27d51dd3b4ca14c1fd1bd8656 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Pablo=20P=C3=A9rez?= Date: Mon, 19 Oct 2026 23:03:28 -0500 Subject: [PATCH] docs: fix typos in guides, formats, tutorials and migration notes --- docs/alphatex/document-structure.mdx | 2 +- docs/alphatex/importer.mdx | 2 +- docs/alphatex/lsp.mdx | 2 +- docs/alphatex/monaco.mdx | 2 +- docs/formats/guitar-pro-7.mdx | 2 +- docs/formats/musicxml.mdx | 12 ++++++------ docs/guides/handling-midi-events.mdx | 4 ++-- docs/guides/lowlevel-apis.mdx | 4 ++-- docs/guides/media-sync-editor.mdx | 6 +++--- docs/introduction.mdx | 2 +- docs/migration/breaking-changes-095-096.mdx | 2 +- docs/migration/breaking-changes-097-098.mdx | 2 +- docs/tutorial-android/viewport.mdx | 2 +- docs/tutorial-net/controls.mdx | 2 +- docs/tutorial-net/introduction.mdx | 4 ++-- docs/tutorial-net/track-selector.mdx | 2 +- docs/tutorial-net/viewport.mdx | 2 +- 17 files changed, 27 insertions(+), 27 deletions(-) diff --git a/docs/alphatex/document-structure.mdx b/docs/alphatex/document-structure.mdx index d29dcd670..8cb514282 100644 --- a/docs/alphatex/document-structure.mdx +++ b/docs/alphatex/document-structure.mdx @@ -4,7 +4,7 @@ title: Document Structure import { AlphaTexSample } from '@site/src/components/AlphaTexSample'; -An alphaTex file is simply a list of bars and every bar has metadata and contents. For organizational reasons we commend +An alphaTex file is simply a list of bars and every bar has metadata and contents. For organizational reasons we recommend that metadata tags describing the general song information are added to the start of the file, and external media synchronization points are added on the end of the file: diff --git a/docs/alphatex/importer.mdx b/docs/alphatex/importer.mdx index 74730b1a2..7c961c4b7 100644 --- a/docs/alphatex/importer.mdx +++ b/docs/alphatex/importer.mdx @@ -106,7 +106,7 @@ the severity, a technical code identifying the error and a textual error message The importer also allows access to the abstract syntax tree of the parsed code. The AST might also be available for only partially parsed code. -The following code should give an idea on how to access the AST by printing the whole hiearchy of nodes to the console: +The following code should give an idea on how to access the AST by printing the whole hierarchy of nodes to the console: ```js import * as alphaTab from '@coderline/alphatab'; diff --git a/docs/alphatex/lsp.mdx b/docs/alphatex/lsp.mdx index c0a0c6e11..2c1f73076 100644 --- a/docs/alphatex/lsp.mdx +++ b/docs/alphatex/lsp.mdx @@ -45,7 +45,7 @@ the editor will show descriptions when hovering the elements. No need to exit yo ## Signature Help -When passing arguments to metadata tags and properties the language server will provide a signature help to provide addtional guidance on what parameters and values exist: +When passing arguments to metadata tags and properties the language server will provide a signature help to provide additional guidance on what parameters and values exist: diff --git a/docs/alphatex/monaco.mdx b/docs/alphatex/monaco.mdx index e383713b9..e28528129 100644 --- a/docs/alphatex/monaco.mdx +++ b/docs/alphatex/monaco.mdx @@ -74,7 +74,7 @@ At this point you should get an editor with syntax highlighting. ## Starting the language server -To get the remaining capabilites into Monaco, we first have to launch the alphaTex language server in a web worker. +To get the remaining capabilities into Monaco, we first have to launch the alphaTex language server in a web worker. The NPM package provides a module which can be spawned as web worker: diff --git a/docs/formats/guitar-pro-7.mdx b/docs/formats/guitar-pro-7.mdx index 74c384d47..d80eb1edc 100644 --- a/docs/formats/guitar-pro-7.mdx +++ b/docs/formats/guitar-pro-7.mdx @@ -17,7 +17,7 @@ In version 7, Guitar Pro changed to use a zip based file archive format. The zip * `PartConfiguration` - A binary file holding information on what tracks and staves to show in single and multi-track views. * `LayoutConfiguration` - A binary file holding information on what layout to use for displaying music sheets (e.g. zoom level) -The `score.gpif` is the same as in Guitar Pro 6 but evovling with new features since then. +The `score.gpif` is the same as in Guitar Pro 6 but evolving with new features since then. **Compatibility Level:** Mature and well tested diff --git a/docs/formats/musicxml.mdx b/docs/formats/musicxml.mdx index 0934cefb4..57a95ec38 100644 --- a/docs/formats/musicxml.mdx +++ b/docs/formats/musicxml.mdx @@ -19,7 +19,7 @@ notation elements to be described. This also makes it quite complex to handle as Unfortunately MusicXML implies a lot of details on the visual arrangements of elements and expect applications like alphaTab to adhere to their layouting principles. With alphaTab not having a strict print-page display (yet) respecting those arrangement aspects is not possible. -Additionally MusicXML differenciates between "displayed" music notation and the "sound" of elements which can be potentially inconsistent. +Additionally MusicXML differentiates between "displayed" music notation and the "sound" of elements which can be potentially inconsistent. alphaTab does its best to load any semantic information contained in the files (both in visual and sound related elements). Due to this alphaTab might visually indicate some elements which are not visually described in MusicXML. This can be a benefit in some cases. @@ -33,10 +33,10 @@ Be sure to check the [MusicXML reference](https://www.w3.org/2021/06/musicxml40/ **How to read the table:** -* The feature table tries to describe the support matching [MusicXML 4.0 element eference](https://www.w3.org/2021/06/musicxml40/musicxml-reference/elements/). +* The feature table tries to describe the support matching [MusicXML 4.0 element reference](https://www.w3.org/2021/06/musicxml40/musicxml-reference/elements/). * Every group is typically a MusicXML Element describing what attributes and sub-elements are supported. * Elements are listed with their exact names, attributes are prefixed with `@`. -* If individual attribute values are not supported they might be listed in a format like `@attribute=value`. But for keeping this docs at a managable scale not all details might be listed. +* If individual attribute values are not supported they might be listed in a format like `@attribute=value`. But for keeping this docs at a manageable scale not all details might be listed. * The sub-element support indicates whether generally the tag is considered. What parts are supported, are then listed in the dedicated group of the respective tag. * Some common attributes are only listed once instead on each element. Some simple elements are listed as part of their parent element, while other element are listed as own feature section. * Some attributes we considered not relevant at all are not even listed (e.g. `@id` of `credit`). @@ -2812,13 +2812,13 @@ import { FileFormatFeatureTable, FileFormatFeatureGroup, FileFormatFeatureRow, F render={[FeatureStatus.NotSupported]} audio={[FeatureStatus.NotSupported]} tex={[FeatureStatus.NotSupported]} /> - - - { svgChunks = []; // clear on new rendering }); // since 1.2.3 we need to request -// rendering of each chunk layed out. +// rendering of each chunk laid out. // you can defer rendering based on your needs. renderer.partialLayoutFinished.on(r => { renderer.renderResult(r.id); @@ -135,7 +135,7 @@ renderer.PreRender.On(isResize => { svgChunks.Clear(); // clear on new rendering }); // since 1.2.3 we need to request -// rendering of each chunk layed out. +// rendering of each chunk laid out. // you can defer rendering based on your needs. renderer.PartialLayoutFinished.On(r => { renderer.RenderResult(r.Id); diff --git a/docs/guides/media-sync-editor.mdx b/docs/guides/media-sync-editor.mdx index 5da7a711f..923a4134d 100644 --- a/docs/guides/media-sync-editor.mdx +++ b/docs/guides/media-sync-editor.mdx @@ -97,7 +97,7 @@ To activate or deactivate any sync point doubleclick it and it will be toggled. Inactive markers are placed automatically according to the time axis and BPM of the song. They are having light blue arrow heads. -If there are repeats or jumps in the song the repeat counter is shown in parenthesis behind the bar number above the arrow head. For the first occurence no repeat number is shown. +If there are repeats or jumps in the song the repeat counter is shown in parenthesis behind the bar number above the arrow head. For the first occurrence no repeat number is shown. @@ -132,7 +132,7 @@ If the music notation and audio match, you typically do not need any more sync p --- -**Problem:** There are instruction parts where a teacher might explain something inbetween. +**Problem:** There are instruction parts where a teacher might explain something in between. **Solution 1:** If you manually control the external media synchronization (via `IExternalMediaHandler`) you could adjust the time reported to alphaTab so that it quasi stops playing and moving the cursor. @@ -148,7 +148,7 @@ If the music notation and audio match, you typically do not need any more sync p --- -Generally it is discouraged to add too many markers (e.g. for every bar). It's unlikely that the tempo changes constantly and needs adjustment. Rather pick a range where you expect the tempo to be roughtly equal, +Generally it is discouraged to add too many markers (e.g. for every bar). It's unlikely that the tempo changes constantly and needs adjustment. Rather pick a range where you expect the tempo to be roughly equal, mark it with two sync points and place them accordingly. The general recommendation to place markers correctly is: diff --git a/docs/introduction.mdx b/docs/introduction.mdx index 59a1d0d60..f370e5802 100644 --- a/docs/introduction.mdx +++ b/docs/introduction.mdx @@ -124,7 +124,7 @@ the information about music sheets. alphaTab has importers for: This engine is what makes the music sheet visible. alphaTab takes all the information stored in the data model and does a visual layouting and rendering which is called music engraving. -For this, alphaTab builds up a visual tree represntation of all the symbols following the rules of music notation. +For this, alphaTab builds up a visual tree representation of all the symbols following the rules of music notation. Using this model alphaTab can very efficiently provide dynamic resizing and relayouting. The symbols alphaTab is using the [SMuFL](https://www.smufl.org/) music font [Bravura](https://github.com/steinbergmedia/bravura). diff --git a/docs/migration/breaking-changes-095-096.mdx b/docs/migration/breaking-changes-095-096.mdx index 9da262ce4..b467d9767 100644 --- a/docs/migration/breaking-changes-095-096.mdx +++ b/docs/migration/breaking-changes-095-096.mdx @@ -40,7 +40,7 @@ Please find all changes that were introduced below. - This API was removed. Simply change the settings and call `updateSettings` and `render` to achive the same behavior. + This API was removed. Simply change the settings and call `updateSettings` and `render` to achieve the same behavior. diff --git a/docs/migration/breaking-changes-097-098.mdx b/docs/migration/breaking-changes-097-098.mdx index a1c745bec..742f4fe95 100644 --- a/docs/migration/breaking-changes-097-098.mdx +++ b/docs/migration/breaking-changes-097-098.mdx @@ -13,7 +13,7 @@ While this version comes with a lot of new benefits this guide only focuses on t ## Web -For the web version we tried to maintain compatiblity as good as possible while not sacrificing the changes we want to +For the web version we tried to maintain compatibility as good as possible while not sacrificing the changes we want to introduce. ### Quick Migration diff --git a/docs/tutorial-android/viewport.mdx b/docs/tutorial-android/viewport.mdx index 8d30288e4..dc1732239 100644 --- a/docs/tutorial-android/viewport.mdx +++ b/docs/tutorial-android/viewport.mdx @@ -241,7 +241,7 @@ class MainActivity : AppCompatActivity() { ## Result With this code we can launch the app and open a test file. Test files can be added to the simulator via drag&drop onto the simulator screen. -When running debug versions of your app the opening can be quite slow, to experience the real performace deploy a release version and test it. +When running debug versions of your app the opening can be quite slow, to experience the real performance deploy a release version and test it. diff --git a/docs/tutorial-net/controls.mdx b/docs/tutorial-net/controls.mdx index c64197a8f..a776ecf75 100644 --- a/docs/tutorial-net/controls.mdx +++ b/docs/tutorial-net/controls.mdx @@ -169,7 +169,7 @@ public bool IsLooping As alphaTab can change the scale in which the music sheet is rendered, we offer the user a ComboBox to change this scale. As the default ComboBox style does not fit our application style, we modify it a bit with a custom style and template. This style can be added to the resources where -already adjust the stlyes of the buttons. The combobox and icon we add after the looping button. +already adjust the styles of the buttons. The combobox and icon we add after the looping button. diff --git a/docs/tutorial-net/viewport.mdx b/docs/tutorial-net/viewport.mdx index 4450f3e4e..8ee94dbdc 100644 --- a/docs/tutorial-net/viewport.mdx +++ b/docs/tutorial-net/viewport.mdx @@ -363,7 +363,7 @@ to dynamically show/hide it. We add a new property `LoadingIndicatorVisibility` with change notification which we bind to from the XAML. -In the constructor we setup the data context and initialize the indiactor to be hidden to allow opening a file. +In the constructor we setup the data context and initialize the indicator to be hidden to allow opening a file. In the `OnAlphaTabLoaded` we register to the required events to show/hide the indicator dynamically. [`RenderStarted`](/docs/reference/api/renderstarted) will tell us when the rendering of the music sheet started.