From owner-svn-doc-all@FreeBSD.ORG Sun Jun 1 01:52:30 2014 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 B4D5A4AF; Sun, 1 Jun 2014 01:52:30 +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)) (Client did not present a certificate) by mx1.freebsd.org (Postfix) with ESMTPS id 931B6212E; Sun, 1 Jun 2014 01:52:30 +0000 (UTC) Received: from svn.freebsd.org ([127.0.1.70]) by svn.freebsd.org (8.14.8/8.14.8) with ESMTP id s511qUli054900; Sun, 1 Jun 2014 01:52:30 GMT (envelope-from wblock@svn.freebsd.org) Received: (from wblock@localhost) by svn.freebsd.org (8.14.8/8.14.8/Submit) id s511qUin054899; Sun, 1 Jun 2014 01:52:30 GMT (envelope-from wblock@svn.freebsd.org) Message-Id: <201406010152.s511qUin054899@svn.freebsd.org> From: Warren Block Date: Sun, 1 Jun 2014 01:52:30 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r44988 - 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.18 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, 01 Jun 2014 01:52:30 -0000 Author: wblock Date: Sun Jun 1 01:52:30 2014 New Revision: 44988 URL: http://svnweb.freebsd.org/changeset/doc/44988 Log: Add a variablelist example to the Lists and Procedures section, and give it and the entry separate examples. 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 Jun 1 01:04:58 2014 (r44987) +++ head/en_US.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml Sun Jun 1 01:52:30 2014 (r44988) @@ -829,11 +829,11 @@ accomplish a particular goal. To do this, use itemizedlist, - orderedlist, or + orderedlist, variablelist, or procedureThere are other types of list element in DocBook, but we are not concerned with those at the - moment. + moment.. itemizedlist and orderedlist are similar to their @@ -845,16 +845,9 @@ analogous to HTML's li tags. However, unlike HTML, they are required. - procedure is slightly different. It - consists of steps, which may in turn - consists of more steps or - substeps. Each step - contains block elements. - - <tag>itemizedlist</tag>, - <tag>orderedlist</tag>, and - <tag>procedure</tag> + <tag>itemizedlist</tag> and + <tag>orderedlist</tag> Usage: @@ -876,21 +869,7 @@ listitem paraThis is the second ordered item.para listitem -orderedlist - -procedure - step - paraDo this.para - step - - step - paraThen do this.para - step - - step - paraAnd now do this.para - step -procedure +orderedlist Appearance: @@ -913,6 +892,97 @@ This is the second ordered item. + + + An alternate and often + useful way of presenting information is the + variablelist. These are lists where each entry has + a term and a description. They are well suited for many types + of descriptions, and present information in a form that is + often easier for the reader than sections and + subsections. + + A variablelist has a title, and then + pairs of term and listitem + entries. + + + <tag>variablelist</tag> + + Usage: + + variablelist + varlistentry + termParallelvarlistentry + + listitem + paraIn parallel communications, groups of bits arrive + at the same time over multiple communications + channels.para + listitem + varlistentry + + varlistentry + termSerialvarlistentry + + listitem + paraIn serial communications, bits arrive one at a + time over a single communications + channel.para + listitem + varlistentry +variablelist + + Appearance: + + + + Parallel + + + In parallel communications, groups of bits arrive + at the same time over multiple communications + channels. + + + + + Serial + + + In serial communications, bits arrive one at a + time over a single communications channel. + + + + + + A procedure shows a series of + steps, which may in turn + consist of more steps or + substeps. Each step + contains block elements. + + + <tag>procedure</tag> + + Usage: + + procedure + step + paraDo this.para + step + + step + paraThen do this.para + step + + step + paraAnd now do this.para + step +procedure + + Appearance: