From owner-svn-doc-all@freebsd.org Wed Sep 2 20:28:04 2015 Return-Path: Delivered-To: svn-doc-all@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:1900:2254:206a::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id C6E859C81CE; Wed, 2 Sep 2015 20:28:04 +0000 (UTC) (envelope-from wblock@FreeBSD.org) Received: from repo.freebsd.org (repo.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 B70DA130D; Wed, 2 Sep 2015 20:28:04 +0000 (UTC) (envelope-from wblock@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.70]) by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id t82KS4ou012016; Wed, 2 Sep 2015 20:28:04 GMT (envelope-from wblock@FreeBSD.org) Received: (from wblock@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id t82KS4ZY012015; Wed, 2 Sep 2015 20:28:04 GMT (envelope-from wblock@FreeBSD.org) Message-Id: <201509022028.t82KS4ZY012015@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: wblock set sender to wblock@FreeBSD.org using -f From: Warren Block Date: Wed, 2 Sep 2015 20:28:04 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r47338 - head/en_US.ISO8859-1/books/fdp-primer/doc-build 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.20 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: Wed, 02 Sep 2015 20:28:05 -0000 Author: wblock Date: Wed Sep 2 20:28:03 2015 New Revision: 47338 URL: https://svnweb.freebsd.org/changeset/doc/47338 Log: Add a skeletally brief overview of the FORMATS variable and actually show how to build an output file. Both of these are things might be of more than academic value to someone working on the documentation. Modified: head/en_US.ISO8859-1/books/fdp-primer/doc-build/chapter.xml Modified: head/en_US.ISO8859-1/books/fdp-primer/doc-build/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/fdp-primer/doc-build/chapter.xml Wed Sep 2 15:20:47 2015 (r47337) +++ head/en_US.ISO8859-1/books/fdp-primer/doc-build/chapter.xml Wed Sep 2 20:28:03 2015 (r47338) @@ -36,6 +36,76 @@ This chapter covers organization of the documentation build process and how &man.make.1; is used to control it. + + Rendering DocBook into Output + + Different types of output can be produced from a single + DocBook source file. The type of output desired is set with the + FORMATS variable. A list of known formats is + stored in KNOWN_FORMATS: + + &prompt.user; cd ~/doc/en_US.ISO8859-1/books/handbook +&prompt.user; make -V KNOWN_FORMATS + + + Common Output Formats + + + + + FORMATS Value + File Type + Description + + + + + + html + HTML, one file + A single book.html or + article.html. + + + + html-split + HTML, multiple files + Multiple HTML files, one for + each chapter or section, for use on a typical web + site. + + + + pdf + PDF + Portable Document Format + + + +
+ + The default output format can vary by document, but is + usually html-split. Other formats are chosen + by setting FORMATS to a specific value. + Multiple output formats can be created at a single time by + setting FORMATS to a list of formats. + + + Build a Single HTML Output File + + &prompt.user; cd ~/doc/en_US.ISO8859-1/books/handbook +&prompt.user; make FORMATS=html + + + + Build HTML-Split and <acronym>PDF</acronym> Output + Files + + &prompt.user; cd ~/doc/en_US.ISO8859-1/books/handbook +&prompt.user; make FORMATS="html-split pdf" + + + The &os; Documentation Build Toolset