Update of /project/fomus/cvsroot/fomus/doc In directory common-lisp.net:/tmp/cvs-serv16769 Modified Files: marks.xml objects.xml settings.xml Log Message: Doc update Date: Wed Jul 20 06:50:01 2005 Author: dpsenicka Index: fomus/doc/marks.xml diff -u fomus/doc/marks.xml:1.1.1.1 fomus/doc/marks.xml:1.2 --- fomus/doc/marks.xml:1.1.1.1 Tue Jul 19 20:17:05 2005 +++ fomus/doc/marks.xml Wed Jul 20 06:50:00 2005 @@ -44,7 +44,7 @@ </para> </listitem> <listitem><para> - The starting mark is included in the object occuring at the start of the spanner and the mark without a prefix + The starting mark is included in the object occurring at the start of the spanner and the mark without a prefix is included in objects following the starting mark. The last object with a mark in it before a new starting mark is found is considered to be the end of the spanner. @@ -79,7 +79,7 @@ <variablelist> <varlistentry> <term><userinput><anchor id="markarg.art.order"/>art-order</userinput></term> - <listitem>An integer for articulations specifying relative closeness to the notehead (lower numbered articulations are closer than higher numbered ones)</listitem> + <listitem>An integer for articulations specifying relative closeness to the note head (lower numbered articulations are closer than higher numbered ones)</listitem> </varlistentry> <varlistentry> <term><userinput><anchor id="markarg.clef"/>clef</userinput></term> @@ -91,8 +91,8 @@ <listitem> This is an integer distinguishing between inner and outer levels of spanner markings. - Smaller numbers are "inner" markings occuring closest to the staff while larger numbers are "outer" markings - occuring farthest from the staff. + Smaller numbers are "inner" markings occurring closest to the staff while larger numbers are "outer" markings + occurring farthest from the staff. The default value is 1 </listitem> @@ -103,8 +103,8 @@ slot in the <classname><link linkend="class.note">NOTE</link></classname> class).</listitem> </varlistentry> <varlistentry> - <term><userinput><anchor id="markarg.notehead"/>notehead</userinput></term> - <listitem>One of the following notehead symbols: (not implemented yet).</listitem> + <term><userinput><anchor id="markarg.notehead"/>note head</userinput></term> + <listitem>One of the following note head symbols: (not implemented yet).</listitem> </varlistentry> <varlistentry> <term><userinput><anchor id="markarg.string"/>string</userinput></term> @@ -112,7 +112,7 @@ </varlistentry> <varlistentry> <term><userinput><anchor id="markarg.trem.subdiv"/>trem-subdiv</userinput></term> - <listitem>A durational value (a ratio or integer) for a tremelo subdivision</listitem> + <listitem>A durational value (a ratio or integer) for a tremolo subdivision</listitem> </varlistentry> </variablelist> </para> @@ -191,10 +191,10 @@ <title>Ornamentations</title> <simplelist> - <member><function>(<anchor id="tremelo"/>:TREMELO &optional <userinput><link link="markarg.trem.subdiv">trem-subdiv</link></userinput>)</function></member> - <member><function>(<anchor id="righthandtremelo"/>:RIGHTHANDTREMELO &optional + <member><function>(<anchor id="tremelo"/>:TREMOLO &optional <userinput><link link="markarg.trem.subdiv">trem-subdiv</link></userinput>)</function></member> + <member><function>(<anchor id="righthandtremelo"/>:RIGHTHANDTREMOLO &optional <userinput><link link="markarg.trem.subdiv">trem-subdiv</link></userinput>)</function></member> - <member><function>(<anchor id="lefthandtremelo"/>:LEFTHANDTREMELO &optional + <member><function>(<anchor id="lefthandtremelo"/>:LEFTHANDTREMOLO &optional <userinput><link link="markarg.trem.subdiv">trem-subdiv</link></userinput>)</function></member> <member><function><anchor id="longtrill"/>:LONGTRILL</function></member> <member><function>(<anchor id="arpeggio"/>:ARPEGGIO &optional <literal>:UP</literal>/<literal>:DOWN</literal>)</function></member> Index: fomus/doc/objects.xml diff -u fomus/doc/objects.xml:1.1.1.1 fomus/doc/objects.xml:1.2 --- fomus/doc/objects.xml:1.1.1.1 Tue Jul 19 20:17:05 2005 +++ fomus/doc/objects.xml Wed Jul 20 06:50:01 2005 @@ -303,7 +303,7 @@ The offset is measured in "beats," which may indicate different notational positions depending on previous time signatures and what values are present in their <structfield><link linkend="timesig.beat">BEAT</link></structfield> slots. - The number must be precise and notatable (floating point numbers are not recommended and values like 10/3 that don't + The number must be precise and "notatable" (floating point numbers are not recommended and values like 10/3 that don't occur on a regular beat divisions are currently impossible for <application>FOMUS</application> to notate). </para> </listitem> @@ -313,7 +313,7 @@ <term><function><anchor id="timesig.time"/>TIMESIG-TIME</function></term> <listitem> <para> - This is a required list of two integers, specifying the numberator and denominator of the printed time signature. + This is a required list of two integers, specifying the numerator and denominator of the printed time signature. </para> </listitem> </varlistentry> @@ -357,13 +357,13 @@ <listitem> <para> This is a single list or list of lists containing ratios or integers that add up to the total number of beats - in a meaure (as specified by either the <structfield><link linkend="timesig.time">TIME</link></structfield> or + in a measure (as specified by either the <structfield><link linkend="timesig.time">TIME</link></structfield> or <structfield><link linkend="timesig.beat">BEAT</link></structfield> slots). It represents all of the choices available for dividing up measures following this time signature. If the slot contains the default value of <literal>NIL</literal>, <application>FOMUS</application> looks up - divisions first in a user-supplied table if one exists (see the <varname><link linkend="default.meas.divs">DEFALT-MEAS-DIVS</link></varname> + divisions first in a user-supplied table if one exists (see the <varname><link linkend="default.meas.divs">DEFAULT-MEAS-DIVS</link></varname> setting) then in <application>FOMUS</application>'s default table. A value usually only needs to be specified here if the user wants to force <application>FOMUS</application> @@ -618,7 +618,7 @@ that make the best use of tuplets within given constraints while minimizing the amount of adjustment error. If this quantizing algorithm is switched off, then the user must insure that all offset and duration values - are precise and notatable (floating point numbers are not recommended in this case). + are precise and "notatable" (floating point numbers are not recommended in this case). </para> </listitem> </varlistentry> @@ -638,7 +638,7 @@ function. Symbols in this case designate notational values and not beats, although - numbers are still interpretted with respect to beats and not filtered through <application>CM</application>'s + numbers are still interpreted with respect to beats and not filtered through <application>CM</application>'s <function>RHYTHM</function> function. </para> @@ -652,7 +652,7 @@ Also, grace notes with the same position form chords, and notes with negative positions are notated with a slash. - The duration value at the front of the list is still interpretted in terms of beats and notated as such even though + The duration value at the front of the list is still interpreted in terms of beats and notated as such even though the note does not take up time in the measure. Specifying a duration of <literal>'(1/4 -1)</literal>, for example, specifies a grace sixteenth note with a slash @@ -901,7 +901,7 @@ Marks designate extra information that to be applied to a <classname><link linkend="class.note">NOTE</link></classname> or <classname><link linkend="class.rest">REST</link></classname> object - such as articulations, modifications like tremelos or harmonics, printed text, etc.. + such as articulations, modifications like tremolos or harmonics, printed text, etc.. After voices and staff assignments have been established, information in the <classname><link linkend="class.mark">MARK</link></classname> objects is dumped into the <structfield><link linkend="note.marks">MARKS</link></structfield> slots of <classname><link linkend="class.note">NOTE</link></classname> and @@ -1013,7 +1013,7 @@ only need to appear in one place. In the case of the example above, a mark with this value in its <structfield><link linkend="mark.voice">VOICE</link></structfield> - slot that is applied to a grandstaff is attached to a note in a voice close to the inside of the staff. + slot that is applied to a grand staff is attached to a note in a voice close to the inside of the staff. </para> <para> @@ -1266,11 +1266,11 @@ <para> The value of this slot influences how <application>FOMUS</application> decides when to change clefs. - A clef change isn't considered necessary until the number of leger lines required exceeds a threshold value. + A clef change isn't considered necessary until the number of ledger lines required exceeds a threshold value. Other factors determine if there is actually a clef change or not. - If the value is an integer, it designates the threshold number of leger lines in all cases. + If the value is an integer, it designates the threshold number of ledger lines in all cases. If it's a list, the first element of the list must be an integer specifying a default threshold. @@ -1278,7 +1278,7 @@ This exception list contains a clef symbol (see the <structfield><link linkend="instr.clefs">CLEFS</link></structfield> slot above) followed by one of the two symbols <literal>:UP</literal> or <literal>:DN</literal> - and ended by an integer specifying the number of leger lines. + and ended by an integer specifying the number of ledger lines. An example illustrates this data structure. @@ -1298,10 +1298,10 @@ <para> This value influences how <application>FOMUS</application> chooses where to place ottava brackets above the staff. - An ottava bracket isn't considered necessary until the number of leger lines required exceeds a threshold value. + An ottava bracket isn't considered necessary until the number of ledger lines required exceeds a threshold value. An integer in this slot indicates the threshold value, while - a list of two elements specifies the threshold for the ottava bracket to begin and the threshold below which the number of leger lines must + a list of two elements specifies the threshold for the ottava bracket to begin and the threshold below which the number of ledger lines must drop for it to end. </para> </listitem> @@ -1398,7 +1398,7 @@ <para> This is an integer or symbol designating where the instrument's notes are to appear on the staff. - The value is interpretted as if notated with a treble cleff signature. + The value is interpreted as if notated with a treble clef signature. See <function>EVENT-NOTE</function> in the <classname><link linkend="class.note">NOTE</link></classname> class for information on specifying notes with symbols. Index: fomus/doc/settings.xml diff -u fomus/doc/settings.xml:1.1.1.1 fomus/doc/settings.xml:1.2 --- fomus/doc/settings.xml:1.1.1.1 Tue Jul 19 20:17:03 2005 +++ fomus/doc/settings.xml Wed Jul 20 06:50:01 2005 @@ -253,7 +253,7 @@ <listitem> <para> This is a real number between <literal>0</literal> and <literal>1</literal> indicating the score for - finding note spellings that form augmented or dimished (rather than diatonic) intervals. + finding note spellings that form augmented or diminished (rather than diatonic) intervals. This value should probably be less than <varname><link linkend="acc.diatonic.int.score">ACC-DIATONIC-INT-SCORE</link></varname>. </para> @@ -265,7 +265,7 @@ <listitem> <para> This is a real number between <literal>0</literal> and <literal>1</literal> indicating the score for - spelling an ascending chromatic line with flats or a decending chromatic line with sharps. + spelling an ascending chromatic line with flats or a descending chromatic line with sharps. This value should probably be less than <varname><link linkend="acc.good.unison.score">ACC-GOOD-UNISON-SCORE</link></varname>. </para> @@ -521,7 +521,7 @@ <term><varname><anchor id="auto.distr.rests.fun"/>:AUTO-DISTR-RESTS-FUN</varname></term> <listitem> <para> - Designates which function is to be used for determining how rests are distributed amoung staves. + Designates which function is to be used for determining how rests are distributed among staves. Current possible values are <literal>:DEFAULT</literal> and <literal>:RESTS1</literal>. @@ -627,7 +627,7 @@ Floating point numbers are treated with the <function>RATIONALIZE</function> function in this case (this isn't recommended). - If offsets and durations of events aren't notatable then <application>FOMUS</application> will complain with an error. + If offsets and durations of events aren't "notatable" then <application>FOMUS</application> will complain with an error. Note that mark objects aren't quantized (see class <classname><link linkend="class.mark">MARK</link></classname> for details). </para> @@ -689,7 +689,7 @@ <term><varname><anchor id="auto.voicing"/>:AUTO-VOICING</varname></term> <listitem> <para> - If set to <literal>T</literal>, <application>FOMUS</application> automatically decides how to distribute notes amoung multiple voices, + If set to <literal>T</literal>, <application>FOMUS</application> automatically decides how to distribute notes among multiple voices, given the choices specified in the <classname>NOTE</classname>, <classname>REST</classname> and <classname>MARK</classname> objects. If set to <literal>NIL</literal>, the user must explicitly specify which voice an event belongs to. @@ -845,7 +845,7 @@ <listitem> <para> When set to <literal>T</literal>, the cautionary accidental algorithm considers the presence ottava brackets, placing - cautionary accidentals where apparant octave transpositions might cause confusion. + cautionary accidentals where apparent octave transpositions might cause confusion. </para> </listitem> </varlistentry> @@ -854,7 +854,7 @@ <term><varname><anchor id="check.ranges"/>:CHECK-RANGES</varname></term> <listitem> <para> - When set to <literal>T</literal>, activates a check that prints warnings if it finds notes out of range for their intruments. + When set to <literal>T</literal>, activates a check that prints warnings if it finds notes out of range for their instruments. The <structfield>MINP</structfield> and <structfield>MAXP</structfield> slots in the appropriate <classname>INSTR</classname> object must be set for this to have any effect. @@ -891,8 +891,8 @@ It affects how clef change decisions are made. - When notes require leger lines that can be avoided by a clef change, the algorithm will consider one if the number of - leger lines increases past a certain threshold (specified in the <structfield><link linkend="instr.cleflegls">CLEFLEGLS</link></structfield> slot of the + When notes require ledger lines that can be avoided by a clef change, the algorithm will consider one if the number of + ledger lines increases past a certain threshold (specified in the <structfield><link linkend="instr.cleflegls">CLEFLEGLS</link></structfield> slot of the <classname><link linkend="struct.instr">INSTR</link></classname> structure). If set to a number this setting will cause the algorithm to consider one anyways if it occurs for the specified duration. @@ -1205,7 +1205,7 @@ <listitem> <para> When set to <literal>T</literal> or <literal>:SOME</literal>, indicates that <application>FOMUS</application> hides some rests - when combining multiple voices in a grandstaff. + when combining multiple voices in a grand staff. This makes the notation easier to read for multi-staff instruments by eliminating rests that aren't necessary. @@ -1386,7 +1386,7 @@ This is a real number greater than <literal>0</literal>, specifying the minimum duration that a group of rests must occupy in order to be hidden. - Extra rests may be hidden when multiple voices are being combined in a grandstaff. + Extra rests may be hidden when multiple voices are being combined in a grand staff. </para> </listitem> </varlistentry> @@ -1430,7 +1430,7 @@ <term><varname><anchor id="parts"/>:PARTS</varname></term> <listitem> <para> - This is a list of <classname><link linkend="class.part">PART</link></classname> objects, each representing a stave or grandstaff in the score. + This is a list of <classname><link linkend="class.part">PART</link></classname> objects, each representing a stave or grand staff in the score. At least one part must be specified. </para> @@ -1505,7 +1505,7 @@ <para> This must be set to an integer greater or equal to <literal>100</literal>. - This value affects the performance of the search algorithm that decides how notes are distributed amoung staves. + This value affects the performance of the search algorithm that decides how notes are distributed among staves. A larger value will cause the algorithm to be slower but more accurate while a smaller value has the opposite affect. </para> @@ -1519,7 +1519,7 @@ This must be set to a real number between <literal>0</literal> and <literal>1</literal>. The value together with the value of <varname><link linkend="staff.importance.steps">STAFF-IMPORTANCE-STEPS</link></varname> - affects the performance of the algorithm that decides how notes are distributed amoung staves. + affects the performance of the algorithm that decides how notes are distributed among staves. As the algorithm searches ahead through possible paths, it regards previous paths as less important depending on how much farther the current best path is. @@ -1539,7 +1539,7 @@ This must be set to an integer greater than <literal>0</literal>. This value together with the value of <varname><link linkend="staff.importance.score">STAFF-IMPORTANCE-SCORE</link></varname> - affects the performance of the algorithm that decides how notes are distributed amoung staves. + affects the performance of the algorithm that decides how notes are distributed among staves. As the algorithm searches ahead through possible paths, it regards previous paths as less important depending on how much farther the current best path is. @@ -1651,7 +1651,7 @@ <varname><link linkend="cm.scale">CM-SCALE</link></varname> as if it were passed as the <literal>:IN</literal> argument to <application>CM</application>'s <function>KEYNUM</function> function. - Also, durations specified as symbols indicate notational durations and are interpretted + Also, durations specified as symbols indicate notational durations and are interpreted as such using <application>CM</application>'s <function>RHYTHM</function> function. Numbers are still interpreted by <application>FOMUS</application> in terms of beats. @@ -1727,7 +1727,7 @@ <listitem> <para> This is a real number between <literal>0</literal> and <literal>1</literal> indicating the penalty for too much - material occuring in one voice and not another. + material occurring in one voice and not another. </para> </listitem> </varlistentry> @@ -1778,7 +1778,7 @@ <para> This must be set to an integer greater or equal to <literal>100</literal>. - This value affects the performance of the search algorithm that decides how notes are distributed amoung voices. + This value affects the performance of the search algorithm that decides how notes are distributed among voices. A larger value will cause the algorithm to be slower but more accurate while a smaller value has the opposite affect. </para> @@ -1816,7 +1816,7 @@ <listitem> <para> This is a real number between <literal>0</literal> and <literal>1</literal> indicating the penalty for placing lower pitched notes - above higher pitched notes when distributing them amoung voices. + above higher pitched notes when distributing them among voices. </para> </listitem> </varlistentry> @@ -1828,7 +1828,7 @@ This must be set to a real number between <literal>0</literal> and <literal>1</literal>. The value together with the value of <varname><link linkend="voice.importance.steps">VOICE-IMPORTANCE-STEPS</link></varname> - affects the performance of the algorithm that decides how notes are distributed amoung voices. + affects the performance of the algorithm that decides how notes are distributed among voices. As the algorithm searches ahead through possible paths, it regards previous paths as less important depending on how much farther the current best path is. @@ -1848,7 +1848,7 @@ This must be set to an integer value greater than 0. The value together with the value of <varname><link linkend="voice.importance.score">VOICE-IMPORTANCE-SCORE</link></varname> - affects the performance of the algorithm that decides how notes are distributed amoung voices. + affects the performance of the algorithm that decides how notes are distributed among voices. As the algorithm searches ahead through possible paths, it regards previous paths as less important depending on how much farther the current best path is. @@ -1891,7 +1891,7 @@ <term><varname><anchor id="voice.leading.penalty"/>:VOICE-LEADING-PENALTY</varname></term> <listitem> <para> - This is a real number between <literal>0</literal> and <literal>1</literal> indicating the penalty for occurances of disjunct melodic lines + This is a real number between <literal>0</literal> and <literal>1</literal> indicating the penalty for occurrences of disjunct melodic lines and wide intervals in voices. This helps to insure that material in each voice is playable. @@ -1929,10 +1929,10 @@ <term><varname><anchor id="voice.simult.penalty"/>:VOICE-SIMULT-PENALTY</varname></term> <listitem> <para> - This is a real number between <literal>0</literal> and <literal>1</literal> indicating the penalty for simultaneous notes occuring in + This is a real number between <literal>0</literal> and <literal>1</literal> indicating the penalty for simultaneous notes occurring in one voice. - This causes chords to be distributed evenly amoung all voices. + This causes chords to be distributed evenly among all voices. </para> </listitem> </varlistentry>