view release on metacpan or  search on metacpan

lib/ChordPro/res/pod/Config.pod  view on Meta::CPAN

    
        // The actual backend module.
        module : HTML
    
        // Stylesheets for display and printing.
        styles {
    
            // Relative path to a CSS file to use for styling HTML output.
            default : chordpro.css
    
            // Relative path to a CSS file to use for styling displayed HTML output on screen media.
            screen : ""
    
            // Relative path to a CSS file to use for styling printed HTML output.
            print : chordpro_print.css
    
            // Embed the styles instead of linking to them.
            embed : false
    
            // Legacy style for `"screen"`.
            display : ""
        }
    }
    
    // Settings for LaTeX backend.
    latex {
    
        // Include paths for templates.
        template_include_path : []
    
        // Templates for LaTeX generation.
        templates {
    
            // Master template to render the songbook.
            songbook : songbook.tt
    
            // Helper template to render comments.
            comment : comment.tt
    
            // Helper template to render images.
            image : image.tt
        }
    }
    
    // Settings for Text (output) backend.
    // See the ChordPro backend for details.
    text.chorus.recall {
        tag   : ""
        type  : ""
        quote : false
    }
    
    // Settings for A2Crd (input) frontend.
    a2crd {
    
        // Treat leading lyrics lines as title/subtitle lines.
        // The first non-empty, non-chord, non-directive lines are taken to be the song title and subtitle.
        infer-titles : true
    
        // Strategies to recognize chords and lyrics lines are implemented by classifiers.
        // The default classifier is `"pct_chords"` and is based on the percentage of chords recognized.
        classifier : pct_chords
    
        // Tab stop width for tab expansion. Set to `0` to disable.
        // Tabs in the input source are replaced by an appropriate amount of spaces.
        tabstop : 8
    }
    
    // Settings for the markup processor.
    // Shortcodes allow user defined markup, e.g. <foo>...</foo>.
    // ```
    // markup.shortcode {
    //    heavy :  "weight='bold' size='large'"
    // }
    // Each occurrence of <heavy>...</heavy> will be replaced by
    // <span weight='bold' size='large'>...</span>.
    // ```
    markup.shortcodes {}
    
    // Settings for the parser/preprocessor
    parser {
    
        // For the exceptional case you need brackets [] in your lyrics or annotations.
        // These characters are replaced by normal brackets **after** chord analysis.
        // E.g. `parser.altbrackets: "«»"`
        // Use wisely. Better still, don't use this.
        altbrackets : null
    
        // Settings for the parser/preprocessor.
        // For selected lines, you can specify a series of 
        // { "target" : "xxx", "replace" : "yyy" }
        // Every occurrence of "xxx" will be replaced by "yyy".
        // Use "pattern" instead of "target" for regular expression replacement.
        // Use wisely.
        preprocess {
            all       : []
            directive : []
            songline  : []
        }
    }
    
    // Miscellaneous debug settings.
    // A boolean value or an integer. `0` means `false` and nozero means `true`.
    debug {
    
        // Insert extra debugging info into the generated PDF document.
        runtimeinfo : 1
    
        // All debug settings are intended for development and debugging and are not useful for ChordPro users.
        a2crd : 0
        abc         : 0
        assets      : 0
        chords      : 0
        config      : 0
        csv         : 0
        echo        : 0
        fit         : 0
        fonts       : 0
        images      : 0
        layout      : 0
        ly          : 0