bug#27153: gnu: sicp: Add the HTML version.

bug#27153: gnu: sicp: Add the HTML version.

[Clément Lassieur]

Yesterday, while browsing the Info version of SICP, I came accross an
incomplete figure (Figure 3.1: environments A and B are missing).  I
thought the HTML version might be complete and indeed it was.  It's
really nice by the way, see http://sarabander.github.io/sicp/.  And real
figures are in my opinion more pleasant to study than ASCII art figures.

So I think we should add the HTML version to our package. :-)  That
would allow us to use it without Internet access.

I find it much easier to browse the Info manual than the HTML one, so I
wrote this small Elisp snippet to switch from the former to the latter:

--8<---------------cut here---------------start------------->8---
(defun sicp-browse ()
  "Ask a browser to load the HTML version of the current node."
  (interactive)
  (let* ((home (expand-file-name "~"))
         (dir (concat "file://" home "/.guix-profile/share/doc/sicp/html/"))
         (node Info-current-node)
         (pattern
          (string-join
           '("^\\(?1:[0-9]\\)\.\\(?2:[0-9]\\)\.\\(?3:[0-9]\\)$" ; 4-5-7
             "^\\(?1:[0-9]\\)\.\\(?2:[0-9]\\)$"                 ; 4-5
             "^Chapter \\(?1:[0-9]\\)$")                        ; Chapter 4
           "\\|")))
    (if (string-match pattern node)
        (let ((chapter     (match-string 1 node)) ; 4
              (section     (match-string 2 node)) ; 5
              (sub-section (match-string 3 node)) ; 7
              base
              (anchor ""))
          (if section
              (setq base (format "%s_002e%s" chapter section))
            (setq base (format "Chapter-%s" chapter)))
          (when sub-section
            (setq anchor (format "#g_t%s_002e%s" base sub-section)))
          (browse-url (concat dir base ".xhtml" anchor)))
      (error "Node not matched"))))
--8<---------------cut here---------------end--------------->8---

bug#27153: [PATCH] gnu: sicp: Add the HTML version.

[Clément Lassieur]

* gnu/packages/scheme.scm (sicp)[arguments]: Copy the HTML directory to the
output.
---
 gnu/packages/scheme.scm | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/gnu/packages/scheme.scm b/gnu/packages/scheme.scm
index f6aee005c..eacfd733d 100644
--- a/gnu/packages/scheme.scm
+++ b/gnu/packages/scheme.scm
@@ -7,6 +7,7 @@
 ;;; Copyright © 2016 Jan Nieuwenhuizen <janneke@gnu.org>
 ;;; Copyright © 2016, 2017 ng0 <contact.ng0@cryptolab.net>
 ;;; Copyright © 2017 John Darrington <jmd@gnu.org>
+;;; Copyright © 2017 Clément Lassieur <clement@lassieur.org>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -780,7 +781,9 @@ engineering.")
            (let ((gzip (assoc-ref %build-inputs "gzip"))
                  (source (assoc-ref %build-inputs "source"))
                  (texinfo (assoc-ref %build-inputs "texinfo"))
+                 (html-dir (string-append %output "/share/doc/" ,name "/html"))
                  (info-dir (string-append %output "/share/info")))
+             (copy-recursively (string-append source "/html") html-dir)
              (setenv "PATH" (string-append gzip "/bin"
                                            ":" texinfo "/bin"))
              (mkdir-p info-dir)
-- 
2.13.0

bug#27153: gnu: sicp: Add the HTML version.

[Maxim Cournoyer]

Hi Clément,

Clément Lassieur <clement@lassieur.org> writes:

> Yesterday, while browsing the Info version of SICP, I came accross an
> incomplete figure (Figure 3.1: environments A and B are missing).  I
> thought the HTML version might be complete and indeed it was.  It's
> really nice by the way, see http://sarabander.github.io/sicp/.  And real
> figures are in my opinion more pleasant to study than ASCII art figures.
>
> So I think we should add the HTML version to our package. :-)  That
> would allow us to use it without Internet access.
>
> I find it much easier to browse the Info manual than the HTML one, so I
> wrote this small Elisp snippet to switch from the former to the latter:
>
> (defun sicp-browse ()
>   "Ask a browser to load the HTML version of the current node."
>   (interactive)
>   (let* ((home (expand-file-name "~"))
>          (dir (concat "file://" home "/.guix-profile/share/doc/sicp/html/"))
>          (node Info-current-node)
>          (pattern
>           (string-join
>            '("^\\(?1:[0-9]\\)\.\\(?2:[0-9]\\)\.\\(?3:[0-9]\\)$" ; 4-5-7
>              "^\\(?1:[0-9]\\)\.\\(?2:[0-9]\\)$"                 ; 4-5
>              "^Chapter \\(?1:[0-9]\\)$")                        ; Chapter 4
>            "\\|")))
>     (if (string-match pattern node)
>         (let ((chapter     (match-string 1 node)) ; 4
>               (section     (match-string 2 node)) ; 5
>               (sub-section (match-string 3 node)) ; 7
>               base
>               (anchor ""))
>           (if section
>               (setq base (format "%s_002e%s" chapter section))
>             (setq base (format "Chapter-%s" chapter)))
>           (when sub-section
>             (setq anchor (format "#g_t%s_002e%s" base sub-section)))
>           (browse-url (concat dir base ".xhtml" anchor)))
>       (error "Node not matched"))))

Cool! Thanks for sharing. I having started my study of SICP yet, but
that's something I've been meaning to do.

Also, couldn't the info version contain real figures (bitmaps)? Emacs is
capable of displaying images; maybe the info viewer is able to detect if
yes or no images are supported, and degrade gracefully to an alternative
(ascii art) when support is lacking?

Just some thoughts :)

Maxim

bug#27153: gnu: sicp: Add the HTML version.

[Clément Lassieur]

Hi Maxim,

Maxim Cournoyer <maxim.cournoyer@gmail.com> writes:

> Also, couldn't the info version contain real figures (bitmaps)? Emacs is
> capable of displaying images; maybe the info viewer is able to detect if
> yes or no images are supported, and degrade gracefully to an alternative
> (ascii art) when support is lacking?

You're right, I think they should be displayed but for some reason they
aren't.  There is an 'Info-display-images-node' function in 'info.el.gz'
though, but the regexp there isn't matching anything.

Clément

bug#27153: gnu: sicp: Add the HTML version.

[Ludovic Courtès]

Hi,

Clément Lassieur <clement@lassieur.org> skribis:

> Maxim Cournoyer <maxim.cournoyer@gmail.com> writes:
>
>> Also, couldn't the info version contain real figures (bitmaps)? Emacs is
>> capable of displaying images; maybe the info viewer is able to detect if
>> yes or no images are supported, and degrade gracefully to an alternative
>> (ascii art) when support is lacking?
>
> You're right, I think they should be displayed but for some reason they
> aren't.

Could it be that they’re not installed in the right place?

The Guix manual has a couple of images (info "(guix) Invoking guix
graph") and they are properly displayed by Emacs on X11.

Thanks,
Ludo’.

bug#27153: [PATCH] gnu: sicp: Add the HTML version.

[Ludovic Courtès]

Clément Lassieur <clement@lassieur.org> skribis:

> * gnu/packages/scheme.scm (sicp)[arguments]: Copy the HTML directory to the
> output.

LGTM, thanks!

Ludo'.

bug#27153: [PATCH] gnu: sicp: Add the HTML version.

[Clément Lassieur]

Ludovic Courtès <ludo@gnu.org> writes:

> Clément Lassieur <clement@lassieur.org> skribis:
>
>> * gnu/packages/scheme.scm (sicp)[arguments]: Copy the HTML directory to the
>> output.
>
> LGTM, thanks!
>
> Ludo'.

Pushed, thank you!

bug#27153: gnu: sicp: Add the HTML version.

[Christopher Allan Webber]

Ludovic Courtès writes:

> Hi,
>
> Clément Lassieur <clement@lassieur.org> skribis:
>
>> Maxim Cournoyer <maxim.cournoyer@gmail.com> writes:
>>
>>> Also, couldn't the info version contain real figures (bitmaps)? Emacs is
>>> capable of displaying images; maybe the info viewer is able to detect if
>>> yes or no images are supported, and degrade gracefully to an alternative
>>> (ascii art) when support is lacking?
>>
>> You're right, I think they should be displayed but for some reason they
>> aren't.
>
> Could it be that they’re not installed in the right place?
>
> The Guix manual has a couple of images (info "(guix) Invoking guix
> graph") and they are properly displayed by Emacs on X11.
>
> Thanks,
> Ludo’.

I think it's because the texinfo version has the images replaced with
ascii art, in most places!

bug#27153: gnu: sicp: Add the HTML version.

[Maxim Cournoyer]

[-- Attachment #1: Type: text/plain, Size: 172 bytes --]

>
>
> I think it's because the texinfo version has the images replaced with
> ascii art, in most places!
>
>
OK. Not something we can fix at the package level then.

Maxim

[-- Attachment #2: Type: text/html, Size: 480 bytes --]