NewtWiki version 0.2.2 Copyright ©2002, J.B. Hemlock All rights reversed. ============================================================ CONTENTS 1. NewtWiki? 2. Files Included 3. Installation 4. Using NewtWiki 5. Special hyperlinks 6. Bugs 7. Source Code Notes 8. Copyleft Information ============================================================ 1. NewtWiki? NewtWiki is a single-user Wiki for Newtons running NOS 2.0 and greater. A Wiki is a type of communal web site that allows any user to edit any page. The page markup typically uses no HTML, with hyperlinks created by SmashingWordsTogether LikeThis. In a traditional Wiki any words SmashedTogether make a hyperlink, even to a page that doesn't yet exist. The Wikis simple hyperlink scheme makes it trivial to sprinkle hyperlinks in a page. NewtWiki adds Wiki-style hyperlinking to Notes. In NewtWiki any single word can be a hyperlink to an existing note, or used to create a new linked note. I've tested this software on both an UMP2000 and an eMate. It should run on any NOS 2.0 Newton as well. ============================================================ 2. Files Included ReadMe.txt This file. license.txt A copy of the GNU general license. See copyleft information below. NewtWiki.pkg The NewtWiki package source The directory containing the NTK source for building NewtWiki. ============================================================ 3. Installation Install NewtWiki.pkg with your Newton package installer. The package will install new code into Notes, plus a small "bookmark" application. You might want to take a minute to create templates for your new notes (see below). ============================================================ 4. Using NewtWiki NewtWiki is designed to be almost transparent to the user. Any word in a note has the potential to be a hyperlink linking to a note with the same title (i.e.: the word NewtWiki links to a note with the title NewtWiki) _in the same folder_. Hyperlinks in NewtWiki cannot cross folder boundaries. This allows you to have multiple sets of linked notes where the sets do not interlink with each other. I use this, for instance, to keep all my work-related notes apart from my personal notes. To follow a link, draw a line to the right from the word. Make it a longish line to avoid confusion with the dash or underline character. If a note with the same title exists in the same folder, NewtWiki will navigate to it. If there isn't a note with that title, NewtWiki will pop up a popup allowing you to select what kind of stationary you want to use for the new note. Out of the box, NewtWiki knows how to create plain Note stationary. For other kinds of stationary (i.e.: Outline), you need to create a template. A Template is a note with the title NewtWikiTemplate. When NewtWiki creates a new note, it will look for a note called NewtWikiStationary with the same stationary type as the user selected for the new note. It will duplicate this note to be the new note. For instance, if you gesture from the word Newton and choose to create a new recording, NewtWiki will look for a recording called NewtWikiTemplate and duplicate that to be the new note. Since it duplicates the template notes, you can write anything you want to appear in your new notes into the stationary. NewtWiki maintains a list of notes you've visited by gesturing. You can follow this list back by drawing a line to the left. NewtWiki does a little bit of stemming and title munging when it looks for a note to link to. If a word is plural, it will look for the singular form of the word if it can't find a note with the plural title (i.e.: if it can't find the note NewtonLinks it will look for the note NewtonLink). It also only considers the first word of the title (i.e.: it will link from the word Newton to a note with the title "Newton -- some easter eggs"). NewtWiki also includes a small application which is a little like a simple version of Notes. This makes a nice little bookmark application. Links from this app to Notes work just like inter-note links, except they ignore folder boundaries. ============================================================ 5. Special hyperlinks NewtWiki supports sending URLs to NewtsCape. If you gesture from a URL, and you have NewtsCape installed, NewtWiki will fire up NewtsCape to follow the link. NewtWiki also supports a couple of special links to control internal routines. The word Backlight will toggle the backlight, if your Newt has one. The word NewtWikiOrphanedList will generate a note with a list of all the notes whose titles aren't referenced in a link. This can be useful if you really get into having all your notes linked. It takes a while to run, though (about 2 minutes on my UMP2000 with ~400 notes). ============================================================ 6. Bugs Why none, of course! Seriously, though, please send any bug reports to me at blag@narcosislabs.org. ============================================================ 7. Source notes I've included the Windows NTK source code for NewtWiki. All the source code lives in the source directory in this distribution. I haven't tried compiling this project with Mac NTK, so I'm not sure what would be involved. I think the bitmaps would have to be converted, at least. Feel free to modify this source and release it. Please see the enclosed GNU general license for terms. ============================================================ 8. Copyleft information Copyright ©2002, J.B. Hemlock All rights reversed. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program (see LICENSE.TXT); if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.