add a bunch of descriptions

BurningTreeC · Aug 23, 2021 · 7c5137a · 7c5137a
1 parent 308b732
commit 7c5137a
Show file tree

Hide file tree

Showing 20 changed files with 20 additions and 0 deletions.
diff --git a/plugins/musicsheets/ui/Symbols/TuneHeader/book.tid b/plugins/musicsheets/ui/Symbols/TuneHeader/book.tid
@@ -2,5 +2,6 @@ title: $:/plugins/BTC/musicsheets/ui/Symbols/Book
 tags: $:/tags/MusicSheets/TuneHeader
 caption: B: Book
 category: Tune Header
+description: i.e. printed tune book
 
 B:
diff --git a/plugins/musicsheets/ui/Symbols/TuneHeader/composer.tid b/plugins/musicsheets/ui/Symbols/TuneHeader/composer.tid
@@ -2,5 +2,6 @@ title: $:/plugins/BTC/musicsheets/ui/Symbols/Composer
 tags: $:/tags/MusicSheets/TuneHeader
 caption: C: Composer
 category: Tune Header
+description: The C: field is used to indicate the composer(s).
 
 C:
diff --git a/plugins/musicsheets/ui/Symbols/TuneHeader/default-note-length.tid b/plugins/musicsheets/ui/Symbols/TuneHeader/default-note-length.tid
@@ -2,5 +2,6 @@ title: $:/plugins/BTC/musicsheets/ui/Symbols/NoteLength
 tags: $:/tags/MusicSheets/TuneHeader
 caption: L: Default Note Length
 category: Tune Header
+description: The L: field specifies the unit note length - the length of a note as represented by a single letter in abc
 
 L:
diff --git a/plugins/musicsheets/ui/Symbols/TuneHeader/discography.tid b/plugins/musicsheets/ui/Symbols/TuneHeader/discography.tid
@@ -2,5 +2,6 @@ title: $:/plugins/BTC/musicsheets/ui/Symbols/Discography
 tags: $:/tags/MusicSheets/TuneHeader
 caption: D: Discography
 category: Tune Header
+description: i.e. a CD or LP where the tune can be heard
 
 D:
diff --git a/plugins/musicsheets/ui/Symbols/TuneHeader/filename.tid b/plugins/musicsheets/ui/Symbols/TuneHeader/filename.tid
@@ -2,5 +2,6 @@ title: $:/plugins/BTC/musicsheets/ui/Symbols/FileName
 tags: $:/tags/MusicSheets/TuneHeader
 caption: F: File Name
 category: Tune Header
+description: i.e. where the either the abc tune or the abc file can be found on the web
 
 F:
diff --git a/plugins/musicsheets/ui/Symbols/TuneHeader/geographical-area.tid b/plugins/musicsheets/ui/Symbols/TuneHeader/geographical-area.tid
@@ -2,5 +2,6 @@ title: $:/plugins/BTC/musicsheets/ui/Symbols/Area
 tags: $:/tags/MusicSheets/TuneHeader
 caption: A: (Geographical) Area
 category: Tune Header
+description: Historically, the A: field has been used to contain area information (more specific details of the tune origin). However this field is now deprecated and it is recommended that such information be included in the O: field.
 
 A:
diff --git a/plugins/musicsheets/ui/Symbols/TuneHeader/geographical-origin.tid b/plugins/musicsheets/ui/Symbols/TuneHeader/geographical-origin.tid
@@ -2,5 +2,6 @@ title: $:/plugins/BTC/musicsheets/ui/Symbols/Origin
 tags: $:/tags/MusicSheets/TuneHeader
 caption: O: (Geographical) Origin
 category: Tune Header
+description: The O: field indicates the geographical origin(s) of a tune.
 
 O:
diff --git a/plugins/musicsheets/ui/Symbols/TuneHeader/group.tid b/plugins/musicsheets/ui/Symbols/TuneHeader/group.tid
@@ -2,5 +2,6 @@ title: $:/plugins/BTC/musicsheets/ui/Symbols/Group
 tags: $:/tags/MusicSheets/TuneHeader
 caption: G: Group
 category: Tune Header
+description: Database software may use this field to group together tunes (for example by instruments) for indexing purposes. It can also be used for creating medleys - however, this usage is not standardised.
 
 G:
diff --git a/plugins/musicsheets/ui/Symbols/TuneHeader/history.tid b/plugins/musicsheets/ui/Symbols/TuneHeader/history.tid
@@ -2,5 +2,6 @@ title: $:/plugins/BTC/musicsheets/ui/Symbols/History
 tags: $:/tags/MusicSheets/TuneHeader
 caption: H: History
 category: Tune Header
+description: Designed for multi-line notes, stories and anecdotes.
 
 H:
diff --git a/plugins/musicsheets/ui/Symbols/TuneHeader/information.tid b/plugins/musicsheets/ui/Symbols/TuneHeader/information.tid
@@ -2,5 +2,6 @@ title: $:/plugins/BTC/musicsheets/ui/Symbols/Information
 tags: $:/tags/MusicSheets/TuneHeader
 caption: I: Information
 category: Tune Header
+description: The I:(instruction) field is used for an extended set of instruction directives concerned with how the abc code is to be interpreted.
 
 I:
diff --git a/plugins/musicsheets/ui/Symbols/TuneHeader/key.tid b/plugins/musicsheets/ui/Symbols/TuneHeader/key.tid
@@ -2,5 +2,6 @@ title: $:/plugins/BTC/musicsheets/ui/Symbols/Key
 tags: $:/tags/MusicSheets/TuneHeader
 caption: K: Key
 category: Tune Header
+description: The key signature should be specified with a capital letter (A-G) which may be followed by a # or b for sharp or flat respectively. In addition the mode should be specified (when no mode is indicated, major is assumed).
 
 K:
diff --git a/plugins/musicsheets/ui/Symbols/TuneHeader/meter.tid b/plugins/musicsheets/ui/Symbols/TuneHeader/meter.tid
@@ -2,5 +2,6 @@ title: $:/plugins/BTC/musicsheets/ui/Symbols/Meter
 tags: $:/tags/MusicSheets/TuneHeader
 caption: M: Meter
 category: Tune Header
+description: The M: field indicates the meter. Apart from standard meters, e.g. M:6/8 or M:4/4, the symbols M:C and M:C| give common time (4/4) and cut time (2/2) respectively. The symbol M:none omits the meter entirely (free meter). It is also possible to specify a complex meter, e.g. M:(2+3+2)/8, to make explicit which beats should be accented. The parentheses around the numerator are optional.
 
 M:
diff --git a/plugins/musicsheets/ui/Symbols/TuneHeader/notes.tid b/plugins/musicsheets/ui/Symbols/TuneHeader/notes.tid
@@ -2,5 +2,6 @@ title: $:/plugins/BTC/musicsheets/ui/Symbols/Notes
 tags: $:/tags/MusicSheets/TuneHeader
 caption: N: Notes
 category: Tune Header
+description: Contains general annotations, such as references to other tunes which are similar, details on how the original notation of the tune was converted to abc, etc.
 
 N:
diff --git a/plugins/musicsheets/ui/Symbols/TuneHeader/parts.tid b/plugins/musicsheets/ui/Symbols/TuneHeader/parts.tid
@@ -2,5 +2,6 @@ title: $:/plugins/BTC/musicsheets/ui/Symbols/Parts
 tags: $:/tags/MusicSheets/TuneHeader
 caption: P: Parts
 category: Tune Header
+description: The P: field can be used in the tune header to state the order in which the tune parts are played, i.e. P:ABABCDCD, and then inside the tune body to mark each part, i.e. P:A or P:B. (In this context part refers to a section of the tune, rather than a voice in multi-voice music.)
 
 P:
diff --git a/plugins/musicsheets/ui/Symbols/TuneHeader/rhythm.tid b/plugins/musicsheets/ui/Symbols/TuneHeader/rhythm.tid
@@ -2,5 +2,6 @@ title: $:/plugins/BTC/musicsheets/ui/Symbols/Rhythm
 tags: $:/tags/MusicSheets/TuneHeader
 caption: R: Rhythm
 category: Tune Header
+description: Contains an indication of the type of tune (e.g. hornpipe, double jig, single jig, 48-bar polka, etc). This gives the musician some indication of how a tune should be interpreted as well as being useful for database applications.
 
 R:
diff --git a/plugins/musicsheets/ui/Symbols/TuneHeader/source.tid b/plugins/musicsheets/ui/Symbols/TuneHeader/source.tid
@@ -2,5 +2,6 @@ title: $:/plugins/BTC/musicsheets/ui/Symbols/Source
 tags: $:/tags/MusicSheets/TuneHeader
 caption: S: Source
 category: Tune Header
+description: i.e. the circumstances under which a tune was collected or learned
 
 S:
diff --git a/plugins/musicsheets/ui/Symbols/TuneHeader/tempo.tid b/plugins/musicsheets/ui/Symbols/TuneHeader/tempo.tid
@@ -2,5 +2,6 @@ title: $:/plugins/BTC/musicsheets/ui/Symbols/Tempo
 tags: $:/tags/MusicSheets/TuneHeader
 caption: Q: Tempo
 category: Tune Header
+description: The Q: field defines the tempo in terms of a number of beats per minute, e.g. Q:1/2=120 means 120 half-note beats per minute.
 
 Q:
diff --git a/plugins/musicsheets/ui/Symbols/TuneHeader/title.tid b/plugins/musicsheets/ui/Symbols/TuneHeader/title.tid
@@ -2,5 +2,6 @@ title: $:/plugins/BTC/musicsheets/ui/Symbols/Title
 tags: $:/tags/MusicSheets/TuneHeader
 caption: T: Title
 category: Tune Header
+description: A T: (title) field must follow immediately after the X: field; it is the human identifier for the tune (although it may be empty).
 
 T:
diff --git a/plugins/musicsheets/ui/Symbols/TuneHeader/transcription-note.tid b/plugins/musicsheets/ui/Symbols/TuneHeader/transcription-note.tid
@@ -2,5 +2,6 @@ title: $:/plugins/BTC/musicsheets/ui/Symbols/TranscriptionNote
 tags: $:/tags/MusicSheets/TuneHeader
 caption: Z: Transcription Note
 category: Tune Header
+description: Typically the Z: field contains the name(s) of the person(s) who transcribed the tune into abc, and possibly some contact information, e.g. an (e-)mail address or homepage URL.
 
 Z:
diff --git a/plugins/musicsheets/ui/Symbols/TuneHeader/tune-reference-number.tid b/plugins/musicsheets/ui/Symbols/TuneHeader/tune-reference-number.tid
@@ -2,5 +2,6 @@ title: $:/plugins/BTC/musicsheets/ui/Symbols/TuneReferenceNumber
 tags: $:/tags/MusicSheets/TuneHeader
 caption: X: Tune Reference Number
 category: Tune Header
+description: The X: (reference number) field is used to assign to each tune within a tunebook a unique reference number (a positive integer), for example: X:23. The X: field is also used to indicate the start of the tune (and hence the tune header), so all tunes must start with an X: field and only one X: field is allowed per tune.
 
 X: