summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTommy Reynolds <Tommy.Reynolds@MegaCoder.com>2005-12-14 15:55:34 +0000
committerTommy Reynolds <Tommy.Reynolds@MegaCoder.com>2005-12-14 15:55:34 +0000
commitd31866be2dd42315ac4d4d605dfd72997d8c4518 (patch)
tree5c843e2d18e5a0c6d613e82486c2ab23d0c5021b
parent35d09733456dc09d1f0da062b7175409587e1f3d (diff)
downloaddocumentation-guide-d31866be2dd42315ac4d4d605dfd72997d8c4518.tar.gz
documentation-guide-d31866be2dd42315ac4d4d605dfd72997d8c4518.tar.xz
documentation-guide-d31866be2dd42315ac4d4d605dfd72997d8c4518.zip
Fixed minor typo's. Added admonition about preferring PNG to JPG.
-rw-r--r--docs-getting-files-en.xml17
1 files changed, 15 insertions, 2 deletions
diff --git a/docs-getting-files-en.xml b/docs-getting-files-en.xml
index abed9c4..8f362d8 100644
--- a/docs-getting-files-en.xml
+++ b/docs-getting-files-en.xml
@@ -200,7 +200,7 @@ cvs co example-tutorial</userinput>
<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&apos;s paste.
+ The document <filename>Makefile</filename> content is designed for cut&apos;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 @@ include ../docs-common/Makefile.common
</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 @@ include ../docs-common/Makefile.common
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.