From owner-svn-doc-all@FreeBSD.ORG Sun Dec 8 22:15:16 2013 Return-Path: Delivered-To: svn-doc-all@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:1900:2254:206a::19:1]) (using TLSv1 with cipher ADH-AES256-SHA (256/256 bits)) (No client certificate requested) by hub.freebsd.org (Postfix) with ESMTPS id 93759B7B; Sun, 8 Dec 2013 22:15:16 +0000 (UTC) Received: from svn.freebsd.org (svn.freebsd.org [IPv6:2001:1900:2254:2068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mx1.freebsd.org (Postfix) with ESMTPS id 73CDE13AB; Sun, 8 Dec 2013 22:15:16 +0000 (UTC) Received: from svn.freebsd.org ([127.0.1.70]) by svn.freebsd.org (8.14.7/8.14.7) with ESMTP id rB8MFGcL074912; Sun, 8 Dec 2013 22:15:16 GMT (envelope-from wblock@svn.freebsd.org) Received: (from wblock@localhost) by svn.freebsd.org (8.14.7/8.14.7/Submit) id rB8MFGRS074911; Sun, 8 Dec 2013 22:15:16 GMT (envelope-from wblock@svn.freebsd.org) Message-Id: <201312082215.rB8MFGRS074911@svn.freebsd.org> From: Warren Block Date: Sun, 8 Dec 2013 22:15:16 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r43309 - head/en_US.ISO8859-1/books/fdp-primer/docbook-markup X-SVN-Group: doc-head MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-all@freebsd.org X-Mailman-Version: 2.1.17 Precedence: list List-Id: "SVN commit messages for the entire doc trees \(except for " user" , " projects" , and " translations" \)" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sun, 08 Dec 2013 22:15:16 -0000 Author: wblock Date: Sun Dec 8 22:15:15 2013 New Revision: 43309 URL: http://svnweb.freebsd.org/changeset/doc/43309 Log: Improve examples of filename and package tag use. Modified: head/en_US.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml 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 Sun Dec 8 20:39:07 2013 (r43308) +++ head/en_US.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml Sun Dec 8 22:15:15 2013 (r43309) @@ -1558,28 +1558,30 @@ This is the file called 'foo2' Files, Directories, Extensions To refer to the name of a file, a directory, or a file - extension, use filename. + extension, use filename. For directory names, set + the class attribute to + directory. <tag>filename</tag> Usage: - paraThe XML source for the Handbook in English is - found in filename class="directory"/usr/doc/en_US.ISO8859-1/books/handbook/filename. The first - file is called filenamebook.xmlfilename in that - directory. There is also a filenameMakefilefilename - and a number of files with a filename.entfilename - extension.para + paraThe source for the Handbook in English is found in + filename + class="directory"/usr/doc/en_US.ISO8859-1/books/handbook/filename. + The main file is called filenamebook.xmlfilename. + There is also a filenameMakefilefilename and a + number of files with a filename.entfilename extension.para Appearance: - The XML source for the Handbook in English can be - found in /usr/doc/en/handbook/. The - first file is called handbook.xml in - that directory. There is also a - Makefile and a number of files with a - .ent extension. + The source for the Handbook in English is found in + usr/doc/en_US.ISO8859-1/books/handbook/. + The main file is called book.xml. + There is also a Makefile and a number + of files with a .ent extension. @@ -1596,22 +1598,35 @@ This is the file called 'foo2' To include the name of a program from the &os; Ports Collection in the document, use the - package tag. Since ports can be installed in + package tag. Since the Ports Collection can be installed in any number of locations, only include the category and the port name; do not include /usr/ports. + By default, package refers to a binary package. + To refer to a port that will be built from source, set the + role attribute to + port. + <tag>package</tag> Tag Usage: - paraInstall the packagenet/wiresharkpackage port to view network traffic.para + paraInstall the packagenet/wiresharkpackage binary + package to view network traffic.para + +parapackage role="port"net/wiresharkpackage can also be + built and installed from the Ports Collection.para Appearance: - Install the net/wireshark port to + Install the net/wireshark binary + package to view network traffic. + + net/wireshark can also be + built and installed from the Ports Collection. @@ -2330,7 +2345,7 @@ IMAGES+= fig3.png names in the IMAGES variable in the Makefile, and including the directory name in the imagedata - element in the document document. + element in the document. For example, if the book has chapter1/fig1.png, then