1 ;;; GNU Guix --- Functional package management for GNU
2 ;;; Copyright © 2019 Ludovic Courtès <ludo@gnu.org>
4 ;;; This file is part of GNU Guix.
6 ;;; GNU Guix is free software; you can redistribute it and/or modify it
7 ;;; under the terms of the GNU General Public License as published by
8 ;;; the Free Software Foundation; either version 3 of the License, or (at
9 ;;; your option) any later version.
11 ;;; GNU Guix is distributed in the hope that it will be useful, but
12 ;;; WITHOUT ANY WARRANTY; without even the implied warranty of
13 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 ;;; GNU General Public License for more details.
16 ;;; You should have received a copy of the GNU General Public License
17 ;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
20 ;; This file contains machinery to build HTML and PDF copies of the manual
21 ;; that can be readily published on the web site. To do that, run:
23 ;; guix build -f build.scm
25 ;; The result is a directory hierarchy that can be used as the manual/
26 ;; sub-directory of the web site.
36 (gnu packages gettext)
38 (gnu packages guile-xyz)
39 (gnu packages iso-codes)
40 (gnu packages texinfo)
46 (@@ (guix self) file-append*))
48 (define translated-texi-manuals
49 (@@ (guix self) translate-texi-manuals))
52 (@@ (guix self) info-manual))
55 ;; The manual to build--i.e., the base name of a .texi file, such as "guix"
56 ;; or "guix-cookbook".
57 (or (getenv "GUIX_MANUAL")
61 '("de" "en" "es" "fr" "ru" "zh_CN"))
63 (define (texinfo-manual-images source)
64 "Return a directory containing all the images used by the user manual, taken
65 from SOURCE, the root of the source tree."
67 (module-ref (resolve-interface '(gnu packages graphviz))
71 (file-append* source "doc/images"))
74 (with-imported-modules '((guix build utils))
76 (use-modules (guix build utils)
79 (define (dot->image dot-file format)
80 (invoke #+(file-append graphviz "/bin/dot")
81 "-T" format "-Gratio=.9" "-Gnodesep=.005"
82 "-Granksep=.00005" "-Nfontsize=9"
83 "-Nheight=.1" "-Nwidth=.1"
84 "-o" (string-append #$output "/"
85 (basename dot-file ".dot")
91 (for-each (lambda (dot-file)
92 (for-each (cut dot->image dot-file <>)
94 (find-files #$images "\\.dot$"))
97 (for-each (lambda (png-file)
98 (install-file png-file #$output))
99 (find-files #$images "\\.png$")))))
101 (computed-file "texinfo-manual-images" build))
103 (define* (texinfo-manual-source source #:key
105 (languages %languages)
107 "Gather all the source files of the Texinfo manuals from SOURCE--.texi file
108 as well as images, OS examples, and translations."
109 (define documentation
110 (file-append* source "doc"))
113 (file-append* source "gnu/system/examples"))
116 (with-imported-modules '((guix build utils))
118 (use-modules (guix build utils)
121 (define (make-version-texi language)
122 ;; Create the 'version.texi' file for LANGUAGE.
123 (let ((file (if (string=? language "en")
125 (string-append "version-" language ".texi"))))
126 (call-with-output-file (string-append #$output "/" file)
128 (let* ((version #$version)
129 (time (make-time time-utc 0 #$date))
130 (date (time-utc->date time)))
133 @set UPDATED-MONTH ~a
136 (date->string date "~e ~B ~Y")
137 (date->string date "~B ~Y")
138 version version))))))
140 (install-file #$(file-append* documentation "/htmlxref.cnf")
143 (for-each (lambda (texi)
144 (install-file texi #$output))
145 (append (find-files #$documentation "\\.(texi|scm)$")
146 (find-files #$(translated-texi-manuals source)
149 ;; Create 'version.texi'.
150 (for-each make-version-texi '#$languages)
152 ;; Copy configuration templates that the manual includes.
153 (for-each (lambda (template)
156 #$output "/os-config-"
157 (basename template ".tmpl")
159 (find-files #$examples "\\.tmpl$"))
161 (symlink #$(texinfo-manual-images source)
162 (string-append #$output "/images")))))
164 (computed-file "texinfo-manual-source" build))
166 (define %web-site-url
167 ;; URL of the web site home page.
168 (or (getenv "GUIX_WEB_SITE_URL")
171 (define %makeinfo-html-options
172 ;; Options passed to 'makeinfo --html'.
173 '("--css-ref=https://www.gnu.org/software/gnulib/manual.css"
174 "-c" "EXTRA_HEAD=<meta name=\"viewport\" \
175 content=\"width=device-width, initial-scale=1\" />"))
177 (define guile-lib/htmlprag-fixed
178 ;; Guile-Lib with a hotfix for (htmlprag).
182 (inherit (package-source guile-lib))
183 (modules '(( guix build utils)))
187 ;; "<body><blockquote><p>foo</p>\n</blockquote></body>",
188 ;; 'html->shtml' would mistakenly close 'blockquote' right
189 ;; before <p>. This patch removes 'p' from the
190 ;; 'parent-constraints' alist to fix that.
191 (substitute* "src/htmlprag.scm"
192 (("^[[:blank:]]*\\(p[[:blank:]]+\\. \\(body td th\\)\\).*")
196 (substitute-keyword-arguments (package-arguments guile-lib)
197 ((#:phases phases '%standard-phases)
198 `(modify-phases ,phases
199 (add-before 'check 'skip-known-failure
201 ;; XXX: The above change causes one test failure among
202 ;; the htmlprag tests.
203 (setenv "XFAIL_TESTS" "htmlprag.scm")
206 (define* (syntax-highlighted-html input
208 (name "highlighted-syntax")
210 "/static/base/css/code.css"))
211 "Return a derivation called NAME that processes all the HTML files in INPUT
212 to (1) add them a link to SYNTAX-CSS-URL, and (2) highlight the syntax of all
213 its <pre class=\"lisp\"> blocks (as produced by 'makeinfo --html')."
215 (with-extensions (list guile-lib/htmlprag-fixed guile-syntax-highlight)
216 (with-imported-modules '((guix build utils))
218 (use-modules (htmlprag)
220 (syntax-highlight scheme)
221 (syntax-highlight lexers)
226 (define (pair-open/close lst)
227 ;; Pair 'open' and 'close' tags produced by 'highlights' and
228 ;; produce nested 'paren' tags instead.
233 ((('open open) rest ...)
236 (loop rest (+ 1 level) '()))
237 (lambda (inner close rest)
239 (cons `(paren ,level ,open ,inner ,close)
241 ((('close str) rest ...)
243 (values (reverse result) str rest)
245 (format (current-error-port)
246 "warning: extra closing paren; context:~% ~y~%"
248 (loop rest 0 (cons `(close ,str) result)))))
250 (loop rest level (cons item result)))
253 (format (current-error-port)
254 "warning: missing ~a closing parens; context:~% ~y%"
255 level (reverse result)))
256 (values (reverse result) "" '())))))
258 (define (highlights->sxml* highlights)
259 ;; Like 'highlights->sxml', but handle nested 'paren tags. This
260 ;; allows for paren matching highlights via appropriate CSS
261 ;; "hover" properties.
262 (define (tag->class tag)
263 (string-append "syntax-" (symbol->string tag)))
266 ((? string? str) str)
267 (('paren level open (body ...) close)
268 `(span (@ (class ,(string-append "syntax-paren"
269 (number->string level))))
271 (span (@ (class "syntax-symbol"))
272 ,@(highlights->sxml* body))
275 `(span (@ (class ,(tag->class tag))) ,text)))
278 (define entity->string
283 (e (pk 'unknown-entity e) (primitive-exit 2))))
285 (define (concatenate-snippets pieces)
286 ;; Concatenate PIECES, which contains strings and entities,
287 ;; replacing entities with their corresponding string.
288 (let loop ((pieces pieces)
292 (string-concatenate-reverse strings))
293 (((? string? str) . rest)
294 (loop rest (cons str strings)))
295 ((('*ENTITY* "additional" entity) . rest)
296 (loop rest (cons (entity->string entity) strings)))
297 ((('span _ lst ...) . rest) ;for <span class="roman">
298 (loop (append lst rest) strings))
300 (pk 'unsupported-code-snippet something)
301 (primitive-exit 1)))))
303 (define (syntax-highlight sxml)
304 ;; Recurse over SXML and syntax-highlight code snippets.
306 (('*TOP* decl body ...)
307 `(*TOP* ,decl ,@(map syntax-highlight body)))
310 (link (@ (rel "stylesheet")
312 (href #$syntax-css-url)))))
313 (('pre ('@ ('class "lisp")) code-snippet ...)
314 `(pre (@ (class "lisp"))
317 (highlight lex-scheme
318 (concatenate-snippets code-snippet))))))
319 ((tag ('@ attributes ...) body ...)
320 `(,tag (@ ,@attributes) ,@(map syntax-highlight body)))
322 `(,tag ,@(map syntax-highlight body)))
326 (define (process-html file)
327 ;; Parse FILE and perform syntax highlighting for its Scheme
328 ;; snippets. Install the result to #$output.
329 (format (current-error-port) "processing ~a...~%" file)
330 (let* ((shtml (call-with-input-file file html->shtml))
331 (highlighted (syntax-highlight shtml))
332 (base (string-drop file (string-length #$input)))
333 (target (string-append #$output base)))
334 (mkdir-p (dirname target))
335 (call-with-output-file target
337 (write-shtml-as-html highlighted port)))))
339 (define (copy-as-is file)
340 ;; Copy FILE as is to #$output.
341 (let* ((base (string-drop file (string-length #$input)))
342 (target (string-append #$output base)))
343 (mkdir-p (dirname target))
346 (if (eq? 'symlink (stat:type (lstat file)))
347 (symlink (readlink file) target)
350 (let ((errno (system-error-errno args)))
351 (pk 'error-link file target (strerror errno))
352 (primitive-exit 3))))))
354 ;; Install a UTF-8 locale so we can process UTF-8 files.
355 (setenv "GUIX_LOCPATH"
356 #+(file-append glibc-utf8-locales "/lib/locale"))
357 (setlocale LC_ALL "en_US.utf8")
359 (n-par-for-each (parallel-job-count)
361 (if (string-suffix? ".html" file)
364 (find-files #$input))))))
366 (computed-file name build))
368 (define* (html-manual source #:key (languages %languages)
372 (options %makeinfo-html-options))
373 "Return the HTML manuals built from SOURCE for all LANGUAGES, with the given
375 (define manual-source
376 (texinfo-manual-source source
378 #:languages languages
382 (texinfo-manual-images source))
385 (with-imported-modules '((guix build utils))
387 (use-modules (guix build utils)
390 (define (normalize language)
391 ;; Normalize LANGUAGE. For instance, "zh_CN" becomes "zh-cn".
392 (string-map (match-lambda
395 (string-downcase language)))
397 (define (language->texi-file-name language)
398 (if (string=? language "en")
399 (string-append #$manual-source "/"
401 (string-append #$manual-source "/"
402 #$manual "." language ".texi")))
404 ;; Install a UTF-8 locale so that 'makeinfo' is at ease.
405 (setenv "GUIX_LOCPATH"
406 #+(file-append glibc-utf8-locales "/lib/locale"))
407 (setenv "LC_ALL" "en_US.utf8")
409 (setvbuf (current-output-port) 'line)
410 (setvbuf (current-error-port) 'line)
412 (for-each (lambda (language)
413 (let* ((texi (language->texi-file-name language))
415 "-c" ,(string-append "TOP_NODE_UP_URL=/manual/"
419 (format #t "building HTML manual for language '~a'...~%"
421 (mkdir-p (string-append #$output "/"
422 (normalize language)))
423 (setenv "LANGUAGE" language)
424 (apply invoke #$(file-append texinfo "/bin/makeinfo")
425 "-o" (string-append #$output "/"
429 (apply invoke #$(file-append texinfo "/bin/makeinfo")
432 (string-append #$output "/"
435 (if (string=? language "en")
437 (string-append "." language))
441 ;; Make sure images are available.
443 (string-append #$output "/" (normalize language)
446 (string-append #$output "/" (normalize language)
447 "/html_node/images"))))
448 (filter (compose file-exists? language->texi-file-name)
451 (let* ((name (string-append manual "-html-manual"))
452 (manual (computed-file name build)))
453 (syntax-highlighted-html manual
454 #:name (string-append name "-highlighted"))))
456 (define* (pdf-manual source #:key (languages %languages)
461 "Return the HTML manuals built from SOURCE for all LANGUAGES, with the given
463 (define manual-source
464 (texinfo-manual-source source
466 #:languages languages
469 ;; FIXME: This union works, except for the table of contents of non-English
470 ;; manuals, which contains escape sequences like "^^ca^^fe" instead of
474 ;; (texlive-union (list texlive-tex-texinfo
475 ;; texlive-generic-epsf
476 ;; texlive-fonts-ec)))
479 (with-imported-modules '((guix build utils))
481 (use-modules (guix build utils)
485 (define (normalize language) ;XXX: deduplicate
486 ;; Normalize LANGUAGE. For instance, "zh_CN" becomes "zh-cn".
487 (string-map (match-lambda
490 (string-downcase language)))
492 ;; Install a UTF-8 locale so that 'makeinfo' is at ease.
493 (setenv "GUIX_LOCPATH"
494 #+(file-append glibc-utf8-locales "/lib/locale"))
495 (setenv "LC_ALL" "en_US.utf8")
497 (string-append #+(file-append texlive "/bin") ":"
498 #+(file-append texinfo "/bin") ":"
500 ;; Below are command-line tools needed by
501 ;; 'texi2dvi' and friends.
502 #+(file-append sed "/bin") ":"
503 #+(file-append grep "/bin") ":"
504 #+(file-append coreutils "/bin") ":"
505 #+(file-append gawk "/bin") ":"
506 #+(file-append tar "/bin") ":"
507 #+(file-append diffutils "/bin")))
509 (setvbuf (current-output-port) 'line)
510 (setvbuf (current-error-port) 'line)
512 (setenv "HOME" (getcwd)) ;for kpathsea/mktextfm
514 ;; 'SOURCE_DATE_EPOCH' is honored by pdftex.
515 (setenv "SOURCE_DATE_EPOCH" "1")
517 (for-each (lambda (language)
518 (let ((opts `("--pdf"
521 ,(if (string=? language "en")
522 (string-append #$manual-source "/"
524 (string-append #$manual-source "/"
525 #$manual "." language ".texi")))))
526 (format #t "building PDF manual for language '~a'...~%"
528 (mkdir-p (string-append #$output "/"
529 (normalize language)))
530 (setenv "LANGUAGE" language)
533 ;; FIXME: Unfortunately building PDFs for non-Latin
534 ;; alphabets doesn't work:
535 ;; <https://lists.gnu.org/archive/html/help-texinfo/2012-01/msg00014.html>.
536 (guard (c ((invoke-error? c)
537 (format (current-error-port)
538 "~%~%Failed to produce \
539 PDF for language '~a'!~%~%"
541 (apply invoke #$(file-append texinfo "/bin/makeinfo")
543 (string-append #$output "/"
546 (if (string=? language "en")
554 (computed-file (string-append manual "-pdf-manual") build))
556 (define (guix-manual-text-domain source languages)
557 "Return the PO files for LANGUAGES of the 'guix-manual' text domain taken
560 (file-append* source "/po/doc"))
563 (with-imported-modules '((guix build utils))
565 (use-modules (guix build utils))
568 (for-each (lambda (language)
570 (string-append #$output "/" language
574 (invoke #+(file-append gnu-gettext "/bin/msgfmt")
576 (string-append directory "/guix-manual.mo")
577 (string-append #$po-directory "/guix-manual."
579 '#$(delete "en" languages)))))
581 (computed-file "guix-manual-po" build))
583 (define* (html-manual-indexes source
584 #:key (languages %languages)
587 (title (if (string=? "guix" manual)
588 "GNU Guix Reference Manual"
589 "GNU Guix Cookbook"))
592 (with-extensions (list guile-json-3)
593 (with-imported-modules '((guix build utils))
595 (use-modules (guix build utils)
603 (define (normalize language) ;XXX: deduplicate
604 ;; Normalize LANGUAGE. For instance, "zh_CN" becomes "zh-cn".
605 (string-map (match-lambda
608 (string-downcase language)))
610 (define-syntax-rule (with-language language exp ...)
611 (let ((lang (getenv "LANGUAGE")))
614 (setenv "LANGUAGE" language)
615 (setlocale LC_MESSAGES))
619 (setenv "LANGUAGE" lang)
620 (unsetenv "LANGUAGE"))
621 (setlocale LC_MESSAGES)))))
623 ;; (put 'with-language 'scheme-indent-function 1)
624 (define* (translate str language
625 #:key (domain "guix-manual"))
628 (bindtextdomain "guix-manual"
629 #+(guix-manual-text-domain
632 (bindtextdomain "iso_639-3" ;language names
633 #+(file-append iso-codes
635 (write (gettext ,str ,domain))))
637 (with-language language
638 ;; Since the 'gettext' function caches msgid translations,
639 ;; regardless of $LANGUAGE, we have to spawn a new process each
640 ;; time we want to translate to a different language. Bah!
641 (let* ((pipe (open-pipe* OPEN_READ
642 #+(file-append guile-2.2
644 "-c" (object->string exp)))
649 (define (seconds->string seconds language)
650 (let* ((time (make-time time-utc 0 seconds))
651 (date (time-utc->date time)))
652 (with-language language (date->string date "~e ~B ~Y"))))
654 (define (guix-url path)
655 (string-append #$%web-site-url path))
657 (define (sxml-index language title body)
658 ;; FIXME: Avoid duplicating styling info from guix-artwork.git.
659 `(html (@ (lang ,language))
661 (title ,(string-append title " — GNU Guix"))
662 (meta (@ (charset "UTF-8")))
663 (meta (@ (name "viewport") (content "width=device-width, initial-scale=1.0")))
665 (link (@ (rel "prefetch") (href ,(guix-url "menu/index.html"))))
667 (link (@ (rel "stylesheet") (href ,(guix-url "static/base/css/elements.css"))))
668 (link (@ (rel "stylesheet") (href ,(guix-url "static/base/css/common.css"))))
669 (link (@ (rel "stylesheet") (href ,(guix-url "static/base/css/messages.css"))))
670 (link (@ (rel "stylesheet") (href ,(guix-url "static/base/css/navbar.css"))))
671 (link (@ (rel "stylesheet") (href ,(guix-url "static/base/css/breadcrumbs.css"))))
672 (link (@ (rel "stylesheet") (href ,(guix-url "static/base/css/buttons.css"))))
673 (link (@ (rel "stylesheet") (href ,(guix-url "static/base/css/footer.css"))))
675 (link (@ (rel "stylesheet") (href ,(guix-url "static/base/css/page.css"))))
676 (link (@ (rel "stylesheet") (href ,(guix-url "static/base/css/post.css")))))
678 (header (@ (class "navbar"))
679 (h1 (a (@ (class "branding")
680 (href #$%web-site-url)))
681 (span (@ (class "a11y-offset"))
683 (nav (@ (class "menu"))))
684 (nav (@ (class "breadcrumbs"))
685 (a (@ (class "crumb")
686 (href #$%web-site-url))
691 (define (language-index language)
693 (translate #$title language))
699 (@ (class "page centered-block limit-width"))
701 (p (@ (class "post-metadata centered-text"))
703 ,(seconds->string #$date language))
707 (li (a (@ (href "html_node"))
708 "HTML, with one page per node"))
712 (if (string=? language
718 "HTML, entirely on one page"))
719 ,@(if (member language '("ru" "zh_CN"))
721 `((li (a (@ (href ,(string-append
723 (if (string=? language "en")
730 (define %iso639-languages
732 (assoc-ref (call-with-input-file
733 #+(file-append iso-codes
734 "/share/iso-codes/json/iso_639-3.json")
738 (define (language-code->name code)
739 "Return the full name of a language from its ISO-639-3 code."
740 (let ((code (match (string-index code #\_)
742 (index (string-take code index)))))
743 (any (lambda (language)
744 (and (string=? (or (assoc-ref language "alpha_2")
745 (assoc-ref language "alpha_3"))
747 (assoc-ref language "name")))
750 (define (top-level-index languages)
751 (define title #$title)
756 (@ (class "page centered-block limit-width"))
759 "This document is available in the following
762 ,@(map (lambda (language)
763 `(li (a (@ (href ,(normalize language)))
765 (language-code->name language)
767 #:domain "iso_639-3"))))
770 (define (write-html file sxml)
771 (call-with-output-file file
773 (display "<!DOCTYPE html>\n" port)
774 (sxml->xml sxml port))))
776 (setenv "GUIX_LOCPATH"
777 #+(file-append glibc-utf8-locales "/lib/locale"))
778 (setenv "LC_ALL" "en_US.utf8")
779 (setlocale LC_ALL "en_US.utf8")
781 (for-each (lambda (language)
783 (string-append #$output "/"
784 (normalize language)))
787 (write-html (string-append directory "/index.html")
788 (language-index language)))
791 (write-html (string-append #$output "/index.html")
792 (top-level-index '#$languages))))))
794 (computed-file "html-indexes" build))
796 (define* (pdf+html-manual source
797 #:key (languages %languages)
799 (date (time-second (current-time time-utc)))
801 "Return the union of the HTML and PDF manuals, as well as the indexes."
802 (directory-union (string-append manual "-manual")
806 #:languages languages
809 (list html-manual-indexes
810 html-manual pdf-manual))
813 (define (latest-commit+date directory)
814 "Return two values: the last commit ID (a hex string) for DIRECTORY, and its
815 commit date (an integer)."
816 (let* ((repository (repository-open directory))
817 (head (repository-head repository))
818 (oid (reference-target head))
819 (commit (commit-lookup repository oid)))
820 ;; TODO: Use (git describe) when it's widely available.
821 (values (oid->string oid) (commit-time commit))))
824 (let* ((root (canonicalize-path
825 (string-append (current-source-directory) "/..")))
826 (commit date (latest-commit+date root)))
827 (format (current-error-port)
828 "building manual from work tree around commit ~a, ~a~%"
830 (let* ((time (make-time time-utc 0 date))
831 (date (time-utc->date time)))
832 (date->string date "~e ~B ~Y")))
833 (pdf+html-manual (local-file root "guix" #:recursive? #t
834 #:select? (git-predicate root))
835 #:version (or (getenv "GUIX_MANUAL_VERSION")
836 (string-take commit 7))