[musicians-guide] Added entities for operating system; added documentation for the Ardour nudge tool
crantila
crantila at fedoraproject.org
Mon Jun 27 19:32:16 UTC 2011
commit 1ad21715f8e4259950b579104d0e0479758dfa62
Author: Christopher Antila <crantila at fedoraproject.org>
Date: Mon Jun 27 15:32:06 2011 -0400
Added entities for operating system; added documentation for the Ardour nudge tool
en-US/Ardour.xml | 49 +++++++++++++++-----------
en-US/Musicians_Guide.ent | 6 ++-
en-US/Revision_History.xml | 31 ++++++++++++++--
en-US/images/Ardour-interface-nudge-pane.png | Bin 0 -> 14273 bytes
4 files changed, 59 insertions(+), 27 deletions(-)
---
diff --git a/en-US/Ardour.xml b/en-US/Ardour.xml
index f4f7905..24c3e86 100644
--- a/en-US/Ardour.xml
+++ b/en-US/Ardour.xml
@@ -154,15 +154,15 @@
</section>
<section id="sect-Musicians_Guide-Ardour-Recording-Setting_up_the_Timeline">
<title>Setting up the Timeline</title>
- <para>At the top of the main <application>Ardour</application> window, to the right of the transport's toolbar, are two relatively large clocks. Right-click the clocks to choose what you want them to display:</para>
+ <para>At the top of the main <application>Ardour</application> window, to the right of the transport's toolbar, are two relatively large clocks. If you do not need both clocks, you can turn off one of them. Right-click the clocks to choose what you want them to display:</para>
<itemizedlist>
- <listitem><para><guimenuitem>Bars:Beats</guimenuitem> displays the number of bars and beats <!-- TODO (how to use it?) --></para></listitem>
- <listitem><para><guimenuitem>Minutes:Seconds</guimenuitem> displays the time since beginning of track <!-- TODO (how to use it?)--></para></listitem>
+ <listitem><para><guimenuitem>Bars:Beats</guimenuitem> displays the number of bars and beats</para></listitem>
+ <listitem><para><guimenuitem>Minutes:Seconds</guimenuitem> displays the time since beginning of track</para></listitem>
<listitem><para><guimenuitem>Timecode</guimenuitem> displays frames-per-second timecode (usually for work with films)</para></listitem>
- <listitem><para><guimenuitem>Samples</guimenuitem> displays the samples since start <!-- TODO (how to use it?) --></para></listitem>
+ <listitem><para><guimenuitem>Samples</guimenuitem> displays the samples since start</para></listitem>
</itemizedlist>
<para>
- If you do not need both clocks, you can turn one of them off.
+ Refer to <xref linkend="sect-Musicians_Guide-Vocabulary-Time" /> for more information about time measurement.
</para>
<para>
The <guimenu>snap mode</guimenu> menu is located between the timeline and the clocks. This menu controls where regions may move. You need to change these as you work with a session, depending on the current activity. The left menu contains:
@@ -173,18 +173,25 @@
<listitem><para><guimenuitem>Magnetic</guimenuitem> regions can move freely, but when they are near a grid point, they automatically snap to it</para></listitem>
</itemizedlist>
<para>
- The middle menu controls where to place the grid lines; by timecode, by clock time, by beats and bars, or by regions.
+ The middle menu controls where to place the grid lines: by SMPTE timecode, by clock time, by beats and bars, or by regions.
+ </para>
+ <figure id="ardour_interface_nudge_pane"><title>The Ardour nudge pane</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="./images/Ardour-interface-nudge-pane.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <para>
+ The Ardour nudge pane.
+ </para>
+ </textobject>
+ </mediaobject>
+ </figure>
+ <para>
+ <xref linkend="ardour_interface_nudge_pane" /> shows the nudge pane, part of the transport. The nudge tool moves a selected region or regions forward or back in the session by a specific amount. The <guibutton><</guibutton> button moves regions back in the session. The <guibutton>></guibutton> button moves regions forward in the session. If no regions are selected, the nudge tool moves the transport head. The display to the right of the <guibutton>></guibutton> button tells you how far a selected region would move. In this case, the nudge tool moves regions by 5 seconds.
</para>
- <!-- TODO <itemizedlist>
- <listitem><para>SMPTE things: for timecode</para></listitem>
- <listitem><para>seconds and minutes: for time</para></listitem>
- <listitem><para>beats and bars: for beats and bars</para></listitem>
- <listitem><para>Region stuff: edges of regions</para></listitem>
- </itemizedlist> -->
-
- <!-- TODO Explain the thing to the right, which allows you to move the playhead by certain amounts. -->
<para>
- The timeline (which contains many <firstterm>rulers</firstterm> showing different time-marking scales) is located at the top of the canvas area, underneath the toolbars. Use the right-click menu to select which rulers you want to display. The rulers you should choose depends on the clock settings and the snap mode.
+ The timeline contains many <firstterm>rulers</firstterm> that show different time-marking scales. The timeline is located at the top of the canvas area, below the toolbars. Use the context menu (<keycombo><mousebutton>right-click</mousebutton></keycombo>) to select which rulers you want to display. The rulers you should choose depends on the clock settings and the snap mode.
</para>
</section>
<section id="sect-Musicians_Guide-Ardour-Recording-Connecting_Audio_Sources">
@@ -1096,9 +1103,9 @@
<listitem><para>If you click in the automation track, a point will appear. Each point represents an absolute setting for the control. After the point appears, if you click-and-drag it, the yellow numbers by the cursor will tell you the fader's setting at that point.</para></listitem>
<listitem><para>If there are two or more points in the automation track, lines will appear to connect them. The fader will be moved gradually between absolute settings, as shown by the line connecting the points.</para></listitem>
<listitem><para>If you make a mistake and want to start over, you can press the 'clear' button on the automation track's control box. Unfortunately, you can't remove a single point. This isn't really necessary anyway; if you accidentally add too many points, simply use the extra one to keep a setting constant.</para></listitem>
- <listitem><para>Add one point to the beginning of the automation track, with a setting of 0.0 dB</para></listitem>
- <listitem><para>Add one point at about 00:00:15.000, with a setting of 0.0 dB</para></listitem>
- <listitem><para>Add one point at about 00:00:16.500 (where the singer starts), with a setting of -10.0 dB, or whatever you set earlier.</para></listitem>
+ <listitem><para>Add one point to the beginning of the automation track, with a setting of 0.0 dB</para></listitem>
+ <listitem><para>Add one point at about 00:00:15.000, with a setting of 0.0 dB</para></listitem>
+ <listitem><para>Add one point at about 00:00:16.500 (where the singer starts), with a setting of -10.0 dB, or whatever you set earlier.</para></listitem>
<listitem><para>Now you've set up an automation plan, but the fader is still in "Manual" mode, so the automation track will have no effect. Change the automation track's setting by clicking on the mode button in the track's control box. The button currently says "Manual."</para></listitem>
<listitem><para>From the menu, select "Play," which will cause the automation settings to be played. In "Manual" mode, you have to adjust all settings manually. In "Write" mode, changes that you make as the session plays will be recorded into the automation track, over-writing previous settings. In "Touch" mode, changes that you make as the session plays will be incorporated into the pre-existing automation settings.</para></listitem>
<listitem><para>Finally, listen to confirm that you like the automated panner change. If you don't, you can always adjust it now or later.</para></listitem>
@@ -1117,7 +1124,7 @@
<listitem><para>Find a meaningful way to incorporate the region with the sound of the chairs.</para></listitem>
<listitem><para>Compare the currently-unused clarinet regions with the in-use ones. Try different combinations of the regions, and remove the unused regions from the session.</para></listitem>
<listitem><para>Compare the currently-unused strings regions with the in-use ones. These regions are much longer than the clarinet regions, so you might even want to pick and choose ranges of regions to switch back and forth.</para></listitem>
- <listitem><para>Have a friend - or at least somebody else - listen to the mix you're preparing. Get their opinion on difficulties that you may be having, or use them as a more generic listener.</para></listitem>
+ <listitem><para>Have a friend--or at least somebody else--listen to the mix you're preparing. Get their opinion on difficulties that you may be having, or use them as a more generic listener.</para></listitem>
<listitem><para>Listen to the mix on different kinds of reproduction equipment (speakers and amplifiers). The same audio signals will sound different when played on different equipment.</para></listitem>
</itemizedlist>
</para>
@@ -1185,7 +1192,7 @@
<section id="sect-Musicians_Guide-Ardour-Mastering-Choosing_Export_Format">
<title>Choose the Export Format</title>
<para>
- <application>Ardour</application> offers quite a variety of output formats, and knowing which to choose can be baffling. Not all options are available with all file types. Fedora Linux does not support MP3 files by default, for legal reasons. For more information, refer to <citetitle>MP3 (Fedora Project Wiki)</citetitle> <ulink url="http://fedoraproject.org/wiki/Multimedia/MP3" />.
+ <application>Ardour</application> offers quite a variety of output formats, and knowing which to choose can be baffling. Not all options are available with all file types. &OPERATING_SYSTEM; does not support MP3 files by default, for legal reasons. For more information, refer to <citetitle>MP3 (Fedora Project Wiki)</citetitle> <ulink url="http://fedoraproject.org/wiki/Multimedia/MP3" />.
</para>
<para>
The tutorial's regions have 24-bit samples, recorded at a 48 kHz rate. Exporting any part of the session with a higher sample format or sample rate is likely to result in decreased audio quality.
@@ -1220,7 +1227,7 @@
</itemizedlist> -->
</para>
<para>
- "Convesion quality" and "dither type" are not available options for the file formats offered in Fedora Linux.
+ "Convesion quality" and "dither type" are not available options for the file formats offered in &OPERATING_SYSTEM;.
</para>
<para>
The "CD Marker File Type" allows you to export a CUE- or TOC-format list of CD tracks in the exported file. This is most useful when exporting a whole session, which contains a whole CD, that would be subsequently burned to disc.
diff --git a/en-US/Musicians_Guide.ent b/en-US/Musicians_Guide.ent
index 2d97d86..e4abbbe 100644
--- a/en-US/Musicians_Guide.ent
+++ b/en-US/Musicians_Guide.ent
@@ -2,5 +2,7 @@
<!ENTITY BOOKID "musicians-guide">
<!ENTITY YEAR "2011">
<!ENTITY HOLDER "Red Hat, Inc. and others">
-<!ENTITY PRODVER "15">
-<!ENTITY PREVVER "14">
\ No newline at end of file
+<!ENTITY PRODVER "16">
+<!ENTITY PREVVER "15">
+<!ENTITY O_S "Fedora">
+<!ENTITY OPERATING_SYSTEM "Fedora Linux">
\ No newline at end of file
diff --git a/en-US/Revision_History.xml b/en-US/Revision_History.xml
index 4e4d452..35368fd 100644
--- a/en-US/Revision_History.xml
+++ b/en-US/Revision_History.xml
@@ -332,26 +332,49 @@
</revdescription>
</revision>
+ <revision>
+ <revnumber>15.9.3</revnumber>
+ <date>?????????????????????????????????????????????????????</date>
+ <author>
+ <firstname>Christopher</firstname>
+ <surname>Antila</surname>
+ <email>crantila at fedoraproject.org</email>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>Added "O_S" and "OPERATING_SYSTEM" entities to aid potential adoption by other distributions.</member>
+ <member>Started replacing "Fedora" and "Fedora Linux" with entities listed above.</member>
+ <member>Added documentation of the Ardour "nudge tool."</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+
<!-- NOTE: When adding a revision above, be sure to update the <edition> tag in "Book_Info.xml" -->
<!-- Fedora 16 (General) -->
<!-- TODO: standardize the paragraph about installing JACK -->
<!-- TODO: ensure correct permissions for JACK; I think I have the user group wrong -->
- <!-- TODO: finish the "TODO" in Ardour.xml at line 178 -->
<!-- TODO: Bug 710330 ("Section 11.5.1 Broken Link to Local Help File") -->
+ <!-- TODO: Update all files to use the &OPERATING_SYSTEM; and &O_S; entities for "Fedora Linux" and "Fedora"
+ Progress:
+ -Ardour.xml -->
<!-- QA: Bug 673519 ("Where is 'Percussion' check-box?") -->
+ <!-- DONE: finish the "TODO" in Ardour.xml at line 178 -->
<!-- Fedora 16 (LilyPond) -->
<!-- TODO: Bug 710333 ("Section 12.6 Needs to Be Rewritten") -->
<!-- TODO: Bug 710334 ("Section 12.7 Needs to Be Rewritten") -->
<!-- TODO: Bug 710336 ("Section 13 Integration with Section 12") -->
<!-- TODO: Bug 665664 ("LilyPond Example Scores Are Incomplete") -->
+ <!-- TODO: Introduction: is "ooolilypond" gone or replaced? -->
+ <!-- TODO: Revise the LilyPond introductory chapters -->
<!-- Fedora 16 (Qthings) -->
<!-- QA: Bug 670540 ("Qsynth's MIDI driver... ") -->
<!-- QA: Bug 670533 ("Qtractor chapter needs step-by-step... ") -->
- <!-- Low-Priority -->
+ <!-- Fedora 17 or Later -->
+ <!-- TODO: Revise Ardour.xml, and input correct semantic XML tags -->
<!-- TODO: Bug 665662 ("SuperCollider Chapters Are in First Person") -->
<!-- TODO: Bug 622168 ("Rosegarden Tutorial Is Boring") -->
<!-- TODO: add source-file and PDF/graphics examples to LilyPond-syntax.xml; already started for example at line 365 -->
@@ -363,8 +386,8 @@
<!-- TODO: fix up the SELinux portion of "Install SoundFont Files" in FluidSynth (ch. 10.2.5 in f15) -->
<!-- Ongoing Tasks -->
- <!-- TODO: ensure that everything is formatted correctly -->
- <!-- TODO: re-write the entire Guide to use the Chicago Manual of Style, deferring to the Apple Style Guide where necessary -->
+ <!-- TODO: Revise all chapters for correct XML tagging -->
+ <!-- TODO: Revise all chapters to use the Chicago Manual of Style, deferring to the Apple Style Guide where necessary -->
</revhistory>
</simpara>
</appendix>
diff --git a/en-US/images/Ardour-interface-nudge-pane.png b/en-US/images/Ardour-interface-nudge-pane.png
new file mode 100644
index 0000000..0b53945
Binary files /dev/null and b/en-US/images/Ardour-interface-nudge-pane.png differ
More information about the docs-commits
mailing list