Export html

annotate/README.md

@@ -12,11 +12,11 @@ annotations are printed* (see `scholarly/annotate/config.ily`). At the beginning
 the music document, we can tell *scholarLY* which types of documents to export:
 
 ```lilypond
-\setOption scholarly.annotate.export-targets #'(plaintext latex)
+\setOption scholarly.annotate.export-targets #'(plaintext html latex)
 ```
 
 Those output files will automatically format annotations to be further processed by the
-relevant programs. Currently, *plaintext* and *latex* are available, while other types
+relevant programs. Currently, *plaintext*, *latex* and *html* are available, while other types
 are on the wishlist (such as *scheme* and *markdown*).
 
 ## Basic Syntax

annotate/config.ily

@@ -94,6 +94,25 @@
 \registerOption scholarly.colorize ##t
 
 
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%% Filenames to Export
+%%%%%%%%%%%%%%%%%%%%%%%%
+% default is <project-name>.annotations.<ext>
+\registerOption scholarly.annotate.export.filenames
+%   <ext>   <file name>
+#`((html . "index.html") ;; html
+   (latex . default)     ;; latex
+   (scheme . default)    ;; scheme
+   (plaintext . default) ;; plaintext
+   )
+
+
+
+
+
+
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %%%% Handling of annotation types for plain text output
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -111,6 +130,31 @@
    (question . "Question:")
    (todo . "TODO:"))
 
+
+
+%%%%%%%%%%%%%%%%%
+%%%% HTML options
+%%%%%%%%%%%%%%%%%
+
+% Annotation types for html text output
+\registerOption scholarly.annotate.export.html.labels
+#`((critical-remark . "Critical Remark")
+  (musical-issue . "Musical Issue")
+  (lilypond-issue . "Lilypond Issue>")
+  (question . "Question")
+  (todo . "TODO"))
+
+
+% Which props to print to html
+\registerOption scholarly.annotate.export.html.props
+  #`(type grob-location grob-type message)
+
+% Which stylesheet to link in html (just a proof of concept at the moment)
+\registerOption scholarly.annotate.export.html.css
+  #"annotate-styles.css"
+
+
+
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %%%% Handling of annotation types for LaTeX output
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

annotate/export-html.ily

@@ -0,0 +1,138 @@
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%                                                                             %
+% This file is part of ScholarLY,                                             %
+%                      =========                                              %
+% a toolkit library for scholarly work with GNU LilyPond and LaTeX,           %
+% belonging to openLilyLib (https://github.com/openlilylib/openlilylib        %
+%              -----------                                                    %
+%                                                                             %
+% ScholarLY is free software: you can redistribute it and/or modify           %
+% it under the terms of the GNU General Public License as published by        %
+% the Free Software Foundation, either version 3 of the License, or           %
+% (at your option) any later version.                                         %
+%                                                                             %
+% ScholarLY is distributed in the hope that it will be useful,                %
+% but WITHOUT ANY WARRANTY; without even the implied warranty of              %
+% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               %
+% GNU Lesser General Public License for more details.                         %
+%                                                                             %
+% You should have received a copy of the GNU General Public License           %
+% along with ScholarLY.  If not, see <http://www.gnu.org/licenses/>.          %
+%                                                                             %
+% ScholarLY is maintained by Urs Liska, [email protected]                    %
+% Copyright Urs Liska, 2015-17                                                %
+%                                                                             %
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%% Export annotations to html file
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+#(define (nest-indent inpt num)
+  (let* ((indentation ""))
+    (do ((i 0 (1+ i)))
+        ((= i num))
+        (set! indentation (string-append indentation "  ")))
+    (string-append indentation inpt)))
+
+
+% convenience functions
+#(define (stringify-html-tag tag)
+  (format "\"~a\"" tag))
+#(define (delimit-html-tags tags)
+  (format "<div ~a>" tags))
+
+% open div with unique tags
+#(define (div-open ann-or-string nest-level)
+  ;; if class = string, don't check for an id. otherwise it
+  ;; is an ann props list, so check for an id and apply if necessary
+  (if (string? ann-or-string)
+      (let* ((class (string-append "class=" (stringify-html-tag ann-or-string)))
+             (div-tag (delimit-html-tags class))
+             (div-begin (nest-indent div-tag nest-level)))
+          (append-to-output-stringlist div-begin))
+      (let* ((ann ann-or-string)
+             (class (string-append "class=" (stringify-html-tag "annotation")))
+             (id (if (assq-ref ann 'html-id)
+                     (string-append " id=" (stringify-html-tag (assoc-ref ann 'html-id)))
+                     ""))
+             (div-tags (delimit-html-tags (string-append class id)))
+             (div-begin (nest-indent div-tags nest-level)))
+          (append-to-output-stringlist div-begin))))
+
+% close any div
+#(define (div-close nest-level)
+   (append-to-output-stringlist (nest-indent "</div>" nest-level)))
+
+% get all the props we want exported from the option
+#(define (html-process-props ann)
+  (let ((props (getOption `(scholarly annotate export html props))))
+        (for-each
+          (lambda (prop)
+            (let* ((val (cond ((equal? prop 'grob-location)
+                                 (format-location ann))
+                              ((equal? prop 'type)
+                                 (getChildOption
+                                   `(scholarly annotate export html labels)
+                                   (assq-ref ann 'type)))
+                              (else (assq-ref ann prop)))))
+              (begin
+              (if (symbol? val)
+                  (set! val (symbol->string val)))
+              (div-open (symbol->string prop) 3)
+              (append-to-output-stringlist
+                (nest-indent val 4))
+              (div-close 3))))
+          props)))
+
+
+
+\register-export-routine html
+#(lambda ()
+
+  (let ((println append-to-output-stringlist))
+
+  (println "<head>")
+  (println (string-append
+    "  <link rel=\"stylesheet\" type=\"text/css\" href=\""
+    (string-append (getOption `(scholarly annotate export html css))
+                   "\">")))
+  (println "</head>")
+  (println " ")
+
+  (println "<body>")
+  (println " ")
+
+  ;; wrap everything in the annotations div. this is sort of redundant, but
+  ;; could be useful if projects have multiple bookparts with annotation lists.
+  (div-open "annotations" 0)
+  (println " ")
+
+  (for-each
+    (lambda (ann)
+
+      ;; wrap each annotation in the common annotation class
+      ;; add div ID tag if available
+      (div-open ann 1)
+
+        ;; type as a class - maybe we want different types to have some different styles
+        (div-open (symbol->string (assq-ref ann 'type)) 2)
+
+          ;; add the rest of the props to output
+          (html-process-props ann) ;; nest-indents x 3
+
+        (div-close 2)
+
+      (div-close 1)
+      (println " "))
+
+    annotations)
+
+    ;; close ann list div
+    (div-close 0)
+    (println " ")
+
+    (println "</body>")
+
+    ;; write to output file
+    (write-output-file 'html)))

annotate/export-latex.ily

@@ -218,5 +218,4 @@
     annotations)
 
    ;; write to output file
-   (write-output-file "inp"))
-
+   (write-output-file 'latex))

annotate/export-plaintext.ily

@@ -73,5 +73,4 @@
     annotations)
 
    ;; write to output file
-   (write-output-file "log"))
-
+   (write-output-file 'plaintext))

annotate/export.ily

@@ -86,15 +86,22 @@ setAnnotationOutputBasename =
 
 % Take the stringlist 'annotate-export-stringlist
 % and write it out to a file
-#(define (write-output-file ext)
+#(define (write-output-file type)
    ;
    ; TODO
    ; remove "messages" here and directly use the global object
    ;
-   ; TODO
-   ; Make the file name configurable and let it respect the target format
-   ;
-   (let* ((logfile (format "~a.annotations.~a" annotation-out-basename ext)))
+   (let* ((default-exts '((html . "html")
+                          (latex . "inp")
+                          (scheme . "scm")
+                          (plaintext . "log")))
+          (logfile (if (equal? (getChildOption
+                                 '(scholarly annotate export filenames) type)
+                               'default)
+                        (format "~a.annotations.~a" annotation-out-basename
+                          (assoc-ref default-exts type))
+                        (getChildOption
+                          '(scholarly annotate export filenames) type))))
      (ly:message "writing '~a' ..." logfile)
      (with-output-to-file logfile
        (lambda ()
@@ -140,5 +147,3 @@ setAnnotationOutputBasename =
         ly:message)
        (ly:message "")))
     annotations))
-
-

annotate/module.ily

@@ -59,6 +59,7 @@
 \include "export.ily"
 \include "export-latex.ily"
 \include "export-plaintext.ily"
+\include "export-html.ily"
 \include "engraver.ily"
 
 % Include `editorial-functions` module

usage-examples/annotate-styles.css

@@ -0,0 +1,16 @@
+
+html,
+body {
+  background: gray;
+  margin: 0.5em;
+}
+
+annotations {
+  width: 100%;
+  height: 100%;
+}
+
+.annotation {
+  margin: 1em;
+  background: lightgray;
+}

usage-examples/annotate.ly

@@ -8,8 +8,11 @@
 
 \markup \vspace #1
 
-\setOption scholarly.annotate.export-targets #'(plaintext latex)
+\setOption scholarly.annotate.export-targets #'(plaintext latex html)
 
+\setOption scholarly.annotate.export.html.props
+  #`(type grob-type message)
+
 music = \relative c'{
   c4 d e
     \criticalRemark \with {
@@ -32,6 +35,7 @@ music = \relative c'{
     { \voiceOne
         \criticalRemark \with {
           message = "An annotation for the top voice."
+          html-id = "my-unique-id"
         }
         NoteHead
       cis d