Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/build-pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ jobs:
node-version: lts/*
- run: npm install
- run: npm install @coderline/alphatab@alpha
- run: npm run generate-alphatabdoc
- run: npm run build
- run: cp web.config ./build
- uses: actions/upload-artifact@v4
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/deploy-develop.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ jobs:
node-version: lts/*
- run: npm install
- run: npm install @coderline/alphatab@alpha
- run: npm run generate-alphatabdoc
- run: npm run build
- run: cp web.config ./build
- name: Package Zip
Expand Down
4 changes: 3 additions & 1 deletion .github/workflows/deploy-main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,15 @@ on:
workflow_dispatch:
schedule:
- cron: '0 1 * * 0'

jobs:
build:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
with:
ref: 'main'
- uses: montudor/action-zip@v1
- uses: actions/setup-node@v4
with:
Expand Down
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,6 @@
npm-debug.log*
yarn-debug.log*
yarn-error.log*

src/alphatabdoc/
docs/reference/types/
57 changes: 57 additions & 0 deletions docs/alphatex/bar-metadata.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -229,3 +229,60 @@ To apply simile marks use the `\simile type` where type is:
<AlphaTexSample player="true">{`
3.3*4 | \\simile simple | 3.3*4 | 4.3*4 | \\simile firstofdouble | \\simile secondofdouble
`}</AlphaTexSample>

## Bar Lines

For some special notation needs, the default bar line can be adjusted on every bar.
The bar line styles are aligned with the ones from [MusicXML](https://www.w3.org/2021/06/musicxml40/musicxml-reference/data-types/bar-style/).

* `\barlineLeft` adjusts the left bar line
* `\barlineRight` adjusts the right bar line

alphaTab attempts to reuse lines on overlapping styles across bars.

<AlphaTexSample tracks="all">{`
\\instrument piano
.
\\track "Overlapping"
\\staff
\\barlineleft dashed
\\barlineright dotted
|
\\barlineleft heavyheavy
\\barlineright heavyheavy

\\staff
\\barlineleft lightlight
\\barlineright lightheavy
|
\\barlineleft heavylight
\\barlineright dashed
\\track "All Styles"
\\staff
\\barlineright dashed |
\\barlineright dotted |
\\barlineright heavy |
\\barlineright heavyHeavy |
\\barlineright heavyLight |
\\barlineright lightHeavy |
\\barlineright lightlight |
\\barlineright none |
\\barlineright regular |
\\barlineright short |
\\barlineright tick |
`}</AlphaTexSample>

* `automatic` - Bar lines are determined automatically based on details like repeats and free time (default).
* `dashed`
* `dotted`
* `heavy`
* `heavyheavy`
* `heavylight`
* `lightheavy`
* `lightlight`
* `none`
* `regular`
* `short`
* `tick`


2 changes: 1 addition & 1 deletion docs/alphatex/beat-effects.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Please find the list of supported effects in the example below.

## Dynamics

Dynamics are beat effects with the indicator `dy` followed by one of the supported dynamics values FFF, FF, F, MF, MP, P, PP or PPP.
Dynamics are beat effects with the indicator `dy` followed by one of the supported dynamics values PPP, PP, P, MP, MF, F, FF, FFF, PPPP, PPPPP, PPPPPP, FFFF, FFFFF, FFFFFF, SF, SFP, SFPP, FP, RF, RFZ, SFZ, SFFZ, FZ, N, PF, SFZP.

<AlphaTexSample>{`
1.1.8{dy ppp} 1.1{dy pp} 1.1{dy p} 1.1{dy mp} 1.1{dy mf} 1.1{dy f} 1.1{dy ff} 1.1{dy fff}
Expand Down
30 changes: 29 additions & 1 deletion docs/alphatex/metadata.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@ title: Metadata
---

import { AlphaTexSample } from '@site/src/components/AlphaTexSample';
import { SinceBadge } from '@site/src/components/SinceBadge';

Metadata is specified using `\tagname value value` at the beginning of the score.
Metadata is specified using `\tagname value` at the beginning of the score.
It can be used to specify global information like title, tempo or track tuning.
Metadata is optional, but if specified, it must be followed by a dot to indicate the end
of the metadata.
Expand Down Expand Up @@ -39,6 +40,33 @@ Please refer to the [Tracks and Staves](/docs/alphatex/tracks-staves) or details

Strings can contain escape sequences: `\n`, `\r`, `\t`, `\\`, `\"`, `\'`.

<SinceBadge inline={true} since="1.5.0" /> its possible to also change the template and alignment of the song information
via `\tagname value template alignment`.

The `template` is a string which can have following placeholders which are then replaced with the respective info of the song:

* `%TITLE%`
* `%SUBTITLE%`
* `%ARTIST%`
* `%ALBUM%`
* `%WORDS%`
* `%WORDSMUSIC%`
* `%MUSIC%`
* `%TABBER%`
* `%COPYRIGHT%`

The `alignment` is one of the following values:

* `left`
* `center`
* `right`

<AlphaTexSample>{`
\\title "Song Title" "Title: %TITLE%" left
\\artist Artist "Written by %ARTIST%" right
.
`}</AlphaTexSample>

## Instrument
As indicated above, the instrument can be changed via the `\instrument` metadata.
Refer to the table below for all possible values and names. The list represents the General MIDI instrument list.
Expand Down
28 changes: 28 additions & 0 deletions docs/alphatex/stylesheet.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -116,3 +116,31 @@ To configure the mode how to show [track names](/docs/showcase/general.mdx#track
C4 D4 E4 F4 | C4 D4 E4 F4 | C4 D4 E4 F4 | C4 D4 E4 F4 | C4 D4 E4 F4 |
`}</AlphaTexSample>

## Multi-Bar Rests

To configure whether [multibar rests](/docs/showcase/layouts.mdx#multi-bar-rests) should be enabled use:

* `\multiBarRest` - On top level for configuring the use on multi-track renderings
* `\track { multiBarRest }` - On track level for single track renderings

<AlphaTexSample tracks="all">{`
\\title "Multi Track"
\\multiBarRest
.
\\track "Piano 1" "pno1"
\\staff {score}
C4 D4 E4 F4 | r | r | C4 D4 E4 F4 | r | r | r | C4

\\track "Piano 2" "pno1"
\\staff {score}
C4 D4 E4 F4 | r | r | C4 D4 E4 F4 | r | r | r | r |
`}</AlphaTexSample>

<AlphaTexSample tracks="all">{`
\\title "Single Track"
.
\\track "Piano 1" "pno1" { multiBarRest }
\\staff {score}
C4 D4 E4 F4 | r | r | C4 D4 E4 F4 | r | r | r | C4
`}</AlphaTexSample>

10 changes: 5 additions & 5 deletions docs/formats/guitar-pro-7.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -338,11 +338,11 @@ import { FileFormatFeatureTable, FileFormatFeatureGroup, FileFormatFeatureRow, F
tex={[FeatureStatus.Supported]} />

<FileFormatFeatureRow feature="Multirest" isNewFeature="true"
model={[FeatureStatus.NotSupported]}
reading={[FeatureStatus.NotSupported]}
render={[FeatureStatus.NotSupported]}
audio={[FeatureStatus.Ignored]}
tex={[FeatureStatus.NotSupported]} />
model={[FeatureStatus.Supported]}
reading={[FeatureStatus.Supported]}
render={[FeatureStatus.Supported]}
audio={[FeatureStatus.Supported]}
tex={[FeatureStatus.Supported]} />

</FileFormatFeatureGroup>
<FileFormatFeatureGroup title="Beat Level">
Expand Down
10 changes: 5 additions & 5 deletions docs/formats/guitar-pro-8.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -350,11 +350,11 @@ import { FileFormatFeatureTable, FileFormatFeatureGroup, FileFormatFeatureRow, F
tex={[FeatureStatus.Supported]} />

<FileFormatFeatureRow feature="Multirest"
model={[FeatureStatus.NotSupported]}
reading={[FeatureStatus.NotSupported]}
render={[FeatureStatus.NotSupported]}
audio={[FeatureStatus.Ignored]}
tex={[FeatureStatus.NotSupported]} />
model={[FeatureStatus.Supported]}
reading={[FeatureStatus.Supported]}
render={[FeatureStatus.Supported]}
audio={[FeatureStatus.Supported]}
tex={[FeatureStatus.Supported]} />

</FileFormatFeatureGroup>
<FileFormatFeatureGroup title="Beat Level">
Expand Down
Loading