view release on metacpan or  search on metacpan

lib/ChordPro/res/config/chordpro.rjson  view on Meta::CPAN

settings {

    // Stricter checks and more warnings.
    strict : false

    // Obsolete.
    lineinfo : true

    // Titles flush.
    // Obsolete, use page headings/footers instead.
    titles : center

    // Columns.
    // Either the number of columns, default: 1, or an array with column widths.
    columns : 1

    // Suppress empty chord lines.
    suppress-empty-chords : true

    // Suppress blank lyrics lines.
    suppress-empty-lyrics : true

    // Suppress chords, only outputs lyrics.
    lyrics-only : false

    // Deprecated, Do not use.
    memorize : false

    // Chords inline instead of above.
    // May be a string containing `pretext %s posttext`.
    // Defaults to `"[%s]"` if set to a value that doesn't contain `"%s"`.
    inline-chords : false

    // Annotations inline instead of above. Ignored unless `inline-chords` is set.
    // Must be a string containing pretext `%s` posttext.
    // Default is `"%s"`.
    inline-annotations : %s

    // Chords under the lyrics.
    chords-under : false

    // Transpose the song by a number of semitones.
    // A positive number transposes up, a negative number transposes down.
    // An optional postfix of `"s"` or `"f"` can be used to enforce the use of sharps resp. flats when a transposed chord requires accidentals.
    // A postfix of `"k"` will use the key signature to determine whether flats or sharps are needed.
    transpose : 0

    // Always apply `"k"` semantics if no other postfix was specified.
    transpose-sf-key : false

    // Force enharmonic when transposing (experimental).
    enharmonic-transpose : true

    // Transcode chords.
    transcode : ""

    // Eliminate capo by transposing chords.
    decapo : false

    // Strictness of parsing chord names.
    // Values are `"strict"` (only known chord forms) or `"relaxed"` (anything that looks sane).
    chordnames : strict

    // Allow parsing of note names in `[]`.
    notenames : false

    // Always replace chords by their canonical form.
    chords-canonical : false

    // If `false`, chorus labels are used as tags.
    choruslabels : true

    // Substitute Unicode sharp/flats in chord names.
    // This will fallback to the ChordProSymbols the selected chord font doesn't have the glyphs.
    truesf : false

    // Substitute delta for maj7 in chord names.
    // This will fallback to the ChordProSymbols the selected chord font doesn't have the glyphs.
    maj7delta : false

    // Wrap long lines. This may trigger issue #355.
    wraplines : true

    // Indent for wrapped lines.
    // Actual indent is the width of the provided string value.
    wrapindent : x

    // Consider text flowed.
    flowtext : false
}

// Metadata.
metadata {

    // The list of known metadata keys.
    // For these keys you can use `{meta key …}` as well as `{key …}`.
    // Important: `"title"` and `"subtitle"` must always be in this list.
    keys : [
        title
        subtitle
        album
        arranger
        artist
        capo
        composer
        copyright
        duration
        key
        lyricist
        sortartist
        sorttitle
        tag
        tempo
        time
        year
    ]

    // If `true`, `{meta …}` will only accept the keys named here in the `keys` field.
    // Otherwise, any key will be accepted.
    strict : true