Some tinkering with the docbook manual, just for more kicks.
authorCarl Hetherington <carl@carlh.net>
Wed, 21 Dec 2011 00:56:07 +0000 (00:56 +0000)
committerCarl Hetherington <carl@carlh.net>
Wed, 21 Dec 2011 00:56:07 +0000 (00:56 +0000)
git-svn-id: svn://localhost/ardour2/branches/3.0@11040 d708f5d6-7413-0410-9779-e7cbd77b26cf

manual/xml/glossary.xml
manual/xml/setting_up_to_record.xml
manual/xml/using_existing_audio.xml
manual/xml/what_is_different_about_ardour.xml

index 37801539a7d021dac5ce6dfe3965d08bb603ac76..912d75ff56aa1292a5b557075ec4cb2aba4d7d43 100644 (file)
@@ -2,6 +2,9 @@
 
 <!DOCTYPE glossary PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
 
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../build/manual/ent/entities.ent">
+%BOOK_ENTITIES;
+
 ]>
 
 <glossary>
@@ -12,7 +15,7 @@
       <glossterm><acronym>ALSA</acronym></glossterm>
       <glossdef>
         <para>
-          Abbreviation for Advanced Linux Sound Architecture. ALSA provides
+          Acronym of the Advanced Linux Sound Architecture. ALSA provides
           audio and MIDI functionality to the Linux operating system.
         </para>
         <para>
       <glossterm><acronym>DSP</acronym></glossterm>
       <glossdef>
         <para>
-          Some reasonable definition here.
+          Acronym of Digital Signal Processing, a very general term for processing
+         of any digital signal by digital means.  In &ARDOUR_NAME;'s context, it generally
+         refers to the processing peformed on audio signals by &ARDOUR_NAME; and by plugins.
+         It is often talked of in terms of DSP `load', referring to the amount of CPU power
+         that Ardour is using for its signal processing.  This load increases with the
+         number of tracks and plugins that a session uses.  A computer will have an upper
+         limit to the amount of DSP it can perform, depending on its CPU and RAM speed and
+         many other factors.
         </para>
       </glossdef>
     </glossentry>
       <glossterm><acronym>HDR</acronym></glossterm>
       <glossdef>
         <para>
-          Short for Hard Disk Recorder. Some reasonable definition here.
+          Acronym of Hard Disk Recorder.  A general term for devices which record
+         audio onto hard disk; a HDR usually means some kind of standalone recording
+         unit such as the Alesis HD-24 and similar.
         </para>
       </glossdef>
     </glossentry>
       <glossterm><acronym>JACK</acronym></glossterm>
       <glossdef>
         <para>
-          Initialism of Jack Audio Connection Kit. Some reasonable
+          Acronym of the Jack Audio Connection Kit. Some reasonable
           definition here.
         </para>
         <para>
       <glossterm><acronym>LADSPA</acronym> </glossterm>
       <glossdef>
         <para>
-          Abbreviation of Linux Audio Developers Simple Plugin API. Some
-          reasonable definition here.
+          Acronym of Linux Audio Developers Simple Plugin API.  One standard
+         for writing plugins which &ARDOUR_NAME; can use.  Many LADSPA plugins
+         are available; some free and open-source and others closed-source.  See, for example:
+         <ulink url="http://plugin.org.uk/"/>
+         <ulink url="http://calf.sourceforge.net/"/>
         </para>
         <para>
           <ulink url="http://ladspa.org"/>
       <glossterm><acronym>MIDI</acronym> </glossterm>
       <glossdef>
         <para>
-          Abbreviation for Musical Instrument Digital Interface. Some
-          reasonable definition here.
+          Acronym of Musical Instrument Digital Interface.  A standard for communicating note
+         and other information between keyboards, computers, sound modules and many other devices.
         </para>
       </glossdef>
     </glossentry>
       <glossterm>Playlist</glossterm>
       <glossdef>
         <para>
-          some reasonable definition here.
+         A list of <glossterm linkend="gt-region">regions</glossterm>; each
+         <glossterm id="gt-track">track</glossterm> has one or more Playlists, one of which
+         is active; this specifies the regions that will be played back by the track.
         </para>
       </glossdef>
     </glossentry>
       <glossterm>plugin</glossterm>
       <glossdef>
         <para>
-          some reasonable definition here.
+         A piece of software that can be used inside Ardour to process audio
+         or MIDI data.  Common examples are equalisers, compressors or reverb
+         processors using the <glossterm linkend="gt-ladspa">LADSPA</glossterm>,
+         <glossterm linkend="gt-lv2">LV2</glossterm> or <glossterm linkend="gt-vst">VST</glossterm>
+         standards.
         </para>
       </glossdef>
     </glossentry>
index 5891ef2b7131c1d37be6ea17dfecfc361c936059..dca9b07bfeeda3db1aaa5e60fb7bf869b97950a4 100644 (file)
@@ -89,7 +89,7 @@
     </para>
   </section>
   
-  <section id="setup-external-monitoring">
+  <section id="tape-machine-mode">
     <title>Tape Machine Mode</title>
     <para>
       Nearly all traditional tape recorders use the same monitoring model. 
index e3ab54d40a05fe0a86954ca5dc5f201075e7bbf5..e81d47493e605efab10cfd558ef1d7c1ef256feb 100644 (file)
     linkend="gt-embed">embedded</link> into your session.</para>
   </section>
 
-  <section id="how-to-embed-a-file">
+  <section id="working-with-tags">
     <title>Working with Tags</title>
 
     <para>A "tag" is bit of information, or <emphasis>metadata</emphasis>,
     </section>
   </section>
 
-  <section id="how-to-embed-a-file">
+  <section id="searching-freesound-for-soundfiles">
     <title>Searching Freesound for soundfiles (optional)</title>
 
     <para>Freesound (http://freesound.iua.upf.edu/) is an online database with
index ff41c305784923b3180e9d9bf7575ee241f39802..8179a0456319708cc027c8abcdd66f3fb1afa486 100644 (file)
     </para>
   </section>
 
-  <section id="no-visible-send-controls">
-    <title>No visible send controls</title>
-    <para>
-      Although Ardour supports sends, there is no way to control them
-      directly from the mixer interface - you don't get a dedicated knob on
-      the mixer strip. However, if you bring up the send's own editor (for
-      example, by double-clicking on its name in the redirect list), you
-      will find a richer set of functionality than most other DAWs offer for
-      controlling the behaviour of a send.
-    </para>
-  </section>
-
   <section id="a-smaller-set-of-tools">
     <title>A smaller set of tools</title>
     <para>