From 37b4eeb0cc002c67095ec2ab48f279f1c537a807 Mon Sep 17 00:00:00 2001 From: Carsten Tinggaard Date: Thu, 4 Dec 2008 21:15:08 +0000 Subject: [PATCH] Suggested internal song format bzr-revno: 177 --- documentation/SongFormat.txt | 60 ++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 documentation/SongFormat.txt diff --git a/documentation/SongFormat.txt b/documentation/SongFormat.txt new file mode 100644 index 000000000..b3b05019b --- /dev/null +++ b/documentation/SongFormat.txt @@ -0,0 +1,60 @@ +This file documents the OpenLP2 song format. + +All fields are strings to ease reading and writing of SQLITE files. + +A Song has the following fields + title + searchableTitle - no hyphens, commas, punctuation etc + authorList - like "A. Williams, B C Dee" + songCcliNo + copyright - like authorList + showTitle - 0: dont show, 1: do show + showAuthorList - 0: dont show, 1: do show + showSongCcli - 0: dont show, 1: do show + showCopyright - 0: dont show, 1: do show + theme - name of theme or blank + categoryArray - list of categories "Hymn, Traditional ..." + songBook - + songNumber - + comments - any comment you may have + verseOrder - like "V1 C V2 C V3 B V4 C" + lyrics - formatted as XML - see below + searchableLyrics -- the lyrics without any xml formatting; the raw song text + + + +The lyrics definition (more or less similar to interformat to/from ChangingSong +The tags can also be used within the lyrics test. + +! Please note that this format has been checked at http://validator.w3.org/#validate_by_upload + + + Amazing Grace + + name of verse specific theme (optional) + any text (optional) + + Amazing grace, how ... + + + A b c + D e f + + ... + + + name of verse specific theme (optional) + any text (optional) + ... + + + + Erstaunliche Anmut + + Erstaunliche Anmut, wie + ... + + + ... + +