summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCarl Hetherington <carl@carlh.net>2011-12-21 00:56:07 +0000
committerCarl Hetherington <carl@carlh.net>2011-12-21 00:56:07 +0000
commite62e94b63c2ca32db6f3d790e58ef18d8528ea53 (patch)
treea86f59c86428a3b11acd6ca4b2a82b8cc9d40bbe
parent5c1e4e1c79088f222271dd659e03abc59c3ae6fc (diff)
Some tinkering with the docbook manual, just for more kicks.
git-svn-id: svn://localhost/ardour2/branches/3.0@11040 d708f5d6-7413-0410-9779-e7cbd77b26cf
-rw-r--r--manual/xml/glossary.xml41
-rw-r--r--manual/xml/setting_up_to_record.xml2
-rw-r--r--manual/xml/using_existing_audio.xml4
-rw-r--r--manual/xml/what_is_different_about_ardour.xml12
4 files changed, 34 insertions, 25 deletions
diff --git a/manual/xml/glossary.xml b/manual/xml/glossary.xml
index 37801539a7..912d75ff56 100644
--- a/manual/xml/glossary.xml
+++ b/manual/xml/glossary.xml
@@ -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>
@@ -98,7 +101,14 @@
<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>
@@ -122,7 +132,9 @@
<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>
@@ -146,7 +158,7 @@
<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>
@@ -162,8 +174,11 @@
<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"/>
@@ -178,8 +193,8 @@
<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>
@@ -191,7 +206,9 @@
<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>
@@ -200,7 +217,11 @@
<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>
diff --git a/manual/xml/setting_up_to_record.xml b/manual/xml/setting_up_to_record.xml
index 5891ef2b71..dca9b07bfe 100644
--- a/manual/xml/setting_up_to_record.xml
+++ b/manual/xml/setting_up_to_record.xml
@@ -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.
diff --git a/manual/xml/using_existing_audio.xml b/manual/xml/using_existing_audio.xml
index e3ab54d40a..e81d47493e 100644
--- a/manual/xml/using_existing_audio.xml
+++ b/manual/xml/using_existing_audio.xml
@@ -217,7 +217,7 @@
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>,
@@ -267,7 +267,7 @@
</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
diff --git a/manual/xml/what_is_different_about_ardour.xml b/manual/xml/what_is_different_about_ardour.xml
index ff41c30578..8179a04563 100644
--- a/manual/xml/what_is_different_about_ardour.xml
+++ b/manual/xml/what_is_different_about_ardour.xml
@@ -55,18 +55,6 @@
</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>