From nobody Sun Jan 09 11:37:50 2022 X-Original-To: dev-commits-doc-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 86BC7194B265 for ; Sun, 9 Jan 2022 11:37:50 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4JWw1V1hJfz4ktK; Sun, 9 Jan 2022 11:37:50 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 1B2DD11A82; Sun, 9 Jan 2022 11:37:50 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 209BboO1015981; Sun, 9 Jan 2022 11:37:50 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 209Bbo5k015980; Sun, 9 Jan 2022 11:37:50 GMT (envelope-from git) Date: Sun, 9 Jan 2022 11:37:50 GMT Message-Id: <202201091137.209Bbo5k015980@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: "Danilo G. Baio" Subject: git: 079fda540d - main - fdp-primer/doc-build: Update pdf instructions List-Id: Commit messages for all branches of the doc repository List-Archive: https://lists.freebsd.org/archives/dev-commits-doc-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-doc-all@freebsd.org X-BeenThere: dev-commits-doc-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: dbaio X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 079fda540d30e1830239bede5fcb8a2816993850 Auto-Submitted: auto-generated ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1641728270; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=UwffgAtV1DHLzhT/CA3z256OhRjKmaKkjTkBlQvKEUI=; b=qRpMV9J+1ahO4faTfeMV647DxjYuus+akb6YDaMXzCEky5zWh1mRNn1utIP8gBKq2qemKZ jc/2yG7ZT59oZ2CsLy4awXIMmC5nAPbpw9MsQbrczaXH0ja19iNVYRLjnYnfQSXmq+yd0g ONwu2RLz73sZQfwS1DX875MYIBHsVkrSTQppPXD9jgWLOa0zSBAAT2JpfHDJaA6VS5sDEl fr8q3IhmiQyY8qDpCf+nCFqiI/0I/zsitwODUesVxbE21aJ1OKHYo8wIU6tGYz6aeQYOWU uy+E3YIeOgZDgkrXj80ytYmaAo65kEGx2WWabpXqJA8D1bHIY4TpHSbB1rj7xA== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1641728270; a=rsa-sha256; cv=none; b=CeOHrTkNe2AMlKRVC1nTFu+YlUCe+P+d5k5thfy3BHfblrV8w2+M0Y3sdQ1F8of71OzDvZ pDocKljqghafZvlYc/cUCiTOTB7RfkYMPMqiKXbmI9egyob3wKNNa1faJZTkOD20buqQTo yY5zgVXZyp8GdhSOl4yDVGCcS1kghFt5kudGbAZNb7V16AUew6etZ11Wh2PE+4pJPEA9d7 ABypXoQXYcyxLunt8FhbUFx8Rx0HNAs82oMzca13I2lsIechdaDDPtLtYrNbAdogzSoPtx IfaWPqo0YNrlarXNfHvDBtjjDiNUyE4LEHrnGPDheV5r6p0i6wBauw0fTGgiwA== ARC-Authentication-Results: i=1; mx1.freebsd.org; none X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by dbaio: URL: https://cgit.FreeBSD.org/doc/commit/?id=079fda540d30e1830239bede5fcb8a2816993850 commit 079fda540d30e1830239bede5fcb8a2816993850 Author: Danilo G. Baio AuthorDate: 2022-01-09 02:29:08 +0000 Commit: Danilo G. Baio CommitDate: 2022-01-09 11:36:30 +0000 fdp-primer/doc-build: Update pdf instructions Now there are specific targets to build pdf documents. It's not needed to use asciidoctor-pdf directly. --- .../en/books/fdp-primer/doc-build/_index.adoc | 59 ++++++++++++++++------ 1 file changed, 44 insertions(+), 15 deletions(-) diff --git a/documentation/content/en/books/fdp-primer/doc-build/_index.adoc b/documentation/content/en/books/fdp-primer/doc-build/_index.adoc index 19c2b20063..f240133e53 100644 --- a/documentation/content/en/books/fdp-primer/doc-build/_index.adoc +++ b/documentation/content/en/books/fdp-primer/doc-build/_index.adoc @@ -154,31 +154,60 @@ A `hostname` can also be set as base url to Hugo’s internal webserver: [[doc-build-rendering-pdf]] === Rendering to pdf -To generate a document in `pdf` format use this command. -In this example the English Handbook will be used. -In order to export the document correctly all the extensions should be passed using the `-r` argument. +To render the documentation to `pdf`, use one of the following examples. [[document-pdf-example]] -.Build a document in pdf +.Build all documents in pdf [example] ==== [source,shell] .... % cd ~/doc/documentation -% asciidoctor-pdf \ - -r ./shared/lib/man-macro.rb \ - -r ./shared/lib/git-macro.rb \ - -r ./shared/lib/packages-macro.rb \ - -r ./shared/lib/inter-document-references-macro.rb \ - -r ./shared/lib/sectnumoffset-treeprocessor.rb \ - --doctype=book \ - -a skip-front-matter \ - -a pdf-theme=./themes/default-pdf-theme.yml \ - -o /tmp/handbook.pdf \ - content/en/books/handbook/book.adoc +% make pdf .... ==== +[[document-pdf-articles-example]] +.Build all articles in pdf +[example] +==== +[source,shell] +.... +% cd ~/doc/documentation +% make pdf-articles +.... +==== + +[[document-pdf-books-example]] +.Build all books in pdf +[example] +==== +[source,shell] +.... +% cd ~/doc/documentation +% make pdf-books +.... +==== + +[[document-pdf-language-example]] +.Build documents in pdf for specific languages +[example] +==== +[source,shell] +.... +% cd ~/doc/documentation +% make DOC_LANG="en" pdf +.... +This will build all English documents in pdf. + +[source,shell] +.... +% cd ~/doc/documentation +% make DOC_LANG="en fr" pdf-books +.... +This will build all English and French books in pdf. +==== + [[doc-build-toolset]] == The FreeBSD Documentation Build Toolset