]> Shamusworld >> Repos - ardour-manual/blob - include/plugin-manager.html
Initial work on fixing up Plugins section.
[ardour-manual] / include / plugin-manager.html
1
2 <p>
3   The <dfn>Plugin Manager</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
6   <a href="@@processor-box">Processor Box</a>. It is
7   displayed either by a double-click in the <dfn>Processor Box</dfn> or by
8   choosing <kbd class="menu">New Plugin &gt; Plugin Manager&hellip;</kbd> from the
9   <dfn>Processor Box</dfn> context menu.
10 </p>
11
12 <p>
13   Displayed for each plugin is the status (normal, favorite, hidden),
14   name, type, category, creator (author), and the number of audio and MIDI
15   connections. The plugins can be sorted by clicking on a column header.
16 </p>
17
18 <figure class=center>
19 <img src="/images/plugin-manager.png" alt="Plugin Manager window"/>
20 <figcaption class=center>The Plugin Manager window.</figcaption>
21 </figure>
22
23 <h2>Plugin Display Status</h2>
24
25 <p>
26   Click on a Fav(orite) or Hide radio button to change 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>. Setting the hide
31   radio button on a plugin will keep the plugin from showing in the
32   <dfn>Processor Box</dfn> context menus
33   <kbd class="menu">New Plugin &gt; By Creator</kbd> or
34   <kbd class="menu">New Plugin &gt; By Category</kbd>.
35 </p>
36
37 <h2>Filtering Listed Plugins</h2>
38
39 <p>
40   The middle of the <dfn>Plugin Manager</dfn> is used to filter the listed
41   plugins. Typing into the text-box will filter the plugins based on the filter
42   mode selected by drop-down box. Clicking <kbd class="button">Clear</kbd>
43   empties the text-box.
44 </p>
45
46 <h2>Inserting Plugins in the Processor Box</h2>
47
48 <p>
49   The bottom half of the plugin manager shows plugins that have been selected
50   for insertion into the <dfn>Processor Box</dfn>. A plugin can be added by
51   either double clicking the plugin entry in the top half, or, if already
52   selected in top half, by clicking <kbd class="button">Add</kbd>.
53 <p>
54
55 <p>
56   Plugins can be removed from the bottom half with a double click, or, if
57   already selected, by clicking <kbd class="button">Remove</kbd>.
58 </p>
59