]> Shamusworld >> Repos - ardour-manual/commitdiff
Add text for MIDNAM-files
authorTobias Blaschke <code@tobiasblaschke.de>
Tue, 13 Feb 2018 21:33:41 +0000 (22:33 +0100)
committerTobias Blaschke <code@tobiasblaschke.de>
Tue, 13 Feb 2018 21:33:41 +0000 (22:33 +0100)
include/patch-change.html

index d0f78f699a18b7b5c5cbdfa6c323a877cfc8d2fb..ce0a2dbd9f468e4902192c32ceacc7013b7bef9e 100644 (file)
 </p>
 
 <h2>Names for Patch Numbers: MIDNAM files</h2>
+<p>
+  MIDNAM files assign human-redable names to the "coordinates" (MSB, LSB, pc) of 
+  instruments and controls of MIDI-devices. Quite some files already come pre-bundled 
+  with Ardour. Should this not be the case for your device, you can add your own (see below).
+</p>
+
+<h3>Selecting a device</h3>
+<p>
+  For the proper names to show up in the "Patch Selector"-dialog, you have to assign a 
+  device to your current track. To do so, hover the lower border of the tracks header 
+  (the mouse-cursor will change to a "resize-cursor") and expand it. 
+  You'll see dropdown menus. Select your device in the menu.
+</p>
 
-<p class=fixme>
-  Add content
+<h3>Adding a custom MIDNAM-file</h3>
+<p>
+  MIDNAM-files are XML-Files. You can edit them using your favorite text-editor. When 
+  doing so, please ensure to change the "Model" of the device, as Ardour will only load
+  each model once (i.e. it will skip files, if there are clashes).
+</p>
+<p>
+  After you have done modifications to a file, it's a good idea to validate it. This can
+  be done using the tool <i>xmllint</i> as shown below:
+</p>
+<pre><code class="bash">
+$ xmllint --valid --noout myfile.midnam
+$ wget http://www.midi.org/dtds/MIDINameDocument10.dtd
+$ xmllint --dtdvalid MIDINameDocument10.dtd myfile.midnam
+</code></pre>
+<p>
+  Once you are satisfied with your file, you have to put it at a location where Ardour 
+  picks it up. The best place would be the (hidden) directory 
+  <i>.config/ardour5/patchfiles/</i>
+  in your home-folder. Should the sub-directory <i>patchfiles</i> not exist yet, just 
+  create it. The path and file-names are case-sensitive. The file should end with 
+  "<i>.midnam</i>".
+</p>
+<p>
+  After restarting Ardour, hit the small Log-button in the upper right corner of the
+  main window. It should say something like:
+</p>
+<pre>[INFO]: Loading 3 MIDI patches from /home/username/.config/ardour5/patchfiles</pre>
+<p>
+  The added device should now show up in the dropdown mentioned in the previous paragraph.
+</p>
+<p>
+  Should the MIDNAM-file be useful for the general public, it would be nice to share it:
+  Fork the Ardour-project on <a href="https://github.com/Ardour/ardour">gitHub</a> by 
+  hitting the "Fork"-Button. Go to the <a>patchfiles</a>-directory (and read the README).
+</p>
+<p>
+  You can upload the file using the Web-Interface. Be sure to select
+  "<i>Create a new branch for this commit and start a pull request</i>".
 </p>