What is Pimki?
================

Pimki is a Personal Information Manager based on Instiki's Wiki technology.

It has some added features over Instiki, while keeping (most of) the simplicity 
of Instiki. Add added complication is installing GraphViz on the path. GraphViz
is available from: http://www.research.att.com/sw/tools/graphviz.

Instiki Features:
* Regular expression search: Find deep stuff really fast
* Revisions: Follow the changes on every page from birth. Rollback to an earlier rev
* Export to HTML or markup in a zip: Take the entire wiki with you home or for reference
* RSS feeds to track recently revised pages
* Multiple webs: Create separate wikis with their own namespace
* Password-protected webs: Keep it private
* Authors: Each revision is associated with an author, so you can see who changed what
* Reference tracker: Which other pages are pointing to the current?
* Speed: Using Madelein for persistence (all pages are in memory)
* Three markup choices: Textile (default / RedCloth), Markdown (BlueCloth), and RDoc
* Embedded webserver: Through WEBrick
* Internationalization: Wiki words in any latin, greek, cyrillian, or armenian characters
* Color diffs: Track changes through revisions

Pimki added features:
* Mind Map: a graph of wiki connections (made with GraphViz). All graphs can be 
  laid-out with the 4 GraphViz engines. Graph contents can be arranged as:
   * Page -> linked pages
   * Authors -> pages
   * Categories -> pages
* Bliki: a blog integrated with the wiki. Blog entries are simply wiki-pages in
  a special space. Can link from an entry to wiki pages via PageName or [[page name]]
  and from pages to Bliki entries via [bliki[page name]].
* Todo Items & List:
   * 'todo:' items are highlighted on each page.
   * Added a capacity to pull and list todo items from all pages.
   * On main list, items are highlighted according to date (if there is one).
* Added capacity to (persistently :) delete/rename pages through the 'All Pages'
  list.
* Added left-side menu. Content options are:
   * Only pages that reference other pages (default)
   * Only pages that belong to a specific category
   * All pages: by name
   * All pages: recently revised
   * All pages: recently visited
   * All pages: most often visited
   * User definable wiki-text
* Expanded Search:
   * Search also tries to match the page names (not just contents).
   * Now showing part of sentance around match in search-results page
* Removed unnecessary (for me) stuff from the nav-bar: RSS, authors, export. 
  Moved to bottom of Home Page.
* Minor stylesheet tweaks.

Missing:

* Expand todo with more task types?
* Expand Search
   * Highlight match on individual page when clicked form search results
   * Advanced Search (not just regexp, case sensitivity)?
* Editable left-side menu options: by search results? by author?
* Bliki entries revision diff.


Command-line options:
Run "ruby pimki.rb --help"

History:

1.1.092 Bug-fix and minor enhancements release
    - Changed storage path to be relative to CWD to avoid storing under gem
      version directory. When running/installing service should normally
      provide the --storage command-line parameter. (Chad)
    - Fixed a problem with the bliki_new form that prevented saving the entry
      due to debug code in the JS validation code of the entry name. (PragDave)
    - Fixed problem with export and storage path relating to app-dir instead
      of storage dir in Instiki core. (Prag Dave)
    - Fixed problem of missing files in in tgz packaging (rake needs 
      PackagingTask defined _before_ GemPackageTask). (Ruben)
    - Fixed require 'YAML' to correct 'yaml' in Instiki core. (Chad)
    - Added capability to link from pages to Bliki entries. To use link via:
      [bliki[entry name]]
    - ToDo list picks up items from bliki entries and links to the entry (Ruben)
    - Menu can be set as all pages belonging to a specific category. If you set
      some page to a category e.g. 'menu', only those pages will appear on the
      left-side menu.

1.0.092 Updated Initial Release
    - Finalized Numbering scheme.
    - Made available as a gem.

0.9.2-7 Initial Public Release
    I have been working on Pimki for my own use for quite some time. It is
    fairly mature and stable. The version number reflects the base Instiki
    version (0.9.2; or actually the latest CVS that's markes so) and the
    running number of my feature-addition releases.


Download latest from: 
http://rubyforge.org/project/showfiles.php?group_id=447

Or go the Gem way and install through:
gem install pimki

Visit the official Pimki home page at:
http://pimki.rubyforge.org/

Visit the official Instiki wiki:
http://www.instiki.org/

License is the same as Ruby's.

--
Assaph Mehr
assaph@gmail.com