~ubuntu-branches/ubuntu/karmic/rosegarden/karmic

« back to all changes in this revision

Viewing changes to docs/en/index.docbook

  • Committer: Bazaar Package Importer
  • Author(s): Stefan Ebner
  • Date: 2008-05-02 00:33:44 UTC
  • mfrom: (1.1.7 upstream) (6.1.1 lenny)
  • Revision ID: james.westby@ubuntu.com-20080502003344-67vbfhgqx2yl0ksi
Tags: 1:1.7.0-1ubuntu1
* Merge from Debian unstable. (LP: #225849) Remaining Ubuntu changes:
  - Add usr/share/doc/kde/HTML to rosegarden-data, to provide online
    help documentation.
  - Change fftw3-dev to libfftw3-dev.
  - Update maintainer field as per spec.

Show diffs side-by-side

added added

removed removed

Lines of Context:
245
245
      <author>
246
246
        <firstname>Guillaume</firstname>
247
247
        <surname>Laurent</surname>
 
248
        <firstname>D. Michael</firstname>
 
249
        <surname>McIntyre</surname>
 
250
        <firstname>Pedro</firstname>
 
251
        <surname>Lopez-Cabanillas</surname>
 
252
        <firstname>Heikki</firstname>
 
253
        <surname>Junes</surname>
248
254
      </author>
249
255
      <!-- TRANS:ROLES_OF_TRANSLATORS -->
250
256
    </authorgroup>
251
257
 
252
258
    <copyright>
253
 
      <year>2002-2007</year>
254
 
      <holder>Chris Cannam, Richard Bown, Guillaume Laurent</holder>
 
259
      <year>2002-2008</year>
 
260
      <holder>Chris Cannam, Richard Bown, Guillaume Laurent, D. Michael
 
261
      McIntyre, Pedro Lopez-Cabanillas, Heikki Junes</holder>
255
262
    </copyright>
256
263
 
257
 
    <date>2007-09-09</date>
258
 
    <releaseinfo>1.6.0</releaseinfo>
 
264
    <date>2008-05-05</date>
 
265
    <releaseinfo>1.7.0</releaseinfo>
259
266
 
260
267
    <abstract>
261
268
      <para>
313
320
      care to specify.  You can use Rosegarden to write, edit, and
314
321
      organise music to create a composition, which you can then
315
322
      synthesise, add effects to, and mix down for burning to CD or
316
 
      distribution on the web.  Rosegarden also contains professional
 
323
      distribution on the web.  Rosegarden also contains well-rounded 
317
324
      notation editing support for high quality printed output.
318
325
    </para>
319
326
 
619
626
          </menuchoice>
620
627
          function, and it
621
628
          features special <link linkend="nv-lilypond-directives">exportable
622
 
              directives</link> that provide access to LilyPond features for
 
629
              directives</link> and <link linkend="track-parameters">track
 
630
              parameters</link> that provide access to LilyPond features for
623
631
          which there is currently no parallel within &rosegarden;'s own
624
632
          native interface.
625
633
      </para>
629
637
            <guimenu lang="en">File</guimenu>
630
638
            <guimenuitem>Preview with LilyPond</guimenuitem>
631
639
          </menuchoice>
632
 
          function,  which exports the file into a temporary file and processes
 
640
          function, which exports the file into a temporary file and processes
633
641
          it directly with LilyPond for preview with a PDF viewer.
634
642
          If you are happy with the preview, you may print the score using the
635
 
          printing capability of the PDF viewer,  or use the 
 
643
          printing capability of the PDF viewer, or use the 
636
644
          <menuchoice>
637
645
            <guimenu lang="en">File</guimenu>
638
646
            <guimenuitem>Print with LilyPond</guimenuitem>
659
667
          <term>LilyPond version</term>
660
668
            <listitem><para>
661
669
                LilyPond version installed into the system should be automatically
662
 
                detected in the dialog,  but it is possible to export to any other
663
 
                LilyPond version since 2.6.  Historically,  LilyPond's syntax has
664
 
                changed somewhat over time,  but since LilyPond version 2.6 changes
 
670
                detected in the dialog, but it is possible to export to any other
 
671
                LilyPond version since 2.6.  Historically, LilyPond's syntax has
 
672
                changed somewhat over time, but since LilyPond version 2.6 changes
665
673
                have have been less radical and more maintainable.</para>
666
674
            </listitem>
667
675
        </varlistentry>
676
684
          <term>Font size</term>
677
685
            <listitem><para>
678
686
                Font size affects the size of the notes.  If you want to fit more
679
 
                staffs into the paper,  you should decrease the font size.</para>
 
687
                staffs into the paper, you should decrease the font size.</para>
680
688
            </listitem>
681
689
        </varlistentry>
682
690
        <varlistentry>
684
692
            <listitem><para>
685
693
                Export content concerns tracks that have segments in them, which
686
694
                are the tracks that are not empty.
687
 
                It is possible to export All tracks,  Non-muted tracks, the current
688
 
                Selected track,  or Selected segments.  If LilyPond export is
689
 
                launched from the Notation view,  Selected segments include
 
695
                It is possible to export All tracks, Non-muted tracks, the current
 
696
                Selected track, or Selected segments.  If LilyPond export is
 
697
                launched from the Notation view, Selected segments include
690
698
                the same selection which was used in opening the Notation view.</para>
691
699
            </listitem>
692
700
        </varlistentry>
697
705
                This options allows for example to make a piano score with 
698
706
                several independent voices.  You may give first three tracks
699
707
                name "Right" and three next tracks "Left" and then merge
700
 
                them in LilyPond export.  Sometimes you may encounter notes that
701
 
                overlap in printed from,  you may avoid them by selecting one
702
 
                of the collapsing notes and fine adjust its position in
703
 
                Notation view function
 
708
                them in LilyPond export.  (This provides an easier way to manage
 
709
                overlapping segments with the price that the top and bottom
 
710
                parts will have different names on the page.  If you wish both
 
711
                of them to be named, eg. "Piano," then you will have to keep all
 
712
                of the segments on the same pair of staffs. Consult <ulink
 
713
                url="http://rosegarden.sourceforge.net/tutorial/supplemental/piano/">Piano
 
714
                by Example</ulink> for a hands-on demonstration of this.) <!--
 
715
                this comment makes absolutely no sense to me(dmm):   Sometimes you
 
716
                may encounter notes that overlap in printed form, you may avoid
 
717
                them by selecting one of the collapsing notes and fine adjust
 
718
                its position in Notation view function -->
704
719
          <menuchoice>
705
720
            <guimenu lang="en">Adjust</guimenu>
706
721
            <guimenuitem>Fine Positioning</guimenuitem>
712
727
          <term>Export tempo marks</term>
713
728
            <listitem><para>
714
729
                Tempo marks are not exported by default.  If tempo changes
715
 
                rarely,  you may want to export all tempo marks,  but if
716
 
                tempo changes too often,  you may eport only the first mark.</para>
 
730
                rarely, you may want to export all tempo marks, but if
 
731
                tempo changes too often, you may export only the first mark.</para>
717
732
            </listitem>
718
733
        </varlistentry>
719
734
        <varlistentry>
722
737
                <link linkend="nv-text-lyrics">Lyrics</link> is exported if this
723
738
                option is checked.  Text is entered in Unicode, which
724
739
                makes it possible to enter lyrics in all languages.  Multiple
725
 
                lines of lyrics per staff is also possible,  see the section
726
 
                on <link linkend="nv-text-lyrics">Editign lyrics</link>.</para>
 
740
                lines of lyrics per staff is also possible, see the section
 
741
                on <link linkend="nv-text-lyrics">Editing lyrics</link>.</para>
727
742
            </listitem>
728
743
        </varlistentry>
729
744
        <varlistentry>
730
745
          <term>Export beamings</term>
731
746
            <listitem><para>
732
747
                <link linkend="nv-beamed-groups">Beams</link> defined in
733
 
                &rosegarden; can be exported,  or the default
 
748
                &rosegarden; can be exported, or the default
734
749
                beam grouping of LilyPond can be used.  Future versions
735
750
                of &rosegarden; may support nested note grouping.</para>
736
751
            </listitem>
737
752
        </varlistentry>
738
 
        <varlistentry>
 
753
<!-- deprecated
 
754
        <varlistentry>
739
755
          <term>Add staff group bracket</term>
740
756
            <listitem><para>
741
757
                Staff group bracket may be added to cover all staffs.
742
758
                Future versions of &rosegarden; may support nested staff
743
759
                groupings.</para>
744
760
            </listitem>
745
 
        </varlistentry>
 
761
        </varlistentry> -->
746
762
        <varlistentry>
747
763
          <term>Lyrics alignment</term>
748
764
            <listitem><para>
749
765
                Lyrics is aligned Left by default.  Sometimes Center or
750
 
                Right alignment provides results in more pleasant output.</para>
 
766
                Right alignment provides results and more pleasant output.</para>
751
767
            </listitem>
752
768
        </varlistentry>
753
769
        <varlistentry>
754
770
          <term>Ragged bottom</term>
755
771
            <listitem><para>
756
 
                The staff cover the whole page from the top to the bottom.
757
 
                When there are only few staff,  Ragged bottom places the
758
 
                extra vertical space to the bottom of the page instead.</para>
 
772
                The staffs normally cover the whole page from top to bottom.
 
773
                When there are only a few staffs, this option places the
 
774
                extra vertical space at the bottom of the page instead.</para>
759
775
            </listitem>
760
776
        </varlistentry> <varlistentry>
761
777
          <term>Enable "point-and-click" debugging</term>
766
782
            <guimenuitem>Export</guimenuitem>
767
783
            <guimenuitem>Export LilyPond</guimenuitem>
768
784
          </menuchoice>
769
 
                function,  you may open the LilyPond source by clicking
 
785
                function, you may open the LilyPond source by clicking
770
786
                notes in the PDF output.  Consult <ulink url="  http://lilypond.org/doc/v2.10/Documentation/user/lilypond/Point-and-click#Point-and-click">LilyPond documentation</ulink> for more
771
787
                information.
772
788
</para>
774
790
        </varlistentry> <varlistentry>
775
791
          <term>Export \midi block</term>
776
792
            <listitem><para>
777
 
                LilyPond is capable to produce also MIDI output.  Check this
 
793
                LilyPond is also capable of producing MIDI output.  Check this
778
794
                option if you wish the LilyPond source to use this option.
779
795
                Note however that MIDI output which you obtain via &rosegarden;
780
796
                sequencer, via
783
799
            <guimenuitem>Export</guimenuitem>
784
800
            <guimenuitem>Export MIDI file</guimenuitem>
785
801
          </menuchoice>,
786
 
                and via LilyPond's MIDI output may differ.</para>
 
802
                and via LilyPond's MIDI output may differ considerably.</para>
787
803
            </listitem>
788
804
        </varlistentry> <varlistentry>
789
805
          <term>Headers</term>
966
982
    </sect1>
967
983
    <sect1 id="segment-view-creating">
968
984
      <title>Creating segments</title>
 
985
 
969
986
      <para>
970
987
        To create an empty segment, in order to begin composing
971
988
        something new, you need to use the pencil tool (which is normally the
977
994
        and drag rightwards until the segment is the right number of
978
995
        bars long.
979
996
      </para>
 
997
 
 
998
      <para>You can also create segments using the <link
 
999
      linkend="segment-view-selector">Select tool</link>, by clicking
 
1000
      and dragging either with the middle mouse button, or with the
 
1001
      left button and Ctrl held down.</para>
 
1002
 
 
1003
 
980
1004
      <para>If you want to draw a segment longer than the visible
981
1005
        portion of the canvas, the canvas will scroll automatically once you
982
1006
        reach its edge.  If you keep dragging past the end of the entire
983
1007
        composition, you can keep dragging, and will push the end marker right along
984
 
        with you.  (This is a welcome contrast to earlier version of
 
1008
        with you.  (This is a welcome contrast to earlier versions of
985
1009
        &rosegarden;.)
986
1010
      </para>
987
1011
 
991
1015
        holding down Shift while clicking and dragging.
992
1016
      </para>
993
1017
 
994
 
      <para>New segments are created in a green colour, with a treble clef by
 
1018
      <para>New segments are created in a yellow colour, with a treble clef by
995
1019
          default.  You may wish to jump ahead and have a look at <link
996
1020
              linkend="track-parameters">track parameters</link> to explore
997
1021
          other possibilities.
998
1022
      </para>
999
1023
 
 
1024
      <para>If you wish to draw a segment that begins in the middle of an
 
1025
      existing segment, hold Ctrl and Alt when clicking.  The track will
 
1026
      automatically expand to accommodate this new segment.  This is especially
 
1027
      useful for some situations involving music notation.
 
1028
      </para>
 
1029
 
1000
1030
      <para>
1001
1031
        Once you have created a segment, you can then begin editing
1002
1032
        using the <link linkend="matrix-view">matrix</link>, <link linkend="percussion-matrix-view">percussion matrix</link> or <link
1108
1138
        </para>
1109
1139
 
1110
1140
        <para>To move segments with the select tool, simply click and
1111
 
          drag on the segment.  To create copies, click and drag with
1112
 
          Ctrl held down.  To resize a segment, click and drag on the
1113
 
          right-hand edge of the segment; and to create new segments,
1114
 
          click and drag on an empty area with the middle mouse button.
1115
 
        </para>
 
1141
        drag on the segment.  To create copies, click and drag with
 
1142
        Ctrl held down.  To resize a segment, click and drag on the
 
1143
        right-hand edge of the segment.  To create new segments, click
 
1144
        and drag on an empty area either with the middle mouse button
 
1145
        or with the left mouse button and Ctrl held down.</para>
1116
1146
 
1117
1147
        <para>
1118
1148
          The select tool doesn't replace the other tools completely,
1507
1537
        pressed.</para>
1508
1538
      </sect2>
1509
1539
 
 
1540
      <sect2 id="quick_marker">
 
1541
    <title>Quick Marker</title>
 
1542
 
 
1543
    <para>The quick marker is a special moment in time that can be defined
 
1544
    on the fly with a single key (by default Ctrl-1) from the main window
 
1545
    (track editor). Once defined it appears as a red line in the loop ruler 
 
1546
    (it does not appear among other markers, since it does not have a label).
 
1547
    At any time when in the track editor you can jump to the quick marker
 
1548
    position with a single key (by default simply 1).
 
1549
    <screenshot>
 
1550
      <mediaobject>
 
1551
        <imageobject>
 
1552
          <imagedata fileref="rg-quickmarker.png" format="PNG"/>
 
1553
      </imageobject>
 
1554
    <textobject>
 
1555
      <phrase>Quick Marker at the start of the third bar</phrase>
 
1556
    </textobject>
 
1557
      </mediaobject>
 
1558
      </screenshot>
 
1559
    </para>
 
1560
    
 
1561
    <para>A typical use of the quick marker is when you want to record the same bars
 
1562
    on different instruments: after setting the quick marker at the first bar of 
 
1563
    the working interval, it is easy to jump to the quick marker each time you need
 
1564
    to record a new part.</para>
 
1565
    
 
1566
    <para>Note that the quick marker position is not saved in your &rosegarden; file.</para>
 
1567
      </sect2>
 
1568
      
1510
1569
      <sect2 id="ranges-loops">
1511
1570
        <title>Ranges and loops</title>
1512
1571
        <para>
2747
2806
    <para>
2748
2807
        It allows you to assign instruments to tracks, control what
2749
2808
        incoming &MIDI; data from which sources will be recorded to
2750
 
        particular tracks, and make selections that govern how &MIDI; segments
 
2809
        particular tracks, control staff attributes (currently only for LilyPond
 
2810
        export,) make selections that govern how &MIDI; segments
2751
2811
        will be created for each track that is assigned to a non-audio
2752
 
        instrument.
 
2812
        instrument, and apply these selections to existing segments (as when
 
2813
        converting a trumpet part from an imported &MIDI; file to be
 
2814
        represented as notation playable by a real human on a real instrument,
 
2815
        for example.)
2753
2816
    </para>
2754
2817
    <para>This box is divided into three sections:</para>
2755
2818
        <sect2 id="track-playback-parameters">
2786
2849
                The recording filters are also used to <link linkend="studio-midi-routing">route MIDI events </link> to the assigned track instrument when you are recording.
2787
2850
             </para>
2788
2851
        </sect2>
 
2852
        <sect2 id="track-staff-params">
 
2853
            <title>Staff export options</title>
 
2854
            <para>
 
2855
                These provide you with a means of exporting notation to render
 
2856
                at either normal, small, or tiny size (eg. for printing certain
 
2857
                parts at cue size,) and allow you to export a variety of nested
 
2858
                brackets.
 
2859
           </para>
 
2860
           <para>
 
2861
                You are responsible for creating a series of bracket start and
 
2862
                end markers that will yield a functional result, and if you make
 
2863
                a mistake with these, it is likely that your file will not
 
2864
                export or preview correctly in LilyPond.
 
2865
           </para>
 
2866
           <para>For a detailed, hands-on demonstration of brackets in action,
 
2867
           please see
 
2868
           <ulink url="http://rosegarden.sourceforge.net/tutorial/supplemental/fidelio/fidelio.html">this
 
2869
           online tutorial.</ulink>
 
2870
           </para>
 
2871
        </sect2>
2789
2872
        <sect2 id="track-create-with">
2790
2873
            <title>Create segments with</title>
2791
2874
            <para>
2812
2895
                                launches a dialog that allows you to pick
2813
2896
                                a pre-defined collection of parameters
2814
2897
                                that provide guidelines for how you should
2815
 
                                write parts for real-world instruments.
 
2898
                                write parts for real-world instruments, and
 
2899
                                optionally convert any existing segments on this
 
2900
                                track to take on these new parameters.
 
2901
                                <!-- needs a tutorial somewhere, and a link to
 
2902
                                that tutorial DMM -->
2816
2903
                            </para>
2817
2904
                            <para>
2818
2905
                            <inlinemediaobject>
2822
2909
                            </inlinemediaobject>
2823
2910
                            </para>
2824
2911
                            <para>
2825
 
                                You first pick a Category, then an
2826
 
                                Instrument, and finally choose whether you
2827
 
                                wish to write a part for an amateur or a
2828
 
                                professional player. <footnote><para>This database was
2829
 
                                compiled by Magnus Johansson, who deserves
2830
 
                                all the special mention we can muster for
2831
 
                                his outstanding effort on this.</para></footnote>
 
2912
                                You first pick a Category, then an Instrument,
 
2913
                                and finally choose whether you wish to write a
 
2914
                                part for an amateur or a professional player.
 
2915
                                <footnote><para>This database was compiled by
 
2916
                                Magnus Johansson, who deserves all the special
 
2917
                                mention we can muster for his outstanding effort
 
2918
                                on this.</para></footnote> The Scope controls
 
2919
                                allow you to choose whether these parameters
 
2920
                                will only affect segments that don't yet exist
 
2921
                                (which you will subsequently record, or draw
 
2922
                                with the pencil) or should convert any existing
 
2923
                                segments to take these parameters as well.  (For
 
2924
                                a demonstration of the latter case in action,
 
2925
                                please see
 
2926
                                <ulink url="http://rosegarden.sourceforge.net/tutorial/supplemental/fidelio/fidelio.html">
 
2927
                                this online tutorial.)</ulink>
2832
2928
                                Clicking the <guimenuitem>OK</guimenuitem>
2833
 
                                button injects the appropriate parameters
2834
 
                                into the remaining widgets in this part of
2835
 
                                the track parameters box, where you can
2836
 
                                tweak them if you desire.<footnote><para>No
2837
 
                                    facility is provided at this time for
2838
 
                                    assembling your own database of presets,
2839
 
                                    or customizing the existing ones in a
2840
 
                                    permanent way.</para></footnote>
2841
 
                            </para>
 
2929
                                button injects the appropriate parameters into
 
2930
                                the remaining widgets in this part of the track
 
2931
                                parameters box, where you can tweak them if you
 
2932
                                desire.<footnote><para>No facility is provided
 
2933
                                at this time for assembling your own database of
 
2934
                                presets, or customizing the existing ones in a
 
2935
                                permanent way.</para></footnote> </para>
2842
2936
                            <para>
2843
2937
                                Once you have loaded a preset, the name of
2844
2938
                                your chosen preset will be used as the label
3461
3555
        corresponding to the distance you drag before releasing the
3462
3556
        mouse button.</para>
3463
3557
 
 
3558
        <para>You can also draw notes using the Select tool (the
 
3559
        arrow), by clicking and dragging either with the middle mouse
 
3560
        button, or with the left mouse button and Ctrl pressed.</para>
 
3561
 
3464
3562
      <para>By default, the time and duration are snapped to a
3465
3563
        particular grid unit, according to the Grid setting on the
3466
3564
        View menu or the toolbar.  You can prevent this effect by
3661
3759
        and paste functions.  After the paste the pasted notes will
3662
3760
        be selected instead, and you can then drag them wherever you
3663
3761
        need them.  You may also copy notes by selecting them with
3664
 
        the Select tool,  then keeping Ctrl pressed click-and-drag
 
3762
        the Select tool, then keeping Ctrl pressed click-and-drag
3665
3763
        the selected notes in a new position.
3666
3764
      </para>
3667
3765
    </sect1>
4065
4163
              used. Some of them (such as <guimenuitem>Cut</guimenuitem> 
4066
4164
              or the <guimenuitem>Note Style</guimenuitem>
4067
4165
              functions) will operate on any selected events; others
4068
 
              (such as the <guimenuitem>Grace Notes</guimenuitem> 
4069
 
              or <guimenuitem>Stem Directions</guimenuitem> functions)
 
4166
              (<guimenuitem>Stem Directions</guimenuitem> function)
4070
4167
              will refuse to work unless the selection contains 
4071
4168
              some notes.
4072
4169
            </para>
4759
4856
          You may always attach one more verse into a single staff
4760
4857
          by clicking Add Verse in the lyrics editor.  All the verses
4761
4858
          are entered with the same syntax.  If you leave the last verse
4762
 
          without syllables,  or make it empty,  it is removed from
 
4859
          without syllables, or make it empty, it is removed from
4763
4860
          the list of verses next time you open the lyrics editor.
4764
4861
          </para>
4765
4862
 
5268
5365
          </para>
5269
5366
        </sect3>
5270
5367
 
 
5368
        <sect3 id="nv-rescale">
 
5369
          <title>Rescaling note durations</title>
 
5370
          <para>The 
 
5371
          <menuchoice> <guimenu>Adjust</guimenu>
 
5372
          <guimenuitem>Rescale</guimenuitem> <guimenuitem>Halve
 
5373
          Durations</guimenuitem> </menuchoice> and
 
5374
          <menuchoice> <guimenu>Adjust</guimenu>
 
5375
          <guimenuitem>Rescale</guimenuitem> <guimenuitem>Double
 
5376
          Durations</guimenuitem> </menuchoice> functions can be
 
5377
          used to perform the most simple rescaling functions.
 
5378
          </para>
 
5379
 
 
5380
          <para>For more elaborate rescalings, use the
 
5381
          <menuchoice> <guimenu>Adjust</guimenu>
 
5382
          <guimenuitem>Rescale</guimenuitem> <guimenuitem>Stretch
 
5383
          or Squash...</guimenuitem> </menuchoice> function with
 
5384
          which you scale the total lenth of the selection.
 
5385
          </para>
 
5386
        </sect3>
 
5387
 
5271
5388
<!-- need a proper section for this and diatonic transpose
5272
5389
            <varlistentry id="nv-transpose">
5273
5390
            <title>Transpose</title>
6588
6705
        <listitem>
6589
6706
          <para>
6590
6707
 
6591
 
            Rosegarden is Copyright 2000-2007 Guillaume Laurent,
 
6708
            Rosegarden is Copyright 2000-2008 Guillaume Laurent,
6592
6709
            Chris Cannam and Richard Bown.  The moral rights of
6593
6710
            Guillaume Laurent, Chris Cannam and Richard Bown to be
6594
6711
            identified as the authors of this work have been asserted.
6673
6790
      <title>Rosegarden Revision History</title>
6674
6791
      <para>
6675
6792
        <itemizedlist>
 
6793
          <listitem><para>
 
6794
              1.7.0 &ndash; May 2008: notation track headers, nested brackets in
 
6795
              LilyPond export, grace notes finally functional, quick playback
 
6796
              position marker, ties can be flipped, variable-height tracks allow
 
6797
              access to all previously overlapping segments, take track
 
6798
              transpose into account while recording, convert existing segments
 
6799
              when loading an instrument preset, etc., bug fixes galore
 
6800
          </para></listitem>
6676
6801
          <listitem><para>
6677
6802
              1.6.0 &ndash; November 2007: fretboards, diatonic transpose, multiple lines of lyrics, marker ruler improvements, overlapping notes visibility, LilyPond export enhancements and new dialog, better infrared remote control support, better configuration dialog, fixes
6678
6803
          </para></listitem>