[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
03/07: doc: Build a top-level index of the manuals.
|
From: |
guix-commits |
|
Subject: |
03/07: doc: Build a top-level index of the manuals. |
|
Date: |
Mon, 15 Jul 2019 06:48:59 -0400 (EDT) |
civodul pushed a commit to branch master
in repository guix.
commit e591541d36215eda3aa2d877578e00939001fb85
Author: Ludovic Courtès <address@hidden>
Date: Mon Jul 15 12:33:07 2019 +0200
doc: Build a top-level index of the manuals.
Suggested by Julien Lepiller.
* doc/build.scm (html-manual-indexes)[build]: Add 'with-extensions'.
(translate): Actually honor DOMAIN. Add call to 'bindtextdomain' for
ISO-CODES.
(%iso639-languages): New variable.
(language-code->name, top-level-index): New procedures.
Add call to 'write-html' for OUTPUT/index.html.
---
doc/build.scm | 360 +++++++++++++++++++++++++++++++++-------------------------
1 file changed, 204 insertions(+), 156 deletions(-)
diff --git a/doc/build.scm b/doc/build.scm
index c0952ec..a2f353a 100644
--- a/doc/build.scm
+++ b/doc/build.scm
@@ -34,6 +34,7 @@
(gnu packages gawk)
(gnu packages gettext)
(gnu packages guile)
+ (gnu packages iso-codes)
(gnu packages texinfo)
(gnu packages tex)
(srfi srfi-19)
@@ -183,7 +184,7 @@ makeinfo OPTIONS."
(ice-9 match))
(define (normalize language)
- ;; Normalize LANGUAGE. For instance, "zh_CN" become "zh-cn".
+ ;; Normalize LANGUAGE. For instance, "zh_CN" becomes "zh-cn".
(string-map (match-lambda
(#\_ #\-)
(chr chr))
@@ -365,161 +366,208 @@ from SOURCE."
(manual "guix")
(date 1))
(define build
- (with-imported-modules '((guix build utils))
- #~(begin
- (use-modules (guix build utils)
- (ice-9 match)
- (ice-9 popen)
- (sxml simple)
- (srfi srfi-19))
-
- (define (normalize language) ;XXX: deduplicate
- ;; Normalize LANGUAGE. For instance, "zh_CN" become "zh-cn".
- (string-map (match-lambda
- (#\_ #\-)
- (chr chr))
- (string-downcase language)))
-
- (define-syntax-rule (with-language language exp ...)
- (let ((lang (getenv "LANGUAGE")))
- (dynamic-wind
- (lambda ()
- (setenv "LANGUAGE" language)
- (setlocale LC_MESSAGES))
- (lambda () exp ...)
- (lambda ()
- (if lang
- (setenv "LANGUAGE" lang)
- (unsetenv "LANGUAGE"))
- (setlocale LC_MESSAGES)))))
-
- ;; (put 'with-language 'scheme-indent-function 1)
- (define* (translate str language
- #:key (domain "guix-manual"))
- (define exp
- `(begin
- (bindtextdomain "guix-manual"
- #+(guix-manual-text-domain
- source
- languages))
- (write (gettext ,str "guix-manual"))))
-
- (with-language language
- ;; Since the 'gettext' function caches msgid translations,
- ;; regardless of $LANGUAGE, we have to spawn a new process each
- ;; time we want to translate to a different language. Bah!
- (let* ((pipe (open-pipe* OPEN_READ
- #+(file-append guile-2.2
- "/bin/guile")
- "-c" (object->string exp)))
- (str (read pipe)))
- (close-pipe pipe)
- str)))
-
- (define (seconds->string seconds language)
- (let* ((time (make-time time-utc 0 seconds))
- (date (time-utc->date time)))
- (with-language language (date->string date "~e ~B ~Y"))))
-
- (define (guix-url path)
- (string-append #$%web-site-url path))
-
- (define (sxml-index language title body)
- ;; FIXME: Avoid duplicating styling info from guix-artwork.git.
- `(html (@ (lang ,language))
- (head
- (title ,(string-append title " — GNU Guix"))
- (meta (@ (charset "UTF-8")))
- (meta (@ (name "viewport") (content "width=device-width,
initial-scale=1.0")))
- ;; Menu prefetch.
- (link (@ (rel "prefetch") (href ,(guix-url
"menu/index.html"))))
- ;; Base CSS.
- (link (@ (rel "stylesheet") (href ,(guix-url
"static/base/css/elements.css"))))
- (link (@ (rel "stylesheet") (href ,(guix-url
"static/base/css/common.css"))))
- (link (@ (rel "stylesheet") (href ,(guix-url
"static/base/css/messages.css"))))
- (link (@ (rel "stylesheet") (href ,(guix-url
"static/base/css/navbar.css"))))
- (link (@ (rel "stylesheet") (href ,(guix-url
"static/base/css/breadcrumbs.css"))))
- (link (@ (rel "stylesheet") (href ,(guix-url
"static/base/css/buttons.css"))))
- (link (@ (rel "stylesheet") (href ,(guix-url
"static/base/css/footer.css"))))
-
- (link (@ (rel "stylesheet") (href ,(guix-url
"static/base/css/page.css"))))
- (link (@ (rel "stylesheet") (href ,(guix-url
"static/base/css/post.css")))))
- (body
- (header (@ (class "navbar"))
- (h1 (a (@ (class "branding")
- (href #$%web-site-url)))
- (span (@ (class "a11y-offset"))
- "Guix"))
- (nav (@ (class "menu"))))
- (nav (@ (class "breadcrumbs"))
- (a (@ (class "crumb")
- (href #$%web-site-url))
- "Home"))
- ,body
- (footer))))
-
- (define (language-index language)
- (define title
- (translate "GNU Guix Reference Manual" language))
-
- (sxml-index
- language title
- `(main
- (article
- (@ (class "page centered-block limit-width"))
- (h2 ,title)
- (p (@ (class "post-metadata centered-text"))
- #$version " — "
- ,(seconds->string #$date language))
-
- (div
- (ul
- (li (a (@ (href "html_node"))
- "HTML, with one page per node"))
- (li (a (@ (href
- ,(string-append
- #$manual
- (if (string=? language
- "en")
- ""
- (string-append "."
- language))
- ".html")))
- "HTML, entirely on one page"))
- ,@(if (member language '("ru" "zh_CN"))
- '()
- `((li (a (@ (href ,(string-append
- #$manual
- (if (string=? language "en")
- ""
- (string-append "."
- language))
- ".pdf"))))
- "PDF")))))))))
-
- (define (write-html file sxml)
- (call-with-output-file file
- (lambda (port)
- (display "<!DOCTYPE html>\n" port)
- (sxml->xml sxml port))))
-
- (setenv "GUIX_LOCPATH"
- #+(file-append glibc-utf8-locales "/lib/locale"))
- (setenv "LC_ALL" "en_US.utf8")
- (setlocale LC_ALL "en_US.utf8")
-
- (bindtextdomain "guix-manual"
- #+(guix-manual-text-domain source languages))
-
- (for-each (lambda (language)
- (define directory
- (string-append #$output "/"
- (normalize language)))
-
- (mkdir-p directory)
- (write-html (string-append directory "/index.html")
- (language-index language)))
- '#$languages))))
+ (with-extensions (list guile-json-3)
+ (with-imported-modules '((guix build utils))
+ #~(begin
+ (use-modules (guix build utils)
+ (json)
+ (ice-9 match)
+ (ice-9 popen)
+ (sxml simple)
+ (srfi srfi-1)
+ (srfi srfi-19))
+
+ (define (normalize language) ;XXX: deduplicate
+ ;; Normalize LANGUAGE. For instance, "zh_CN" becomes "zh-cn".
+ (string-map (match-lambda
+ (#\_ #\-)
+ (chr chr))
+ (string-downcase language)))
+
+ (define-syntax-rule (with-language language exp ...)
+ (let ((lang (getenv "LANGUAGE")))
+ (dynamic-wind
+ (lambda ()
+ (setenv "LANGUAGE" language)
+ (setlocale LC_MESSAGES))
+ (lambda () exp ...)
+ (lambda ()
+ (if lang
+ (setenv "LANGUAGE" lang)
+ (unsetenv "LANGUAGE"))
+ (setlocale LC_MESSAGES)))))
+
+ ;; (put 'with-language 'scheme-indent-function 1)
+ (define* (translate str language
+ #:key (domain "guix-manual"))
+ (define exp
+ `(begin
+ (bindtextdomain "guix-manual"
+ #+(guix-manual-text-domain
+ source
+ languages))
+ (bindtextdomain "iso_639-3" ;language names
+ #+(file-append iso-codes
+ "/share/locale"))
+ (write (gettext ,str ,domain))))
+
+ (with-language language
+ ;; Since the 'gettext' function caches msgid translations,
+ ;; regardless of $LANGUAGE, we have to spawn a new process each
+ ;; time we want to translate to a different language. Bah!
+ (let* ((pipe (open-pipe* OPEN_READ
+ #+(file-append guile-2.2
+ "/bin/guile")
+ "-c" (object->string exp)))
+ (str (read pipe)))
+ (close-pipe pipe)
+ str)))
+
+ (define (seconds->string seconds language)
+ (let* ((time (make-time time-utc 0 seconds))
+ (date (time-utc->date time)))
+ (with-language language (date->string date "~e ~B ~Y"))))
+
+ (define (guix-url path)
+ (string-append #$%web-site-url path))
+
+ (define (sxml-index language title body)
+ ;; FIXME: Avoid duplicating styling info from guix-artwork.git.
+ `(html (@ (lang ,language))
+ (head
+ (title ,(string-append title " — GNU Guix"))
+ (meta (@ (charset "UTF-8")))
+ (meta (@ (name "viewport") (content "width=device-width,
initial-scale=1.0")))
+ ;; Menu prefetch.
+ (link (@ (rel "prefetch") (href ,(guix-url
"menu/index.html"))))
+ ;; Base CSS.
+ (link (@ (rel "stylesheet") (href ,(guix-url
"static/base/css/elements.css"))))
+ (link (@ (rel "stylesheet") (href ,(guix-url
"static/base/css/common.css"))))
+ (link (@ (rel "stylesheet") (href ,(guix-url
"static/base/css/messages.css"))))
+ (link (@ (rel "stylesheet") (href ,(guix-url
"static/base/css/navbar.css"))))
+ (link (@ (rel "stylesheet") (href ,(guix-url
"static/base/css/breadcrumbs.css"))))
+ (link (@ (rel "stylesheet") (href ,(guix-url
"static/base/css/buttons.css"))))
+ (link (@ (rel "stylesheet") (href ,(guix-url
"static/base/css/footer.css"))))
+
+ (link (@ (rel "stylesheet") (href ,(guix-url
"static/base/css/page.css"))))
+ (link (@ (rel "stylesheet") (href ,(guix-url
"static/base/css/post.css")))))
+ (body
+ (header (@ (class "navbar"))
+ (h1 (a (@ (class "branding")
+ (href #$%web-site-url)))
+ (span (@ (class "a11y-offset"))
+ "Guix"))
+ (nav (@ (class "menu"))))
+ (nav (@ (class "breadcrumbs"))
+ (a (@ (class "crumb")
+ (href #$%web-site-url))
+ "Home"))
+ ,body
+ (footer))))
+
+ (define (language-index language)
+ (define title
+ (translate "GNU Guix Reference Manual" language))
+
+ (sxml-index
+ language title
+ `(main
+ (article
+ (@ (class "page centered-block limit-width"))
+ (h2 ,title)
+ (p (@ (class "post-metadata centered-text"))
+ #$version " — "
+ ,(seconds->string #$date language))
+
+ (div
+ (ul
+ (li (a (@ (href "html_node"))
+ "HTML, with one page per node"))
+ (li (a (@ (href
+ ,(string-append
+ #$manual
+ (if (string=? language
+ "en")
+ ""
+ (string-append "."
+ language))
+ ".html")))
+ "HTML, entirely on one page"))
+ ,@(if (member language '("ru" "zh_CN"))
+ '()
+ `((li (a (@ (href ,(string-append
+ #$manual
+ (if (string=? language "en")
+ ""
+ (string-append "."
+ language))
+ ".pdf"))))
+ "PDF")))))))))
+
+ (define %iso639-languages
+ (vector->list
+ (assoc-ref (call-with-input-file
+ #+(file-append iso-codes
+
"/share/iso-codes/json/iso_639-3.json")
+ json->scm)
+ "639-3")))
+
+ (define (language-code->name code)
+ "Return the full name of a language from its ISO-639-3 code."
+ (let ((code (match (string-index code #\_)
+ (#f code)
+ (index (string-take code index)))))
+ (any (lambda (language)
+ (and (string=? (or (assoc-ref language "alpha_2")
+ (assoc-ref language "alpha_3"))
+ code)
+ (assoc-ref language "name")))
+ %iso639-languages)))
+
+ (define (top-level-index languages)
+ (define title
+ "GNU Guix Reference Manual")
+ (sxml-index
+ "en" title
+ `(main
+ (article
+ (@ (class "page centered-block limit-width"))
+ (h2 ,title)
+ (div
+ "The GNU Guix Reference Manual is available in the following
+languages:\n"
+ (ul
+ ,@(map (lambda (language)
+ `(li (a (@ (href ,(normalize language)))
+ ,(translate
+ (language-code->name language)
+ language
+ #:domain "iso_639-3"))))
+ languages)))))))
+
+ (define (write-html file sxml)
+ (call-with-output-file file
+ (lambda (port)
+ (display "<!DOCTYPE html>\n" port)
+ (sxml->xml sxml port))))
+
+ (setenv "GUIX_LOCPATH"
+ #+(file-append glibc-utf8-locales "/lib/locale"))
+ (setenv "LC_ALL" "en_US.utf8")
+ (setlocale LC_ALL "en_US.utf8")
+
+ (for-each (lambda (language)
+ (define directory
+ (string-append #$output "/"
+ (normalize language)))
+
+ (mkdir-p directory)
+ (write-html (string-append directory "/index.html")
+ (language-index language)))
+ '#$languages)
+
+ (write-html (string-append #$output "/index.html")
+ (top-level-index '#$languages))))))
(computed-file "html-indexes" build))
- branch master updated (886986b -> fb8b99a), guix-commits, 2019/07/15
- 01/07: gnu: monero: Make tests more verbose., guix-commits, 2019/07/15
- 02/07: doc: Generalize build procedures of HTML indexes., guix-commits, 2019/07/15
- 04/07: gnu: python-aiorpcx: Update to 0.18.3, guix-commits, 2019/07/15
- 05/07: gnu: python-aiohttp: Update to 3.5.4, guix-commits, 2019/07/15
- 06/07: gnu: python-aiorpcx: capitalize description, guix-commits, 2019/07/15
- 03/07: doc: Build a top-level index of the manuals.,
guix-commits <=
- 07/07: doc: note how to install git send-email, guix-commits, 2019/07/15