erbook 7.1.1 → 7.3.0

data/fmt/xhtml.yaml

@@ -45,6 +45,15 @@ code: |
         end
       end.pack('U*').strip.gsub(/[[:space:]-]+/, '-')
     end
+
+    ##
+    # Evaluates this string as an Ember
+    # template (created with the given
+    # options) inside the given binding.
+    #
+    def thru_ember binding, options = {}
+      ::Ember::Template.new(self, options).render(binding)
+    end
   end
 
   class Hash
@@ -455,7 +464,6 @@ nodes:
       bypass: false
       output: |
         <div id="<%= @node.type_frag %>">
-          <%= @node.navigation %>
           <h1 class="title"><%= @node.type_label %></h1>
           <%= @node.content_xhtml_div %>
         </div>
@@ -675,7 +683,7 @@ output: |
       lof = lof_enums.sort.map do |type, nodes|
         nested = nodes.map do |n|
           %{<li><a id="#{n.list_frag}" href="##{n.here_frag}">#{n.title.to_s.to_inline_xhtml}</a></li>}
-        end
+        end.join
 
         label = ERBook::PHRASES[type.capitalize << 's']
         frag = nodes.first.type_frag
@@ -758,22 +766,18 @@ output: |
       /*]]>*/
       </style>
 
-      % require 'rainpress'
       % @format['styles'].each do |style|
         % style.each_pair do |media, sass|
           <style type="text/css" media="<%= media %>">
           /*<![CDATA[*/<%=
 
             # expand eRuby directives in SASS templates
-            sass = ::Ember::Template.new(sass).render(binding)
+            sass = sass.to_s.thru_ember(binding)
 
             # compile SASS into CSS
             require 'sass'
             css = ::Sass::Engine.new(sass).render
 
-            # minify the CSS
-            css = Rainpress.compress(css)
-
           %>/*]]>*/
           </style>
 
@@ -781,264 +785,10 @@ output: |
       //<![CDATA[
         %< File.join(JQUERY_DIR, 'jquery-1.3.2.min.js')
         %< File.join(JQUERY_DIR, 'jquery-ui-1.7.2.custom.min.js')
-
-        $(function() {
-          /*
-          %< File.join(ERBook::INSTALL, 'LICENSE')
-          */
-
-          //
-          // respond to changes in window location
-          //
-          var $last_hash = null;
-
-          function on_hash_change() {
-            var curr_hash = window.location.hash;
-
-            if (curr_hash && curr_hash != $last_hash) {
-              $last_hash = curr_hash;
-              reveal_hash(curr_hash);
-            }
-
-            setTimeout(on_hash_change, 300);
-          }
-
-          //
-          // Sets the location bar hash to the given value.
-          //
-          // [prevent_jump]
-          //  If true, prevents the browser from jumping to
-          //  the element corresponding to the given hash.
-          //
-          function set_hash(hash, prevent_jump) {
-            if ($last_hash == hash) {
-              return;
-            }
-
-            var set_the_hash = function() {
-              //
-              // XXX: bypass on_hash_change() by setting $last_hash
-              //
-              window.location.hash = $last_hash = hash;
-            }
-
-            if (prevent_jump) {
-              var target = $(hash);
-
-              if (target.length) {
-                //
-                // This particular approach to solving the browser
-                // jumping problem comes from the jQuery.LocalScroll
-                // plugin, which is dual licensed under MIT and GPL:
-                //
-                //   Copyright (c) 2007-2009 Ariel Flesler - aflesler(at)gmail(dot)com | http://flesler.blogspot.com
-                //
-                //   Permission is hereby granted, free of charge, to any person obtaining a copy
-                //   of this software and associated documentation files (the "Software"), to deal
-                //   in the Software without restriction, including without limitation the rights
-                //   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-                //   copies of the Software, and to permit persons to whom the Software is
-                //   furnished to do so, subject to the following conditions:
-                //
-                //   The above copyright notice and this permission notice shall be included in
-                //   all copies or substantial portions of the Software.
-                //
-                //   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-                //   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-                //   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-                //   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-                //   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-                //   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-                //   THE SOFTWARE.
-                //
-                // This plugin is documented at:
-                //
-                //   http://flesler.blogspot.com/2007/10/jquerylocalscroll-10.html
-                //
-                // And its source is available at:
-                //
-                //   http://flesler-plugins.googlecode.com/svn/trunk/jquery.localScroll/jquery.localScroll.js
-                //
-                var target_id = target.attr('id');
-
-                //
-                // temporarily place a dummy element at the current
-                // screen position and give it the ID of the target
-                //
-                var original_screen_position = $(window).scrollTop();
-
-                var dummy = $('<span/>').attr('id', target_id).css({
-                  position: 'absolute',
-                  top:      original_screen_position
-                });
-
-                target.removeAttr('id').before(dummy);
-
-                //
-                // when we set the hash, the browser will jump to the
-                // dummy, which is where the browser screen currently
-                // is, and therefore the jump will not be visualized!
-                //
-                set_the_hash();
-
-                //
-                // undo the temporary changes
-                //
-                dummy.remove();
-                target.attr('id', target_id);
-
-                //
-                // the above approach does not work for Opera and IE.
-                // they ignore the dummy and jump to the actual target
-                //
-                $(window).scrollTop(original_screen_position);
-
-                return;
-              }
-            }
-
-            set_the_hash();
-          }
-
-          //
-          // Returns the tab corresponding to the
-          // given panel in the given tabs widget.
-          //
-          function tab_by_panel(panel, tabs_widget) {
-            if (!tabs_widget) {
-              tabs_widget = panel.parent('.ui-tabs');
-            }
-
-            return tabs_widget.find(
-              '.ui-tabs-nav > li > a[href=#'+ panel.attr('id') +']'
-            ).parent('li');
-          }
-
-          //
-          // Reveals the element at the given hash by (1) activating all
-          // tabs that contain it, (2) smoothly scrolling to it, and (3)
-          // updating the hash in the browser's location bar accordingly.
-          //
-          function reveal_hash(hash) {
-            var target = $(hash);
-
-            if (target.length) {
-              var target_is_panel = target.is('div') &&
-                target.parent('.ui-tabs').length;
-
-              var target_initially_hidden = target.is(':hidden');
-
-              //
-              // reveal all tabs which contain the target
-              //
-              if (target_initially_hidden) {
-                var panels = target.parents('.ui-tabs > div:hidden').get().reverse();
-
-                if (target_is_panel) {
-                  panels.push(target);
-                }
-
-                for (var i in panels) {
-                  var panel = $(panels[i]);
-                  var tabs_widget = panel.parent('.ui-tabs');
-                  var selected_index = tabs_widget.tabs('option', 'selected');
-
-                  //
-                  // map the panel to its tab because tabs do not
-                  // have to be in the same order as their panels
-                  //
-                  var tab = tab_by_panel(panel, tabs_widget);
-                  var wanted_index = tab.prevAll('li').length;
-
-                  if (wanted_index != selected_index) {
-                    tabs_widget.tabs('select', wanted_index);
-                  }
-                }
-              }
-
-              //
-              // scroll to the tab bar instead of the target
-              // because it contains the title for the target
-              //
-              var scroll_target = target_is_panel ?
-                target.parent('.ui-tabs') : target;
-
-              var screen_before_scroll = $(window).scrollTop();
-
-              $('html, body').animate(
-                { scrollTop: Math.floor(scroll_target.offset().top) },
-                'slow', 'swing', function() {
-                  var screen_after_scroll = $(window).scrollTop();
-
-                  set_hash(hash, target_is_panel);
-
-                  if (
-                    !target_initially_hidden &&
-                    screen_after_scroll == screen_before_scroll
-                  ) {
-                    //
-                    // nothing changed on the screen.
-                    // the target was already visible.
-                    // highlight it to notify the user.
-                    //
-                    target.effect('highlight', 'slow');
-                  }
-                }
-              );
-            }
-          }
-
-          //
-          // create jQuery UI tabs
-          //
-          $('.tabs').tabs();
-
-          //
-          // make internal hyperlinks reveal their targets when clicked
-          //
-          $('a[href^=#]').click(function() {
-            var link = $(this);
-            var hash = link.attr('href');
-
-            if (link.parent('li').parent('.ui-tabs-nav').length) {
-              // tab clicks should not cause the screen to scroll
-              set_hash(hash, true);
-            }
-            else {
-              reveal_hash(hash);
-            }
-
-            return false;
-          });
-
-          //
-          // checkbox for printer friendly stylesheet
-          //
-          $('#__header__ > .authors_and_date').append(
-            $('<span/>').append(
-              $('<input/>').attr('type', 'checkbox').click(function() {
-                if ($(this).is(':checked')) {
-                  $('style[media=screen]').attr('media', 'neercs');
-                  $('style[media=print]').attr('media', 'screen');
-                }
-                else {
-                  $('style[media=screen]').attr('media', 'print');
-                  $('style[media=neercs]').attr('media', 'screen');
-                }
-                return true;
-              })
-            ).append(" <%= ERBook::PHRASES['Printer friendly'] %>")
-          );
-
-          //
-          // ready for action!
-          //
-          $('#__loading__').append("<%= ERBook::PHRASES['Ready!'] %>").
-          fadeOut('slow', function() {
-            $('#__body__').show();
-            on_hash_change();
-          });
-        });
+        <%=
+          # expand eRuby directives in JavaScript template
+          js = @format['javascript'].to_s.thru_ember(binding)
+        %>
       //]]>
       </script>
     </head>
@@ -1226,6 +976,302 @@ output: |
     </body>
   </html>
 
+javascript: |
+  $(function() {
+    /*
+    %< File.join(ERBook::INSTALL, 'LICENSE')
+    */
+
+    //
+    // respond to changes in window location
+    //
+    var $last_hash = null;
+
+    function on_hash_change() {
+      var curr_hash = window.location.hash;
+
+      if (curr_hash && curr_hash != $last_hash) {
+        $last_hash = curr_hash;
+        reveal_hash(curr_hash);
+      }
+
+      setTimeout(on_hash_change, 300);
+    }
+
+    //
+    // Sets the location bar hash to the given value.
+    //
+    // [prevent_jump]
+    //  If true, prevents the browser from jumping to
+    //  the element corresponding to the given hash.
+    //
+    function set_hash(hash, prevent_jump) {
+      if ($last_hash == hash) {
+        return;
+      }
+
+      var set_the_hash = function() {
+        //
+        // XXX: bypass on_hash_change() by setting $last_hash
+        //
+        window.location.hash = $last_hash = hash;
+      }
+
+      if (prevent_jump) {
+        var target = $(hash);
+
+        if (target.length) {
+          //
+          // This particular approach to solving the browser
+          // jumping problem comes from the jQuery.LocalScroll
+          // plugin, which is dual licensed under MIT and GPL:
+          //
+          //   Copyright (c) 2007-2009 Ariel Flesler - aflesler(at)gmail(dot)com | http://flesler.blogspot.com
+          //
+          //   Permission is hereby granted, free of charge, to any person obtaining a copy
+          //   of this software and associated documentation files (the "Software"), to deal
+          //   in the Software without restriction, including without limitation the rights
+          //   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+          //   copies of the Software, and to permit persons to whom the Software is
+          //   furnished to do so, subject to the following conditions:
+          //
+          //   The above copyright notice and this permission notice shall be included in
+          //   all copies or substantial portions of the Software.
+          //
+          //   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+          //   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+          //   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+          //   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+          //   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+          //   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+          //   THE SOFTWARE.
+          //
+          // This plugin is documented at:
+          //
+          //   http://flesler.blogspot.com/2007/10/jquerylocalscroll-10.html
+          //
+          // And its source is available at:
+          //
+          //   http://flesler-plugins.googlecode.com/svn/trunk/jquery.localScroll/jquery.localScroll.js
+          //
+          var target_id = target.attr('id');
+
+          //
+          // temporarily place a dummy element at the current
+          // screen position and give it the ID of the target
+          //
+          var original_screen_position = $(window).scrollTop();
+
+          var dummy = $('<span/>').attr('id', target_id).css({
+            position: 'absolute',
+            top:      original_screen_position
+          });
+
+          target.removeAttr('id').before(dummy);
+
+          //
+          // when we set the hash, the browser will jump to the
+          // dummy, which is where the browser screen currently
+          // is, and therefore the jump will not be visualized!
+          //
+          set_the_hash();
+
+          //
+          // undo the temporary changes
+          //
+          dummy.remove();
+          target.attr('id', target_id);
+
+          //
+          // the above approach does not work for Opera and IE.
+          // they ignore the dummy and jump to the actual target
+          //
+          $(window).scrollTop(original_screen_position);
+
+          return;
+        }
+      }
+
+      set_the_hash();
+    }
+
+    //
+    // Returns the tab corresponding to the
+    // given panel in the given tabs widget.
+    //
+    function tab_by_panel(panel, tabs_widget) {
+      if (!tabs_widget) {
+        tabs_widget = panel.parent('.ui-tabs');
+      }
+
+      return tabs_widget.find(
+        '.ui-tabs-nav > li > a[href=#'+ panel.attr('id') +']'
+      ).parent('li');
+    }
+
+    //
+    // Reveals the element at the given hash by (1) activating all
+    // tabs that contain it, (2) smoothly scrolling to it, and (3)
+    // updating the hash in the browser's location bar accordingly.
+    //
+    function reveal_hash(hash) {
+      var target = $(hash);
+
+      if (target.length) {
+        var target_is_panel = target.is('div') &&
+          target.parent('.ui-tabs').length;
+
+        var target_initially_hidden = target.is(':hidden');
+
+        //
+        // reveal all tabs which contain the target
+        //
+        if (target_initially_hidden) {
+          var panels = target.parents('.ui-tabs > div:hidden').get().reverse();
+
+          if (target_is_panel) {
+            panels.push(target);
+          }
+
+          for (var i in panels) {
+            var panel = $(panels[i]);
+            var tabs_widget = panel.parent('.ui-tabs');
+            var selected_index = tabs_widget.tabs('option', 'selected');
+
+            //
+            // map the panel to its tab because tabs do not
+            // have to be in the same order as their panels
+            //
+            var tab = tab_by_panel(panel, tabs_widget);
+            var wanted_index = tab.prevAll('li').length;
+
+            if (wanted_index != selected_index) {
+              tabs_widget.tabs('select', wanted_index);
+            }
+          }
+        }
+
+        //
+        // scroll to the tab bar instead of the target
+        // because it contains the title for the target
+        //
+        var scroll_target = target;
+
+        if (target_is_panel) {
+          var tabs_nav = target.parent('.ui-tabs').find('> .ui-tabs-nav');
+
+          if (!tabs_nav.is(':hidden')) {
+            scroll_target = tabs_nav;
+          }
+        }
+
+        var screen_before_scroll = $(window).scrollTop();
+
+        $('html, body').animate(
+          { scrollTop: Math.floor(scroll_target.offset().top) },
+          'slow', 'swing', function() {
+            var screen_after_scroll = $(window).scrollTop();
+
+            set_hash(hash, target_is_panel);
+
+            if (
+              !target_initially_hidden &&
+              screen_after_scroll == screen_before_scroll
+            ) {
+              //
+              // nothing changed on the screen.
+              // the target was already visible.
+              // highlight it to notify the user.
+              //
+              target.effect('highlight', 'slow');
+            }
+          }
+        );
+      }
+    }
+
+    //
+    // create jQuery UI tabs
+    //
+    $('.tabs').tabs();
+
+    //
+    // make internal hyperlinks reveal their targets when clicked
+    //
+    $('a[href^=#]').click(function() {
+      var link = $(this);
+      var hash = link.attr('href');
+
+      if (link.parent('li').parent('.ui-tabs-nav').length) {
+        // tab clicks should not cause the screen to scroll
+        set_hash(hash, true);
+      }
+      else {
+        reveal_hash(hash);
+      }
+
+      return false;
+    });
+
+    //
+    // checkbox for printer friendly stylesheet
+    //
+    $('#__header__ > .authors_and_date').append(
+      $('<span/>').addClass('printer_friendly_toggle').append(
+        $('<input/>').attr('type', 'checkbox').click(function() {
+          var checkbox = $(this);
+
+          function change_media(src, dst) {
+            var styles = $('style[media="'+ src +'"]');
+            if (styles.length) {
+              //
+              // try changing the media in-place
+              //
+              var before = checkbox.offset();
+              styles.attr('media', dst);
+              var after = checkbox.offset();
+
+              if (after.top == before.top && after.left == before.left) {
+                //
+                // try reinserting the <style> into document.
+                // this works in Webkit browsers, which ignore
+                // the in-place changing approach tried above.
+                //
+                styles.each(function() {
+                  var style = $(this);
+                  var parent = style.parent();
+
+                  style.remove();
+                  parent.append(style);
+                });
+              }
+            }
+          }
+
+          if (checkbox.is(':checked')) {
+            change_media('screen', 'none');
+            change_media('print', 'screen,print');
+          }
+          else {
+            change_media('screen,print', 'print');
+            change_media('none', 'screen');
+          }
+
+          return true;
+        })
+      ).append(" <%= ERBook::PHRASES['Printer friendly'] %>")
+    );
+
+    //
+    // ready for action!
+    //
+    $('#__loading__').append("<%= ERBook::PHRASES['Ready!'] %>").
+    fadeOut('slow', function() {
+      $('#__body__').show();
+      on_hash_change();
+    });
+  });
+
 # definition of font families for use in the CSS styles
 fonts:
   serif:      Constantia, "Book Antiqua", "URW Bookman L", serif
@@ -1241,15 +1287,15 @@ styles: # these are SASS templates
       font-family: <%= @format['fonts']['sans-serif'] %>
 
 
+    em, strong, dt
+      font-family: <%= @format['fonts']['serif'] %>
+
+
     blockquote
       color: #333
       font-style: italic
 
 
-    em, strong, dt
-      font-family: <%= @format['fonts']['serif'] %>
-
-
     hr
       height: 0
       border: 0
@@ -1258,8 +1304,8 @@ styles: # these are SASS templates
 
     tt, code, pre
       font-family: <%= @format['fonts']['monospace'] %>
-      // appears like "size: small" otherwise
-      font-size: 100%
+      font-size: 1em
+      line-height: 1em
 
 
     // output of the syntax coloring library
@@ -1341,6 +1387,16 @@ styles: # these are SASS templates
       font-size: 2.25em
 
 
+    @media print
+      #__header__ .printer_friendly_toggle
+        display: none
+
+
+    @media screen
+      #__header__ .printer_friendly_toggle
+        display: inline
+
+
     #__abstract__
       margin-bottom: 5em
 
@@ -1351,10 +1407,6 @@ styles: # these are SASS templates
 
       li ul
         padding-bottom: 1em
-        border-left: thick solid #F5F5F5
-
-        &:hover
-          border-color: #DCDCDC
 
       > ul
         padding-left: 1em
@@ -1477,13 +1529,6 @@ styles: # these are SASS templates
         color: #800080
 
 
-    #__toc__ a:target, #__lof__ a:target
-      background: <%= ICON_BY_NAME['here_frag'].data_css %>
-      background-position: center right
-      background-repeat: no-repeat
-      padding-right: 20px
-
-
     #__header__ >
       .logo
         float: left
@@ -1512,6 +1557,23 @@ styles: # these are SASS templates
           font-weight: lighter
 
 
+    // visually indicate the current location in
+    // the hierarchy as the cursor hovers about
+    #__toc__
+      li ul
+        border-left: thick solid #F5F5F5
+
+        &:hover
+          border-color: #DCDCDC
+
+
+    #__toc__ a:target, #__lof__ a:target
+      background: <%= ICON_BY_NAME['here_frag'].data_css %>
+      background-position: center right
+      background-repeat: no-repeat
+      padding-right: 20px
+
+
     .nav
       float: right
 
@@ -1527,6 +1589,14 @@ styles: # these are SASS templates
 
 
 - print: |
+    body
+      font-family: <%= @format['fonts']['serif'] %>
+
+
+    em, strong, dt
+      font-family: <%= @format['fonts']['sans-serif'] %>
+
+
     tt
       font-weight: normal
 
@@ -1535,8 +1605,9 @@ styles: # these are SASS templates
       border: none
 
 
-    h1, h2, h3, h4, h5, h6
+    h1, h2, h3, h4, h5, h6, .title
       font-weight: normal
+      font-family: <%= @format['fonts']['sans-serif'] %>
       clear: both
 
 
@@ -1575,7 +1646,7 @@ styles: # these are SASS templates
         font-size: smaller
 
 
-    .tabs > ul, .nav, #__lof__, #__nfo__ > .validations
+    .tabs > ul, .nav, #__lof__, #__nfo__
       display: none
 
 
@@ -1587,7 +1658,7 @@ styles: # these are SASS templates
       text-align: center
 
 
-    #__header__ > .authors
+    #__header__ > .authors_and_date > .authors
       margin-top: 1.625em
       margin-bottom: -0.25em