|
| 1 | +$Revision$ |
| 2 | +$LastChangedDate$ |
| 3 | + |
| 4 | + |
| 5 | +Plain Text Wiki |
| 6 | +=============== |
| 7 | + |
| 8 | +Plain Text Wiki is a TextMate bundle which allows you to use a directory of |
| 9 | +text files as a simple wiki. |
| 10 | + |
| 11 | +The bundle is by Matt Webb <http://interconnected.org/home>. |
| 12 | + |
| 13 | + |
| 14 | +Installation |
| 15 | +------------ |
| 16 | + |
| 17 | +Download and unzip Plain-Text-Wiki.zip. Double-click on the bundle to install |
| 18 | +(the bundle requires TextMate: <http://macromates.com>). |
| 19 | + |
| 20 | + |
| 21 | +Usage |
| 22 | +----- |
| 23 | + |
| 24 | +* Create a new directory |
| 25 | +* In TextMate, choose 'Create New Wiki' from the menu |
| 26 | + Bundles > Plain Text Wiki |
| 27 | +* Select your new directory. A file 'IndexPage.txt' will be created and opened |
| 28 | +* Reference new pages using CamelCase or [[like this]]. Page names will appear |
| 29 | + underlined |
| 30 | +* To follow a link, put the text cursor over a page name and hit Enter (not |
| 31 | + Return) |
| 32 | + |
| 33 | +Return to the index page at any time: Type shift+ctrl+i |
| 34 | + |
| 35 | +Plain Text Wiki understands Markdown: |
| 36 | +http://daringfireball.net/projects/markdown/syntax |
| 37 | + |
| 38 | +If the wiki is written in Markdown, choose 'Export Wiki as HTML' from the |
| 39 | +Plain Text Wiki commands menu. You will be prompted for a directory where the |
| 40 | +Web pages will be saved (please make sure it's empty). |
| 41 | + |
| 42 | + |
| 43 | +Bugs and issues |
| 44 | +--------------- |
| 45 | + |
| 46 | +Please let me know about any bugs. Patches are welcome! |
| 47 | + |
| 48 | +Advice welcome on: |
| 49 | + |
| 50 | +* How to include the text.html.markdown language grammar while still keeping |
| 51 | + the underlined wiki page names |
| 52 | +* How to make sure the shell and URI escaping really, *really* works |
| 53 | +* Better Ruby idiom (I'm new to the language) |
| 54 | +* Better TextMate bundle behaviour (ditto) |
| 55 | + |
| 56 | + |
| 57 | +Miscellaneous |
| 58 | +------------- |
| 59 | + |
| 60 | +More background to Plain Text Wiki: |
| 61 | +http://interconnected.org/home/2007/05/20/plain_text_wiki |
| 62 | + |
0 commit comments