forked from openlp/openlp
Change comments to reStructuredText format
This commit is contained in:
Derek Scotney
parent
88f5de47ba
commit
d3ee43965f
|
|
@ -49,7 +49,7 @@ class CCLIFileImport(SongImport):
|
||||||
|
|
||||||
``manager``
|
``manager``
|
||||||
The song manager for the running OpenLP installation.
|
The song manager for the running OpenLP installation.
|
||||||
``filenames``
|
``filenames``
|
||||||
The files to be imported.
|
The files to be imported.
|
||||||
|
|
||||||
"""
|
"""
|
||||||
|
|
@ -100,26 +100,46 @@ class CCLIFileImport(SongImport):
|
||||||
|
|
||||||
def do_import_usr_file(self, textList):
|
def do_import_usr_file(self, textList):
|
||||||
"""
|
"""
|
||||||
Process the USR file
|
The :method:`do_import_usr_file` method provides OpenLP with the ability to
|
||||||
|
import CCLI SongSelect songs in *USR* file format
|
||||||
|
|
||||||
``textList``
|
``textList``
|
||||||
An array of strings containing the usr file content.
|
An array of strings containing the usr file content.
|
||||||
|
|
||||||
The format of the .usr format is:
|
**SongSelect .usr file format**
|
||||||
==========
|
``[File]``
|
||||||
[File]
|
USR file format first line
|
||||||
Type=SongSelect Import File
|
``Type=``
|
||||||
Version=3.0
|
Indicates the file type
|
||||||
[S A2672885]
|
e.g. *Type=SongSelect Import File*
|
||||||
Title=Above All
|
``Version=3.0``
|
||||||
Author=LeBlanc, Lenny | Baloche, Paul
|
File format version
|
||||||
Copyright=1999 Integrity's Hosanna! Music | LenSongs Publishing (Verwaltet von Gerth Medien Musikverlag) | (Verwaltet von Gerth Medien Musikverlag)
|
``[S A2672885]``
|
||||||
Admin=Gerth Medien Musikverlag
|
Contains the CCLI Song number e.g. *2672885*
|
||||||
Themes=Cross/tKingship/tMajesty/tRedeemer
|
``Title=``
|
||||||
Keys=A
|
Contains the song title (e.g. *Title=Above All*)
|
||||||
Fields=Vers 1/tVers 2/tChorus 1/tAndere 1
|
``Author=``
|
||||||
Words=Above all powers.... [/n = CR, /n/t = CRLF]
|
Contains a | delimited list of the song authors
|
||||||
==========
|
e.g. *Author=LeBlanc, Lenny | Baloche, Paul*
|
||||||
|
``Copyright=``
|
||||||
|
Contains a | delimited list of the song copyrights
|
||||||
|
e.g. Copyright=1999 Integrity's Hosanna! Music | LenSongs Publishing (Verwaltet von Gerth Medien Musikverlag) | (Verwaltet von Gerth Medien Musikverlag)
|
||||||
|
``Admin=``
|
||||||
|
Contains the song administrator
|
||||||
|
e.g. *Admin=Gerth Medien Musikverlag*
|
||||||
|
``Themes=``
|
||||||
|
Contains a /t delimited list of the song themes
|
||||||
|
e.g. *Themes=Cross/tKingship/tMajesty/tRedeemer*
|
||||||
|
``Keys=``
|
||||||
|
Contains the keys in which the music is played??
|
||||||
|
e.g. *Keys=A*
|
||||||
|
``Fields=``
|
||||||
|
Contains a list of the songs fields in order /t delimited
|
||||||
|
e.g. *Fields=Vers 1/tVers 2/tChorus 1/tAndere 1*
|
||||||
|
``Words=``
|
||||||
|
Contains the songs various lyrics in order as shown by the
|
||||||
|
*Fields* description
|
||||||
|
e.g. *Words=Above all powers....* [/n = CR, /n/t = CRLF]
|
||||||
"""
|
"""
|
||||||
|
|
||||||
log.debug('USR file text: %s', textList)
|
log.debug('USR file text: %s', textList)
|
||||||
|
|
@ -181,29 +201,46 @@ class CCLIFileImport(SongImport):
|
||||||
|
|
||||||
def do_import_txt_file(self, textList):
|
def do_import_txt_file(self, textList):
|
||||||
"""
|
"""
|
||||||
Process the TXT file - pass in a list of lines
|
The :method:`do_import_txt_file` method provides OpenLP with the ability to
|
||||||
|
import CCLI SongSelect songs in *TXT* file format
|
||||||
|
|
||||||
``textList``
|
``textList``
|
||||||
An array of strings containing the txt file content.
|
An array of strings containing the txt file content.
|
||||||
|
|
||||||
The format of the .txt format is:
|
**SongSelect .txt file format**
|
||||||
==========
|
|
||||||
Song Title
|
``Song Title``
|
||||||
<>
|
Contains the song title
|
||||||
Description of following text (Verse/Chorus) and number
|
|
||||||
<verse/chorus lyrics>
|
<Empty line>
|
||||||
<>
|
|
||||||
<>
|
``Title of following verse/chorus and number``
|
||||||
Next text block description (etc)
|
e.g. Verse 1, Chorus 1
|
||||||
<verse/chorus lyrics>
|
|
||||||
<>
|
``Verse/Chorus lyrics``
|
||||||
<>
|
|
||||||
CCLI Number (e.g.CCLI-Liednummer: 2672885)
|
<Empty line>
|
||||||
Copyright "|" delimited (e.g. © 1999 Integrity's Hosanna! Music | LenSongs Publishing)
|
|
||||||
Authors "|" delimited (e.g. Lenny LeBlanc | Paul Baloche)
|
<Empty line>
|
||||||
Licencing info (e.g. For use solely with the SongSelect Terms of Use. All rights Reserved. www.ccli.com)
|
|
||||||
CCLI Licence number (e.g. CCL-Liedlizenznummer: 14 / CCLI License No. 14)
|
``Title of next verse/chorus (repeats)``
|
||||||
==========
|
|
||||||
|
``Verse/Chorus lyrics``
|
||||||
|
|
||||||
|
<Empty line>
|
||||||
|
|
||||||
|
<Empty line>
|
||||||
|
|
||||||
|
``Song CCLI Number``
|
||||||
|
e.g. CCLI Number (e.g.CCLI-Liednummer: 2672885)
|
||||||
|
``Song Copyright``
|
||||||
|
e.g. © 1999 Integrity's Hosanna! Music | LenSongs Publishing
|
||||||
|
``Song Authors``
|
||||||
|
e.g. Lenny LeBlanc | Paul Baloche
|
||||||
|
``Licencing info``
|
||||||
|
e.g. For use solely with the SongSelect Terms of Use. All rights Reserved. www.ccli.com
|
||||||
|
``CCLI Licence number of user``
|
||||||
|
e.g. CCL-Liedlizenznummer: 14 / CCLI License No. 14
|
||||||
"""
|
"""
|
||||||
|
|
||||||
log.debug('TXT file text: %s', textList)
|
log.debug('TXT file text: %s', textList)
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue