svn commit: r44895 - in head/en_US.ISO8859-1/books/fdp-primer: . docbook-markup

[Hiroki Sato]

Author: hrs
Date: Wed May 21 09:23:53 2014
New Revision: 44895
URL: http://svnweb.freebsd.org/changeset/doc/44895

Log:
  - Add SCR and PIC as image format.
  - Bump copyright year.

Modified:
  head/en_US.ISO8859-1/books/fdp-primer/book.xml
  head/en_US.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml

Modified: head/en_US.ISO8859-1/books/fdp-primer/book.xml
==============================================================================
--- head/en_US.ISO8859-1/books/fdp-primer/book.xml	Wed May 21 03:03:39 2014	(r44894)
+++ head/en_US.ISO8859-1/books/fdp-primer/book.xml	Wed May 21 09:23:53 2014	(r44895)
@@ -59,6 +59,7 @@
       <year>2011</year>
       <year>2012</year>
       <year>2013</year>
+      <year>2014</year>
       <holder role="mailto:doceng at FreeBSD.org">DocEng</holder>
     </copyright>
 

Modified: head/en_US.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml
==============================================================================
--- head/en_US.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml	Wed May 21 03:03:39 2014	(r44894)
+++ head/en_US.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml	Wed May 21 09:23:53 2014	(r44895)
@@ -2072,24 +2072,68 @@ This is the file called 'foo2'</screen>
     <sect2 xml:id="docbook-markup-image-formats">
       <title>Image Formats</title>
 
-      <para>Two image formats are currently supported.  The type of
-	image determines which format to use.</para>
-
-      <para>Images that are primarily vector based, such as network
-	diagrams, time lines, and similar, should be in
-	<acronym>EPS</acronym> (Encapsulated Postscript) format.
-	These images have a <filename>.eps</filename>
-	extension.</para>
-
-      <para>For bitmaps, such as screen captures, use the
-	<acronym>PNG</acronym> (Portable Network Graphic) format.
-	These images have the <filename>.png</filename>
-	extension.</para>
+      <para>The following image formats are currently supported.  An
+	image file will automatically be converted to bitmap or vector
+	image depending on the output document format.</para>
 
       <para>These are the <emphasis>only</emphasis> formats in which
 	images should be committed to the documentation
 	repository.</para>
 
+      <variablelist>
+	<varlistentry>
+	  <term><acronym>EPS</acronym> (Encapsulated Postscript)</term>
+
+	  <listitem>
+	    <para>Images that are primarily vector based, such as
+	      network diagrams, time lines, and similar, should be in
+	      this format.  These images have a
+	      <filename>.eps</filename> extension.</para>
+	  </listitem>
+	</varlistentry>
+
+	<varlistentry>
+	  <term><acronym>PNG</acronym> (Portable Network Graphic)</term>
+
+	  <listitem>
+	    <para>For bitmaps, such as screen captures, use this format.
+	      These images have the <filename>.png</filename>
+	      extension.</para>
+	  </listitem>
+	</varlistentry>
+
+	<varlistentry>
+	  <term><acronym>PIC</acronym> (PIC graphics language)</term>
+
+	  <listitem>
+	    <para><acronym>PIC</acronym> is a language for drawing
+	      simple vector-based figures used in the &man.pic.1;
+	      utility.  These images have the
+	      <filename>.pic</filename> extension.</para>
+	  </listitem>
+	</varlistentry>
+
+	<varlistentry>
+	  <term><acronym>SCR</acronym> (SCReen capture)</term>
+
+	  <listitem>
+	    <para>This format is specific to screenshots of console
+	      output.  The following command generates an SCR file
+	      <filename>shot.scr</filename> from video buffer of
+	      <filename>/dev/ttyv0</filename>:</para>
+
+	    <screen>&prompt.root; <userinput><command>vidcontrol -p</command> < <filename><replaceable>/dev/ttyv0</replaceable></filename> > <filename><replaceable>shot.scr</replaceable></filename></userinput></screen>
+
+	    <para>This is preferable to <acronym>PNG</acronym> format
+	      for screenshots because the <acronym>SCR</acronym> file
+	      contains plain text of the command lines so that it can
+	      be converted to a <acronym>PNG</acronym> image or a
+	      plain text depending on the output document
+	      format.</para>
+	  </listitem>
+	</varlistentry>
+      </variablelist>
+
       <para>Use the appropriate format for each image.  Documentation
 	will often have a mix of <acronym>EPS</acronym> and
 	<acronym>PNG</acronym> images.  The