Recent Changes - Search:

Cookbook

PmWiki

pmwiki.org

Chord Pro

Summary: Display ChordPro-formatted song sheets in a wiki page
Version: 2015-07-01
Prerequisites: Requires at least PmWiki version: 2.2.59; last tested on PmWiki version: pmwiki-2.2.65 (compatible with PHP 5.5)
Status: Stable
Maintainer: Simon
Discussion: ChordPro-Talk
Categories: Editing, Layout, Markup, PHP55
License: GPL3+

Description

Use ChordPro formatted lyrics and tablature in a PmWiki page to embed and display ChordPro-formatted song sheets into a wiki page.

Markup

ChordPro is an early text format which was used to quickly generate song list with the chords mixed in with the lyrics. In many ways it is very wiki-like. Its goal is to make a machine-readable songsheet syntax, suitable for pretty-printing, which is also relatively easy on human eyes.

This recipe adds custom markup - ||: text :|| - for embedding ChordPro text within a wiki page. Within the custom markup ChordPro directives consist of keywords encapsulated in braces (curly brackets), viz "{keyword}", and text representing lyrics, within which chords, signified by square brackets, viz "[C#m7]", are embedded.

See ChordPro markup for details.

Formatting

All formatting is controlled by CSS. By default the chords and lyrics text is monospaced and the same size, however this is not necessary.

The spacing between the chording and the lyrics is controlled by the line-height CSS property. The spacing between each line of the song is controlled by padding above the chords and padding below the lyrics.

Modify chordpro.css to change colours, font-size, font-family, spacing etc. It is quite easy to do so and the CSS file is commented.

Installation

Download and unzip the archive chordpro-2015-07-01.zipΔ.

  • move the chordpro.php file to the /cookbook/ directory
  • move the chordpro.css file to the /pub/css/ directory unless you have customised it previously

Add the following line to config.php

@include_once("$FarmD/cookbook/chordpro.php");

Notes

Releases

2015-07-01
use relative font sizes in CSS
2014-08-10
GPL3. Use Markup_e for PHP5 compatibility
2009-10-01
Change handling of Title, Subtitle, and Album. Better cope with two directives on one line. Add CSS for page breaks and page directives. Adjust CSS for line-height and song line spacing.
2009-08-20
A significant release providing css controlled formatting for wiki pages and printing, with correct handling of blank lines

Contributors

See also

  • Cookbook:AbcMusic - Display music scores from abc notation
  • Cookbook:Music - Display music scores from various ascii notations (abc, abctab, asciitab, tab)

Related pages

Cookbook /
ChordPro-ChordSheets  ChordPro chord sheet documentation and examples
ChordPro-Format  ChordPro Basics and text format
ChordPro-Markup  ChordPro markup supported by this recipe
ChordPro-Sandbox  Test and try out ChordPro
ChordPro-Talk  Discussion of ChordPro (Stable)
ChordPro-Users  User notes for the Chord Pro recipe.

References

(:template each:)

User notes +1: If you use, used or reviewed this recipe, you can add your name. These statistics appear in the Cookbook listings and will help newcomers browsing through the wiki.

Edit - History - Print - Recent Changes - Search
Page last modified on July 01, 2015, at 04:08 AM