soywiki 0.2.3 → 0.2.7

data/README.markdown

@@ -43,7 +43,7 @@ SoyWiki is free and open source.
 ## Prerequisites
 
 * a recent version of Vim (SoyWiki is developed against Vim 7.2 and 7.3)
-* a recent version of Ruby (SoyWiki is developed using Ruby 1.9.2)
+* a recent version of Ruby: Ruby 1.9.2 is recommended
 * RubyGems (if Ruby version is older than 1.9)
 * a recent version of [Git][git] (1.7.0.4 or above to be safe)
 
@@ -97,17 +97,19 @@ To use MacVim as your SoyWiki Vim engine, you can run soywiki like this
 or you can `export SOYWIKI_VIM=mvim` in your `~/.bash_profile` and then
 just run `soywiki`.
 
+
 ## Basic usage
 
 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 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 how you create wiki pages and link them together. You'll be
-surprised at how powerful this simple mechanism is for organizing your
-notes. 
+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. Whenever you type a valid WikiLink,
+it 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 how you create wiki pages and
+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
@@ -119,36 +121,41 @@ That's all you need to know to get started.
 
 ## Namespaced WikiWords
 
-You can get very far with SoyWiki using normal CamelCase WikiWords.  
+Every WikiWord in SoyWiki is implicitly or explicitly namespaced.
 
-    NormalWikiWord
+An explicitly namespaced WikiWord looks like this:
 
-But if you want, you can also namespace your WikiWords, like so:
+    recipes.SoyRaspberrySmoothie
 
-    namespace.WikiWord
+The implicitly namespaced form looks just like a conventional WikiWord:
 
-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.
+    SoyRaspberrySmoothie
 
-Namespaced WikiWords help organize your wiki space conceptually. They also
-have two other benefits: 
+A namespace must start with a lower-case letter and consist only of letters,
+numbers, and underscore characters. 
 
-First, wiki pages that represent a namespaced WikiWord are stored under a
-subdirectory named after the namespace. This can help reduce clutter in
-your wiki directory.
+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. 
 
-Every WikiWord namespace lets you use abbreviated links within that
-namespace. For example, if you are editing a page called
-`recipes.SoyMacaroni` and you want to link to another page in the same
-namespace called `recipes.SoyRaspberrySmoothie` you can type the link as
-just `SoyRaspberrySmoothie`. SoyWiki will know that this is a link to
-another page in the same namespace. 
+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
+graph][graph].  SoyWiki namespaces are not supposed to represent hierarchies,
+but domains (e.g., personal, work, project1, project2, etc.).  You can easily
+represent hierarchical relationships _within_ a wiki page. See "Expanding a
+wiki page" below to see how you can use SoyWiki like an outliner program.
 
-When you start SoyWiki for the first time, the active namespace is the
-default namespace `main`. 
+[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.
 
 ## Wiki navigation 
 
@@ -174,7 +181,7 @@ this. You can press `CTRL-^` to toggle between the current page and the
 last page you looked at.
 
 You can view all the pages in your wiki, most recently modified first,
-by press `,m`. This opens both a page list and autocompletion window.
+by pressing `,m`. This opens both a page list and autocompletion window.
 You can use the standard Vim autocompletion commands here to find the
 page you want and call it up.  See Vim's `:help ins-completion-menu` for
 further instructions.
@@ -310,11 +317,13 @@ 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, just follow
-the general instructions [here][git-sync].
+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.
 
 [git-sync]:http://www-cs-students.stanford.edu/~blynn/gitmagic/ch03.html
 
+
 If you want to edit a common SoyWiki with many other people, it's
 probably best to set up a common upstream Git repository and to work
 locally on a development branch before pulling the HEAD of the master
@@ -347,8 +356,8 @@ anything, and it erases the WikiWord that got expanded.
 
 * `,x` expands a wiki page seamfully and opens on a vertical split
 * `,X` expands a wiki page seamlessly and opens on a vertical split
-* `,nx` expands a wiki page seamfully and opens on normal split
-* `,nX` expands a wiki page seamlessly and opens on a normal split
+* `,hx` expands a wiki page seamfully and opens on normal split
+* `,hX` expands a wiki page seamlessly and opens on a normal split
 * `q` closes the expanded view window
 
 Both modes of expansion are useful when you want to assemble a long
@@ -360,8 +369,8 @@ dreams within dreams.
 
 ## Exporting to HTML
 
-Want to share your wiki with non-Vim-users?  Export your wiki into a directory
-of html pages, type `soywiki --html` from the root directory of your wiki.
+Want to share your wiki with non-Vim-users?  You can export your wiki into a directory
+of html pages. Type `soywiki --html` from the root directory of your wiki.
 
 
 ## Extra macros
@@ -386,7 +395,7 @@ Some people don't like the CamelCase (a.k.a. WikiCase) wiki link
 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]. 
+* 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.
@@ -407,9 +416,9 @@ can email me at dhchoi {at} gmail.com.
 
 ## How to support the SoyWiki project
 
-If you find SoyWiki very useful, feel free to drop me a note to say so. If you
-have a bug to report or a good feature to suggest, please file it on the [issue
-tracker][1].  
+SoyWiki is very new, so there are kinks and bugs to iron out and lot of
+desirable features to add.  If you have a bug to report or a good feature to
+suggest, please file it on the [issue tracker][1].  That will help a lot.
 
 [1]:https://github.com/danchoi/soywiki/issues
 

data/Rakefile

@@ -1,5 +1,4 @@
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), 'lib')
-require 'couchrest'
 require 'yaml'
 require 'json'
 require 'rake'

data/lib/soywiki.rb

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

data/lib/soywiki.vim

@@ -292,13 +292,15 @@ endfunc
 func! s:get_page_list()
   " no file current in buffer
   if len(bufname('')) == 0
-    return split(system(s:ls_command), "\n")
+    let pages = split(system(s:ls_command), "\n")
   elseif bufname('') == 'pages-linking-in'
     " this needs refactoring to rely less on state
-    return s:pages_linking_in
+    let pages = s:pages_linking_in
   else
-    return s:omit_this_page(split(system(s:ls_command), "\n"))
+    "let pages = s:omit_this_page(split(system(s:ls_command), "\n"))
+    let pages = split(system(s:ls_command), "\n")
   endif
+  return pages
 endfunction
 
 
@@ -389,12 +391,11 @@ function! CompletePageTitle(findstart, base)
   endif
 endfun
 
-
 function! s:select_page()
   let page = s:trimString( get(split(getline(line('.')), ": "), 1) )
   close
   exe s:return_to_winnr . "wincmd w"
-  if (page == '0' || page == '') " no selection
+  if (page == '') " no selection
     return
   end
   let match = ""
@@ -599,8 +600,8 @@ func! s:prep_buffer()
 
     noremap <buffer> <leader>x :call <SID>expand(0,1)<CR>
     noremap <buffer> <leader>X :call <SID>expand(1,1)<CR>
-    noremap <buffer> <leader>nx :call <SID>expand(0,0)<CR>
-    noremap <buffer> <leader>nX :call <SID>expand(1,0)<CR>
+    noremap <buffer> <leader>hx :call <SID>expand(0,0)<CR>
+    noremap <buffer> <leader>hX :call <SID>expand(1,0)<CR>
 
     noremap <silent> <leader>? :call <SID>show_help()<cr>
 
@@ -615,7 +616,7 @@ endfunc
 
 func! s:highlight_wikiwords()
   if (s:is_wiki_page()) 
-    syntax clear
+"    syntax clear
     exe "syn match Comment /". s:wiki_link_pattern. "/"
     exe "syn match Constant /". s:http_link_pattern . "/"
   endif
@@ -650,3 +651,5 @@ endif
 syntax enable
 let mapleader = ','
 call s:highlight_wikiwords() 
+
+

data/website/gen.rb

@@ -1,14 +1,14 @@
-require 'liquid'
 require 'rdiscount'
+require 'liquid'
 
 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)
+    raise "No README" unless File.size?(readme)
     md = File.read(readme).split(/^\s*$/)
-    headers = md.grep(/## Prerequisites/)
-    insert_at = md.index headers.first
+    insert_before = md.grep(/^A quick overview of/)
+    insert_at = md.index insert_before.first
     md.insert(insert_at, screenshots) 
     md = md.join("\n\n")
     # for some reason markdown inserts extra blank lines

data/website/soywiki-template.html

@@ -36,6 +36,7 @@
               <li><a href="https://rubygems.org/gems/soywiki">rubygems page</a></li>
               <li><a href="https://github.com/danchoi/soywiki/issues">issue tracker</a></li>
               <li><a href="https://github.com/danchoi/soywiki/commits/master">commit history</a></li>
+              <li><a href="http://groups.google.com/group/soywiki-users?msg=new&lnk=gcis">google group</a></li>
               <li><a href="https://github.com/danchoi/soywiki/wiki">wiki</a></li>
             </ul>
 
@@ -43,6 +44,7 @@
 
 <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>
 
             <div class="also-by">
               <h4>also by this developer</h4>

data/website/top.screenshots

@@ -1,7 +1,7 @@
 ## Screenshots
 
-<a href="images-soywiki/1.png" rel="lightbox[screens]"><img src="images-soywiki/1-small.png" /></a>
-<a href="images-soywiki/autocomplete.png" rel="lightbox[screens]"><img src="images-soywiki/autocomplete-small.png" /></a>
-<a href="images-soywiki/attach.png" rel="lightbox[screens]"><img src="images-soywiki/attach-small.png" /></a>
+<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

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 3
-  version: 0.2.3
+  - 7
+  version: 0.2.7
 platform: ruby
 authors: 
 - Daniel Choi
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-13 00:00:00 -05:00
+date: 2011-02-14 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -65,6 +65,15 @@ files:
 - website/.gitignore
 - website/bottom.markdown
 - website/gen.rb
+- website/images-soywiki/expand.png
+- website/images-soywiki/expand.xcf
+- website/images-soywiki/page-select.png
+- website/images-soywiki/page-select.xcf
+- website/images-soywiki/search.png
+- website/images-soywiki/search.xcf
+- website/images-soywiki/sm-expand.png
+- website/images-soywiki/sm-page-select.png
+- website/images-soywiki/sm-search.png
 - website/lightbox2/css/lightbox.css
 - website/lightbox2/images/bullet.gif
 - website/lightbox2/images/close.gif