Text tokens

Text tokens are codes that you can use as substitutes for information stored in your project, such as titles, composers, and the time and date. This can reduce the risk of mistakes or outdated information appearing in your project. Text tokens are also known as “wildcards” or “text codes”.

For example, if you use a token for the title of your project, you can change the project title in the Project Info dialog as often as you want, and the project title in every layout in your project is updated automatically.

Tokens can refer to information in the Project Info dialog, including for the whole project or each flow individually. Tokens can also refer to the current time and date or the time and date the project was last saved.

Note
  • You can only use text tokens in text frames. You cannot use tokens in text/system text objects.

  • Flow tokens refer to the nearest flow below the top edge of their text frame. When the top edge of a text frame containing a flow token is in line with or above the top staff line of the first staff in a system, it then refers to that flow.

    You can specify the flow number to which you want flow tokens to refer, such as {@flow2title@}. This always shows the specified flow, regardless of the token’s position.

    If you want to use tokens that refer to flow information on pages that contain no music, such as title pages, you must specify the flow number in the token. For example, if you use {@flowtitle@} on a title page containing no music frames, the token does not display any information, but {@flow1title@} displays the title of the first flow in your project.

    You can see the flow number of each flow in the Flows panel in Setup mode.

The following tokens are available in Dorico Pro.

Tip

You can access all the available tokens from the context menu when the cursor is inside a text frame. In the context menu, tokens are organized into submenus.

Table 1. General tokens

Description

Token

Page number

{@page@}

Player list

{@playerlist@}

Player names

{@playernames@}

Layout name

{@layoutname@}

Layout number, as set in the Layouts panel in Setup mode

{@layoutnumber@}

Table 2. Staff label tokens

Music symbol

Token

Full staff labels of the players in the current layout

{@staffLabelsFull@}

Abbreviated staff labels of the players in the current layout

{@staffLabelsShort@}

You can use staff label tokens, for example, as an alternative way to name part layouts, instead of using the default {@layoutName@} token shown at the top left of the first page in part layouts.

Note

Staff label tokens might not exactly match the appearance of staff labels shown before initial barlines; however, staff label tokens respect your per-layout options for how transpositions appear in staff labels.

Table 3. Music symbol tokens

Music symbol

Token

Flat accidental:

{@flat@}

Sharp accidental:

{@sharp@}

Natural accidental:

{@natural@}

Treble clef

{@U+E050@}

Fermata above

{@U+E4C0@}

Tip
  • This list is not comprehensive, as you can enter the code point for any SMuFL symbol within a token. You can find the necessary code points in the SMuFL specification online.

  • Music symbol tokens in text frames automatically use the Music text character style, which is set to Bravura Text by default.

  • You can include music symbol tokens in fields in the Project Info dialog. For example, if you enter Symphony in B{@flat@} major into the Title field, the title displayed in text frames using the corresponding title token is Symphony in B major.

Table 4. Project/Flow-specific information tokens

Field in the Project Info dialog

Token for Project page

Token for Flow pages

Title

{@projecttitle@}

{@flowtitle@}

Subtitle

{@projectsubtitle@}

{@flowsubtitle@}

Dedication

{@projectdedication@}

{@flowdedication@}

Composer

{@projectcomposer@}

{@flowcomposer@}

Arranger

{@projectarranger@}

{@flowarranger@}

Lyricist

{@projectlyricist@}

{@flowlyricist@}

Artist

{@projectartist@}

{@flowartist@}

Copyist

{@projectcopyist@}

{@flowcopyist@}

Publisher

{@projectpublisher@}

{@flowpublisher@}

Editor

{@projecteditor@}

{@floweditor@}

Copyright

{@projectcopyright@}

{@flowcopyright@}

Work number

{@projectworknumber@}

{@flowworknumber@}

Composer dates

{@projectcomposerdates@}

{@flowcomposerdates@}

Composition year

{@projectcompositionyear@}

{@flowcompositionyear@}

Other information

{@projectotherinfo@}

{@flowotherinfo@}

Table 5. Per-flow tokens

Per-flow token function

Token

Flow number of the current flow, according to its position in the Flows panel in Setup mode

{@flownumber@}

Flow number of the current flow, according to its position in the current layout.

{@flowInLayoutNumber@}

Flow number of the current flow shown in lower case Roman numerals, such as iii or xvi

{@flowNumberRomanLower@}

Flow number of the current flow shown in upper case Roman numerals, such as III or XVI

{@flowNumberRomanUpper@}

Number of this page within the current flow, counting from 1

{@flowPage@}

Total number of pages in the current flow

{@flowPageCount@}

The displayed page number on which the specified flow “n” begins, such as {@flow3PageCount@}

{@flownPageCount@}

Duration of the current flow in minutes and seconds

{@flowDuration@}

Duration of the specified flow “n” in minutes and seconds, such as {@flow3Duration@}

{@flownDuration@}

Table 6. Page number tokens

Page number token function

Token

Total number of pages in the layout

{@pageCount@}

Number of this page within the current flow, counting from 1 for the first page of the flow and including pages with no displayed page number

{@flowPage@}

Total number of pages in the current flow

{@flowPageCount@}

Displayed page number of the page on which the specified flow “n” begins, according to its position in the Flows panel in Setup mode, for example, {@flow5FirstPage@}

{@flownFirstPage@}

Note

{@flowPage@} and {@flowPageCount@} tokens only consider the flow that is active at the beginning of the first system of the music frame closest to the top left corner of the page on which the tokens are used.

Table 7. Time/Date tokens to show when the project was last saved

Time/Date description

Time/Date example

Token

Standard date and time string (locale dependent)

Sun Dec 31 11:10:12 2017

{@projectdate@}

Four-digit year

2017

{@projectdateyear@}

Two-digit year

17

{@projectdateyearshort@}

Full month name (locale dependent)

October

{@projectdatemonth@}

Short month name (locale dependent)

Oct

{@projectdatemonthshort@}

Month as a decimal number, range 1-12

10

{@projectdatemonthnum@}

Full weekday name (locale dependent)

Friday

{@projectdateday@}

Abbreviated weekday name (locale dependent)

Fri

{@projectdatedayshort@}

Day of month as decimal number, range 1-31

24

{@projectdatedaynum@}

ISO 8601 date

2017-12-31

{@projectdateymd@}

Month day, year

December 31, 2017

{@projectdatemdy@}

Day month year

31 December 2017

{@projectdatedmy@}

Time representation (locale dependent)

11:10:12

{@projectdatetime@}

Hours:minutes, hour in 24-hour clock range

23:10

{@projectdatetimeHHMM@}

Hours:minutes:seconds, hour in 24-hour clock range

13:02:24

{@projectdatetimeHHMMSS@}

Hour in 24-hour clock range

23

{@projectdatetimehour24@}

Hour in 12-hour clock range

11

{@projectdatetimehour12@}

Minute as decimal number, range 00-59

10

{@projectdatetimeminute@}

Second as decimal number, range 00-59

44

{@projectdatetimesecond@}

Table 8. Time/Date tokens to show the current time and date

Time/Date description

Time/Date example

Token

Standard date and time string (locale dependent)

Sun Dec 31 11:10:12 2017

{@date@}

Four-digit year

2017

{@dateyear@}

Two-digit year

17

{@dateyearshort@}

Full month name (locale dependent)

October

{@datemonth@}

Short month name (locale dependent)

Oct

{@datemonthshort@}

Month as a decimal number, range 1-12

10

{@datemonthnum@}

Full weekday name (locale dependent)

Friday

{@dateday@}

Abbreviated weekday name (locale dependent)

Fri

{@datedayshort@}

Day of month as decimal number, range 1-31

24

{@datedaynum@}

ISO 8601 date

2017-12-31

{@dateymd@}

Month day, year

December 31, 2017

{@datemdy@}

Day month year

31 December 2017

{@datedmy@}

Time representation (locale dependent)

11:10:12

{@datetime@}

Hours:minutes, hour in 24-hour clock range

23:10

{@datetimeHHMM@}

Hours:minutes:seconds, hour in 24-hour clock range

13:02:24

{@datetimeHHMMSS@}

Hour in 24-hour clock range

23

{@datetimehour24@}

Hour in 12-hour clock range

11

{@datetimehour12@}

Minute as decimal number, range 00-59

10

{@datetimeminute@}

Second as decimal number, range 00-59

44

{@datetimesecond@}