Merge branch 'arkkra' into shiny
[mup] / mup / docs / template.mup
1 //!Mup-Arkkra
2 // This is a Mup input file template.
3 // Lines starting with // are "comments" that are here for your benefit.
4 // You can remove them without affecting the output.
5
6 /////////////////////////////////////////////////////////////////////////
7 // things to go on the top of the first page
8 top
9
10 // centered title.
11 // The number in parentheses is the text point size.
12 // Make it bigger if you want a bigger title or smaller if you
13 // want a smaller title
14 title (18) "Replace this with the title of your song"
15
16 // subtitle
17 // If you want a subtitle, remove the // from the beginning
18 // of the next line and fill in the appropriate subtitle text
19 // title (14) "Replace this with the subtitle"
20
21 // composer info
22 // The first pair of double quotes enclose what to left justify,
23 // the second encloses what to right justify.
24 // If you want more than one line, add similar lines of input
25 title "" "Replace this with composer info"
26
27
28 /////////////////////////////////////////////////////////////////////////
29 // things to go on the bottom on the first page
30 bottom
31 // If you want a copyright notice, remove the //
32 // from the next line and edit in the appropriate information
33 // title "\(copyright) Copyright Replace this with year and name"
34
35
36 /////////////////////////////////////////////////////////////////////////
37 // things to go on the top of pages other than the first
38 top2
39 // This example will give a centered page number between dashes.
40 // You can customize as you wish.
41 title "- \% -"
42
43
44 /////////////////////////////////////////////////////////////////////////
45 // things to go at the bottom of pages other than the first
46 bottom2
47 // if you want things printed at the bottom of pages of than
48 // the first page, place them here
49
50
51 /////////////////////////////////////////////////////////////////////////
52 // score-wide parameters
53 //
54 // You may or may not need to change some items in this section
55 //
56 // The values given as examples are the default values that Mup uses
57 // if you don't specify anything for them
58 score
59 // time signature. Can be cut, com,
60 // or two numbers with a / between them
61 time = 4/4
62
63 // key signature. Value is a number from 0 to 7
64 // followed by # or & for number of sharps or flats.
65 key = 0#
66
67 // how many staffs. Can be a number from 1 to 40
68 staffs = 1
69
70 // clef. Can be treble, treble8, 8treble, frenchviolin,
71 // soprano, mezzosoprano, alto, tenor, baritone, or bass
72 clef = treble
73
74 // Note: there are many more parameters that can be set,
75 // but they are not included in this simple template.
76 // There are parameters to set margins, control how things
77 // are laid out on the page, transpositions value, font and size
78 // for text and lyrics, etc
79
80
81 /////////////////////////////////////////////////////////////////////////
82 // You can set some parameters for specific staffs,
83 // to override the score-wide parameters. For example,
84 // if you specify staffs = 2 in the score-wide parameters above,
85 // and want to use bass clef on staff 2, even though the score-wide
86 // clef parameter is set to treble, you can do
87 // staff 2
88 // clef = bass
89
90
91 /////////////////////////////////////////////////////////////////////////
92 // music input starts here
93 music
94
95
96 // For each measure, you enter one line of input for each staff,
97 // then indicate what kind of barline to print.
98 // The following specifies that staff 1 contains a measure of rest
99 // and that an ordinary bar line is to be used at the end of the measure.
100
101 1: mr;
102 bar
103
104 // Usually, a measure of input for one staff consists of one or more chords
105 // Each chord is specified by
106 // time_value notes ;
107 // where time_value is something like
108 // 4 for a quarter note
109 // 8 for an eighth note
110 // 4. for a dotted-quarter note
111 // etc and notes is a list of one or more notes, specified as a pitch from
112 // a to g, optionally followed by an accidental (#, &, x, &&, or n for sharp,
113 // flat, double sharp, double flat, or natural respectively).
114 // Examples:
115 // 4c;
116 // 2. ceg;
117 // 16 f#;
118 // 1 d b&;
119 // (Spaces are optional, you can put them in if you want, but don't have to)
120 //
121 // So a complete measure might look something like:
122 // 1: 4e; 4d; 2c;
123 // bar
124 //
125 // If you want a note in a different octave than the default octave
126 // (the octave from middle-C up for treble clef,
127 // or the octave below middle-C for bass clef),
128 // you can add a + for each octave to go up or - for each octave to go down.
129 // For example:
130 // 1: c+; gc+e+; a&-; f#---;
131 //
132 // There are many other things you can specify, such as ties, slurs, grace
133 // notes, etc, and there are also many shortcuts you can use to save typing.
134 // Consult the Mup documentation for more details.
135
136 // Other bar types you may want to use are
137 // repeatstart
138 // repeatend
139 // repeatboth
140 // dblbar
141 // endbar
142 // invisbar