App-Music-ChordPro
view release on metacpan or search on metacpan
lib/ChordPro/res/pod/Config.pod view on Meta::CPAN
}
// Embedding textblock.
textblock {
// The result produced by the delegate handler.
type : none
// The module's method to call.
handler : none
// The name of the (perl) module that implements the delegate.
module : TextBlock
// Specific settings for the PDF backend.
pdf {
handler : txt2xform
type : image
}
// Specific settings for the HTML backend.
html {
handler : txt2html
type : html
}
}
}
// Settings for PDF output.
pdf {
// Choose a `PDF::API2` compatible library, or leave empty to have ChordPro choose one for you.
library : ""
// PDF Properties.
// Arbitrary key/values may be added.
// Note that the context for substitutions is the first song.
info {
// Document title.
title : "%{title}"
// Name of the author.
author : ""
// Document subject.
subject : ""
// Document keywords.
keywords : ""
}
// Output paper size.
// The size can be specified either as the name of a known page size, e.g. `"a4`", or as a 2-element list containing the width and height of the page in PDF units (DTP points, pt, 1/72 inch).
papersize : a4
// For future use.
page_layout : false
// Theme
// These settings can be used to control the foreground and background colours of the PDF output.
// Valid values include colour names, full hex strings (`"#555555"`), or `"none"`.
// Background `"none"` or `"white"` means there will be no background colour added to the output.
// It may be useful to put your theme settings in a separate config file, together with additional settings that make up the theme.
// Other configuration settings that use colours can use `foreground`, `foreground-light`, `foreground-medium`, and `background` to refer to the colours defined in the theme.
theme {
// Foreground colour. Usually black.
foreground : black
// Light foreground colour
foreground-medium : grey70
// Very light foreground colour
foreground-light : grey90
// Background colour. Usually white.
background : none
}
// Distance between columns in multi-column mode.
// When output is produced in multiple columns, this is the space between the columns, in pt.
columnspace : 20
// Page top margin, excluding `headspace`.
margintop : 80
// Page bottom margin, excluding `footspace`.
marginbottom : 40
// Page left margin.
marginleft : 40
// Page right margin.
marginright : 40
// Space for page titles.
headspace : 60
// Space for page footers.
footspace : 20
// Heading on first page only; the headspace is added to the other pages so they become larger.
head-first-only : false
// Baseline distances as a factor of the font size.
spacing {
// Spacing for page titles.
title : 1.2
// Spacing between songlines (grouped chords + lyrics).
lyrics : 1.2
// Spacing between chords and lyrics in songlines.
chords : 1.2
// Spacing between the chord name and the diagram in chord diagrams.
diagramchords : 1.2
// Spacing after each grid line.
grid : 1.2
// Spacing for tab lines.
tab : 1
// Spacing for table of contents lines.
toc : 1.4
// Spacing for empty (blank) lines.
// By setting this to a small value you get fine-grained control over the distance between song elements by adding empty lines.
empty : 1
}
// Appearance of chorus.
chorus {
// Indentation of the chorus, not including bar.
lib/ChordPro/res/pod/Config.pod view on Meta::CPAN
// Volta span (fraction of measure).
span : 0.7
// Colour of the volta.
color : blue
}
}
// New style page control.
songbook {
// Dual (odd/even) pages when set to true.
// False means all pages will be the same (odd, right).
// With dual pages, all the parts of the songbook (covers,
// tables of contents, etc.) are always aligned to a right page.
dual-pages : true
// With dual pages, align individual tables of content
// to right pages by inserting a blank filler page.
// Values are true, false, or "song". In the latter case the
// pagealign settings for songs are used for the tables of contents.
align-tocs : true
// With dual pages, a true value aligns songs to right pages
// by inserting a blank filler page if necessary.
// If false, no alignment takes place, all pages follow
// each other.
align-songs : true
// If true, all songs will start on left pages instead of right pages.
align-songs-spread : false
// If true, the fill pages will have headings and footers
// as if they were part of the song.
align-songs-extend : false
// Sort songs by `"title"` or `"subtitle"`.
// title : sort pages alphabetically by title.
// subtitle : sort pages alphabetically by subtitle. If this is used together with title, only title is used.
// Put a minus sign before title and/or subtitle to obtain descending order.
sort-songs : false
// If true, the order of the songs is adjusted to make the
// songbook as compact as possible, while each of the songs
// require minimal page turns.
// Note: this option requires extra processing time since
// the songbook has to be processed twice.
compact-songs : false
// PDF file to add as cover page(s).
cover : false
// PDF file to add as front matter.
front-matter : false
// PDF file to add as back matter.
back-matter : false
}
// Page formats.
// Each of these page classes can have settings for a page title, subtitle, footer, and background. The settings inherit from `default` to `title` to `first`. So a `title` page has everything a `default` page has, and a `first` page has every...
// All heading strings may contain references to metadata in the form %{name}, for example %{title}. The current page number can be obtained with %{page}, and the song index in the songbook with %{songindex}. For a complete description on how...
// When even/odd page printing is selected, the left and right parts are swapped on even pages.
// By default, the "title" element shows the value of metadata item "title", centered on the page. Likewise "subtitle".
// NOTE: The "title" and "subtitle" page elements have the same names as the default metadata values which may be confusing. To show metadata item, e.g. "artist", add its value to one of the title/subtitle fields. Don't try to add an artist p...
formats {
// Headers/footers/background for all pages that aren't first page of the output, of a song, or alignment pages.
default {
// Topmost title element.
// It uses the `fonts.title` font.
title : [ "" "" "" ]
// Second title element.
// It uses the `fonts.subtitle` font.
subtitle : [ "" "" "" ]
// It uses the `fonts.footer` font.
footer : [ "%{title}" "" "%{page}" ]
// Page background.
// This can be used to designate an existing PDF document to be used as the background of the output page. It has the form `filename` or `filename:page`. Page numbers count from one.
// If odd/even printing is in effect, the designated page number is used for left pages, and the next page (if it exists) for right pages.
background : ""
}
// Headers/footers/background for the first page of a song.
title {
// Topmost title element.
// It uses the `fonts.title` font.
title : [ "" "%{title}" "" ]
// Second title element.
// It uses the `fonts.subtitle` font.
subtitle : [ "" "%{subtitle}" "" ]
// It uses the `fonts.footer` font.
footer : [ "" "" "%{page}" ]
// Page background.
// This can be used to designate an existing PDF document to be used as the background of the output page. It has the form `filename` or `filename:page`. Page numbers count from one.
// If odd/even printing is in effect, the designated page number is used for left pages, and the next page (if it exists) for right pages.
background : ""
}
// Headers/footers/background for the vefy first page of the output.
first {
// It uses the `fonts.footer` font.
footer : [ "" "" "" ]
// Page background.
// This can be used to designate an existing PDF document to be used as the background of the output page. It has the form `filename` or `filename:page`. Page numbers count from one.
// If odd/even printing is in effect, the designated page number is used for left pages, and the next page (if it exists) for right pages.
background : ""
}
// Headers/footers/background for all pages for alignment.
filler.background : ""
}
// Split marker for syllables that are smaller than chord width.
// `split-marker` is a 3-part array: `start`, `repeat`, and `final`, or can be a single string representing `start`.
// `final` is always printed, last.
// `start` is printed if there is enough room.
// `repeat` is printed repeatedly to fill the rest.
// If `split-marker` is a single string, this is `start`.
// All elements may be left empty strings.
split-marker : [ "" "" "" ]
// The `fontdir` setting can be used to add one or more private font directories to the font libraries. The private directories will be searched first.
fontdir : []
// Experimental: Remap corefonts to real truetype fonts.
// This requires a set of truetype fonts to be available in the `fontdir` under a well-defined name. See the docs.
// Fontsets currenly supported are `"free"` for the GNU Free Fonts, and `"tex"` for the Tex Gyre fonts.
// Value `false` inhibits remapping.
// Value `null` will have ChordPro look for the fonts itself.
corefonts.remap : null
// Font families and properties.
// `fontconfig` maps members of font families to physical fonts.
// Optionally, additional properties of the fonts can be specified.
// Physical fonts can be the names of TrueType/OpenType fonts, or names of built-in fonts (`corefonts`).
// Relative filenames are looked up in the `fontdir`.
fontconfig {
serif {
"" : Times-Roman
bold : Times-Bold
italic : Times-Italic
bolditalic : Times-BoldItalic
}
times {
"" : Times-Roman
bold : Times-Bold
italic : Times-Italic
bolditalic : Times-BoldItalic
}
helvetica {
"" : Helvetica
bold : Helvetica-Bold
oblique : Helvetica-Oblique
boldoblique : Helvetica-BoldOblique
}
"sans, sans-serif" {
"" : Helvetica
bold : Helvetica-Bold
italic : Helvetica-Oblique
bolditalic : Helvetica-BoldOblique
}
courier {
"" : Courier
bold : Courier-Bold
italic : Courier-Oblique
bolditalic : Courier-BoldOblique
}
"mono, monospace" {
"" : Courier
bold : Courier-Bold
italic : Courier-Oblique
bolditalic : Courier-BoldOblique
}
"muse, musejazztext" {
"" : MuseJazzText.otf
bold : MuseJazzText.otf
italic : MuseJazzText.otf
bolditalic : MuseJazzText.otf
}
dingbats. : ZapfDingbats
}
// `fonts` maps output elements to fonts as defined in `fontconfig`.
//
// Some element mappings can be specified, but it's not needed for all since they default to other elements:
// subtitle --> text
// chorus --> text
// comment --> text
// comment_italic --> chord
// comment_box --> chord
// annotation --> chord
// toc --> text
// grid --> chord
// grid_margin --> comment
// footer --> subtitle @ 60%
// empty --> text
// diagram --> comment
// diagram_base --> text (but at a small size)
fonts {
// The font used for page titles.
title : "Times-Bold 14"
// The font used for lyrics texts.
text : "Times-Roman 12"
// The font used for chords above the lyrics.
chord : "Helvetica-Oblique 10"
// Font for numbers in chord diagram dots.
// `color` is for the numbers.
// `numbercolor` is for the dots.
// `size` doesn't matter unless `diagrams.fingers` = `"below"`.
chordfingers : "sans; numbercolor=background"
// The font used for comments. If not set, falls back on the `text` font.
comment : "Helvetica 12; background=foreground-light"
// The font used for `comment_italic` directives. If not set, falls back on the `chord` font.
comment_italic : "Helvetica-Oblique 12"
// The font used for `comment_box` directives. If not set, falls back on the `chord` font.
comment_box : "Helvetica 12; frame=1"
// The font used for the contents of tab environments.
tab : "Courier 10"
// The font used for the table of contents. If not set, falls back on the `text` font.
toc : "Times-Roman 11"
// The font used for grid elements. If not set, falls back on the `chord` font.
grid : "Helvetica 10"
// Font for typesetting gridstrum symbols.
// You can set size and colours, but you cannot change the font.
gridstrum : "ChordProSymbols 13"
// Font for typesetting grilles.
grille : "Helvetica 10"
}
// PDF outlines (index) can be used in most PDF viewers for quick navigation.
outlines : [
{
// An identifying name for this outline.
name : by_title
// Primary and (optional) secondary fields.
fields : [ sorttitle artist ]
// Title, omitted if there's only one outline.
label : "By Title"
// The format for the outline entries.
line : "%{title}%{artist| - %{}}"
// Initial display is collapsed.
collapse : false
// If there are at least as many outline items with differing first letters than the amount specified here, an extra level of outlines (letter index) is created for easy navigation. A value of zero (`0`) disables this.
letter : 5
// For future use.
fold : false
}
{
// An identifying name for this outline.
name : by_artist
// Primary and (optional) secondary fields.
fields : [ artist sorttitle ]
// Title, omitted if there's only one outline.
label : "By Artist"
( run in 0.828 second using v1.01-cache-2.11-cpan-f56aa216473 )