Shamusworld >> Repos - ardour-manual/blob - include/plugin-selector.html

   1
   2 <p>
   3   The <dfn>Plugin Selector</dfn> serves two purposes. Primarily it is used to
   4   control the display status of plugins. It can also be used to find and insert
   5   plugins into the <a href="@@processor-box">Processor Box</a>. It is
   6   displayed either by a double-click in the <dfn>Processor Box</dfn> or by
   7   choosing <kbd class="menu">New Plugin &gt; Plugin Selector&hellip;</kbd>
   8   from the <dfn>Processor Box</dfn> context menu.
   9 </p>
  10
  11 <p>
  12   Displayed for each plugin is the status (favorite, hidden),
  13   name, tags, creator (author), type, and the number of audio and MIDI
  14   connections. The plugins can be sorted by clicking on a column header.
  15 </p>
  16
  17 <figure class=center>
  18 <img src="/images/plugin-selector.png" alt="The Plugin Selector window"/>
  19 <figcaption class=center>The Plugin Selector window.</figcaption>
  20 </figure>
  21
  22 <h2>Plugin Display Status</h2>
  23
  24 <p>
  25   Clicking on a <em>Fav</em>(orite) or <em>Hide</em> radio button changes
  26   a plugin's display status.
  27   Clicking on an already selected radio button will cancel it, returning the
  28   plugin to the normal display status. Plugins marked as a favorite show up in
  29   the <dfn>Processor Box</dfn> context menu under
  30   <kbd class="menu">New Plugin &gt; Favorites</kbd> and in the
  31   <a href="@@favorite-plugins-window">Favorite Plugins window</a>. Setting the hide
  32   radio button on a plugin will keep the plugin from showing in the
  33   <dfn>Processor Box</dfn> context menus
  34   <kbd class="menu">New Plugin &gt; By Creator</kbd> or
  35   <kbd class="menu">New Plugin &gt; By Category</kbd>.
  36 </p>
  37
  38 <h2>Filtering Listed Plugins</h2>
  39
  40 <p>
  41   The bottom left part of the <dfn>Plugin Selector</dfn> is used to filter the listed
  42   plugins.
  43 </p>
  44 <p>
  45   The center <dfn>Filter</dfn> column allows to show only some of the plugins, based
  46   on what they are, their properties, format, creator...
  47 </p>
  48 <p>
  49   Moreover, direct text search are available in the the Search text-field
  50   on the bottom left. Only the plugins that match <em>all</em> the search terms
  51   (space separated) will show up in the upper list.
  52 </p>
  53 <p>
  54   This textual search can be matched against Name and/or Tags by checking
  55   the relevant momentary buttons under the search field.
  56   <kbd class="menu">Ignore Filters when searching</kbd> displays all the matching
  57   plugins, regardless of the active <em>Filters</em>.
  58 </p>
  59
  60 <h2>Tags</h2>
  61
  62 <p>
  63   Tags are text labels that can be used to mark a plugin. They are totally
  64   free in their content, allowing the user to mark a plugin with whatever
  65   info is relevant to him, but cannot include spaces (as spaces are used
  66   to separate tags) or special characters except dashes, colons and underscores.
  67 </p>
  68 <p>
  69   Adding or removing tags is as simple as editing the <dfn>Tags for Selected Plugin</dfn>
  70   field while the targeted plugin is selected.
  71 </p>
  72 <p>
  73   Ardour comes with a large selection of tags for provided or usual plugins,
  74   that are used by default but can be modified at will. It is possible to
  75   go back to this "standard" tagging for a plugin by clicking the
  76   <kbd class="menu">Reset</kbd> button.
  77 </p>
  78
  79 <h2>Inserting Plugins in the Processor Box</h2>
  80
  81 <p>
  82   The bottom-right part of the Plugin Selector <dfn>Plugins to be connected</dfn>
  83   shows plugins that have been selected for insertion into the
  84   <dfn>Processor Box</dfn>. A plugin can be added by either double clicking
  85   the plugin entry in the top part, or, if already selected in top left part,
  86   by clicking the <kbd class="menu">Add</kbd> button.
  87 <p>
  88
  89 <p>
  90   Plugins can be removed from the right part with a double click, or, if
  91   already selected, by clicking <kbd class="menu">Remove</kbd>.
  92 </p>
  93