]> Shamusworld >> Repos - ardour-manual/commitdiff
Replacing plugin-manager with plugin-selector. Updated the Plugin-selector page.
authorEd Ward <edwsaintesprit@hotmail.com>
Fri, 28 May 2021 21:17:07 +0000 (23:17 +0200)
committerEd Ward <edwsaintesprit@hotmail.com>
Fri, 28 May 2021 21:17:07 +0000 (23:17 +0200)
include/favorite-plugins-window.html
include/plugin-manager.html
include/processor-box.html
master-doc.txt
source/images/plugin-manager.png [deleted file]
source/images/plugin-selector.png [new file with mode: 0644]

index ed54ee76bc031b40b284682dc172ed35f9eed680..6305bbf31d74903ce7f7a5710f21ad5f2eeea45e 100644 (file)
@@ -78,7 +78,7 @@
 </ul>
 
 <p class="note">
-  When favorites are added with the <a href="@@plugin-manager">Plugin Manager</a>,
+  When favorites are added with the <a href="@@plugin-selector">Plugin Selector</a>,
   they are appended to the bottom of the list.
 </p>
 
index 452db5dd9c605d7e6267e8c9cb6b45b729afce7a..4efe28a561d8a5d73ed4b02100aa4fd2cdc78db4 100644 (file)
@@ -1,33 +1,34 @@
 
 <p>
-  The <dfn>Plugin Manager</dfn> serves two purposes. Primarily it is used to
+  The <dfn>Plugin Selector</dfn> serves two purposes. Primarily it is used to
   control the display status of plugins. It can also be used to find and insert
-  plugins into the
-  <a href="@@processor-box">Processor Box</a>. It is
+  plugins into the <a href="@@processor-box">Processor Box</a>. It is
   displayed either by a double-click in the <dfn>Processor Box</dfn> or by
-  choosing <kbd class="menu">New Plugin &gt; Plugin Manager&hellip;</kbd> from the
-  <dfn>Processor Box</dfn> context menu.
+  choosing <kbd class="menu">New Plugin &gt; Plugin Selector&hellip;</kbd>
+  from the <dfn>Processor Box</dfn> context menu.
 </p>
 
 <p>
-  Displayed for each plugin is the status (normal, favorite, hidden),
-  name, type, category, creator (author), and the number of audio and MIDI
+  Displayed for each plugin is the status (favorite, hidden),
+  name, tags, creator (author), type, and the number of audio and MIDI
   connections. The plugins can be sorted by clicking on a column header.
 </p>
 
 <figure class=center>
-<img src="/images/plugin-manager.png" alt="Plugin Manager window"/>
-<figcaption class=center>The Plugin Manager window.</figcaption>
+<img src="/images/plugin-selector.png" alt="The Plugin Selector window"/>
+<figcaption class=center>The Plugin Selector window.</figcaption>
 </figure>
 
 <h2>Plugin Display Status</h2>
 
 <p>
-  Click on a Fav(orite) or Hide radio button to change a plugin's display status.
+  Clicking on a <em>Fav</em>(orite) or <em>Hide</em> radio button changes
+  a plugin's display status.
   Clicking on an already selected radio button will cancel it, returning the
   plugin to the normal display status. Plugins marked as a favorite show up in
   the <dfn>Processor Box</dfn> context menu under
-  <kbd class="menu">New Plugin &gt; Favorites</kbd>. Setting the hide
+  <kbd class="menu">New Plugin &gt; Favorites</kbd> and in the 
+  <a href="@@favorite-plugins-window">Favorite Plugins window</a>. Setting the hide
   radio button on a plugin will keep the plugin from showing in the
   <dfn>Processor Box</dfn> context menus
   <kbd class="menu">New Plugin &gt; By Creator</kbd> or
 <h2>Filtering Listed Plugins</h2>
 
 <p>
-  The bottom left part of the <dfn>Plugin Manager</dfn> is used to filter the listed
-  plugins. Typing into the text-box will filter the plugins based on the filter
-  mode selected by drop-down box. Clicking <kbd class="menu">Clear</kbd>
-  empties the text-box.
+  The bottom left part of the <dfn>Plugin Selector</dfn> is used to filter the listed
+  plugins.
+</p>
+<p>
+  The center <dfn>Filter</dfn> column allows to show only some of the plugins, based
+  on what they are, their properties, format, creator...
+</p>
+<p>
+  Moreover, direct text search are available in the the Search text-field
+  on the bottom left. Only the plugins that match <em>all</em> the search terms
+  (space separated) will show up in the upper list.
+</p>
+<p>
+  This textual search can be matched against Name and/or Tags by checking
+  the relevant momentary buttons under the search field. 
+  <kbd class="menu">Ignore Filters when searching</kbd> displays all the matching
+  plugins, regardless of the active <em>Filters</em>.
+</p>
+
+<h2>Tags</h2>
+
+<p>
+  Tags are text labels that can be used to mark a plugin. They are totally
+  free in their content, allowing the user to mark a plugin with whatever
+  info is relevant to him, but cannot include spaces (as spaces are used
+  to separate tags) or special characters except dashes, colons and underscores. 
+</p>
+<p>
+  Adding or removing tags is as simple as editing the <dfn>Tags for Selected Plugin</dfn>
+  field while the targeted plugin is selected.
+</p>
+<p>
+  Ardour comes with a large selection of tags for provided or usual plugins,
+  that are used by default but can be modified at will. It is possible to
+  go back to this "standard" tagging for a plugin by clicking the 
+  <kbd class="menu">Reset</kbd> button.
 </p>
 
 <h2>Inserting Plugins in the Processor Box</h2>
 
 <p>
-  The right part of the plugin manager shows plugins that have been selected
-  for insertion into the <dfn>Processor Box</dfn>. A plugin can be added by
-  either double clicking the plugin entry in the top left part, or, if already
-  selected in top left part, by clicking <kbd class="menu">Add</kbd>.
+  The bottom-right part of the Plugin Selector <dfn>Plugins to be connected</dfn>
+  shows plugins that have been selected for insertion into the 
+  <dfn>Processor Box</dfn>. A plugin can be added by either double clicking
+  the plugin entry in the top part, or, if already selected in top left part, 
+  by clicking the <kbd class="menu">Add</kbd> button.
 <p>
 
 <p>
index 9e9fe09d22f9008867e9b3535da501f2c07b049e..dffc2af31485d6b0fde1c5882be3a49e2c72bdb7 100644 (file)
@@ -52,7 +52,7 @@
 </p>
 
 <p class="note">
-  The <dfn>Favorite Plugins</dfn> window can be populated via the <a href="@@plugin-manager">Plugin Manager</a>, or by dragging
+  The <dfn>Favorite Plugins</dfn> window can be populated via the <a href="@@plugin-selector">Plugin Selector</a>, or by dragging
    and dropping an existing processor from the <dfn>processor box</dfn> to the <dfn>Favorite Plugins</dfn> window.
 </p>
 
index e860aa6ddc5c49878858d9bf228be94456f5f2f5..9fedd26402c9b9ad497c48f04550b03ec99bcee6 100644 (file)
@@ -1671,9 +1671,9 @@ part: subchapter
 ---
 
 ---
-title: Plugin Manager
+title: Plugin Selector
 include: plugin-manager.html
-link: plugin-manager
+link: plugin-selector
 uri: working-with-plugins/plugin-manager
 part: subchapter
 ---
diff --git a/source/images/plugin-manager.png b/source/images/plugin-manager.png
deleted file mode 100644 (file)
index ea125a0..0000000
Binary files a/source/images/plugin-manager.png and /dev/null differ
diff --git a/source/images/plugin-selector.png b/source/images/plugin-selector.png
new file mode 100644 (file)
index 0000000..38cec59
Binary files /dev/null and b/source/images/plugin-selector.png differ