[musicians-guide] revision 15.9.3

Christopher Antila crantila at fedoraproject.org
Mon Jul 4 02:32:54 UTC 2011


commit 9999e7ac6daff92c1a4d78a03abb68b4cee5979d
Author: Christopher Antila <crantila at fedoraproject.org>
Date:   Sun Jul 3 22:32:37 2011 -0400

    revision 15.9.3

 en-US/Book_Info.xml         |    2 +-
 en-US/LilyPond/LilyPond.xml |  105 ++++++++++++++++++++++++++++++++++++++++---
 en-US/Musicians_Guide.ent   |    3 +-
 en-US/Musicians_Guide.xml   |    3 +-
 en-US/Revision_History.xml  |   14 +++++-
 5 files changed, 117 insertions(+), 10 deletions(-)
---
diff --git a/en-US/Book_Info.xml b/en-US/Book_Info.xml
index 397ef5d..97e6881 100644
--- a/en-US/Book_Info.xml
+++ b/en-US/Book_Info.xml
@@ -9,7 +9,7 @@
   <!-- Haydn: <subtitle>A guide to Fedora Linux's audio creation and music capabilities, written in a new and special way.</subtitle> -->
   <productname>Fedora Draft Documentation</productname>
   <pubsnumber>0</pubsnumber> <!-- N.B.: I have no idea why this is here, but the book doesn't work without it -CRA -->
-  <edition>15.9.2</edition>
+  <edition>15.9.3</edition>
   
   <abstract>
     <para>
diff --git a/en-US/LilyPond/LilyPond.xml b/en-US/LilyPond/LilyPond.xml
index 16a21e4..6236791 100644
--- a/en-US/LilyPond/LilyPond.xml
+++ b/en-US/LilyPond/LilyPond.xml
@@ -54,14 +54,107 @@
 	
 	<section id="sect-Musicians_Guide-LilyPond-Installation">
 		<title>Requirements and Installation</title>
-		<procedure>
-			<step><para>Use PackageKit or KPackageKit to install the <literal>lilypond</literal> package.</para></step>
-			<step><para>Review the dependencies.  Many packages called <literal>lilypond-*-fonts</literal> are installed.</para></step>
-			<step><para><application>LilyPond</application> is run from the command line, with the command <command>lilypond</command>.</para></step>
-		</procedure>
 		<para>
-			We recommend that you use the <application>Frescobaldi</application> text editor, which is designed specifically for <application>LilyPond</application>. It has many features that enhance productivity when editing <application>LilyPond</application> files, and that greatly speed up the learning process. Refer to <xref linkend="chap-Musicians_Guide-Frescobaldi" /> for more information.
+			Use <application>PackageKit</application> or <application>KPackageKit</application> to install the <package>lilypond</package> package. Review the dependencies carefully. You will see many packages called <package>lilypond-*-fonts</package>.
+		</para>
+		<para>
+			You can use <application>LilyPond</application> from the command line. Run <command>lilypond <replaceable>input_file.ly</replaceable></command> in a terminal emulator.
+		</para>
+		<para>
+			We recommend that you use the <application>Frescobaldi</application> text editor with <application>LilyPond</application>. <application>Frescobaldi</application> has many features specifically for <application>LilyPond</application>.
 		</para>
+		<section id="sect-Musicians_Guide-LilyPond-Installation-Frescobaldi">
+			<title>Learn about Frescobaldi</title>
+			<para>
+				<application>Frescobaldi</application> is an advanced text editor specifically for <application>LilyPond</application> source files. The <application>Frescobaldi</application> user interface simplifies the task of creating and editing musical scores in <application>LilyPond</application>. Here are some benefits of <application>Frescobaldi</application>:
+				<itemizedlist>
+					<listitem><para>The <application>Frescobaldi</application> text-editing component, PDF-preview component, and help file viewer are the same as common applications you may already know (<application>Kate</application>/<application>KWrite</application>, <application>Okular</application>, and <application>Konqueror</application>).</para></listitem>
+					<listitem><para>The <application>Frescobaldi</application> user interface allows you to view the <application>LilyPond</application> source file and the PDF output or a <application>LilyPond</application> help document at the same time.</para></listitem>
+					<listitem><para>You can setup a new score quickly with the "Setup new score" tool. The "Setup new score" tool offers several advanced customization features.</para></listitem>
+					<listitem><para>You can insert articulation, trill, and other musical symbols with the "Quick Insert" sidebar on the left side of the <application>Frescobaldi</application> window. You do not need to consult a <application>LilyPond</application> reference file to remember the correct command because <application>Frescobaldi</application> remembers for you.</para></listitem>
+					<listitem><para>The <menuchoice><guimenu>LilyPond</guimenu></menuchoice> menu in <application>Frescobaldi</application> offers many tools to adjust and troubleshoot your score files.</para></listitem>
+					<listitem><para>You can input notes with a MIDI keyboard, listen to the MIDI output of a <application>LilyPond</application> score, and print the PDF file of your score from within <application>Frescobaldi</application>.</para></listitem>
+				</itemizedlist>
+			</para>
+		</section>
+		<section id="sect-Musicians_Guide-LilyPond-Installation-Frescobaldi-Installation">
+			<title>Requirements and Installation (for <application>Frescobaldi</application>)</title>
+			<para>
+				Use <application>PackageKit</application> or <application>KPackageKit</application> to install the <package>frescobaldi</package> package. Review dependencies carefully before you approve the installation. <application>Frescobaldi</application> depends on many other packages, including:
+				<itemizedlist>
+					<listitem><para><package>perl-<replaceable>*</replaceable></package> packages,</para></listitem>
+					<listitem><para><package>kde-<replaceable>*</replaceable></package> packages,</para></listitem>
+					<listitem><para><application>timidity++</application>, and</para></listitem>
+					<listitem><para><package>fluid-soundfont-gm</package> (which is 114&nbsp;MB)</para></listitem>
+				</itemizedlist>
+			</para>
+			<para>
+				You can run <application>Frescobaldi</application> from the <menuchoice><guisubmenu>Multimedia</guisubmenu></menuchoice> submenu of the <menuchoice><guimenu>Applications</guimenu></menuchoice> menu.
+			</para>
+		</section>
+	</section>
+	
+	<section id="sect-Musicians_Guide-LilyPond-Configure_Frescobaldi">
+		<title>Configure <application>Frescobaldi</application></title>
+		<para>
+			You can use <application>Frescobaldi</application> without further configuration. We recommend you review the settings listed here, because you may use the application more easily.
+		</para>
+		<procedure>
+			<step>
+				<para>
+					From the <application>Frescobaldi</application> menu, choose <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Frescobaldi</guimenuitem></menuchoice>
+				</para>
+			</step>
+			<step>
+				<para>If you want <application>Frescobaldi</application> to save your score automatically before you run <application>LilyPond</application>: check "Save document when LilyPond is run" located in "General Preferences."</para>
+			</step>
+			<step>
+				<para>If you want to change the applications that <application>Frescobaldi</application> uses, choose <guibutton>Paths</guibutton>.
+					<itemizedlist>
+						<listitem>
+							<note><para>You do not need to fill every field.</para></note>
+						</listitem>
+						<listitem>
+							<para>
+								If you use GNOME, we recommend you set the "PDF Viewer" to <command>evince</command>. <application>Frescobaldi</application> will use <application>Evince</application> when you choose <guibutton>Open PDF</guibutton>. The <guibutton>Open PDF</guibutton> button is only visible after you create a score.
+							</para>
+						</listitem>
+						<listitem>
+							<para>
+								If you want to play a <application>LilyPond</application> MIDI file, fill in the "MIDI Player" field. You can use <application>timidity++</application> to convert the MIDI file into a sound file. You can use <application>pmidi</application> (from the Planet CCRMA at Home repository--see <xref linkend="chap-Musicians_Guide-Planet_CCRMA_at_Home" /> for information). Use a terminal emulator to view the <application>man</application> help page for <application>timidity++</application> or <application>pmidi</application>.
+							</para>
+							<!-- <para>
+									The program "pmidi" is available from the Planet CCRMA at Home repositories, and is a command-line MIDI player;  install it with yum; run 'pmidi -l' to see which ports are available; then put "pmidi -p 14:0" in the "MIDI Player" field where "14:0" is instead whatever port you want to use; you'll need a MIDI synthesizer (like FluidSynth) listening.
+							</para> -->
+						</listitem>
+						<listitem>
+							<para>If you do not want to download the <application>LilyPond</application> help files whenever <application>Frescobaldi</application> uses them:
+								<itemizedlist>
+									<listitem>
+										<para>Install the <package>lilypond-doc</package> package. This package takes a long time to download.</para>
+									</listitem>
+									<listitem>
+										<para>Write <filename>/usr/share/doc/lilypond-doc-<replaceable>&LilyPond-version;</replaceable>/index.html</filename> in the "LilyPond documentation" field. </para>
+									</listitem>
+									<listitem>
+										<para>You must update this path when <application>LilyPond</application> is updated. By default, <application>PackageKit</application> will only download the changed documentation with each update, so only the first installation will have a long download.</para>
+									</listitem>
+								</itemizedlist>
+							</para>
+						</listitem>
+					</itemizedlist>
+				</para>
+			</step>
+			<step>
+				<para>The options for the "Editor Component" are the same as those for <application>KWrite</application> or <application>Kate</application>. If you change settings for <application>Frescboaldi</application>, they do <emphasis>not</emphasis> also change for <application>KWrite</application> or <application>Kate</application>.</para>
+					<itemizedlist>
+						<listitem>
+							<para>We recommend that you turn off auto-completion. Select the <guibutton>Editing</guibutton> component, then the <guibutton>Auto Completion</guibutton> tab, then ensure that both check-boxes are un-marked</para>
+						</listitem>
+						<listitem><para>You may want to change other settings here; highly-flexible, customizable, powerful; applies only in Frescobaldi</para></listitem>
+					</itemizedlist>
+			</step>
+		</procedure>
 	</section>
 	
 	<xi:include href="LilyPond-syntax.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
diff --git a/en-US/Musicians_Guide.ent b/en-US/Musicians_Guide.ent
index e4abbbe..e312c8c 100644
--- a/en-US/Musicians_Guide.ent
+++ b/en-US/Musicians_Guide.ent
@@ -5,4 +5,5 @@
 <!ENTITY PRODVER "16">
 <!ENTITY PREVVER "15">
 <!ENTITY O_S "Fedora">
-<!ENTITY OPERATING_SYSTEM "Fedora Linux">
\ No newline at end of file
+<!ENTITY OPERATING_SYSTEM "Fedora Linux">
+<!ENTITY LilyPond-version "2.14.1">
\ No newline at end of file
diff --git a/en-US/Musicians_Guide.xml b/en-US/Musicians_Guide.xml
index fe8590d..ed6cfb8 100644
--- a/en-US/Musicians_Guide.xml
+++ b/en-US/Musicians_Guide.xml
@@ -48,7 +48,8 @@
 			
 			<!-- Typesetting -->
 			<xi:include href="LilyPond/LilyPond.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-			<xi:include href="Frescobaldi.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+			<!-- <xi:include href="Frescobaldi.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> -->
+			<!-- "Frescobaldi" integrated with "LilyPond" as of 15.9.3, in preparation for Fedora 16; file still exists -->
 		
 			<!-- Aural Skills Training -->
 			<xi:include href="Solfege.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
diff --git a/en-US/Revision_History.xml b/en-US/Revision_History.xml
index 35368fd..8224144 100644
--- a/en-US/Revision_History.xml
+++ b/en-US/Revision_History.xml
@@ -334,7 +334,7 @@
 			
 			<revision>
 				<revnumber>15.9.3</revnumber>
-				<date>?????????????????????????????????????????????????????</date>
+				<date>3 July 2011</date>
 				<author>
 					<firstname>Christopher</firstname>
 					<surname>Antila</surname>
@@ -345,16 +345,28 @@
 					  <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>
+					  <member>Integrated useful parts of "Frescobaldi" chapter into "LilyPond" chapter and removed "Frescobaldi."</member>
 					</simplelist>
 				</revdescription>
 			</revision>
 			
 			<!-- NOTE: When adding a revision above, be sure to update the <edition> tag in "Book_Info.xml" -->
 			
+			<!--
+				-Frescobaldi: Will be integrated with the "LilyPond" file for Fedora 16.
+				-LilyPond-piano: Will be completely new for Fedora 16 (available for translation by September 1st)
+				-LilyPond-orchestra: Will be completely new for Fedora 17 or 18
+				-SuperCollider: All files need revised grammar, but with the same meaning; probably for Fedora 18
+				-Rosegarden: Tutorial will be completely new, or chapter will be removed, for Fedora 20.
+				-Qtractor: If Rosegarden is removed in Fedora 20, Qtractor will have an additional tutorial.
+			-->
+			
 			<!-- 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: Bug 710330 ("Section 11.5.1 Broken Link to Local Help File") -->
+			<!-- TODO: include the Qtractor tutorial recording -->
+			<!-- TODO: change copyright holder, front-page placement of my name, and create "contributors to this guide" appendix -->
 			<!-- TODO: Update all files to use the &OPERATING_SYSTEM; and &O_S; entities for "Fedora Linux" and "Fedora"
 						Progress:
 						-Ardour.xml -->


More information about the docs-commits mailing list