soywiki 0.0.3 → 0.0.4

data/.gitignore

@@ -7,5 +7,4 @@ pkg/
 .rvmrc
 notes.txt
 *buffer
-website/
 wiki/

data/README.markdown

@@ -25,8 +25,8 @@ and refactor wiki content at the speed of thought.
 
 SoyWiki is good for tracking projects, contacts, ideas, and collecting
 and organizing research. SoyWiki combines the affordances of notebooks,
-index cards, and Post-it notes, and adds the power of hyperlinks and
-automatic indexing.
+index cards, and Post-it notes, and adds to them the power of hyperlinks
+and automatic indexing.
 
 SoyWiki makes a great writing aid, especially if you do your writing in
 Vim. You can have SoyWiki open in multiple Vim windows, tabs, and
@@ -35,13 +35,6 @@ of Vim abbreviations (`:help abbreviations`), a large monitor, and a
 teapot, and you'll have your paper, essay, book, or screenplay written
 in record time.
 
-You don't need to shell out $$ for tools like [Scrivener][scriv] if you
-appreciate how much more powerful Vim is for editing and navigating text
-and how liberating it is to be able to store your content in the
-non-proprietary, universal plain-text format. Proprietary tools and
-formats will come and go every few years, but the plain text file format
-and Vim are forever.
-
 SoyWiki is free and open source.
 
 [scriv]:http://www.literatureandlatte.com/scrivener.php
@@ -55,9 +48,7 @@ SoyWiki is free and open source.
 
 The current version of SoyWiki assumes a Unix environment. 
 
-To use SoyWiki you should be fairly good at using Vim. More than 80
-percent of the SoyWiki codebase implements the VimScript interface
-layer.
+To use SoyWiki you should be fairly good at using Vim. 
 
 ## Installation
 
@@ -105,7 +96,7 @@ just run `soywiki`.
 For basic use, SoyWiki works exactly like a typical wiki.
 
 You write text, and when you want to create a new wiki page, you come up
-with a WikiWord for it and format it in CamelCase. The wiki-link you
+with a WikiWord for it and format it in CamelCase. The WikiLink you
 just typed will automatically be syntax-highlighted, and pressing ENTER
 on it will take you to the new page. Creating WikiWords and pressing
 ENTER on them is the main way of linking wiki pages together. You'll be
@@ -116,16 +107,16 @@ That's all you need to know to get started.
 
 ## Wiki navigation 
 
-Because SoyWiki is not just wiki but a Vim program, it lets you work a
-lot faster and with more economy than browser-based wikis. 
+Because SoyWiki is not just wiki but also a Vim program, it lets you
+work a lot faster and with more economy than browser-based wikis. 
 
 You can navigate a SoyWiki wiki very quickly with the following
 commands. 
 
-* `CTRL-n` and `CTRL-p` move the cursor directly to the next or previous wiki-link on the page
-* `ENTER` follows the wiki-link under the cursor
-* `,f` follows the first wiki-link after the cursor
-* `,-` opens a wiki-link in a split window
+* `CTRL-n` and `CTRL-p` move the cursor directly to the next or previous WikiLink on the page
+* `ENTER` follows the WikiLink under the cursor
+* `,f` follows the first WikiLink after the cursor
+* `,-` opens a WikiLink in a split window
 * `,|` does the same, but in a vertical split window
 
 You can also use Vim's jump motions `CTRL-o` and `CTRL-i` to move back
@@ -158,10 +149,10 @@ window by putting the cursor at the beginning of a hyperlink and typing
 `gf`, or `C-w f` if you want to open the webpage in a split window.  See
 `:help netrw` for more information.
 
-## Wiki-link autocompletion
+## WikiLink autocompletion
 
 When you're writing a wiki page and you want to link to another page,
-SoyWiki can help you autocomplete your wiki-link. Press `CTRL-x CTRL-u`
+SoyWiki can help you autocomplete your WikiLink. Press `CTRL-x CTRL-u`
 in Vim insert mode to invoke it.
 
 
@@ -257,16 +248,16 @@ But if you want, you can also namespace your WikiWords, like so:
 
     namespaced.WikiWord
 
-A namespaced WikiWord is a WikiWord prefixed by a namespace. The
-namespace word must start with a lower-case letter and consist 
-only of letters, numbers, and underscore characters. You can't chain
-namespace words together: the maximum nesting level is 1.
+A namespaced WikiWord is a WikiWord prefixed by a namespace and a
+period. The namespace word must start with a lower-case letter and
+consist only of letters, numbers, and underscore characters. You can't
+chain namespace words together: the maximum nesting level is 1.
 
-Namespaced WikiWords help organize your conceptual wiki space. They also
+Namespaced WikiWords help organize your wiki space conceptually. They also
 have two other benefits: 
 
 First, wiki pages that represent a namespaced WikiWord are stored under a
-subdirectory named after the namespace. This can help reduce the clutter in
+subdirectory named after the namespace. This can help reduce clutter in
 your wiki directory.
 
 Second, a WikiWord namespace lets you use abbreviated links within that
@@ -284,17 +275,19 @@ WikiLink autocompletion also works with abbreviated namespaced links. Just type
 period, and invoke autocompletion with `CTRL-x CTRL-u`.
 
 
-## Expanding a Wiki page
+## Expanding a wiki page
 
-SoyWiki lets you render a wiki page in "expanded" form.  What this does
-is expand all the wiki links on the page that appear alone on a line to
-include their content inline. This works recursively in all the included
-wiki pages (though it does not go into vicious circles because it only
-expands each link once).
+SoyWiki lets you "expand" a wiki page.  What this does is expand all the
+wiki links in the page that appear alone on a line.  Each of these links
+is replaced by the content of the wiki page the link points to. This
+expansion works recursively on all the expanded content.  Don't worry.
+It can't fall into an infinite recursive loop because it will only
+expand each WikiWord it encounters once, leaving all subsequent
+references to the same WikiWord unexpanded.
 
-The rendered page appears in a Vim scratch buffer. From there you can
-write it out to a new text file, pipe it to `lpr` to print it, or
-whatever you like. 
+The expanded version of the page will appear in a new Vim scratch buffer.
+From there you can write it out to a new text file, pipe it to `lpr` to
+print it, or whatever you like. 
 
 There are two forms of expansion: seamful and seamless. Seamful
 expansion expands wiki links into wiki pages and clearly marks where
@@ -306,14 +299,14 @@ anything, and it erases the WikiWord that got expanded.
 * `,X` expands a wiki page seamlessly
 
 Both modes of expansion are useful when you want to assemble a long
-piece of writing by using one page as a master outline and linking from
-this to other wiki pages that include the real content. And since
-expansion is recursive, you can effectively nest outlines within
-outlines, like dreams within dreams.  
+piece of writing by using one page as a master outline that links to
+other wiki pages that include the real content. And since expansion is
+recursive, you can effectively nest outlines within outlines, like
+dreams within dreams.  
 
 ## Getting help
 
-Typing `,?` will open this webpage in a browser.
+Typing `,?` will open the help webpage in a browser.
 
 
 ## Why CamelCase WikiLinks rule
@@ -323,10 +316,9 @@ pattern. But SoyWiki embraces it and wants everyone to adopt it, for the
 following reasons:
 
 * Besides being the original, CamelCase is the most elegantly minimalist approach to linking wiki pages together -- "with no additional markup whatsoever," as [Ward Cunningham put it][ward]. 
-* It encourages you more than other wiki link patterns to create wiki pages with succinctly descriptive names.  
-* Because the link pattern is so minimal and succinct, inserting them in
-your notes interrupts your flow of
-thought a lot less than other wiki patterns.
+* It encourages you more than other wiki link patterns to create wiki pages with succinctly descriptive names that are easy to remember.
+* Because the link pattern is so minimal and succinct, writing 
+them interrupts your flow of thought a lot less than other wiki patterns.
 * It is very conducive to storing
 wiki pages in plain text files: the page names can map directly to Unix
 file names without any awkward character escaping.

data/Rakefile

@@ -10,12 +10,8 @@ require 'soywiki'
 Bundler::GemHelper.install_tasks
 
 desc "build and push website"
-task :web do
-  version = Soywiki::VERSION
-  Dir.chdir("website") do
-    puts "updating website"
-    puts `./run.sh #{Soywiki::VERSION}`
-  end
+task :web => :build_webpage do
+  `scp website/soywiki.html zoe2@instantwatcher.com:~/danielchoi.com/public/software/`
 end
 
 desc "build website locally"

data/lib/soywiki.rb

@@ -27,7 +27,7 @@ end
 
 
 module Soywiki
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
   WIKI_WORD = /\b([a-z][\w_]+\.)?[A-Z][a-z]+[A-Z]\w*\b|\.[A-Z][a-z]+[A-Z]\w*\b/
 
   def self.run

data/lib/soywiki.vim

@@ -476,7 +476,7 @@ func! s:expand(seamless)
     echom "Expanding seamlessly. Please wait."
     let res = system(s:expand_command . " seamful " . bufname('%'))
   endif
-  vertical botright new 
+  split new 
   setlocal buftype=nofile "scratch buffer for viewing; user can write
   silent! put =res
   silent! 1delete

data/website/.gitignore

@@ -0,0 +1 @@
+images-original/

data/website/gen.rb

@@ -0,0 +1,19 @@
+require 'liquid'
+require 'rdiscount'
+
+module Webpage
+  def self.generate(version)
+    screenshots = RDiscount.new(File.read("top.screenshots")).to_html
+    readme = File.expand_path("../../README.markdown", __FILE__)
+    raise "no README" unless File.size?(readme)
+    md = File.read(readme).split(/^\s*$/)
+    headers = md.grep(/## Prerequisites/)
+    insert_at = md.index headers.first
+    md.insert(insert_at, screenshots) 
+    md = md.join("\n\n")
+    # for some reason markdown inserts extra blank lines
+    content = RDiscount.new(md).to_html.gsub(/\n\n{3,}/, "\n\n")
+    template = File.read("soywiki-template.html")
+    out = Liquid::Template.parse(template).render 'content' => content, 'timestamp' => Time.now.to_i, 'version' => version
+  end
+end

data/website/lightbox2/css/lightbox.css

@@ -0,0 +1,27 @@
+#lightbox{	position: absolute;	left: 0; width: 100%; z-index: 100; text-align: center; line-height: 0;}
+#lightbox img{ width: auto; height: auto;}
+#lightbox a img{ border: none; }
+
+#outerImageContainer{ position: relative; background-color: #fff; width: 250px; height: 250px; margin: 0 auto; }
+#imageContainer{ padding: 10px; }
+
+#loading{ position: absolute; top: 40%; left: 0%; height: 25%; width: 100%; text-align: center; line-height: 0; }
+#hoverNav{ position: absolute; top: 0; left: 0; height: 100%; width: 100%; z-index: 10; }
+#imageContainer>#hoverNav{ left: 0;}
+#hoverNav a{ outline: none;}
+
+#prevLink, #nextLink{ width: 49%; height: 100%; background-image: url(data:image/gif;base64,AAAA); /* Trick IE into showing hover */ display: block; }
+#prevLink { left: 0; float: left;}
+#nextLink { right: 0; float: right;}
+#prevLink:hover, #prevLink:visited:hover { background: url(../images/prevlabel.gif) left 15% no-repeat; }
+#nextLink:hover, #nextLink:visited:hover { background: url(../images/nextlabel.gif) right 15% no-repeat; }
+
+#imageDataContainer{ font: 10px Verdana, Helvetica, sans-serif; background-color: #fff; margin: 0 auto; line-height: 1.4em; overflow: auto; width: 100%	; }
+
+#imageData{	padding:0 10px; color: #666; }
+#imageData #imageDetails{ width: 70%; float: left; text-align: left; }	
+#imageData #caption{ font-weight: bold;	}
+#imageData #numberDisplay{ display: block; clear: left; padding-bottom: 1.0em;	}			
+#imageData #bottomNavClose{ width: 66px; float: right;  padding-bottom: 0.7em; outline: none;}	 	
+
+#overlay{ position: absolute; top: 0; left: 0; z-index: 90; width: 100%; height: 500px; background-color: #000; }

data/website/lightbox2/index.html

@@ -0,0 +1,63 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
+<head>
+	
+	<title>Lightbox JS v2.0 | Test Page</title>
+
+	<link rel="stylesheet" href="css/lightbox.css" type="text/css" media="screen" />
+	
+	<script src="js/prototype.js" type="text/javascript"></script>
+	<script src="js/scriptaculous.js?load=effects,builder" type="text/javascript"></script>
+	<script src="js/lightbox.js" type="text/javascript"></script>
+
+	<style type="text/css">
+		body{ color: #333; font: 13px 'Lucida Grande', Verdana, sans-serif;	}
+	</style>
+
+</head>
+<body>
+
+
+<h1><a href="http://www.lokeshdhakar.com/projects/lightbox2/">Lightbox JS <em>v2.04</em></a></h1>
+<p><a href="http://www.lokeshdhakar.com">by Lokesh Dhakar</a></p>
+
+<h2>Example</h2>
+
+<a href="images/image-1.jpg" rel="lightbox"><img src="images/thumb-1.jpg" width="100" height="40" alt="" /></a>
+
+
+
+
+<h2>How to Use:</h2>
+<h3>Part 1 - Setup</h3>
+<ol>
+<li>Lightbox v2.0 uses the Prototype Framework and Scriptaculous Effects Library. You will need to include these three Javascript files in your header.
+<pre><code>&lt;script type=&quot;text/javascript&quot; src=&quot;js/prototype.js&quot;&gt;&lt;/script&gt;
+&lt;script type=&quot;text/javascript&quot; src=&quot;js/scriptaculous.js?load=effects,builder&quot;&gt;&lt;/script&gt;
+&lt;script type=&quot;text/javascript&quot; src=&quot;js/lightbox.js&quot;&gt;&lt;/script&gt;
+</code></pre>
+</li>
+<li>Include the Lightbox CSS file (or append your active stylesheet with the Lightbox styles).
+<pre><code>&lt;link rel=&quot;stylesheet&quot; href=&quot;css/lightbox.css&quot; type=&quot;text/css&quot; media=&quot;screen&quot; /&gt;
+</code></pre>
+</li>
+<li>Check the CSS and make sure the referenced <code>prevlabel.gif</code> and <code>nextlabel.gif</code> files are in the right location. Also, make sure the <code>loading.gif</code> and <code>closelabel.gif</code> files as referenced near the top of the <code>lightbox.js</code> file are in the right location.</li>
+</ol>
+<h3>Part 2 - Activate</h3>
+<ol>
+<li>Add a <code>rel="lightbox"</code> attribute to any link tag to activate the lightbox. For example:
+<pre><code>&lt;a href=&quot;images/image-1.jpg&quot; rel=&quot;lightbox&quot; title=&quot;my caption&quot;&gt;image #1&lt;/a&gt;
+</code></pre>
+<em>Optional: </em>Use the <code>title</code> attribute if you want to show a caption.		</li>
+<li>If you have a set of related images that you would like to group, follow step one but additionally include a group name between square brackets in the rel attribute. For example: 
+<pre><code>&lt;a href=&quot;images/image-1.jpg&quot; rel=&quot;lightbox[roadtrip]&quot;&gt;image #1&lt;/a&gt;
+&lt;a href=&quot;images/image-2.jpg&quot; rel=&quot;lightbox[roadtrip]&quot;&gt;image #2&lt;/a&gt;
+&lt;a href=&quot;images/image-3.jpg&quot; rel=&quot;lightbox[roadtrip]&quot;&gt;image #3&lt;/a&gt;
+</code></pre>
+No limits to the number of image sets per page or how many images are allowed in each set. Go nuts!</li>
+</ol>	
+
+
+</body>
+</html>

data/website/lightbox2/js/builder.js

@@ -0,0 +1,136 @@
+// script.aculo.us builder.js v1.8.1, Thu Jan 03 22:07:12 -0500 2008
+
+// Copyright (c) 2005-2007 Thomas Fuchs (http://script.aculo.us, http://mir.aculo.us)
+//
+// script.aculo.us is freely distributable under the terms of an MIT-style license.
+// For details, see the script.aculo.us web site: http://script.aculo.us/
+
+var Builder = {
+  NODEMAP: {
+    AREA: 'map',
+    CAPTION: 'table',
+    COL: 'table',
+    COLGROUP: 'table',
+    LEGEND: 'fieldset',
+    OPTGROUP: 'select',
+    OPTION: 'select',
+    PARAM: 'object',
+    TBODY: 'table',
+    TD: 'table',
+    TFOOT: 'table',
+    TH: 'table',
+    THEAD: 'table',
+    TR: 'table'
+  },
+  // note: For Firefox < 1.5, OPTION and OPTGROUP tags are currently broken,
+  //       due to a Firefox bug
+  node: function(elementName) {
+    elementName = elementName.toUpperCase();
+    
+    // try innerHTML approach
+    var parentTag = this.NODEMAP[elementName] || 'div';
+    var parentElement = document.createElement(parentTag);
+    try { // prevent IE "feature": http://dev.rubyonrails.org/ticket/2707
+      parentElement.innerHTML = "<" + elementName + "></" + elementName + ">";
+    } catch(e) {}
+    var element = parentElement.firstChild || null;
+      
+    // see if browser added wrapping tags
+    if(element && (element.tagName.toUpperCase() != elementName))
+      element = element.getElementsByTagName(elementName)[0];
+    
+    // fallback to createElement approach
+    if(!element) element = document.createElement(elementName);
+    
+    // abort if nothing could be created
+    if(!element) return;
+
+    // attributes (or text)
+    if(arguments[1])
+      if(this._isStringOrNumber(arguments[1]) ||
+        (arguments[1] instanceof Array) ||
+        arguments[1].tagName) {
+          this._children(element, arguments[1]);
+        } else {
+          var attrs = this._attributes(arguments[1]);
+          if(attrs.length) {
+            try { // prevent IE "feature": http://dev.rubyonrails.org/ticket/2707
+              parentElement.innerHTML = "<" +elementName + " " +
+                attrs + "></" + elementName + ">";
+            } catch(e) {}
+            element = parentElement.firstChild || null;
+            // workaround firefox 1.0.X bug
+            if(!element) {
+              element = document.createElement(elementName);
+              for(attr in arguments[1]) 
+                element[attr == 'class' ? 'className' : attr] = arguments[1][attr];
+            }
+            if(element.tagName.toUpperCase() != elementName)
+              element = parentElement.getElementsByTagName(elementName)[0];
+          }
+        } 
+
+    // text, or array of children
+    if(arguments[2])
+      this._children(element, arguments[2]);
+
+     return element;
+  },
+  _text: function(text) {
+     return document.createTextNode(text);
+  },
+
+  ATTR_MAP: {
+    'className': 'class',
+    'htmlFor': 'for'
+  },
+
+  _attributes: function(attributes) {
+    var attrs = [];
+    for(attribute in attributes)
+      attrs.push((attribute in this.ATTR_MAP ? this.ATTR_MAP[attribute] : attribute) +
+          '="' + attributes[attribute].toString().escapeHTML().gsub(/"/,'&quot;') + '"');
+    return attrs.join(" ");
+  },
+  _children: function(element, children) {
+    if(children.tagName) {
+      element.appendChild(children);
+      return;
+    }
+    if(typeof children=='object') { // array can hold nodes and text
+      children.flatten().each( function(e) {
+        if(typeof e=='object')
+          element.appendChild(e)
+        else
+          if(Builder._isStringOrNumber(e))
+            element.appendChild(Builder._text(e));
+      });
+    } else
+      if(Builder._isStringOrNumber(children))
+        element.appendChild(Builder._text(children));
+  },
+  _isStringOrNumber: function(param) {
+    return(typeof param=='string' || typeof param=='number');
+  },
+  build: function(html) {
+    var element = this.node('div');
+    $(element).update(html.strip());
+    return element.down();
+  },
+  dump: function(scope) { 
+    if(typeof scope != 'object' && typeof scope != 'function') scope = window; //global scope 
+  
+    var tags = ("A ABBR ACRONYM ADDRESS APPLET AREA B BASE BASEFONT BDO BIG BLOCKQUOTE BODY " +
+      "BR BUTTON CAPTION CENTER CITE CODE COL COLGROUP DD DEL DFN DIR DIV DL DT EM FIELDSET " +
+      "FONT FORM FRAME FRAMESET H1 H2 H3 H4 H5 H6 HEAD HR HTML I IFRAME IMG INPUT INS ISINDEX "+
+      "KBD LABEL LEGEND LI LINK MAP MENU META NOFRAMES NOSCRIPT OBJECT OL OPTGROUP OPTION P "+
+      "PARAM PRE Q S SAMP SCRIPT SELECT SMALL SPAN STRIKE STRONG STYLE SUB SUP TABLE TBODY TD "+
+      "TEXTAREA TFOOT TH THEAD TITLE TR TT U UL VAR").split(/\s+/);
+  
+    tags.each( function(tag){ 
+      scope[tag] = function() { 
+        return Builder.node.apply(Builder, [tag].concat($A(arguments)));  
+      } 
+    });
+  }
+}