/[svn]/jsampler/trunk/manual/docbook/jsampler.xml
ViewVC logotype

Diff of /jsampler/trunk/manual/docbook/jsampler.xml

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1582 by iliev, Mon Oct 15 20:55:33 2007 UTC revision 1583 by iliev, Sat Dec 8 13:13:20 2007 UTC
# Line 22  Line 22 
22        url="gfdl.html">GNU Free Documentation License</ulink>.</para>        url="gfdl.html">GNU Free Documentation License</ulink>.</para>
23      </legalnotice>      </legalnotice>
24    
25      <pubdate>Updated: Fri, 10 August 2007</pubdate>      <pubdate>Updated: Sat, 8 December 2007</pubdate>
26    </bookinfo>    </bookinfo>
27    
28    <chapter>    <chapter id="INTRODUCTION">
29      <title>Introduction</title>      <title>Introduction</title>
30    
31      <section>      <section id="WHAT_IS_JSAMPLER">
32        <title>What is JSampler?</title>        <title>What is JSampler?</title>
33    
34        <para>JSampler is an opensource, platform-independent, GUI front-end for        <para>JSampler is an opensource, platform-independent, GUI front-end for
# Line 57  Line 57 
57        different display requirements and limitations.</para>        different display requirements and limitations.</para>
58      </section>      </section>
59    
60      <section>      <section id="WHAT_IS_JSAMPLER_DISTRIBUTION">
61        <title>What is a JSampler distribution?</title>        <title>What is a JSampler distribution?</title>
62    
63        <para>A JSampler distribution consist of the JSampler core and at least        <para>A JSampler distribution consist of the JSampler core and at least
# Line 82  Line 82 
82      </section>      </section>
83    </chapter>    </chapter>
84    
85    <chapter>    <chapter id="SCREENSHOTS">
86      <title>Screenshots</title>      <title>Screenshots</title>
87    
88      <para>JS Classic with left pane, LS console, statusbar and toolbars</para>      <para>JS Classic with left pane, LS console, statusbar and toolbars</para>
# Line 102  Line 102 
102      fileref="images/fantasia-preview.png" /></ulink></para>      fileref="images/fantasia-preview.png" /></ulink></para>
103    </chapter>    </chapter>
104    
105    <chapter>    <chapter id="INSTALLATION">
106      <title>Installation</title>      <title>Installation</title>
107    
108      <para></para>      <para></para>
109    
110      <section id="download">      <section id="DOWNLOAD">
111        <title>What to download?</title>        <title>What to download?</title>
112    
113        <para>Currently, there are two distributions available for download -        <para>Currently, there are two distributions available for download -
114        <ulink        <ulink
115        url="http://downloads.sourceforge.net/jsampler/JS_Classic-0.7a.jar">JS        url="http://downloads.sourceforge.net/jsampler/JS_Classic-0.8a.jar">JS
116        Classic</ulink> and <ulink        Classic</ulink> and <ulink
117        url="http://downloads.sourceforge.net/jsampler/Fantasia-0.7a.jar">Fantasia</ulink>.</para>        url="http://downloads.sourceforge.net/jsampler/Fantasia-0.8a.jar">Fantasia</ulink>.</para>
118    
119        <para>The source code is available in the <ulink        <para>The source code is available in the <ulink
120        url="http://downloads.sourceforge.net/jsampler/JSampler-0.7a.tar.bz2">JSampler        url="http://downloads.sourceforge.net/jsampler/JSampler-0.8a.tar.bz2">JSampler
121        package</ulink>, which also contains this manual and startup scripts        package</ulink>, which also contains this manual and startup scripts
122        that can be used to run a particular JSampler distribution.</para>        that can be used to run a particular JSampler distribution.</para>
123    
# Line 129  Line 129 
129        jsampler</command></para>        jsampler</command></para>
130      </section>      </section>
131    
132      <section id="requirements">      <section id="REQUIREMENTS">
133        <title lang="" xreflabel="">Requirements</title>        <title lang="" xreflabel="">Requirements</title>
134    
135        <para>To run JSampler you need Java Runtime Environment (JRE) version 6        <para>To run JSampler you need Java Runtime Environment (JRE) version 6
# Line 141  Line 141 
141        tool</ulink>.</para>        tool</ulink>.</para>
142      </section>      </section>
143    
144      <section id="running-js-dist">      <section id="RUNNING_JSAMPLER">
145        <title>Running a JSampler distribution</title>        <title>Running a JSampler distribution</title>
146    
147        <para>Let's assume that you want to run from the command line        <para>Let's assume that you want to run from the command line
148        <code>JS_Classic-0.6a.jar</code>, which is located in        <code>JS_Classic-0.8a.jar</code>, which is located in
149        <code>/home/me/soft</code> directory. First you should check whether the        <code>/home/me/soft</code> directory. First you should check whether the
150        <code>java</code> command is in your path and the version requirements        <code>java</code> command is in your path and the version requirements
151        are met. This can be done by issuing the following command:</para>        are met. This can be done by issuing the following command:</para>
# Line 156  Line 156 
156        issuing the following command:</para>        issuing the following command:</para>
157    
158        <para><command>java -jar        <para><command>java -jar
159        /home/me/soft/JS_Classic-0.6a.jar</command></para>        /home/me/soft/JS_Classic-0.8a.jar</command></para>
160    
161        <para>Otherwise, if the shell response is something like</para>        <para>Otherwise, if the shell response is something like</para>
162    
# Line 184  locate bin/java</command></literallayout Line 184  locate bin/java</command></literallayout
184        Classic issue the following command:</para>        Classic issue the following command:</para>
185    
186        <para><command>/opt/jdk1.6.0/bin/java -jar        <para><command>/opt/jdk1.6.0/bin/java -jar
187        /home/me/soft/JS_Classic-0.6a.jar</command></para>        /home/me/soft/JS_Classic-0.8a.jar</command></para>
188    
189        <para><note>        <para><note>
190            <para>On some systems double clicking on the jar file will be            <para>On some systems double clicking on the jar file will be
# Line 192  locate bin/java</command></literallayout Line 192  locate bin/java</command></literallayout
192          </note></para>          </note></para>
193      </section>      </section>
194    
195      <section>      <section id="USING_SCRIPT">
196        <title>Using a script to run a JSampler distribution</title>        <title>Using a script to run a JSampler distribution</title>
197    
198        <para>There are scripts In the <code>scripts</code> directory of the        <para>There are scripts In the <code>scripts</code> directory of the
199        <ulink        <ulink
200        url="http://downloads.sourceforge.net/jsampler/JSampler-0.7a.tar.bz2">JSampler        url="http://downloads.sourceforge.net/jsampler/JSampler-0.8a.tar.bz2">JSampler
201        package</ulink> that, with a little adjustments (if needed), can be used        package</ulink> that, with a little adjustments (if needed), can be used
202        to run a JSampler distribution. Copy them to a desired location and edit        to run a JSampler distribution. Copy them to a desired location and edit
203        with your preferred editor.</para>        with your preferred editor.</para>
204      </section>      </section>
205    
206      <section>      <section id="GNOME_JAR_ASSOCIATIONS">
207        <title>Telling Gnome how to handle jar files</title>        <title>Telling Gnome how to handle jar files</title>
208    
209        <para>This configuration is optional, but necessary if you want to run        <para>This configuration is optional, but necessary if you want to run
# Line 228  locate bin/java</command></literallayout Line 228  locate bin/java</command></literallayout
228        <para><graphic fileref="images/add-application.png" /></para>        <para><graphic fileref="images/add-application.png" /></para>
229      </section>      </section>
230    
231      <section>      <section id="GNOME_LAUNCHER">
232        <title>Adding an application launcher to a Gnome panel</title>        <title>Adding an application launcher to a Gnome panel</title>
233    
234        <para>To add an application launcher to a Gnome panel, right click on        <para>To add an application launcher to a Gnome panel, right click on
# Line 241  locate bin/java</command></literallayout Line 241  locate bin/java</command></literallayout
241        <guilabel>Command</guilabel> field, of the <guilabel>Create        <guilabel>Command</guilabel> field, of the <guilabel>Create
242        Launcher</guilabel> dialog, fill in the exact command that you use to        Launcher</guilabel> dialog, fill in the exact command that you use to
243        run the JSampler. For more information on how to run a JSampler        run the JSampler. For more information on how to run a JSampler
244        distribution from the command line <link linkend="running-js-dist">click        distribution from the command line <link
245        here</link>.</para>        linkend="RUNNING_JSAMPLER">click here</link>.</para>
246    
247        <para><graphic        <para><graphic
248        fileref="images/add-to-panel-create-launcher.png" /></para>        fileref="images/add-to-panel-create-launcher.png" /></para>
249      </section>      </section>
250    
251      <section>      <section id="RUNING_ON_WINDOWS">
252        <title>Running JSampler on Windows</title>        <title>Running JSampler on Windows</title>
253    
254        <para>To run JSampler distribution on Windows, put a shortcut on the        <para>To run JSampler distribution on Windows, put a shortcut on the
# Line 260  locate bin/java</command></literallayout Line 260  locate bin/java</command></literallayout
260      </section>      </section>
261    </chapter>    </chapter>
262    
263    <chapter>    <chapter id="BUILDING_FROM_SOURCE">
264      <title>Building from source</title>      <title>Building from source</title>
265    
266      <para>If you want to build a JSampler distribution from source, first make      <para>If you want to build a JSampler distribution from source, first make
267      sure that all <link linkend="requirements">requirements</link> are      sure that all <link linkend="REQUIREMENTS">requirements</link> are
268      met.</para>      met.</para>
269    
270      <section>      <section id="BUILDING_FROM_CVS">
271        <title>Building from CVS</title>        <title>Building from CVS</title>
272    
273        <para>When building from CVS, there are some additional steps that        <para>When building from CVS, there are some additional steps that
# Line 292  locate bin/java</command></literallayout Line 292  locate bin/java</command></literallayout
292        directory:</para>        directory:</para>
293    
294        <para><literallayout><command>cd /home/me/soft        <para><literallayout><command>cd /home/me/soft
295  wget -c http://downloads.sourceforge.net/jlscp/jlscp-0.5a.tar.bz2  wget -c http://downloads.sourceforge.net/jlscp/jlscp-0.7a.tar.bz2
296  tar -xjf jlscp-0.5a.tar.bz2  tar -xjf jlscp-0.7a.tar.bz2
297  wget -c http://downloads.sourceforge.net/juife/juife-0.4a.tar.bz2  wget -c http://downloads.sourceforge.net/juife/juife-0.4a.tar.bz2
298  tar -xjf juife-0.4a.tar.bz2  tar -xjf juife-0.4a.tar.bz2
299  cvs -z3 -d:pserver:anonymous@cvs.linuxsampler.org:/var/cvs/linuxsampler co jsampler  cvs -z3 -d:pserver:anonymous@cvs.linuxsampler.org:/var/cvs/linuxsampler co jsampler
# Line 305  cp ../juife-0.4a/lib/juife.jar lib/requi Line 305  cp ../juife-0.4a/lib/juife.jar lib/requi
305        <para>Then follow the steps in the next section.</para>        <para>Then follow the steps in the next section.</para>
306      </section>      </section>
307    
308      <section>      <section id="COMPILATION">
309        <title>Compilation</title>        <title>Compilation</title>
310    
311        <para>To build a JSampler distribution, first set the        <para>To build a JSampler distribution, first set the
# Line 367  cp ../juife-0.4a/lib/juife.jar lib/requi Line 367  cp ../juife-0.4a/lib/juife.jar lib/requi
367        desired location.</para>        desired location.</para>
368      </section>      </section>
369    </chapter>    </chapter>
370    
371      <chapter id="USING_ORCHESTRAS">
372        <title>Using Orchestras</title>
373    
374        <para>Orchestras feature is like bookmarks/favorites for instruments.
375        Instead of having a thousands of unsorted instruments you can categorize
376        your most used instruments for quick access by adding them to orchestras.
377        You can create an arbitrary number of orchestras and in any orchestra you
378        can add an arbitrary number of instruments.<note>
379            <para>Orchestras are not handled by the back-end (LinuxSampler) and
380            does not depend on the <guilabel>Instruments Database</guilabel>. The
381            orchestras are handled by JSampler and are stored on the local machine
382            in <code>&lt;jsampler-home&gt;/orchestras.xml</code>. To port the
383            orchestras to another machine just copy that file.</para>
384          </note></para>
385    
386        <section id="MANAGING_ORCHESTRAS">
387          <title>Managing Orchestras</title>
388    
389          <para>Tool buttons:</para>
390    
391          <para><inlinegraphic fileref="images/new16.png" /> <guilabel>Create new
392          orchestra</guilabel></para>
393    
394          <para><inlinegraphic fileref="images/edit16.png" /> <guilabel>Edit
395          selected orchestra</guilabel></para>
396    
397          <para><inlinegraphic fileref="images/delete16.png" /> <guilabel>Remove
398          selected orchestra</guilabel></para>
399    
400          <para>To create a new orchestra, click on the
401          <guilabel>Orchestras</guilabel> tab then click the <guibutton>Create new
402          orchestra</guibutton> button in the <guilabel>Manage
403          Orchestras</guilabel> tool:</para>
404    
405          <para><graphic align="center" fileref="images/new-orchestra.png" />Then
406          choose orchestra name and description and click
407          <guibutton>OK</guibutton> button. </para>
408    
409          <para>To remove an orchestra, select the orchestra and click the
410          <guibutton>Remove selected orchestra</guibutton> button. To edit an
411          orchestra, select the orchestra and click the <guibutton>Edit selected
412          orchestra</guibutton> button, or just double-click the orchestra to
413          edit.<tip>
414              <para>To change the position of an orchestra in the orchestra list,
415              select the orchestra and use <guilabel>Alt+Up Arrow</guilabel> and
416              <guilabel>Alt+Down Arrow</guilabel> to move the selected orchestra
417              up/down. You can also use <guilabel>Alt+Shift+Up Arow</guilabel> to
418              move the selected orchestra on top and <guilabel>Alt+Shift+Down
419              Arrow</guilabel> to move the selected orchestra to bottom.</para>
420            </tip></para>
421    
422          <para></para>
423        </section>
424    
425        <section id="MANAGING_INSTRUMENTS">
426          <title>Managing Instruments</title>
427    
428          <para>Tool buttons:</para>
429    
430          <para><inlinegraphic fileref="images/new16.png" /> <guilabel>Add new
431          instrument</guilabel></para>
432    
433          <para><inlinegraphic fileref="images/edit16.png" /> <guilabel>Edit
434          selected instrument</guilabel></para>
435    
436          <para><inlinegraphic fileref="images/delete16.png" /> <guilabel>Remove
437          selected instrument</guilabel></para>
438    
439          <para>To add a new instrument to orchestra, first select the desired
440          orchestra from the combobox then click the <guilabel>Add new
441          instrument</guilabel> button:</para>
442    
443          <para><graphic align="center"
444          fileref="images/add-instrument-to-orchestra.png" /><tip>
445              <para>The easiest way to add an instrument to orchestra is to
446              right-click an instrument in the <guilabel>Instruments
447              Database</guilabel>, then select <guimenu>Add To Orchestra</guimenu>
448              and choose the orchestra to which to add the selected instrument.
449              Note that you can select and add more than one instrument to
450              orchestra at once.</para>
451            </tip>To remove an instrument, select the instrument and click the
452          <guibutton>Remove selected instrument</guibutton> button. To edit an
453          instrument, select the instrument and click the <guibutton>Edit selected
454          instrument</guibutton> button, or just double-click the instrument to
455          edit.<tip>
456              <para>To change the position of an instrument in the instrument
457              list, select the instrument and use <guilabel>Alt+Up
458              Arrow</guilabel> and <guilabel>Alt+Down Arrow</guilabel> to move the
459              selected instrument up/down. You can also use <guilabel>Alt+Shift+Up
460              Arow</guilabel> to move the selected instrument on top and
461              <guilabel>Alt+Shift+Down Arrow</guilabel> to move the selected
462              instrument to bottom.</para>
463            </tip></para>
464        </section>
465    
466        <section id="LOADING_ORCHESTRA_INSTRUMENTS">
467          <title>Loading Instruments</title>
468    
469          <para>To load an instrument from orchestra to a sampler channel,
470          right-click on the instrument, select <guimenu>Load
471          Instrument</guimenu>, then choose on which channel to load the selected
472          instrument. You can also load an instrument from orchestra to a sampler
473          channel using the instrument chooser of the sampler channel - click
474          <guilabel>Select instrument from orchestra</guilabel> radio button,
475          choose orchestra and isntrument from the comboboxes and click
476          <guibutton>OK</guibutton> button.</para>
477        </section>
478      </chapter>
479  </book>  </book>

Legend:
Removed from v.1582  
changed lines
  Added in v.1583

  ViewVC Help
Powered by ViewVC