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`

Syntax
\title (value template textAlign)

Description: Set the title of the song.

Parameters:

Name	Description	Type	Required
`value`	The value to set	`String`	yes
`template`	The template used to render the text	`String`	no
`textAlign`	The alignment of the text on the music sheet	`left\|center\|right`	no

Parameter Values:

Following parameters have value limitations

Name Values

textAlign

Value	Description
`left`	Left-align the text
`center`	Center-align the text
`right`	Right-align the text

Example:

\title ("Song Title" "Title: %TITLE%" left) C4

\title ("Song Title" "Title: %TITLE%" left)
C4

`\subtitle`

Syntax
\subtitle (value template textAlign)

Description: Set the subtitle of the song.

Parameters:

Name	Description	Type	Required
`value`	The value to set	`String`	yes
`template`	The template used to render the text	`String`	no
`textAlign`	The alignment of the text on the music sheet	`left\|center\|right`	no

Parameter Values:

Following parameters have value limitations

Name Values

textAlign

Value	Description
`left`	Left-align the text
`center`	Center-align the text
`right`	Right-align the text

Example:

\title ("Song Title" "Title: %TITLE%" left) \subtitle ("Subtitle" "[%SUBTITLE%]" left) C4

\title ("Song Title" "Title: %TITLE%" left)
\subtitle ("Subtitle" "[%SUBTITLE%]" left)
C4

`\artist`

Syntax
\artist (value template textAlign)

Description: Set the artist of the song.

Parameters:

Name	Description	Type	Required
`value`	The value to set	`String`	yes
`template`	The template used to render the text	`String`	no
`textAlign`	The alignment of the text on the music sheet	`left\|center\|right`	no

Parameter Values:

Following parameters have value limitations

Name Values

textAlign

Value	Description
`left`	Left-align the text
`center`	Center-align the text
`right`	Right-align the text

Example:

\title ("Song Title" "Title: %TITLE%" left) \artist "alphaTab" C4

\title ("Song Title" "Title: %TITLE%" left)
\artist "alphaTab"
  C4

`\album`

Syntax
\album (value template textAlign)

Description: Set the album of the song.

Parameters:

Name	Description	Type	Required
`value`	The value to set	`String`	yes
`template`	The template used to render the text	`String`	no
`textAlign`	The alignment of the text on the music sheet	`left\|center\|right`	no

Parameter Values:

Following parameters have value limitations

Name Values

textAlign

Value	Description
`left`	Left-align the text
`center`	Center-align the text
`right`	Right-align the text

Example:

\title ("Song Title" "Title: %TITLE%" left) \album "alphaTab vol.1" C4

\title ("Song Title" "Title: %TITLE%" left)
\album "alphaTab vol.1"
C4

`\words`

Syntax
\words (value template textAlign)

Description: Set the lyrics author of the song.

Parameters:

Name	Description	Type	Required
`value`	The value to set	`String`	yes
`template`	The template used to render the text	`String`	no
`textAlign`	The alignment of the text on the music sheet	`left\|center\|right`	no

Parameter Values:

Following parameters have value limitations

Name Values

textAlign

Value	Description
`left`	Left-align the text
`center`	Center-align the text
`right`	Right-align the text

Example:

\words "CoderLine" C4

\words "CoderLine"
C4

`\music`

Syntax
\music (value template textAlign)

Description: Set the music author of the song.

Parameters:

Name	Description	Type	Required
`value`	The value to set	`String`	yes
`template`	The template used to render the text	`String`	no
`textAlign`	The alignment of the text on the music sheet	`left\|center\|right`	no

Parameter Values:

Following parameters have value limitations

Name Values

textAlign

Value	Description
`left`	Left-align the text
`center`	Center-align the text
`right`	Right-align the text

Example:

\music "CoderLine and Contributors" C4

\music "CoderLine and Contributors"
C4

`\wordsAndMusic`

Syntax
\wordsAndMusic (template textAlign)

Description: Sets the template and text align for combined words and music authors.

Parameters:

Name	Description	Type	Required
`template`	The template used to render the text	`String`	yes
`textAlign`	The alignment of the text on the music sheet	`left\|center\|right`	no

Parameter Values:

Following parameters have value limitations

Name Values

textAlign

Value	Description
`left`	Left-align the text
`center`	Center-align the text
`right`	Right-align the text

Example:

\words "CoderLine" \music "CoderLine" \wordsAndMusic ("Words & Music: %WORDS%") C4

\words "CoderLine"
\music "CoderLine"
\wordsAndMusic ("Words & Music: %WORDS%")
C4

`\copyright`

Syntax
\copyright (value template textAlign)

Description: Set the copyright owner of the song.

Parameters:

Name	Description	Type	Required
`value`	The value to set	`String`	yes
`template`	The template used to render the text	`String`	no
`textAlign`	The alignment of the text on the music sheet	`left\|center\|right`	no

Parameter Values:

Following parameters have value limitations

Name Values

textAlign

Value	Description
`left`	Left-align the text
`center`	Center-align the text
`right`	Right-align the text

Example:

\copyright "CoderLine" C4

\copyright "CoderLine"
C4

`\copyright2`

Syntax
\copyright2 (template textAlign)

Description: Sets the template and text align for the second copyright line.

Parameters:

Name	Description	Type	Required
`template`	The template used to render the text	`String`	yes
`textAlign`	The alignment of the text on the music sheet	`left\|center\|right`	no

Parameter Values:

Following parameters have value limitations

Name Values

textAlign

Value	Description
`left`	Left-align the text
`center`	Center-align the text
`right`	Right-align the text

Example:

\copyright "CoderLine"
\copyright2 "All rights reserved"
C4

`\instructions`

Syntax
\instructions value

Description: Sets additional textual instructions for the song (not displayed).

Parameters:

Name	Description	Type	Required
`value`	The value to set	`String`	yes

Example:

\instructions "Practice this piece until you get it perfect." C4

\instructions "Practice this piece until you get it perfect."
C4

`\notices`

Syntax
\notices value

Description: Sets general notices for the song (not displayed).

Parameters:

Name	Description	Type	Required
`value`	The value to set	`String`	yes

Example:

\notices "I hope you appreciate this music sheet, it was a lot of effort to create!" C4

\notices "I hope you appreciate this music sheet, it was a lot of effort to create!"
C4

`\tab`

Syntax
\tab (value template textAlign)

Description: Set the transcriber of the music sheet.

Parameters:

Name	Description	Type	Required
`value`	The value to set	`String`	yes
`template`	The template used to render the text	`String`	no
`textAlign`	The alignment of the text on the music sheet	`left\|center\|right`	no

Parameter Values:

Following parameters have value limitations

Name Values

textAlign

Value	Description
`left`	Left-align the text
`center`	Center-align the text
`right`	Right-align the text

Example:

\tab "Transcribed by me" C4

\tab "Transcribed by me"
C4

`\systemsLayout`

Syntax
\systemsLayout (numberOfBars)

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.

Parameters:

Name	Description	Type	Required
`numberOfBars`	Defines for every system (line) the number of bars it should contain	`Number[]`	no

Example:

\systemsLayout (2 3 2) \track :1 c4 | c4 | c4 | c4 | c4 | c4 | c4 \track :1 c4 | c4 | c4 | c4 | c4 | c4 | c4

\systemsLayout (2 3 2)
\track 
  :1 c4 | c4 | c4 | c4 | c4 | c4 | c4
\track 
  :1 c4 | c4 | c4 | c4 | c4 | c4 | c4

`\defaultSystemsLayout`

Syntax
\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.

Parameters:

Name	Description	Type	Required
`numberOfBars`	The number of bars the system 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

\defaultSystemsLayout 2
\track 
  :1 c4 | c4 | c4 | c4 | c4 | c4 | c4
\track 
  :1 c4 | c4 | c4 | c4 | c4 | c4 | c4

`\showDynamics`

Syntax
\showDynamics ()

Description: Enables the display of dynamics.

Example:

\showDynamics C4 {dy FFF} D4 E4 {dy PP} F4

\showDynamics
  C4 {dy FFF} D4
  E4 {dy PP} F4

`\hideDynamics`

Syntax
\hideDynamics ()

Description: Disables the display of dynamics.

Example:

\hideDynamics C4 {dy FFF} D4 E4 {dy PP} F4

\hideDynamics
  C4 {dy FFF} D4
  E4 {dy PP} F4

`\useSystemSignSeparator`

Syntax
\useSystemSignSeparator ()

Description: Configures whether a system sign separator should be added (in case multiple tracks are shown).

Example:

\useSystemSignSeparator \defaultSystemsLayout 2 \track "T1" :1 C4 | C4 | C4 \track "T2" :1 C4 | C4 | C4

\useSystemSignSeparator
\defaultSystemsLayout 2
\track "T1"
:1 C4 | C4 | C4
\track "T2"
:1 C4 | C4 | C4

`\multiBarRest`

Syntax
\multiBarRest ()

Description: Show multibar rests when rendering multiple tracks.

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 |

\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 |

`\bracketExtendMode`

Syntax
\bracketExtendMode mode

Description: Set the mode for brackets and braces.

Parameters:

Name	Description	Type	Required
`mode`	The mode to use	`noBrackets\|groupStaves\|groupSimilarInstruments`	yes

Parameter Values:

Following parameters have value limitations

Name Values

mode

Value	Description
`noBrackets`	No brackets
`groupStaves`	Group staves of same track
`groupSimilarInstruments`	Group similar instruments

Example:

\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

\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

`\singleTrackTrackNamePolicy`

Syntax
\singleTrackTrackNamePolicy mode

Description: Configures on which systems to show the track names when only a single track is rendered.

Parameters:

Name	Description	Type	Required
`mode`	The mode to use	`hidden\|firstSystem\|allSystems`	yes

Parameter Values:

Following parameters have value limitations

Name Values

mode

Value	Description
`hidden`	Track names are hidden everywhere.
`firstSystem`	Track names are displayed on the first system.
`allSystems`	Track names are displayed on all systems.

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 |

\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 |

`\multiTrackTrackNamePolicy`

Syntax
\multiTrackTrackNamePolicy mode

Description: Configures on which systems to show the track names when multiple tracks are rendered.

Parameters:

Name	Description	Type	Required
`mode`	The mode to use	`hidden\|firstSystem\|allSystems`	yes

Parameter Values:

Following parameters have value limitations

Name Values

mode

Value	Description
`hidden`	Track names are hidden everywhere.
`firstSystem`	Track names are displayed on the first system.
`allSystems`	Track names are displayed on all systems.

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 |

\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 |

`\firstSystemTrackNameMode`

Syntax
\firstSystemTrackNameMode mode

Description: Configures the text how to show as track names on the first system.

Parameters:

Name	Description	Type	Required
`mode`	The mode to use	`fullName\|shortName`	yes

Parameter Values:

Following parameters have value limitations

Name Values

mode

Value	Description
`fullName`	Short track names (abbreviations) are displayed.
`shortName`	Full track names are displayed.

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 |

\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 |

`\otherSystemsTrackNameMode`

Syntax
\otherSystemsTrackNameMode mode

Description: Configures the text how to show as track names on the second and subsequent systems.

Parameters:

Name	Description	Type	Required
`mode`	The mode to use	`fullName\|shortName`	yes

Parameter Values:

Following parameters have value limitations

Name Values

mode

Value	Description
`fullName`	Short track names (abbreviations) are displayed.
`shortName`	Full track names are displayed.

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 |

`\firstSystemTrackNameOrientation`

Syntax
\firstSystemTrackNameOrientation orientation

Description: Configures the orientation of the track names on the first system.

Parameters:

Name	Description	Type	Required
`orientation`	The orientation to use	`horizontal\|vertical`	yes

Parameter Values:

Following parameters have value limitations

Name Values

orientation

Value	Description
`horizontal`	Text is shown horizontally (left-to-right).
`vertical`	Vertically rotated (bottom-to-top).

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 |

\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 |

`\otherSystemsTrackNameOrientation`

Syntax
\otherSystemsTrackNameOrientation orientation

Description: Configures the orientation of the track names on the second and subsequent systems.

Parameters:

Name	Description	Type	Required
`orientation`	The orientation to use	`horizontal\|vertical`	yes

Parameter Values:

Following parameters have value limitations

Name Values

orientation

Value	Description
`horizontal`	Text is shown horizontally (left-to-right).
`vertical`	Vertically rotated (bottom-to-top).

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 |

\title​

\subtitle​

\artist​

\album​

\words​

\music​

\wordsAndMusic​

\copyright​

\copyright2​

\instructions​

\notices​

\tab​

\systemsLayout​

\defaultSystemsLayout​

\showDynamics​

\hideDynamics​

\useSystemSignSeparator​

\multiBarRest​

\bracketExtendMode​

\singleTrackTrackNamePolicy​

\multiTrackTrackNamePolicy​

\firstSystemTrackNameMode​

\otherSystemsTrackNameMode​

\firstSystemTrackNameOrientation​

\otherSystemsTrackNameOrientation​

`\title`

`\subtitle`

`\artist`

`\album`

`\words`

`\music`

`\wordsAndMusic`

`\copyright`

`\copyright2`

`\instructions`

`\notices`

`\tab`

`\systemsLayout`

`\defaultSystemsLayout`

`\showDynamics`

`\hideDynamics`

`\useSystemSignSeparator`

`\multiBarRest`

`\bracketExtendMode`

`\singleTrackTrackNamePolicy`

`\multiTrackTrackNamePolicy`

`\firstSystemTrackNameMode`

`\otherSystemsTrackNameMode`

`\firstSystemTrackNameOrientation`

`\otherSystemsTrackNameOrientation`