summaryrefslogtreecommitdiff
path: root/manual/xml
diff options
context:
space:
mode:
authorTim Mayberry <mojofunk@gmail.com>2007-02-14 11:23:38 +0000
committerTim Mayberry <mojofunk@gmail.com>2007-02-14 11:23:38 +0000
commit9d548f998b94dcc5e04496740aead50f2b9f5f07 (patch)
tree645ec973389c2935fbdb0da0dabcc165f99bb5f5 /manual/xml
parentc95d382604402863f92df1a6ed9e59a11d56f9eb (diff)
Added the BSD licensed xmlformat utility for keeping the xml pretty
and consistant aswell as a configuration file. When I converted the manual to docbook I was using an old version that I'd modified to insert tabs rather than spaces so using it on the existing documentation will appear to reformat the whole file. I don't think that matters at this stage and I'm tempted to reformat everything now while it isn't an issue. Rewrote the Makefile that builds the docs so that: - building the html only depends on having xsltproc installed. - the xsl and xml files aren't copied to the build directory. - make test does not remove an existing build of the docs. Changed the glossary so that the acronym/abbreviations are the glossary terms, which I've discovered is how it is generally done. It makes total sense now that I actually think about it because you need to find the terms based on their use in the manual. Added a bit of xsl to add the status attribute as a class attribute in the html so that the css can use a draft watermark(or any other watermark). DocBook supports the draft status without the xsl but it has problems, which I've described in the xsl file. Minor tweak to the css to make the glossary terms and any other definition lists bold(that includes the index). git-svn-id: svn://localhost/ardour2/trunk@1457 d708f5d6-7413-0410-9779-e7cbd77b26cf
Diffstat (limited to 'manual/xml')
-rw-r--r--manual/xml/ardour_manual.xml3
-rw-r--r--manual/xml/contributing_to_the_manual.xml19
-rw-r--r--manual/xml/glossary.xml542
-rw-r--r--manual/xml/mixer_strips.xml4
4 files changed, 319 insertions, 249 deletions
diff --git a/manual/xml/ardour_manual.xml b/manual/xml/ardour_manual.xml
index 820e0fe18b..007f5a9c3a 100644
--- a/manual/xml/ardour_manual.xml
+++ b/manual/xml/ardour_manual.xml
@@ -51,4 +51,7 @@
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="glossary.xml" />
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
+ href="contributing_to_the_manual.xml" />
+
</book>
diff --git a/manual/xml/contributing_to_the_manual.xml b/manual/xml/contributing_to_the_manual.xml
new file mode 100644
index 0000000000..4c30463514
--- /dev/null
+++ b/manual/xml/contributing_to_the_manual.xml
@@ -0,0 +1,19 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
+
+]>
+
+<appendix id="ap-contributing-to-the-manual" label="A" status="ardour-draft">
+
+ <title>Contributing to the Manual</title>
+
+ <para>
+ A paragraph
+ </para>
+
+ <!--
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
+ href="Some_Subsection.xml" />
+ -->
+
+</appendix>
diff --git a/manual/xml/glossary.xml b/manual/xml/glossary.xml
index b1eb541174..c82e423aa1 100644
--- a/manual/xml/glossary.xml
+++ b/manual/xml/glossary.xml
@@ -5,251 +5,299 @@
]>
<glossary>
- <title>Ardour Glossary</title>
-
- <glossdiv>
- <title>A</title>
- <glossentry id="gt-alsa">
- <glossterm><ulink url="http://www.alsa-project.org">Advanced Linux Sound Architecture</ulink></glossterm>
- <acronym>ALSA</acronym>
- <glossdef>
- <para>
- The Advanced Linux Sound Architecture (ALSA) provides audio and MIDI functionality to the Linux operating system.
- </para>
- </glossdef>
- </glossentry>
-
- <glossentry id="gt-auditioner">
- <glossterm>Auditioner</glossterm>
- <glossdef>
- <para>
- Some reasonable definition here.
- </para>
- </glossdef>
- </glossentry>
- </glossdiv>
-
- <glossdiv>
- <title>B</title>
- <glossentry id="gt-bus">
- <glossterm>Bus</glossterm>
- <glossdef>
- <para>
- Some reasonable definition here.
- </para>
- </glossdef>
- </glossentry>
- </glossdiv>
-
- <glossdiv>
- <title>C</title>
- <glossentry id="gt-crossfade">
- <glossterm>Crossfade</glossterm>
- <glossdef>
- <para>
- Some reasonable definition here.
- </para>
- </glossdef>
- </glossentry>
- </glossdiv>
-
- <glossdiv>
- <title>D</title>
- <glossentry id="gt-daw">
- <glossterm>Digital Audio Workstation</glossterm>
- <acronym>DAW</acronym>
- <glossdef>
- <para>
- Some reasonable definition here.
- </para>
- </glossdef>
- </glossentry>
- </glossdiv>
-
- <glossdiv>
- <title>E</title>
- <glossentry id="gt-embed">
- <glossterm>Embed</glossterm>
- <glossdef>
- <para>
- Some reasonable definition here.
- </para>
- </glossdef>
- </glossentry>
- </glossdiv>
-
- <glossdiv>
- <title>H</title>
- <glossentry id="gt-hdr">
- <glossterm>Hard Disk Recorder</glossterm>
- <acronym>HDR</acronym>
- <glossdef>
- <para>
- Some reasonable definition here.
- </para>
- </glossdef>
- </glossentry>
- </glossdiv>
-
- <glossdiv>
- <title>I</title>
- <glossentry id="gt-insert">
- <glossterm>Insert</glossterm>
- <glossdef>
- <para>
- Some reasonable definition here.
- </para>
- </glossdef>
- </glossentry>
- </glossdiv>
-
- <glossdiv>
- <title>J</title>
- <glossentry id="gt-jack">
- <glossterm><ulink url="http://jackaudio.org">Jack Audio Connection Kit</ulink></glossterm>
- <acronym>JACK</acronym>
- <glossdef>
- <para>
- Some reasonable definition here.
- </para>
- </glossdef>
- </glossentry>
- </glossdiv>
-
- <glossdiv>
- <title>L</title>
- <glossentry id="gt-ladpsa">
- <glossterm>Linux Audio Developers Simple Plugin API</glossterm>
- <acronym>LADSPA</acronym>
- <glossdef>
- <para>
- <ulink url="http://ladspa.org">Website</ulink>
- Some reasonable definition here.
- </para>
- </glossdef>
- </glossentry>
- </glossdiv>
-
- <glossdiv>
- <title>M</title>
- <glossentry id="gt-midi">
- <glossterm>Musical Instrument Digital Interface</glossterm>
- <acronym>MIDI</acronym>
- <glossdef>
- <para>
- Some reasonable definition here.
- </para>
- </glossdef>
- </glossentry>
- </glossdiv>
-
- <glossdiv>
- <title>P</title>
- <glossentry id="gt-playlist">
- <glossterm>Playlist</glossterm>
- <glossdef>
- <para>
- some reasonable definition here.
- </para>
- </glossdef>
- </glossentry>
-
- <glossentry id="gt-plugin">
- <glossterm>plugin</glossterm>
- <glossdef>
- <para>
- some reasonable definition here.
- </para>
- <!--
- <glossseealso otherterm="gt-session"/>
- -->
- </glossdef>
- </glossentry>
-
- <glossentry id="gt-posix">
- <glossterm>Portable Operating System Interface for uniX</glossterm>
- <acronym>POSIX</acronym>
- <glossdef>
- <para>
- Some reasonable definition here.
- </para>
- </glossdef>
- </glossentry>
- </glossdiv>
-
- <glossdiv>
- <title>R</title>
-
- <glossentry id="gt-region">
- <glossterm>Region</glossterm>
- <glossdef>
- <para>
- Some reasonable definition here.
- </para>
- </glossdef>
- </glossentry>
-
- <glossentry id="gt-redirect">
- <glossterm>Redirect</glossterm>
- <glossdef>
- <para>
- Some reasonable definition here.
- </para>
- </glossdef>
- </glossentry>
- </glossdiv>
-
- <glossdiv>
- <title>S</title>
- <glossentry id="gt-send">
- <glossterm>Send</glossterm>
- <glossdef>
- <para>
- Some reasonable definition here.
- </para>
- </glossdef>
- </glossentry>
- <glossentry id="gt-session">
- <glossterm>Session</glossterm>
- <glossdef>
- <para>
- Some reasonable definition here.
- </para>
- </glossdef>
- </glossentry>
- <glossentry id="gt-session-template">
- <glossterm>Session Template</glossterm>
- <glossdef>
- <para>
- Some reasonable definition here.
- </para>
- <glossseealso otherterm="gt-session"/>
- </glossdef>
- </glossentry>
- </glossdiv>
-
- <glossdiv>
- <title>T</title>
- <glossentry id="gt-track">
- <glossterm>Track</glossterm>
- <glossdef>
- <para>
- Some reasonable definition here.
- </para>
- </glossdef>
- </glossentry>
- </glossdiv>
-
- <glossdiv>
- <title>V</title>
- <glossentry id="gt-vst">
- <glossterm>Virtual Studio Technology</glossterm>
- <acronym>VST</acronym>
- <glossdef>
- <para>
- Some reasonable definition here.
- </para>
- </glossdef>
- </glossentry>
- </glossdiv>
+ <title>Ardour Glossary</title>
+ <glossdiv>
+ <title>A</title>
+ <glossentry id="gt-alsa">
+ <glossterm><acronym>ALSA</acronym></glossterm>
+ <glossdef>
+ <para>
+ Abbreviation for Advanced Linux Sound Architecture. ALSA provides audio
+ and MIDI functionality to the Linux operating system.
+ </para>
+ <para>
+ <ulink url="http://www.alsa-project.org"/>
+ </para>
+ </glossdef>
+ </glossentry>
+
+ <glossentry id="gt-audio-track">
+ <glossterm>Audio Track</glossterm>
+ <glossdef>
+ <para>
+ Some reasonable definition here.
+ </para>
+ </glossdef>
+ </glossentry>
+
+ <glossentry id="gt-auditioner">
+ <glossterm>Auditioner</glossterm>
+ <glossdef>
+ <para>
+ Some reasonable definition here.
+ </para>
+ </glossdef>
+ </glossentry>
+ </glossdiv>
+
+ <glossdiv>
+ <title>B</title>
+ <glossentry id="gt-bus">
+ <glossterm>Bus</glossterm>
+ <glossdef>
+ <para>
+ Some reasonable definition here.
+ </para>
+ </glossdef>
+ </glossentry>
+
+ <glossentry id="gt-bus-track">
+ <glossterm>Bus Track</glossterm>
+ <glossdef>
+ <para>
+ Some reasonable definition here.
+ </para>
+ </glossdef>
+ </glossentry>
+ </glossdiv>
+
+ <glossdiv>
+ <title>C</title>
+ <glossentry id="gt-crossfade">
+ <glossterm>Crossfade</glossterm>
+ <glossdef>
+ <para>
+ Some reasonable definition here.
+ </para>
+ </glossdef>
+ </glossentry>
+ </glossdiv>
+
+ <glossdiv>
+ <title>D</title>
+ <glossentry id="gt-daw">
+ <glossterm><acronym>DAW</acronym></glossterm>
+ <glossdef>
+ <para>
+ Abbreviation of Digital Audio Workstation. Some reasonable definition
+ here.
+ </para>
+ </glossdef>
+ </glossentry>
+
+ <glossentry id="gt-destructive-recording">
+ <glossterm>Destructive Recording</glossterm>
+ <glossdef>
+ <para>
+ Some reasonable definition here.
+ </para>
+ </glossdef>
+ </glossentry>
+ </glossdiv>
+
+ <glossdiv>
+ <title>E</title>
+ <glossentry id="gt-embed">
+ <glossterm>Embed</glossterm>
+ <glossdef>
+ <para>
+ Some reasonable definition here.
+ </para>
+ </glossdef>
+ </glossentry>
+ </glossdiv>
+
+ <glossdiv>
+ <title>H</title>
+ <glossentry id="gt-hdr">
+ <glossterm><acronym>HDR</acronym></glossterm>
+ <glossdef>
+ <para>
+ Short for Hard Disk Recorder. Some reasonable definition here.
+ </para>
+ </glossdef>
+ </glossentry>
+ </glossdiv>
+
+ <glossdiv>
+ <title>I</title>
+ <glossentry id="gt-insert">
+ <glossterm>Insert</glossterm>
+ <glossdef>
+ <para>
+ Some reasonable definition here.
+ </para>
+ </glossdef>
+ </glossentry>
+ </glossdiv>
+
+ <glossdiv>
+ <title>J</title>
+ <glossentry id="gt-jack">
+ <glossterm><acronym>JACK</acronym></glossterm>
+ <glossdef>
+ <para>
+ Initialism of Jack Audio Connection Kit. Some reasonable definition here.
+ </para>
+ <para>
+ <ulink url="http://jackaudio.org"/>
+ </para>
+ </glossdef>
+ </glossentry>
+ </glossdiv>
+
+ <glossdiv>
+ <title>L</title>
+ <glossentry id="gt-ladpsa">
+ <glossterm><acronym>LADSPA</acronym> </glossterm>
+ <glossdef>
+ <para>
+ Abbreviation of Linux Audio Developers Simple Plugin API. Some reasonable
+ definition here.
+ </para>
+ <para>
+ <ulink url="http://ladspa.org"/>
+ </para>
+ </glossdef>
+ </glossentry>
+ </glossdiv>
+
+ <glossdiv>
+ <title>M</title>
+ <glossentry id="gt-midi">
+ <glossterm><acronym>MIDI</acronym> </glossterm>
+ <glossdef>
+ <para>
+ Abbreviation for Musical Instrument Digital Interface. Some reasonable
+ definition here.
+ </para>
+ </glossdef>
+ </glossentry>
+ </glossdiv>
+
+ <glossdiv>
+ <title>P</title>
+ <glossentry id="gt-playlist">
+ <glossterm>Playlist</glossterm>
+ <glossdef>
+ <para>
+ some reasonable definition here.
+ </para>
+ </glossdef>
+ </glossentry>
+
+ <glossentry id="gt-plugin">
+ <glossterm>plugin</glossterm>
+ <glossdef>
+ <para>
+ some reasonable definition here.
+ </para>
+ </glossdef>
+ </glossentry>
+
+ <glossentry id="gt-posix">
+ <glossterm><acronym>POSIX</acronym></glossterm>
+ <glossdef>
+ <para>
+ POSIX stands for Portable Operating System Interface for uniX. Some
+ reasonable definition here.
+ </para>
+ </glossdef>
+ </glossentry>
+ </glossdiv>
+
+ <glossdiv>
+ <title>R</title>
+ <glossentry id="gt-region">
+ <glossterm>Region</glossterm>
+ <glossdef>
+ <para>
+ Some reasonable definition here.
+ </para>
+ </glossdef>
+ </glossentry>
+
+ <glossentry id="gt-redirect">
+ <glossterm>Redirect</glossterm>
+ <glossdef>
+ <para>
+ Some reasonable definition here.
+ </para>
+ </glossdef>
+ </glossentry>
+ </glossdiv>
+
+ <glossdiv>
+ <title>S</title>
+ <glossentry id="gt-send">
+ <glossterm>Send</glossterm>
+ <glossdef>
+ <para>
+ Some reasonable definition here.
+ </para>
+ </glossdef>
+ </glossentry>
+
+ <glossentry id="gt-session">
+ <glossterm>Session</glossterm>
+ <glossdef>
+ <para>
+ Some reasonable definition here.
+ </para>
+ </glossdef>
+ </glossentry>
+
+ <glossentry id="gt-session-template">
+ <glossterm>Session Template</glossterm>
+ <glossdef>
+ <para>
+ Some reasonable definition here.
+ </para>
+ <glossseealso otherterm="gt-session"/>
+ </glossdef>
+ </glossentry>
+
+ <glossentry id="gt-submixing">
+ <glossterm>Submixing</glossterm>
+ <glossdef>
+ <para>
+ Some reasonable definition here.
+ </para>
+ </glossdef>
+ </glossentry>
+ </glossdiv>
+
+ <glossdiv>
+ <title>T</title>
+ <glossentry id="gt-tape-track">
+ <glossterm>Tape Track</glossterm>
+ <glossdef>
+ <para>
+ Some Reasonable definition here.
+ </para>
+ <glossseealso otherterm="gt-track"/>
+ </glossdef>
+ </glossentry>
+
+ <glossentry id="gt-track">
+ <glossterm>Track</glossterm>
+ <glossdef>
+ <para>
+ Some reasonable definition here.
+ </para>
+ </glossdef>
+ </glossentry>
+ </glossdiv>
+
+ <glossdiv>
+ <title>V</title>
+ <glossentry id="gt-vst">
+ <glossterm><acronym>VST</acronym></glossterm>
+ <glossdef>
+ <para>
+ Short for Virtual Studio Technology
+ </para>
+ </glossdef>
+ </glossentry>
+ </glossdiv>
</glossary>
diff --git a/manual/xml/mixer_strips.xml b/manual/xml/mixer_strips.xml
index 0e96f05908..3c52aa13b4 100644
--- a/manual/xml/mixer_strips.xml
+++ b/manual/xml/mixer_strips.xml
@@ -6,8 +6,8 @@
<!-- XXX lots to do on this page -->
-<section id="mixer-window-mixer-strips">
- <title> Mixer Strips </title>
+<section id="mixer-strips">
+ <title>Mixer Strips</title>
<para>
Each track and bus is represented in the mixer window by a <emphasis>mixer
strip</emphasis> that contains various controls related to signal flow.