soywiki 0.2.9 → 0.3.0

data/README.markdown

@@ -4,7 +4,7 @@ SoyWiki turns Vim into a powerful, lean, and fast wiki.  It's got all the
 protein of a more conventional wiki, but less saturated fat and no
 cholesterol. 
 
-A quick overview of its characteristics and features:
+A quick overview of SoyWiki's characteristics and features:
 
 * flat text files
 * maximum data portability
@@ -112,16 +112,18 @@ link them together. You'll be surprised at how powerful this simple mechanism
 is for organizing your notes. 
 
 In SoyWiki, a wiki page is a simple text file that has a WikiWord title
-on the first line (don't alter this line) and any text your want to
-insert below that. SoyWiki will create stub WikiPages for you
-automatically as you traverse WikiLinks that don't yet reference any
-content.
+on the first line and any text your want to insert below that.  (You may
+alter the title line at the top, but it helps you see what wiki page
+you're on.) SoyWiki will create stub WikiPages for you automatically as
+you traverse WikiLinks that don't yet reference any content.
 
 That's all you need to know to get started. 
 
 ## Namespaced WikiWords
 
 Every WikiWord in SoyWiki is implicitly or explicitly namespaced.
+SoyWiki's namespaced WikiWords help organize your wiki space
+conceptually.  They also help reduce clutter in your wiki directory.
 
 An explicitly namespaced WikiWord looks like this:
 
@@ -134,13 +136,18 @@ The implicitly namespaced form looks just like a conventional WikiWord:
 A namespace must start with a lower-case letter and consist only of letters,
 numbers, and underscore characters. 
 
-Within a WikiWord namespace you can use unqualified WikiWords to link pages
-within that namespace together. For example, if you are editing a page called
-`recipes.SoyMacaroni` and you want to link to a page called
+Within a WikiWord namespace you can use unqualified WikiWords to link
+pages within that namespace together. For example, if you are editing a
+page called `recipes.SoyMacaroni` and you want to link to a page called
 `recipes.SoyRaspberrySmoothie`, you can type a link called
 `SoyRaspberrySmoothie`. SoyWiki will treat this link as an implicitly
 namespaced link to another page in the `recipes` namespace. 
 
+SoyWiki wiki pages are stored as text files named by WikiWord within
+subdirectories named after their namespace. So
+`recipes.SoyRaspberrySmoothie` would be written to
+`recipes/SoyRaspberrySmoothie`.
+
 You can't chain namespace words together. The maximum nesting level is 1.  More
 nesting would imply hierarchical relationships, and permitting hierarchical
 nesting goes against the grain of what a wiki is, which is an [undirected
@@ -151,8 +158,6 @@ wiki page" below to see how you can use SoyWiki like an outliner program.
 
 [graph]:http://en.wikipedia.org/wiki/Graph_theory
 
-SoyWiki's namespaced WikiWords help organize your wiki space conceptually.
-They also help reduce clutter in your wiki directory.
 
 When you start SoyWiki for the first time, the active namespace is the default
 namespace `main`. `main.HomePage` is the first page you will see.
@@ -180,6 +185,9 @@ and forth in your jump history. See `:help jump-motions` for more on
 this. You can press `CTRL-^` to toggle between the current page and the
 last page you looked at.
 
+* `,m` opens the page list
+* `,M` opens the inbound links page list 
+
 You can view all the pages in your wiki, most recently modified first,
 by pressing `,m`. This opens both a page list and autocompletion window.
 You can use the standard Vim autocompletion commands here to find the
@@ -190,8 +198,11 @@ When you're on a wiki page and you want to see all the other wiki pages
 that link in to it, press `,M`. If there is only one page that links in,
 you'll be taken there automatically.
 
-`,o` opens the first normal web hyperlink -- the ones that begin with http://
-or https:// -- on or after the cursor in your default web browser.
+* `,o` opens the first web hyperlink on or after the cursor
+
+`,o` opens the next hyperlink on or after the cursor. These are the URLs
+that begin with http:// or https://. You can also use `ENTER` when the
+cursor is over a web hyperlink.
 
 Under the covers, SoyWiki uses the command `gnome-open` or `open` to
 launch your web browser. This should cover Linux Gnome desktop and OS X
@@ -202,8 +213,14 @@ adding this to your `~/.vimrc`:
 
 If your Vim has `netrw`, you can open a hyperlink directly in same Vim
 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.
+`gf`, or `C-w f` if you want to open the webpage in a split window.
+See `:help netrw` for more information.
+
+Tip: I personally like using `netrw` (configured to use elinks) a lot
+more than using a conventional web browser, because it lets me keep all
+my URL bookmarks in regular text files and open, clip, and annotate them
+all in SoyWiki and Vim.
+
 
 ## WikiLink autocompletion
 
@@ -268,8 +285,8 @@ same wiki page.
 
 ## Search
 
-* `:SWSearch` [term]
-* `:SWNamespaceSearch` [term]
+* `:SWSearch [term]`
+* `:SWNamespaceSearch [term]`
 
 These commands search your SoyWiki wiki. `:SWNamespaceSearch` confines
 your search to the current namespace.
@@ -282,11 +299,11 @@ QuickFix commands.
 
 Examples:
 
-    :SWSearch Gnu
-    :SWNamespaceSearch Gnu
+    :SWSearch gnu
+    :SWNamespaceSearch gnu
 
 You can use `:SWS` as a shortcut for `:SWSearch`. You can also
-tab-complete `:SWNS` to `:SWSNamespaceSearch`.
+tab-complete `:SWN` to `:SWNamespaceSearch`.
 
 Searches are case-insensitve.  
 
@@ -318,9 +335,9 @@ You can always bypass Vim and SoyWiki altogether and use Git directly to
 inspect your revision history. The Git repo for your SoyWiki wiki will
 be located in the same directory as your wiki files.
 
-To sync your SoyWiki wiki between two personal computers, you can follow the
-instructions [here][git-sync] or you can set up an bare Git repository
-upstream on some server for all your computers to push to and pull from.
+To sync your SoyWiki wiki between two personal computers, you can follow
+the instructions [here][git-sync] and set up an bare Git repository on
+some server for all your computers to push to and pull from.
 
 [git-sync]:http://www-cs-students.stanford.edu/~blynn/gitmagic/ch03.html
 
@@ -397,10 +414,10 @@ 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 Cunninghamb put it][ward]. 
 * 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.
+them interrupts your flow of thought less than other wiki link 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.
+file names without any awkward character escaping or munging.
 
 [ward]:http://c2.com/cgi/wiki?WikiCase
 

data/bin/soywiki-rename

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# encoding: UTF-8
 require 'soywiki'
 
 oldname, newname = *ARGV
@@ -14,11 +15,15 @@ def change_all_absolute_links(oldname, newname)
   target_files = `grep -rlF '#{oldname.to_page_title}' *`.strip.split(/\n/)
   target_files.each do |file|
     text = File.read(file)
-    regex = /\b#{oldname.to_page_title}\b/
-    matches = text.scan(regex)
-    text.gsub!(regex, newname.to_page_title)
-    File.open(file, 'w') {|f| f.puts text}
-    report file, oldname.to_page_title, newname.to_page_title
+    begin
+      regex = /\b#{oldname.to_page_title}\b/
+      matches = text.scan(regex)
+      text.gsub!(regex, newname.to_page_title)
+      File.open(file, 'w') {|f| f.puts text}
+      report file, oldname.to_page_title, newname.to_page_title
+    rescue
+      puts "Error processing #{file}: #$!"
+    end
   end
 end
 
@@ -27,9 +32,13 @@ def change_unqualified_inbound_links_in_same_namespace(oldname, newname)
   target_files = `grep -rlF '[^.]#{oldname.short_page_title}' #{oldname.namespace}/*`.strip.split(/\n/)
   target_files.each do |file|
     text = File.read(file)
-    text.gsub!(/(\A|\s)#{oldname.short_page_title}\b/, "." + newname)
-    File.open(file, 'w') {|f| f.puts text}
-    report file, oldname.short_page_title, newname
+    begin
+      text.gsub!(/(\A|\s)#{oldname.short_page_title}\b/, "." + newname)
+      File.open(file, 'w') {|f| f.puts text}
+      report file, oldname.short_page_title, newname
+    rescue
+      puts "Error processing #{file}: #$!"
+    end
   end
 end
 
@@ -40,10 +49,14 @@ def absolutize_unqualified_outbound_links(oldname, newname)
   target_file = newname.to_file_path
   if File.exist?(target_file)
     text = File.read(target_file)
-    matches = text.scan(RELATIVE_LINK_REGEX)
-    text.gsub!(RELATIVE_LINK_REGEX, oldname.namespace + '.\1')
-    File.open(target_file, 'w') {|f| f.puts text}
-    MEMO <<  "  - In file #{target_file}: Absolutized these unqualified links: #{matches.inspect}"
+    begin
+      matches = text.scan(RELATIVE_LINK_REGEX)
+      text.gsub!(RELATIVE_LINK_REGEX, oldname.namespace + '.\1')
+      File.open(target_file, 'w') {|f| f.puts text}
+      MEMO <<  "  - In file #{target_file}: Absolutized these unqualified links: #{matches.inspect}"
+    rescue
+      puts "Error processing #{file}: #$!"
+    end
   end
 end
 
@@ -60,9 +73,13 @@ if oldname.namespace == newname.namespace
   target_files = `grep -rlF '#{oldname.short_page_title}' #{oldname.namespace}/*`.strip.split(/\n/)
   target_files.each do |file|
     text = File.read(file)
-    text.gsub!(/(\A\s)(#{oldname.short_page_title})\b/, newname.short_page_title)
-    File.open(file, 'w') {|f| f.puts text}
-    report file, oldname.short_page_title, newname.short_page_title
+    begin
+      text.gsub!(/(\A\s)(#{oldname.short_page_title})\b/, newname.short_page_title)
+      File.open(file, 'w') {|f| f.puts text}
+      report file, oldname.short_page_title, newname.short_page_title
+    rescue
+      puts "Error processing #{file}: #$!"
+    end
   end
 end
 

data/lib/soywiki.rb

@@ -1,7 +1,7 @@
 require 'string_ext'
 
 module Soywiki
-  VERSION = '0.2.9'
+  VERSION = '0.3.0'
   WIKI_WORD = /\b([a-z][\w_]+\.)?[A-Z][a-z]+[A-Z]\w*\b/
   HYPERLINK = %r|\bhttps?://[^ >)\n\]]+|
 

data/lib/soywiki.vim

@@ -236,6 +236,7 @@ func! s:rename_page(page_path_or_title)
     return
   endif
   if s:valid_wiki_word(page_title)
+    write!
     let original_file = bufname('')
     echo system("git mv " . original_file . " " .  newfile)
     exec "!" . s:rename_links_command . original_file . " " . newfile

data/website/soywiki-template.html

@@ -45,6 +45,11 @@
 <span class="st_twitter_large" displayText="Tweet"></span><span class="st_facebook_large" displayText="Facebook"></span><span class="st_ybuzz_large" displayText="Yahoo! Buzz"></span><span class="st_gbuzz_large" displayText="Google Buzz"></span><span class="st_email_large" displayText="Email"></span><span class="st_sharethis_large" displayText="ShareThis"></span>
 
             <iframe src="http://www.facebook.com/plugins/like.php?href=http%3A%2F%2Fdanielchoi.com%2Fsoftware%2Fsoywiki.html&amp;layout=button_count&amp;show_faces=false&amp;width=50&amp;action=like&amp;colorscheme=light" scrolling="no" frameborder="0" allowTransparency="true" style="border:none; overflow:hidden; width:120px; height:25px; margin-top:6px;"></iframe>
+            <br/>
+            <a href="http://twitter.com/share"
+              class="twitter-share-button"
+              data-url="http://danielchoi.com/software/soywiki.html"
+              data-text="SoyWiki" data-count="horizontal">Tweet</a><script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script>
 
             <div class="also-by">
               <h4>also by this developer</h4>

data/website/top.screenshots

@@ -1,5 +1,3 @@
-## Screenshots
-
 <a href="images-soywiki/page-select.png" rel="lightbox[screens]"><img src="images-soywiki/sm-page-select.png" /></a>
 <a href="images-soywiki/search.png" rel="lightbox[screens]"><img src="images-soywiki/sm-search.png" /></a>
 <a href="images-soywiki/expand.png" rel="lightbox[screens]"><img src="images-soywiki/sm-expand.png" /></a>

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 9
-  version: 0.2.9
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Daniel Choi