Score Metadata
This page lists all metadata tags which affect the overall song.
It is recommended that these tags are specified at the very beginning of the file.
\title​
\title value
\title (value template textAlign)
Description: Sets the title of the song in the data model.
Values:
| Name | Description | Type | Required |
|---|---|---|---|
| value | The title of the song | string | yes |
| template | The text template used to render the title | string | no |
| textAlign | The text alignment of the text to display on the music sheet | left, center or right | no |
Example
\title ("Song Title" "Title: %TITLE%" left)
C4
There are no properties on this metadata.
\subtitle​
\subtitle value
\subtitle (value template textAlign)
Description: Sets the subtitle of the song in the data model.
Values:
| Name | Description | Type | Required |
|---|---|---|---|
| value | The subtitle of the song | string | yes |
| template | The text template used to render the subtitle | string | no |
| textAlign | The text alignment of the text to display on the music sheet | left, center or right | no |
Example
\title ("Song Title" "Title: %TITLE%" left)
\subtitle ("Subtitle" "[%SUBTITLE%]" left)
C4
There are no properties on this metadata.
\artist​
\artist value
\artist (value template textAlign)
Description: Sets the artist of the song in the data model.
Values:
| Name | Description | Type | Required |
|---|---|---|---|
| value | The artist of the song | string | yes |
| template | The text template used to render the artist | string | no |
| textAlign | The text alignment of the text to display on the music sheet | left, center or right | no |
Example
\title ("Song Title" "Title: %TITLE%" left)
\artist "alphaTab"
C4
There are no properties on this metadata.
\album​
\album value
\album (value template textAlign)
Description: Sets the album of the song in the data model.
Values:
| Name | Description | Type | Required |
|---|---|---|---|
| value | The album of the song | string | yes |
| template | The text template used to render the album | string | no |
| textAlign | The text alignment of the text to display on the music sheet | left, center or right | no |
Example
\title ("Song Title" "Title: %TITLE%" left)
\album "alphaTab vol.1"
C4
There are no properties on this metadata.
\words​
\words value
\words (value template textAlign)
Description: Sets the words/lyrics author of the song in the data model.
Values:
| Name | Description | Type | Required |
|---|---|---|---|
| value | The words/lyrics author of the song | string | yes |
| template | The text template used to render the words/lyrics author | string | no |
| textAlign | The text alignment of the text to display on the music sheet | left, center or right | no |
Example
\words "CoderLine"
C4
There are no properties on this metadata.
\music​
\music value
\music (value template textAlign)
Description: Sets the music author of the song in the data model.
Values:
| Name | Description | Type | Required |
|---|---|---|---|
| value | The music author of the song | string | yes |
| template | The text template used to render the music author | string | no |
| textAlign | The text alignment of the text to display on the music sheet | left, center or right | no |
Example
\music "CoderLine and Contributors"
C4
There are no properties on this metadata.
\wordsandmusic​
\wordsAndMusic (template textAlign)
Description: Sets the template and text align for the words and music (if they have the same value) Values:
| Name | Description | Type | Required |
|---|---|---|---|
| template | The text template used to render the item | string | yes |
| textAlign | The text alignment of the text to display on the music sheet | left, center or right | no |
There is no own "value" for the wordsAndMusic meta as this display activates
if \words and \music have the same value which will be used.
Example
\words "CoderLine"
\music "CoderLine"
\wordsAndMusic ("Words & Music: %WORDS%")
C4
There are no properties on this metadata.
\copyright​
\copyright value
\copyright (value template textAlign)
Description: Sets owner of the copyright of the song in the data model.
Values:
| Name | Description | Type | Required |
|---|---|---|---|
| value | The owner of the copyright of the song | string | yes |
| template | The text template used to render the item | string | no |
| textAlign | The text alignment of the text to display on the music sheet | left, center or right | no |
Example
\copyright "CoderLine"
C4
There are no properties on this metadata.
\copyright2​
\copyright2 (template textAlign)
Description: Sets the template and text align for the second copyright line. Values:
| Name | Description | Type | Required |
|---|---|---|---|
| template | The text template used to render the item | string | yes |
| textAlign | The text alignment of the text to display on the music sheet | left, center or right | no |
There is no own "value" as it is typically used to just define a static text like "All rights reserved". The "template" can be used for defining the display.
Example
\copyright "CoderLine"
\copyright2 "All rights reserved"
C4
There are no properties on this metadata.
\instructions​
\instructions value
Description: Sets the additional textual instructions attached to the music sheet (not displayed).
Values:
| Name | Description | Type | Required |
|---|---|---|---|
| value | The music author of the song | string | yes |
Example
\instructions "Practice this piece until you get it perfect."
C4
There are no properties on this metadata.
\notices​
\notices value
Description: Sets the general notices attached to the music sheet (not displayed).
Values:
| Name | Description | Type | Required |
|---|---|---|---|
| value | The music author of the song | string | yes |
Example
\notices "I hope you appreciate this music sheet, it was a lot of effort to create!"
C4
There are no properties on this metadata.
\tab​
\tab value
\tab (value template textAlign)
Description: Sets the transcriber of the music sheet in the data model.
Values:
| Name | Description | Type | Required |
|---|---|---|---|
| value | The transcriber of the music sheet | string | yes |
| template | The text template used to render this item | string | no |
| textAlign | The text alignment of the text to display on the music sheet | left, center or right | no |
Example
\tab "Transcribed by me"
C4
There are no properties on this metadata.
\systemsLayout​
\systemsLayout (system1Bars system2Bars...)
Description: Defines the number of bars to display per system when rendering multiple tracks.
The systemsLayout and defaultSystemsLayout allow configuring the system layout.
The system layout, defines how many bars should be displayed per system (line) if enabled via systemsLayoutMode.
Values:
| Name | Description | Type | Required |
|---|---|---|---|
| numberOfBars | Defines for every system (line) the number of bars it should contain | number (repeated) | yes |
Example
\systemsLayout (2 3 2)
\track
:1 c4 | c4 | c4 | c4 | c4 | c4 | c4
\track
:1 c4 | c4 | c4 | c4 | c4 | c4 | c4
There are no properties on this metadata.
\defaultSystemsLayout​
\defaultSystemsLayout numberOfBars
Description: Defines the default number of bars to display per system when rendering multiple tracks.
The systemsLayout and defaultSystemsLayout allow configuring the system layout.
The system layout, defines how many bars should be displayed per system (line) if enabled via systemsLayoutMode.
Values:
| Name | Description | Type | Required |
|---|---|---|---|
| numberOfBars | Defines for every system (line) the number of bars it should contain | number | yes |
Example
\defaultSystemsLayout 2
\track
:1 c4 | c4 | c4 | c4 | c4 | c4 | c4
\track
:1 c4 | c4 | c4 | c4 | c4 | c4 | c4
There are no properties on this metadata.
\showDynamics and \hideDynamics​
\showDynamics
\hideDynamics
Description: Enables or disables the display of dynamics.
Values: None
Example
\showDynamics
C4 {dy FFF} D4
E4 {dy PP} F4
\hideDynamics
C4 {dy FFF} D4
E4 {dy PP} F4
There are no properties on this metadata.
\useSystemSignSeparator​
\useSystemSignSeparator
Description: Configures whether a system sign separator should be added (in case multiple tracks are shown)
Values: None
Example
\useSystemSignSeparator
\defaultSystemsLayout 2
\track "T1"
:1 C4 | C4 | C4
\track "T2"
:1 C4 | C4 | C4
There are no properties on this metadata.
\multiBarRest​
\multiBarRest
Description: Enable the display of multibar rests in case multiple tracks are shown.
Values: None
Example
\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 |
There are no properties on this metadata.
\bracketExtendMode​
\bracketExtendMode mode
Description: Configure the mode how to show brackets and braces.
Values:
| Name | Description | Type | Required |
|---|---|---|---|
| mode | The mode to use | noBrackets, groupStaves or groupSimilarInstruments | yes |
\bracketextendmode GroupSimilarInstruments
\track "Piano1"
\staff {score}
\instrument piano
C4 D4 E4 F4
\staff {score}
\clef f4 C3 D3 E3 F3
\track "Piano2"
\staff {score}
\instrument piano
C4 D4 E4 F4
\track "Flute 1"
\staff { score }
\instrument flute
C4 D4 E4 F4
\track "Flute 2"
\staff { score }
\instrument flute
\clef f4 C3 D3 E3 F3
\track "Guitar 1"
\staff { score tabs }
0.3.4 2.3.4 5.3.4 7.3.4
There are no properties on this metadata.
\singleTrackTrackNamePolicy and \multiTrackTrackNamePolicy​
\singleTrackTrackNamePolicy mode
\multiTrackTrackNamePolicy mode
Description: Configures on which systems to show the track names
As the name implies the tags configure how to behave if only a single, or multiple tracks are displayed.
Values:
| Name | Description | Type | Required |
|---|---|---|---|
| mode | The mode to use | hidden, firstSystem or allSystems | yes |
Example
\singletracktracknamepolicy AllSystems
\track "Piano 1" "pno1" { defaultsystemslayout 3 }
C4 D4 E4 F4 | C4 D4 E4 F4 | C4 D4 E4 F4 | C4 D4 E4 F4 | C4 D4 E4 F4 |
There are no properties on this metadata.
\firstSystemTrackNameMode and \otherSystemsTrackNameMode​
\firstSystemTrackNameMode mode
\otherSystemsTrackNameMode mode
Description: Configures the text how to show as track names
As the name implies the tags configure how to behave on the first or on subquent tracks.
Values:
| Name | Description | Type | Required |
|---|---|---|---|
| mode | The mode to use | shortName or fullName | yes |
Example
\singletracktracknamepolicy AllSystems
\firstsystemtracknamemode fullname
\othersystemstracknamemode shortname
\track "Piano 1" "pno1" { defaultsystemslayout 3 }
C4 D4 E4 F4 | C4 D4 E4 F4 | C4 D4 E4 F4 | C4 D4 E4 F4 | C4 D4 E4 F4 |
There are no properties on this metadata.
\firstSystemTrackNameOrientation and \otherSystemsTrackNameOrientation​
\firstSystemTrackNameOrientation orientation
\otherSystemsTrackNameOrientation orientation
Description: Configures the orientation of the track names
As the name implies the tags configure how to behave on the first or on subquent tracks.
Values:
| Name | Description | Type | Required |
|---|---|---|---|
| orientation | The orientation to use | horizontal or vertical | yes |
Example
\singletracktracknamepolicy AllSystems
\firstsystemtracknamemode fullname
\othersystemstracknamemode shortname
\firstsystemtracknameorientation horizontal
\othersystemstracknameorientation vertical
.
\track "Piano 1" "pno1" { defaultsystemslayout 3 }
\staff {score}
C4 D4 E4 F4 | C4 D4 E4 F4 | C4 D4 E4 F4 | C4 D4 E4 F4 | C4 D4 E4 F4 |
There are no properties on this metadata.