Dance

Type: object

A dance with its metadata and (potentially) all its instructions.

 No Additional Properties

root name
Type: string

The name of the dance.
Example:

"La Ville Lumière"

root author
Type: string

The deviser of the dance, as a string.
Example:

"Aymeric Fromherz"

root short-author
Type: string

A short version of the deviser of the dance, as a string. For instance,
for a dance whose author is “Anne Lanvin, Corentin Lefèvre, Isabelle
Herlant, Louise Baltera, Nicolas “Niols” Jeannerod & Victor Lanvin”, the
short author would be “Anne Lanvin et al.”
Example:

"Anne Lanvin et al."

root scddb-id
Type: integer

The ID of the dance in the SCDDB, if it exists. This is the last integer
in the SCDDB URL. For example, if the URL is
https://my.strathspey.org/dd/dance/20315/, then the ID is 20315.
Example:

20315

root kind
Type: string

The kind of the dance as a full English sentence.
Example:

"32-bar reel for four couples in a four-couple longwise set"

root short-kind
Type: string

The kind of the dance as a compact representation. For example, the
compact representation of “32-bar reel for four couples in a four-couple
longwise set” is “R32 4/4L”.
Example:

"R32 4/4L"

root date
Type: string

The date of composition of the tune, containing at least the year.
Examples:

"2020"

"2021-08"

"2019-03-02"

root date-format
Type: string

A string describing when the tune was composed. The string may contain the
special sequences %year% or %at-date%. For instance, if the "date" field
is "2019-03-02", %year% will be "2019" and %at-date% will be "on 2 March
2019". If this field is not defined, then %at-date% is used.
Examples:

"%at-date%"

"during Summer School %year%"

"for X's anniversary %at-date%"

root editor-details
Type: string

Additional details given by the editor. Those should be factual. For
first-person, personal details given by the deviser, see field
deviser-details".
Examples:

"This dance celebrates [...]."

"This dance was initially written [...]"

root deviser-details
Type: string

Additional details given by the deviser. They will be presented as a
direct quote and should be written using first-person.
Example:

"I wrote this dance for the [...]"

root tunes
Type: array

The tunes to which this dance is associated.

Must contain a minimum of 1 items

Each item of this array must be:

root tunes tunes items

root tunes tunes items oneOf internal
Type: object

An internal tune, that is a tune whose description can be found in
this very database. For such tunes, only the "slug" is required.

 No Additional Properties
Example:

{
    "type": "internal",
    "slug": "la-ville-lumiere"
}

root tunes tunes items oneOf item 0 type
Type: enum (of string)

Must be one of:

  • "internal"

root tunes tunes items oneOf item 0 slug
Type: string

The slug of the tune, that is the name of the database YAML file,
without extension.
root tunes tunes items oneOf external
Type: object

An external tune, that is a tune whose description cannot be found in
this database. For such tunes, one must give a name and can
additionally give a composer and an SCDDB id.

 No Additional Properties
Example:

{
    "type": "external",
    "name": "The Drunken Piper",
    "composer": "Alexander McLeod",
    "scddb-id": 430
}

root tunes tunes items oneOf item 1 type
Type: enum (of string)

Must be one of:

  • "external"

root tunes tunes items oneOf item 1 name
Type: string

The name of the tune.

root tunes tunes items oneOf item 1 composer
Type: string

The composer of the tune (short).

root tunes tunes items oneOf item 1 scddb-id
Type: integer

The identifier in the SCDDB. That is the number at the end of the
SCDDB URL of the tune.

root instructions
Type: array

A dance description, that is a non-empty array of dance description items
of various types.

Must contain a minimum of 1 items

Each item of this array must be:

root instructions item
Type: object

root instructions instructions items oneOf note
Type: object

A dance description note item. This is typically used at the end of
instructions to add details about something particular.

 No Additional Properties
Example:

{
    "type": "note",
    "content": "Remember the person that is at the left of your partner from your\npoint of view: First, third and fifth times, you will start dancing\nwith your partner on your original lines; Second, fourth and sixth\ntimes, you will start dancing with that other person on the opposite\nlines.\n"
}

root instructions instructions items oneOf item 0 type
Type: enum (of string)

Must be one of:

  • "note"

root instructions instructions items oneOf item 0 content
Type: string

A string to be included as a note in the output, modulo some
escaping for HTML entities or TeX special characters.
root instructions instructions items oneOf two-chords
Type: object

The presence of this input specifies that there will be a second chord.
The object describes what happens then.

 No Additional Properties
Examples:

{
    "type": "two chords",
    "couples": [
        "2nd",
        "3rd"
    ]
}

{
    "type": "two chords",
    "custom": "On second chord, everybody claps twice.\n"
}

root instructions instructions items oneOf item 1 type
Type: enum (of string)

Must be one of:

  • "two chords"

root instructions instructions items oneOf item 1 couples-cross
Type: string

The couples that cross on the second chord.

root instructions instructions items oneOf item 1 custom
Type: string

A string describing what happens on the second chord.
root instructions instructions items oneOf kind
Type: object

Specifies the kind that applies to the rest of the description. This is
useful in medleys in particular.

 No Additional Properties
Example:

{
    "type": "kind",
    "kind": "Strathspey"
}

root instructions instructions items oneOf item 2 type
Type: enum (of string)

Must be one of:

  • "kind"

root instructions instructions items oneOf phrase
Type: object

The heart of a dances' instructions. This is one instruction phrase,
delimited in time between when it "starts" and when it "ends". The
content of the phrase is text, but one can add sub-instructions by using
the "instructions" field.

 No Additional Properties
Example:

{
    "type": "phrase",
    "starts": 1,
    "ends": 4,
    "contents": [
        {
            "type": "text",
            "content": "1st couple set and cast off one place as 4th couple set and cast\nup one place. 2nd couple step up and 3rd couple step down on\nbars 3-4.\n"
        }
    ]
}

root instructions instructions items oneOf item 3 type
Type: enum (of string)

Must be one of:

  • "phrase"

root instructions instructions items oneOf item 3 starts
Type: integer

An integer representing the starting bar of the phrase.

root instructions instructions items oneOf item 3 ends
Type: integer

An integer representing the ending bar of the phrase.

root instructions instructions items oneOf item 3 content
Type: string

The instruction corresponding to this phrase.

root instructions instructions items oneOf item 3 instructions
Type: array

Must contain a minimum of 1 items

Each item of this array must be:

root instructions instructions items oneOf item 3 instructions item
Type: object
Same definition as instructions_items
root instructions instructions items oneOf repeat
Type: object
No Additional Properties
Examples:

{
    "type": "repeat",
    "kind": "having passed a couple"
}

{
    "type": "repeat",
    "kind": "custom",
    "text": "Repeat, but only if you want to."
}

root instructions instructions items oneOf item 4 type
Type: enum (of string)

Must be one of:

  • "repeat"

root instructions instructions items oneOf item 4 kind
Type: enum (of string)

The kind of repeat for this dance.

Must be one of:

  • "from new positions"
  • "having passed a couple"
  • "custom"

root instructions instructions items oneOf item 4 text
Type: string

The custom text for the repeat. FIXME: Only if kind=custom, but then
it is required.
root instructions instructions items oneOf devised-by
Type: object

FIXME: Get rid of this.

 No Additional Properties
Example:

{
    "type": "devised by"
}

root instructions instructions items oneOf item 5 type
Type: enum (of string)

Must be one of:

  • "devised by"
root instructions instructions items oneOf music-by
Type: object

FIXME: Get rid of this

 No Additional Properties
Example:

{
    "type": "music by"
}

root instructions instructions items oneOf item 6 type
Type: enum (of string)

Must be one of:

  • "music by"