PC Musician 2000

home *** CD-ROM | disk | FTP | other *** search

/ PC Musician 2000 / PC_Musician_2000.iso / PCMUSIC / MISC / MUSICZIP / STUFFZIP.EXE / FILE_FMT.TXT < prev next >

Wrap

Text File | 1996-03-27 | 14.9 KB | 350 lines

MUSIC v3.3 file formats ~~~~~~~~~~~~~~~~~~~~~~~ Updated: 2/12/96 This file contains: 1) Data file formats MUSIC v3.1 uses for: MUSIC.DWR *.MUS MUSIC.CFG *.PC MUSIC.SL 2) List of Print Code "Keywords" and what they give you. This file is only for those of you hackers who really want to understand what makes MUSIC tick; for those of you who want to write special MUSIC 3rd party utilities that can read/write MUSIC data files. Most of you could/should care less about this stuff. _______________________________________________________________________________ Parameter lines are optional except where noted as (required). Where parameters are left out, MUSIC will set to defaults. All characters stored in each of these data files may be in upper or lower case (or mixed). When MUSIC writes the files it uses upper case. The parameter #MUSIC_VER=xxxx is used so MUSIC can know if a file it is reading was created by a newer version of MUSIC which may use parameter keywords not recognized by the older version (a notice would be given to the user saying that a newer version of MUSIC exists). Parameter type and size limits (as stored in MUSIC) are denoted as: @10 = alphanumeric (char) of up to 10 characters long #2 = numeric (int) of up to 2 digits long Where the parameter doesn't look like the type & size defined for it, the parameter is stored as a simple representation of the value. In such cases the parameter values can be of any length (up to 300 chars for entire line). For example: #1 |#SOUND=ON|OFF @1 |#MONITOR=AUTO|COLOR|MONO SOUND is stored as an int (boolean) where ON=1 (true) and OFF=0 (false) MONITOR is stored as a single char: A|C|M This is how MUSIC internally "stores" the parameter information (like you care) _______________________________________________________________________________ MUSIC.DWR Song Drawer summary files. Located in Song Drawer directories. MUSIC will only write optional parameter lines if a value is specified, otherwise no line will be saved in the file. _______________________________________________________________________________ @25 |#DRAWER=Camp Songs (required) @35 |#TITLE=Example Song (required) @12 |#FILE=034EXAMP.MUS (required) -> |#STORED_KEYS=D-E STEP 2 alternate form: #PRINT_KEYS=D (@3-@3 STEP #2) -> |#PRINT_KEYS=C-G STEP 1 alternate form: #PRINT_KEYS=C (@3-@3 STEP #2) -> |#VOCAL_RANGE=A-Db alternate form: #VOCAL_RANGE=A (@3-@3) @40 |#AUTHOR=The CAP @40 |#COPYRIGHT=1967 Tiny Tunes -> |#LAST_USED=04/22/95 (stored as date type in C: char/char/int) @1 |#ATTR1=X (attributes can be 1 character) @1 |#ATTR2=Y | : @1 |#ATTR12=8 @1 |#IN_SUBLIST=NO (not included in MUSIC.DWR if "=YES", assumed) |-- (song seperator can be anything but "#...") |#TITLE=Another Song |#FILE=EXAMP034.MUS |#KEY=Dbm |#LAST_USED=04/28/95 |#ATTR2=3 |-- | : | : |-- _______________________________________________________________________________ *.MUS Individual song files. Located in Song Drawer directories. Notes: The song body starts (chord/lyric pairs) at first line which does not start with a "#". MUSIC will only write optional parameter lines if a value is specified, otherwise no line will be saved in the file. _______________________________________________________________________________ @35 |#TITLE=Example Song (required) -> |#STORED_KEYS=D-E STEP 2 alternate form: #STORED_KEYS=D (@3-@3 STEP #2) -> |#PRINT_KEYS=C-G STEP 1 alternate form: #PRINT_KEYS=C (@3-@3 STEP #2) -> |#VOCAL_RANGE=A-Db alternate form: #VOCAL_RANGE=A (@3-@3) @40 |#AUTHOR=The CAP @40 |#COPYRIGHT=1967 Tiny Tunes @1 |#ATTR1=X (only attributes storing a value are here) @1 |#ATTR2=Y | : @1 |#ATTR12=8 @80 |## This is comment line 1. @80 |## All comments start with two pound signs and can be up to 80 @80 |## characters long. MUSIC will maintain leading spaces (between @80 |## the pound signs and the comment text). There can be a max of @80 |## 6 comment lines. @80 |## This is the last comment line. @78 | C F Am @78 |Oh I just wrote this work of art @78 | G Bb/F @78 |And if you know any producers @78 | C G Am @78 |Who just fell off the cart @78 | C F Dm G C @78 |Send them my way and I'll give you a part! _______________________________________________________________________________ MUSIC.CFG MUSIC Config file. Located in MUSIC's home directory. Defaults shown first; other options seperated by "|". MUSIC will create MUSIC.CFG with all parameters shown, even if their values are blank. _______________________________________________________________________________ @10 |#MUSIC_VER=3.1 | |## General Config Parameters (lines starting with "##" are comments) |## ------------------------- #1 |#SOUND=ON|OFF @1 |#MONITOR=AUTO|COLOR|MONO #1 |#SCREEN_EFFECTS=ON|OFF @40 |#EDITOR=INTERNAL|my_editor -a $ ("$" replaced by .MUS filename) #1 |#TRAILING_THE=OFF|ON (in songs window: "The Song Name" or "Song Name, The") @40 |#CCLI=my_ccli_number @13 |#DEFAULT_PC_FILE=normal.PC (printer config file to load at startup) #1 |#NOTICE_DETAIL=ON|OFF #1 |#REAL_CHORDS=OFF|ON (show correct or favorite chord names) #1 |#LIST_PEEK=OFF|ON (show Peek box in Lists menu) @40 |#REPORT_OUTPUT=PRINTER (Print Reports output filename or "PRINTER") | |## User-Defined Attribute Info |## --------------------------- @25 |#ATTR=1,Tempo (Xth attribute (1-12), Attribute name) -> |#ATTR=2,Favorite Rating (#2 (not stored), @25) |#ATTR=3,Theme | : |#ATTR=12, | |## Songs Window Display Setup |## -------------------------- #2 |#SW_SHOW=1,KEY (Xth item to show (1-10), item name: |#SW_SHOW=2,KEY MOD Item names: TITLE, FILENAME, KEY, |#SW_SHOW=3,ATTR 2 KEY MOD, MOD STEP, VOCAL MIN, VOCAL MAX, |#SW_SHOW=4,ATTR 1 ATTR 1..ATTR 12, LAST USED) |#SW_SHOW=5,TITLE | : |#SW_SHOW=10, | |## Printer Code Definitions |## ------------------------ @300|#P_RESET={this is a laser printer reset}[ESC]E @300|#P_NORMAL= @300|#P_BOLD_ON= @300|#P_BOLD_OFF= @300|#P_UNDERLINE_ON= @300|#P_UNDERLINE_OFF= @300|#P_ITALICS_ON= @300|#P_ITALICS_OFF= @300|#P_CONDENSED_ON= @300|#P_CONDENSED_OFF= @300|#P_STYLE=1,[ESC]&lp0T (10 user-defined stlyes can reference @300|#P_STYLE=2,[Esc].89s several defined "keywords". See below) @300|#P_STYLE=3,CCLI#: [Bold][CCLI][Bold Off]{shows CCLI # in bold} | : @300|#P_STYLE=10,[Bold Off][Underline Off][Italics Off][Condensed Off] _______________________________________________________________________________ *.PC Printer Config files. Located in MUSIC's home directory. MUSIC will create *.PC files with all parameters shown, even if their values are blank. _______________________________________________________________________________ |## This is a Printer Configuration file used by MUSIC. |## This file is used to customize the way MUSIC prints songs. | @10 |#MUSIC_VER=3.1 | @50 |#DESCRIPTION=Standard Worship List Format for HP PCL | @40 |#OUTPUT=PRINTER|filename #2 |#COPIES=1 @1 |#PRINT_CHORDS=Y|N @1 |#PRINT_LYRICS=Y|N|U (U=Upper case) @1 |#PAGE_FEED=F|Y|N (Fit max songs to page, Yes (every song), No) #2 |#INDENT=99 (characters to indent; 99=center) @1 |#MODULATIONS=A|M|N (Auto, Manual, None) @1 |#DBL_SPACE_SETS=A|Y|N (extra LF between chord/lyric sets: "A"uto) @1 |#PRINT_ATTRIBUTES=0|1|2|3 (0=None, 1=Keys by title, 2=All attributes except comments, 3=All attributes) @1 |#HYPHEN_UNDERLINE=Y|N (underline title with "----"?) @1 |#PRINT_TOC=Y|N|O (priht Table Of Contents? Yes, No, Only) #2 |#LINES_BETWEEN_SONGS=2 (for PAGE_FEED=F or N) @1 |#FORMATTING=0|1|2 (0=None, 1=Bold chords, 3=Before/After codes) #3 |#PAGE_COLUMNS=80 #3 |#PAGE_LINES=60 @1 |#UPDATE_LAST_USED=Y|N | @300|#PAGE_HEADER=Page Number: [Page Num] @300|#BEFORE_ALL=[RESET] @300|#AFTER_ALL=[FORMFEED] @300|#BEFORE_TOC=[STYLE 2] (BEFORE/AFTER codes...) @300|#AFTER_TOC=[NORMAL] @300|#BEFORE_SONG= @300|#AFTER_SONG=[COMMENTS] @300|#BEFORE_LINE= @300|#AFTER_LINE= @300|#BEFORE_TITLE=[STYLE 1] @300|#AFTER_TITLE=[NORMAL] Key: [Key] [Key Mod] @300|#BEFORE_CHORDS=[BOLD] @300|#AFTER_CHORDS=[BOLD OFF] @300|#BEFORE_LYRICS=[ITALICS] @300|#AFTER_LYRICS=[ITALICS OFF] _______________________________________________________________________________ MUSIC.SL Selection Lists data file. There is one MUSIC.SL file in each Song Drawer directory. _______________________________________________________________________________ ______________________________________________ List heading -> |01/02/94 - List comment/description [A] List songs start with a |<tab> {098I_WIL.MUS} I Will Praise Him Tab character then put | {117YOU_A.MUS} You Are the One the song filename in {} | {088LIGHT.MUS} Light of the World followed by a space and | {187POWER.MUS} Powerful Leader the song's title. | {288VICTO.MUS} Victory Chant End of list at empty line -> | |02/03/94 - User's comment/description [C] | : | : |______________________________________________ List headings are appended with " [?]" where ? = "Activity Catagory" A-E: A - Sing Use D - Arrangement B - Projection E - Recording C - Print Where no [?] is saved, the list has no catagory assigned to it (saved as catagory N)one but don't put " [N]" on the heading; just leave it off). At the very end of the MUSIC.SL file (after the last song of the last list) there is no extra blank line to indicate the end of the list; it is assumed. There can be any number of blank lines between the list groupings, but not between the actual songs lines in a list. Once a list is deleted by MUSIC all the extra empty lines will be removed; the file is cleaned up. _______________________________________________________________________________ _______________________________________________________________________________ Defined KEYWORDS which can be referenced by (1) Song Window Display parameters (SW_SHOW=) (2) Pre-Defined character control parameters (like P_BOLD=) (3) User-Defined "Styles" (P_STYLE=) (4) Printer Config file (*.PC) BEFORE/AFTER parameters (like BEFORE_TOC=) Keywords must be enclosed in square brackets "[]". To actually indicate a left square bracket, use two in a row "[[" and it will show only one. This works the same way for comments which are enclosed in curly brackets "{}". Comments can be anywhere in print code definitions. KEYWORDS (1) (2) (3) (4) --------------- --- --- --- --- --constants-- [ESC] X X X (ASCII 27) [LF] X X X (ASCII 13,10) [TAB] X X X (ASCII 9) [FORMFEED] X X X (ASCII 12) [123] X X X (ASCII value in decimal) [0x6D] X X X (ASCII value in hex) [[ X X X (gives only one "[") {{ X X X (gives only one "{") --styles-- [RESET] X X X [NORMAL] X X X [BOLD] X X X [BOLD OFF] X X X [AUTO BOLD] X X X [UNDERLINE] X X X [UNDERLINE OFF] X X X [ITALICS] X X X [ITALICS OFF] X X X [CONDENSED] X X X [CONDENSED OFF] X X X [STYLE 1] X X X : [STYLE 10] X X X --fields-- [TITLE] X X X X [FILENAME] X X X X [KEY FROM] X X X X Key song is stored in (from) [KEY TO] X X X X [KEY MOD STEP] X X X X [PKEY FROM] X X X X Key song will be printed in (from) [PKEY TO] X X X X [PKEY MOD STEP] X X X X [VOCAL MIN] X X X X [VOCAL MAX] X X X X [AUTHOR] X X X X [COPYRIGHT] X X X X [ATTR 1 NAME] X X X User defined attr name ("Tempo") [ATTR 1 VALUE] X X X X This song's value for it ("3") : [ATTR 12 NAME] X X X [ATTR 12 VALUE] X X X X [LAST USED] X X X X 12/12/1995 [COMMENT 1] X X X Just comment line 1 [COMMENT 2] X X X [COMMENT 3] X X X [COMMENT 4] X X X [COMMENT 5] X X X [COMMENT 6] X X X [COMMENTS] X X X All used comment lines --general config variables-- [CCLI] X X X Prints CCLI field (in Configure) [LIST NAME] X X X Name you give the selection list --system variables-- [SONG NUM] X X X Nth selected song [SONGS SELECTED] X X X Total songs selected [PAGE NUM] X X X [COPY] X X X Currently printing copy number N [COPIES] X X X Total number of copies printing [LINE NUM] X X X # of lines since last formfeed [PLACE NUM] X X X song is Nth in song drawer (currently) [DRAWER SIZE] X X X # of songs in song drawer [DATE] X X X 12/12/95 [DATE 2] X X X Mon Dec 12 1995 [TIME] X X X 23:59:59 (military) [TIME 2] X X X 11:59:59 pm [TIME 3] X X X 23:59 (line TIME but no seconds) [DATE TIME] X X X Mon Dec 12 23:59:59 1995 --comments-- {any comments} X X X Use comments to explain codes --------------- --- --- --- --- KEYWORDS (1) (2) (3) (4)