soywiki 0.3.1 → 0.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/.gitignore +2 -0
- data/README.markdown +42 -19
- data/lib/soywiki.rb +1 -1
- data/lib/soywiki.vim +5 -0
- metadata +3 -3
data/.gitignore
CHANGED
data/README.markdown
CHANGED
@@ -168,7 +168,9 @@ You can navigate a SoyWiki wiki very quickly with the following
|
|
168
168
|
commands:
|
169
169
|
|
170
170
|
* `CTRL-j` and `CTRL-k` move the cursor directly to the next or previous WikiLink on the page
|
171
|
-
* `ENTER` follows the WikiLink under the cursor
|
171
|
+
* `ENTER` follows the WikiLink under the cursor; if there is nothing
|
172
|
+
under the cursor, `ENTER` is equivalent to `CTRL-w p` and moves the
|
173
|
+
cursor to the last accessed window
|
172
174
|
* `,f` follows the first WikiLink after the cursor
|
173
175
|
* `CTRL-l` opens a WikiLink in a vertical split window; press `CTRL-l` again
|
174
176
|
while the cursor is on the top line to close the new window
|
@@ -231,7 +233,7 @@ in Vim insert mode to invoke it.
|
|
231
233
|
|
232
234
|
## Wiki refactoring
|
233
235
|
|
234
|
-
You can delete the current page with `:SWDelete
|
236
|
+
You can delete the current page with `:SWDelete`.
|
235
237
|
|
236
238
|
`:SWRenameTo [new name]` renames the current page. Make sure the new name
|
237
239
|
is valid CamelCase. You can put a namespace in front of the new name
|
@@ -271,6 +273,9 @@ the target page doesn't exist, it will be created.
|
|
271
273
|
|
272
274
|
You can use these shortcuts:
|
273
275
|
|
276
|
+
* `:SWDelete` → `:SWD`
|
277
|
+
* `:SWRename` → `:SWR`
|
278
|
+
* `:SWCreate` → `:SWC`
|
274
279
|
* `:SWInsert` → `:SWI`
|
275
280
|
* `:SWAppend` → `:SWA`
|
276
281
|
|
@@ -341,6 +346,10 @@ some server for all your computers to push to and pull from.
|
|
341
346
|
|
342
347
|
[git-sync]:http://www-cs-students.stanford.edu/~blynn/gitmagic/ch03.html
|
343
348
|
|
349
|
+
If you want something simpler, you could also try keeping your wiki
|
350
|
+
folder in a [Dropbox][dropbox] folder.
|
351
|
+
|
352
|
+
[dropbox]:http://stevelosh.com/projects/t/#it-does-the-simplest-thing-that-could-possibly-work
|
344
353
|
|
345
354
|
If you want to edit a common SoyWiki with many other people, it's
|
346
355
|
probably best to set up a common upstream Git repository (e.g. on
|
@@ -386,8 +395,24 @@ dreams within dreams.
|
|
386
395
|
|
387
396
|
## Exporting to HTML
|
388
397
|
|
389
|
-
|
390
|
-
|
398
|
+
* `soywiki --html`
|
399
|
+
|
400
|
+
Want to share your wiki with non-Vim-users? You can export your wiki
|
401
|
+
into a directory of HTML pages. Type `soywiki --html` from the root
|
402
|
+
directory of your wiki.
|
403
|
+
|
404
|
+
Aside from WikiWords, SoyWiki uses no markup system whatsoever. You can
|
405
|
+
write your content in whatever markup system you want, or no markup
|
406
|
+
system at all. It's all plain text to SoyWiki. The HTML export feature
|
407
|
+
just wraps your content in <pre> tags after turning your WikiWords
|
408
|
+
into hyperlinks, so no markup system is really necessary.
|
409
|
+
|
410
|
+
In the future, the HTML export feature may let you specify a markup
|
411
|
+
system for rendering your content. Another possible feature is a Sinatra
|
412
|
+
application that translates wiki pages into web pages upon request.
|
413
|
+
|
414
|
+
If you want to contribute such features, please feel free to implement
|
415
|
+
them and submit a pull request.
|
391
416
|
|
392
417
|
|
393
418
|
## Extra macros
|
@@ -411,31 +436,29 @@ Some people don't like the CamelCase (a.k.a. WikiCase) wiki link
|
|
411
436
|
pattern. But SoyWiki embraces it and wants everyone to adopt it, for the
|
412
437
|
following reasons:
|
413
438
|
|
414
|
-
* Besides being the original, CamelCase is the most elegantly minimalist approach to linking wiki pages together -- "with no additional markup whatsoever," [as Ward
|
439
|
+
* 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].
|
415
440
|
* It encourages you more than other wiki link patterns to create wiki pages with succinctly descriptive names that are easy to remember.
|
416
|
-
* Because the link pattern is so minimal and succinct, writing
|
417
|
-
|
418
|
-
*
|
419
|
-
wiki pages in plain text files: the page names can map directly to Unix
|
420
|
-
file names without any awkward character escaping or munging.
|
441
|
+
* Because the link pattern is so minimal and succinct, writing wiki links interrupts your flow of thought less than other wiki link patterns.
|
442
|
+
* CamelCase wiki links are less noisy than other link patterns in raw plain text form. This also contributes to flow.
|
443
|
+
* The CamelCase link pattern 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 or munging.
|
421
444
|
|
422
445
|
[ward]:http://c2.com/cgi/wiki?WikiCase
|
423
446
|
|
447
|
+
## Bug reports and feature requests
|
448
|
+
|
449
|
+
SoyWiki is very new, so there are kinks and bugs to iron out and lot of
|
450
|
+
desirable features to add. If you have a bug to report or a good feature to
|
451
|
+
suggest, please file it on the [issue tracker][1]. That will help a lot.
|
452
|
+
|
453
|
+
[1]:https://github.com/danchoi/soywiki/issues
|
424
454
|
|
455
|
+
You can also join the [Google Group][group] and comment there.
|
425
456
|
|
426
|
-
[
|
457
|
+
[group]:http://groups.google.com/group/soywiki-users?msg=new&lnk=gcis
|
427
458
|
|
428
459
|
## How to contact the developer
|
429
460
|
|
430
461
|
My name is Daniel Choi. I am based in Cambridge, Massachusetts, USA, and you
|
431
462
|
can email me at dhchoi {at} gmail.com.
|
432
463
|
|
433
|
-
## How to support the SoyWiki project
|
434
|
-
|
435
|
-
SoyWiki is very new, so there are kinks and bugs to iron out and lot of
|
436
|
-
desirable features to add. If you have a bug to report or a good feature to
|
437
|
-
suggest, please file it on the [issue tracker][1]. That will help a lot.
|
438
|
-
|
439
|
-
[1]:https://github.com/danchoi/soywiki/issues
|
440
|
-
|
441
464
|
|
data/lib/soywiki.rb
CHANGED
data/lib/soywiki.vim
CHANGED
@@ -127,6 +127,11 @@ func! s:find_next_wiki_link(backward)
|
|
127
127
|
endfunc
|
128
128
|
|
129
129
|
func! s:follow_link_under_cursor(split)
|
130
|
+
if expand("<cWORD>>") == ''
|
131
|
+
" just switch windows
|
132
|
+
wincmd p
|
133
|
+
return
|
134
|
+
endif
|
130
135
|
if match(expand("<cWORD>>"), s:http_link_pattern) != -1
|
131
136
|
call s:open_href_under_cursor()
|
132
137
|
return
|
metadata
CHANGED
@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
|
|
5
5
|
segments:
|
6
6
|
- 0
|
7
7
|
- 3
|
8
|
-
-
|
9
|
-
version: 0.3.
|
8
|
+
- 2
|
9
|
+
version: 0.3.2
|
10
10
|
platform: ruby
|
11
11
|
authors:
|
12
12
|
- Daniel Choi
|
@@ -14,7 +14,7 @@ autorequire:
|
|
14
14
|
bindir: bin
|
15
15
|
cert_chain: []
|
16
16
|
|
17
|
-
date: 2011-02-
|
17
|
+
date: 2011-02-15 00:00:00 -05:00
|
18
18
|
default_executable:
|
19
19
|
dependencies:
|
20
20
|
- !ruby/object:Gem::Dependency
|