documentation-guide docs-getting-files-en.xml,1.9,1.10

[Tommy Reynolds (jtr)]

Author: jtr

Update of /cvs/docs/documentation-guide
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv6139

Modified Files:
	docs-getting-files-en.xml 
Log Message:
Fixed minor typo's.  Added admonition about preferring PNG to JPG.



Index: docs-getting-files-en.xml
===================================================================
RCS file: /cvs/docs/documentation-guide/docs-getting-files-en.xml,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- docs-getting-files-en.xml	13 Dec 2005 21:56:24 -0000	1.9
+++ docs-getting-files-en.xml	14 Dec 2005 15:55:34 -0000	1.10
@@ -200,7 +200,7 @@
     <para>
       The building system heavily leverages the <application>make(1)</application> tool and shell scripts to automate these activities, but authors need <emphasis>no</emphasis> prior experience with either shell scripts or a <filename>Makefile</filename>.
       While individual documents do have their own <filename>Makefile</filename>, it is only a few lines long and very simple.
-      The document <filename>Makefile</filename> content is designed for cut's paste.
+      The document <filename>Makefile</filename> content is designed for cut'n paste.
     </para>
     <para>
       As an example, <xref linkend="ch-getting-files-build-system-makefile"/> shows the whole <filename>Makefile</filename> for a simple document having only one file and one language.
@@ -351,12 +351,24 @@
       </para>
     </section>
     <section id="ch-getting-files-build-system-images">
-      <title>Finding Document Image Files</title>
+      <title>Using Document Image Files</title>
       <para>
         Image files, such as <filename>.PNG</filename>, are often used in documents.
         While your image files may be placed anywhere you like, we recommend that you store your image files in a <filename>figs/</filename> subdirectory within your document directory.
         In other words, place your image <filename>picture.png</filename> in the <filename>mydoc/figs/picture.png</filename> file.
       </para>
+      <note>
+      <title>Use PNG Images, Not JPG</title>
+        <para>
+            Depending on the output media, sometimes images may be scaled,
+            streteched, or squashed.
+            To minimize any distortions, we recommend that you use only
+            <wordasword>PDF</wordasword> images and avoid <wordasword>JPG</wordasword> files.
+        </para>
+        <para>
+          You may find the <systemitem class="filesystem">convert(1)</systemitem> program, from the <application>ImageMagick</application> <abbrev>RPM</abbrev> package, provides a convenient way to reformat any <wordasword>JPG</wordasword> images you already have.
+        </para>
+      </note>
       <para>
         You may organize your image files into as many subdirectories under <filename>figs/</filename> as you choose.
         The document building system will recreate your image subdirectory structure in the output documents.
@@ -365,6 +377,7 @@
         In addition, we recommend that you follow our convention on naming the image.
         For example, an image often contains a caption or other text.
         This text should be translated along with the document content, so keeping <filename>words-en.png</filename> separate from <filename>words-ru.png</filename> is a good practice.
+        An image file with no text can be named just <filename>picture.png</filename>, for example.
       </para>
       <para>
         Sometimes, a document may require images that do not follow the naming convention.