xref: /plugin/chordsheets/README.md (revision 3d7a173336f953ab1994ced194cc3bfbcfb037d6)
1edb40cceSAndreas Pazureck# chordsheets Plugin for DokuWiki
2edb40cceSAndreas Pazureck
3edb40cceSAndreas PazureckPretty and interactive chord sheets like on ultimate guitar for dokuwiki
4edb40cceSAndreas Pazureck
5edb40cceSAndreas PazureckAll documentation for this plugin can be found at
6edb40cceSAndreas Pazureckhttps://github.com/apazureck/dokuwiki-chordsheets
7edb40cceSAndreas Pazureck
8edb40cceSAndreas PazureckIf you install this plugin manually, make sure it is installed in
9edb40cceSAndreas Pazurecklib/plugins/chordsheets/ - if the folder is called different it
10edb40cceSAndreas Pazureckwill not work!
11edb40cceSAndreas Pazureck
12edb40cceSAndreas PazureckPlease refer to http://www.dokuwiki.org/plugins for additional info
13edb40cceSAndreas Pazureckon how to install plugins in DokuWiki.
14*3d7a1733SAndreas Pazureck
15*3d7a1733SAndreas Pazureck## Usage
16*3d7a1733SAndreas Pazureck
17*3d7a1733SAndreas PazureckTo get a chord sheet, just put your sheet (for example from ultimate guitar) in the chordsheet tags:
18*3d7a1733SAndreas Pazureck
19*3d7a1733SAndreas Pazureck```xml
20*3d7a1733SAndreas Pazureck<chordSheet 0>
21*3d7a1733SAndreas Pazureck[Intro]
22*3d7a1733SAndreas PazureckAm    F/C    C    G    C
23*3d7a1733SAndreas Pazureck
24*3d7a1733SAndreas Pazureck[Verse]
25*3d7a1733SAndreas PazureckC
26*3d7a1733SAndreas PazureckSomeone told me long ago
27*3d7a1733SAndreas PazureckC                                   G
28*3d7a1733SAndreas PazureckThere's a calm before the storm, I know
29*3d7a1733SAndreas Pazureck                     C
30*3d7a1733SAndreas PazureckAnd it's been coming for some time
31*3d7a1733SAndreas PazureckC
32*3d7a1733SAndreas PazureckWhen it's over, so they say
33*3d7a1733SAndreas PazureckC                          G
34*3d7a1733SAndreas PazureckIt'll rain a sunny day, I know
35*3d7a1733SAndreas Pazureck                   C
36*3d7a1733SAndreas PazureckShining down like water
37*3d7a1733SAndreas Pazureck...
38*3d7a1733SAndreas Pazureck</chordSheet>
39*3d7a1733SAndreas Pazureck```
40*3d7a1733SAndreas Pazureck
41*3d7a1733SAndreas PazureckThe number indicates transposition in half-tones (negative numbers is down).
42*3d7a1733SAndreas Pazureck
43*3d7a1733SAndreas PazureckSingle 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*3d7a1733SAndreas Pazureck
45*3d7a1733SAndreas Pazureck![Dokuwiki Output](img/2018-07-28-22-36-13.png)