nandoc 0.0.1

data/proto/README.md

@@ -0,0 +1,31 @@
+### Abstract
+
+This document presents three implementation alternatives of NanDoc site creation, and then explains why we are going with the one we are going with at the time of this writing.  (It was also a chance for me to experiment with markdown footnotes!)
+
+
+### Prototypes
+
+Each folder in this folder is a 'prototype' nanoc installation. (Probably only one folder, called 'default'.)  (The folder called 'misc' holds one-off templates for ad-hoc stuff, maybe for helpers etc.)
+
+The result of each such prototype is comparable to the filetree you get from a default nanoc 'create_site' command, but altered accordingly to be a NanDoc site, whatever that will come to mean.
+
+
+### Changesets through Treebis
+
+The prototype site(s) in this folder is probably expressed as a cangeset to an existing default filetree created by `nanoc create_site <my-site>`.  Given that the default NanDoc site is rougly 90% the same as a default Nanoc3 site ATTOTW, the author felt that it would be best to represent the default NanDoc site as a diff of the default Nanoc site.[^1]
+
+[^1]: At such time as this percentage drops significantly we will reconsider this decision.
+
+Thus the changesets here are the minimal readable expression of changes we want to make to a default nanoc site tree, to alter it to be a default NanDoc
+site tree.  These changesets are expressed using a Treebis 'patch' which is some files along with a Treebis task.  (See documentation there for gory details.)
+
+One big unified diff would have worked to this end, but the author felt that a Treebis patch was more readable and navigable, especially through the perspective of a VCS, which will now be carrying diffs of diffs.
+
+
+#### Caveats and notes
+
+An alternative would be to represent the files we need in our default site tree in their entirety here, and not rely on the nanoc create_site command.[^2] This would have the advantage that it would be less fragile than the current implementation, which will break whenever there are significant changes to the defult site from Nanoc.  However the current implementation has the advantage that A) it might pick up future changes to the nandoc site provided our patch doens't break on it, and B) we get this de-facto early warning mechanism about changes to the default nandoc app site content and structure.
+
+[^2]: We may still rely on the command but not the files it ouputs.
+
+In other words, the disadvantage is that this goes stale loudly.  The advantage is that it goes stale loudly.

data/proto/default/Rakefile

@@ -0,0 +1 @@
+require 'nanoc3/tasks'

data/proto/default/Rules

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+
+# * The order of rules is important: for each item, only the first matching
+#   rule is applied.
+#
+# * Item identifiers start and end with a slash (e.g. "/about/" for the file
+#   "content/about.html"). To select all children, grandchildren, ... of an
+#   item, use the pattern "/about/*/"; "/about/*" will also select the parent,
+#   because "*" matches zero or more characters.
+
+PassThru = [
+  {:dir=>'css', :ext=>'css'},
+  {:dir=>'js',  :ext=>'js'},
+  {:dir=>'vendor', :ext=>'js'}, # sucks
+  {:dir=>'svg', :ext=>'svg'}
+]
+PassThru.each do |x|
+  compile("/#{x[:dir]}/*/"){ } # don't filter or layout
+end
+
+PassThru.each do |x|
+  dir, ext = x[:dir], x[:ext]
+  route "/#{dir}/*" do
+    if item.children.empty?
+      # only operate on leaf nodes
+      basename = item.identifier =~ /^(.+)\/$/ && $1 or
+        fail("parse fail: #{item.identifier}")
+      "#{basename}.#{ext}"
+    end
+  end
+end
+
+# removed some crazy logic in 4189c
+
+compile '*' do
+  filter :nandoc
+  filter :erb
+  filter :kramdown
+  layout 'default'
+end
+
+route '*' do
+  item.identifier + 'index.html'
+end
+
+layout '*', :erb

data/proto/default/config.yaml

@@ -0,0 +1,57 @@
+# A list of file extensions that nanoc will consider to be textual rather than
+# binary. If an item with an extension not in this list is found,  the file
+# will be considered as binary.
+text_extensions: [ 'css', 'erb', 'haml', 'htm', 'html', 'js', 'less', 'markdown', 'md', 'php', 'rb', 'sass', 'txt' ]
+
+# The path to the directory where all generated files will be written to. This
+# can be an absolute path starting with a slash, but it can also be path
+# relative to the site directory.
+output_dir: output
+
+# A list of index filenames, i.e. names of files that will be served by a web
+# server when a directory is requested. Usually, index files are named
+# "index.hml", but depending on the web server, this may be something else,
+# such as "default.htm". This list is used by nanoc to generate pretty URLs.
+index_filenames: [ 'index.html' ]
+
+# Whether or not to generate a diff of the compiled content when compiling a
+# site. The diff will contain the differences between the compiled content
+# before and after the last site compilation.
+enable_output_diff: false
+
+
+# nanDoc: here is an example deployment config node. 
+# uncomment this, get it right, and try `rake deploy:rsync` from your mysite 
+# directory
+# deploy:
+#   default:
+#     dst: "hipeland.org:/var/www/nandoc.hipeland.org"  
+# 
+
+# The data sources where nanoc loads its data from. This is an array of
+# hashes; each array element represents a single data source. By default,
+# there is only a single data source that reads data from the "content/" and
+# "layout/" directories in the site directory.
+data_sources:
+  -
+    config:
+      allow_periods_in_identifiers: true
+      source_file_basenames: ['README', 'NEWS', 'doc']
+      use_as_main_index: 'README.md'
+
+    site_prototype: default
+
+    # The type is the identifier of the data source. By default, this will be
+    # `filesystem_unified`.
+    type: nandoc
+
+    # The path where items should be mounted (comparable to mount points in
+    # Unix-like systems). This is "/" by default, meaning that items will have
+    # "/" prefixed to their identifiers. If the items root were "/en/"
+    # instead, an item at content/about.html would have an identifier of
+    # "/en/about/" instead of just "/about/".
+    items_root: /
+
+    # The path where layouts should be mounted. The layouts root behaves the
+    # same as the items root, but applies to layouts rather than items.
+    layouts_root: /

data/proto/default/content/css/nanoc-dist-altered.css

@@ -0,0 +1,213 @@
+* {
+  margin: 0;
+  padding: 0;
+  /*
+    this was the nandoc-generated font-family:
+    font-family: Georgia, Palatino, Times, 'Times New Roman', sans-serif;
+    this was breaking the default browser's font for <code></code>,
+    decided just to go with the browser default font
+  */
+}
+
+body {
+  background: #fff;
+}
+
+a {
+  text-decoration: none;
+}
+
+a:link,
+a:visited {
+  color: #f30;
+}
+
+a:hover {
+  color: #f90;
+}
+
+.main{
+  float:left;
+  left:59px;
+  position:relative;
+  top:40px;
+  width:500px;
+}
+
+.main h1 {
+  font-size: 40px;
+  font-weight: normal;
+  line-height: 40px;
+  letter-spacing: -1px;
+}
+
+.maincontent p {
+  margin: 20px 0;
+  font-size: 15px;
+  line-height: 20px;
+}
+
+/*
+.main ul {
+  margin: 20px;
+}*/
+/*
+.main li {
+  list-style-type: square;
+  font-size: 15px;
+  line-height: 20px;
+}
+*/
+
+.sidebar {
+  position: relative;
+  float: left;
+  top: 40px;
+  left: 20px;
+  width: 200px;
+  padding: 20px 20px 0 0;
+  border-right: 1px solid #ccc;
+  text-align: right;
+}
+
+.sidebar h2 {
+  /* moved to a class to make it more reusable */
+  margin-top:2em;
+}
+.sidebar h2.first {
+  margin-top: 0;
+}
+
+.sidebar ul {
+  list-style-type: none;
+  /*margin: 20px 0;*/
+}
+
+.sidebar li {
+  font-size: 14px;
+  line-height: 20px;
+}
+
+/*
+############################################################################
+nandoc added.
+alphabetical order disregarding element type, any leading nandoc- prefix
+or whether it is an identifier or a class.
+) */
+.bouncy-lvl1-sep {
+float:left;
+padding: 0 0.2em;
+position: relative;
+z-index: 1;
+}
+.bouncy-lvl2-menu {
+background: #ccc;
+padding: 0em 0.2em 0.2em 0.5em;
+overflow: hidden;
+position: absolute;
+right: 0px;
+text-align: right;
+top: 1em;
+z-index: -1;
+-moz-border-radius-bottomleft: 8px;
+-moz-border-radius-bottomright: 8px;
+-moz-border-radius-topleft: 8px;
+-moz-border-radius-topright: 0px;
+-webkit-border-bottom-left-radius: 8px;
+-webkit-border-bottom-right-radius: 8px;
+-webkit-border-top-left-radius: 8px;
+-webkit-border-top-right-radius: 0px;
+}
+.bouncy-lvl2-item {
+white-space: nowrap;
+}
+.bouncy-lvl2-content a:link {
+color: #333;
+}
+.bouncy-lvl2-content a:visited {
+color: #000;
+}
+.bouncy-lvl2-content a:hover {
+color: #f30;
+}
+.bouncy-lvl2-sep {
+
+}
+.clear {
+clear: both;
+}
+.debug-ging-outline {
+border: 1px solid orange;
+}
+div.footnotes{
+font-size:0.9em;
+}
+dl.faces{
+font-size: 14px;
+line-height: 1.3em;
+}
+dl.faces dt{
+clear: left;
+float: left;
+padding: 0 0.3em 0 0;
+text-align: right;
+width:9em;
+}
+dl.faces dd{
+text-align: left;
+}
+.nandoc-menu-lvl-1{
+float: left;
+position: relative;
+z-index: 2;
+}
+.nandoc-menu-sep {
+float: left;
+margin: 0 0.2em;
+z-index; 1;
+}
+.nanoc-sidebar-h2 {
+color: #333;
+font-size: 13px;
+font-weight: bold;
+letter-spacing: 1px;
+line-height: 20px;
+text-transform: uppercase;
+}
+.main h2, .main h3, .main h4, .main h5, .main h6{
+margin: 0.8em 0 0.4em 0
+}
+.main p{
+margin: 0 0 0.4em 0;
+}
+.main ul{
+margin: 0 0 0 1.0em;
+}
+p.answer:first-letter {
+font-size: 1.5em;
+font-weight: bold;
+}
+span.answer {
+font-size: 1.5em;
+font-weight: bold;
+}
+.sidebar ul.nested {
+margin: 0 0;
+}
+.sidebar ul.nested li {
+line-height: 1em;
+}
+#nandoc-site-map {
+margin: 10px 12px 10px 0px
+}
+.nandoc-topnav {
+padding: 18px 0 18px 0;
+}
+.nandoc-topnav-2 {
+padding: 18px 0 18px 0;
+border: 1px solid black;
+}
+.sidebar .links{
+float: right;
+text-align: center;
+}

data/proto/default/content/css/trollop-subset.css

@@ -0,0 +1,116 @@
+/* copy-pasted, apapted from William Morgan's Trollop */
+/*
+body {
+margin-left:auto;
+margin-right:auto;
+width:800px;
+}
+*/
+code {
+font-size:14px;
+}
+.ruby {
+background:none repeat scroll 0 0 #111122;
+color:#228822;
+padding:10px;
+/*width:800px;*/
+}
+.ruby .normal {
+color:#FFFFFF;
+}
+.ruby .comment {
+color:#9999FF;
+}
+.ruby .keyword {
+color:#AA4444;
+font-weight:bold;
+}
+.ruby .method {
+color:#4444FF;
+}
+.ruby .class {
+color:#00CC44;
+}
+.ruby .module {
+color:#005500;
+}
+.ruby .punct {
+color:#FFFF00;
+font-weight:bold;
+}
+.ruby .symbol {
+color:#FFFF00;
+}
+.ruby .string {
+color:#44FF44;
+}
+.ruby .char {
+color:#FF0077;
+}
+.ruby .ident {
+color:#FFFFFF;
+}
+.ruby .constant {
+color:#00CC44;
+}
+.ruby .regex {
+background:none repeat scroll 0 0 #444444;
+color:#BB6666;
+}
+.ruby .number {
+color:#FF9999;
+}
+.ruby .attribute {
+color:#FFCC44;
+}
+.ruby .global {
+color:#77FFBB;
+}
+.ruby .expr {
+color:#882277;
+}
+.ruby .escape {
+color:#227777;
+}
+.terminal {
+background:none repeat scroll 0 0 #111122;
+/*color:#228822; this is green*/
+color:#AFE793; /* this is pale green*/
+margin:0 0 0.5em 0;
+padding:10px;
+/*width:800px;*/
+}
+.terminal .prompt { /* same as 'green' below */
+color:#00C23C;
+}
+.terminal .normal {
+color:#AFE793
+}
+.terminal .bright {
+font-weight: bold;
+}
+.terminal .black {
+color:#000000;
+}
+.terminal .green {
+/* this is iTerm per digital color meter, not per web colors */
+color:#00C23C;
+}
+.terminal .red {
+color:#FF0000;
+}
+.terminal .yellow {
+color:#FFFF00;
+}
+.terminal .blue {
+color:#0000FF;
+}
+.terminal .magenta {
+color:#FF00FF;
+}
+.terminal .cyan {
+color:#00FFFF;
+}
+.terminal .white {
+color:#FFFFFF;
+}

data/proto/default/content/js/menu-bouncy.js

@@ -0,0 +1,126 @@
+$(document).ready(function(){
+  /*
+  This is adapted from Sam & Zach -
+  http://buildinternet.com/2009/01/how-to-make-a-smooth-animated-menu-with-jquery/
+
+  The use of stop() below is per -
+  http://www.learningjquery.com/2009/01/quick-tip-prevent-animation-queue-buildup/
+
+  @todo maybe make it a jquery poogin
+
+  issues: if the mouse moves sufficiently fast, there is no mouseout event so
+  the menu stays open until etc.
+  */
+
+  $("a").click(function(){   //Remove outline from links
+    $(this).blur();
+  });
+
+  // var puts = (window.console && console.log) ? console.log : function(){};
+  var puts = function(){};
+
+  var menus = [];
+  var registerMenu = function(menu){
+    menu.data('identifier', menus.length);
+    menus.push(menu);
+  };
+
+  var findHotspotFromSepDiv = function(sepDiv){
+    var a = sepDiv.prev().find('a');
+    if (a.length) return a;
+    return sepDiv; // this is for items on level1 that have children and that
+                   // we are at currently. (such items aren't hrefs, just text.)
+  }
+
+  var hideAnyShowing = function(){
+    for (var i=menus.length; i--;) {
+      var menu = menus[i];
+      if (menu.data('showing')) {
+        menu.data('hideMenu')(); // eew
+      }
+    }
+  };
+
+  var setupHotspotAndMenu = function(hotspot, menu){
+    registerMenu(menu);
+    var shortHeight, tallHeight, easing, duration;
+    shortHeight = '0px';
+    tallHeight = menu.height() + 'px';
+    easing = 'easeOutBounce';
+    duration = 600;
+    menu.height(shortHeight);
+    menu.hide();
+    var hide = function(){ menu.hide(); };
+    var showMenu = function(){
+      hideAnyShowing();
+      menu.data('showing', true);
+      menu.show();
+      menu.css({opacity: 1});
+      menu.stop().animate(
+        { height : tallHeight },
+        { queue:false, duration:duration, easing:easing }
+      );
+    };
+    var hideMenu = function(){
+      menu.data('showing', false);
+      menu.data('inMenu', false);
+      menu.stop().animate(
+        { height : shortHeight },
+        { queue:false, duration:duration, easing:easing, complete:hide }
+      );
+      menu.animate(
+        { opacity: 0 },
+        { duration: duration }
+      );
+    };
+    menu.data('hideMenu',hideMenu); // eew
+
+    var hotspotMouseover = function(){
+      if (menu.data('showing')){
+        puts("hs mouseover - showing so nothing.");
+      } else {
+        puts("hs mouseover - not showing so show.");
+        showMenu();
+      }
+    };
+    var hotspotMouseout = function(){
+      // hack - we need to wait a few beats to see if the mouse goes
+      // into the menu or not.
+      setTimeout(function(){
+        if (menu.data('inMenu')) {
+          puts("hotspot mouseout - in menu so stay.");
+        } else {
+          puts("hotspot mouseout - not in menu so hide.");
+          hideMenu();
+        }
+      },600);
+    };
+    var menuMouseover = function(e, e2){
+      if (!e) { e = e2; }
+      // this hits a lot b/c of all the elements in menu.  we take them all
+      menu.data('inMenu', true);
+    };
+    var menuMouseout = function(e, e2){
+      if (!e) { e = e2; }
+      if (e.target != menu[0]){
+        // puts("menu mouseout - ignoring b/c menu was not target."); too noisy
+      } else {
+        puts("menu mouseout - always hides menu when menu was target.");
+        hideMenu();
+      }
+    };
+    hotspot.mouseover(hotspotMouseover);
+    hotspot.mouseout(hotspotMouseout);
+    menu.mouseover(menuMouseover);
+    menu.mouseout(menuMouseout);
+  };
+
+  els = $('.bouncy-lvl2-menu');
+  for (var i=els.length; i--;) {
+    var menu = $(els[i]);
+    var sepDiv = menu.parent();
+    var hotspot = findHotspotFromSepDiv(sepDiv);
+    setupHotspotAndMenu(hotspot, menu);
+  }
+
+});

data/proto/default/content/stylesheet.css.diff

@@ -0,0 +1,20 @@
+--- a/stylesheet.css	0000-00-00 00:00:00.000000000 -0000
++++ b/stylesheet.css	0000-00-00 00:00:00.000000000 -0000
+@@ -1,12 +1,15 @@
+ * {
+   margin: 0;
+   padding: 0;
+-
+-  font-family: Georgia, Palatino, Times, 'Times New Roman', sans-serif;
++  /* no fonts here */
+ }
+
+ body {
+   background: #fff;
++  /*font-family: Georgia, Palatino, Times, 'Times New Roman', sans-serif;
++    we moved this from the * class to here, then decided nah, stick with
++    default browser font to keep it simple and neutral
++  */
+ }
+
+ a {