README.md
1# chordsheets Plugin for DokuWiki
2
3Pretty and interactive chord sheets like on ultimate guitar for dokuwiki
4
5All documentation for this plugin can be found at
6https://github.com/apazureck/dokuwiki-chordsheets
7
8If you install this plugin manually, make sure it is installed in
9lib/plugins/chordsheets/ - if the folder is called different it
10will not work!
11
12Please refer to http://www.dokuwiki.org/plugins for additional info
13on how to install plugins in DokuWiki.
14
15## Usage
16
17To get a chord sheet, just put your sheet (for example from ultimate guitar) in the chordsheet tags:
18
19```xml
20<chordSheet 0>
21[Intro]
22Am F/C C G C
23
24[Verse]
25C
26Someone told me long ago
27C G
28There's a calm before the storm, I know
29 C
30And it's been coming for some time
31C
32When it's over, so they say
33C G
34It'll rain a sunny day, I know
35 C
36Shining down like water
37...
38</chordSheet>
39```
40
41The number indicates transposition in half-tones (negative numbers is down).
42
43Single chords can be displayed using the syntax of [JTab JS](http://jtab.tardate.com/). The rendered `Bm7b5` chord seen below is rendered by using this input: `%7/2.X/X.7/3.7/4.6/1.X/X[Bm7b5]`.
44
45