docs/123918: [patch] Fix Document Format Description in FAQ

[Gabor PALI]

>Number:         123918
>Category:       docs
>Synopsis:       [patch] Fix Document Format Description in FAQ
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Fri May 23 05:10:02 UTC 2008
>Closed-Date:
>Last-Modified:
>Originator:     Gabor PALI
>Release:        FreeBSD 6.3-STABLE i386
>Organization:
>Environment:
System: FreeBSD disznohal 6.3-STABLE FreeBSD 6.3-STABLE #4: Fri Apr 4 23:29:43 CEST 2008 dezzy at disznohal:/usr/obj/usr/src/sys/GENERIC_ i386

>Description:
	I think document format description in the FreeBSD FAQ, Question 2.2
	``Is the documentation available in other formats, such as plain text
	(ASCII), or PostScript?'' should be more general, because there are
	not only books but articles, and they have a different name.
	
	To solve this problem, I would introduce a replaceable type
	parameter.

>How-To-Repeat:

>Fix:

--- books.faq.patch.3.diff begins here ---
Index: book.sgml
===================================================================
RCS file: /doc/en_US.ISO8859-1/books/faq/book.sgml,v
retrieving revision 1.811
diff -u -r1.811 book.sgml
--- book.sgml	12 Apr 2008 20:13:12 -0000	1.811
+++ book.sgml	23 May 2008 02:52:30 -0000
@@ -874,8 +874,8 @@
                 <listitem>
                   <para>All the other formats generate one file,
                     called
-                    <filename>book.<replaceable>format</replaceable></filename>
-                    (i.e., <filename>book.pdb</filename>,
+                    <filename><replaceable>type</replaceable>.<replaceable>format</replaceable></filename>
+                    (i.e., <filename>article.pdf</filename>,
                     <filename>book.html</filename>, and so on).</para>
 
                   <para>These files are then compressed using two
--- books.faq.patch.3.diff ends here ---


>Release-Note:
>Audit-Trail:
>Unformatted: