README-PIMKI in Pimki-1.7.092 vs README-PIMKI in Pimki-1.8.092
- old
+ new
@@ -1,178 +1,182 @@
-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]].
-* c2 Wiki links, via [c2[PageName]]. If you run multiple webs within Pimki, you
- can now link between them using [web_address[PageName]].
-* 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.
-* Lots of web customization and administration options through the edit_web template.
-* 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
-* Added Glossary function: shows all acronyms defined in the web
-* Expanded Search:
- * Search also tries to match the page names (not just contents).
- * Now showing part of sentance around match in search-results page
-* Advanced Search
- * Case sensitivity
- * Search as regex, phrase or words
- * Search pages and bliki entries
- * Search in page names / contents
- * Limit search to selected categories
- * Limit search to selected authors
-* Removed unnecessary (for me) stuff from the nav-bar: RSS, authors, export.
- Moved to bottom of Home Page.
-* Minor stylesheet tweaks.
-
-
-Command-line options:
-Run "ruby pimki.rb --help"
-
-History:
-
-1.7.092 New features
- - Better control on multiple webs, including web administration and links between webs via [web_address[PageName]]
- - Added Glossary function: shows all acronyms defined in the web
- - Better export in anticipation of Pimki2
- - Moved things back to the nav-bar
- - Even more and better things at the web setup (edit_web) template
- - Lots of bug fixes
-
-1.6.092 Mainly bug fixes with some minor enhancements
- - Squashed horrible restart bug
- - Several bug fixes
- - Upgraded to RedCloth 3.0.3, which seems stable enough
- - RSS includes Bliki
- - Added capacity to stop server through the edit_web template
- - Added an error reporting template
- - Can now display just the Mind Map image for printing
- - Minor improvements to the publish interface, e.g. displaying menu
-
-1.5.092 Bug fixes & new features release
- - Several bug fixes
- - RedCloth is now defaulting to 2.0.11. Controllable thru commandline.
- - Advanced Search
- - c2 wiki links via [c2[PageName]]
- - FavIcon (working in Firefox)
- - Madeleine Snapshot Controls (thru edit_web)
-
-1.4.092 New features release
- - Added a major/minor edit override for the default 'continous edit' when
- revising a page.
- - MarkDown can now be through RedCloth 3.0.0 (experimental) or BlueCloth.
- - Integrated Instiki release 0.9.2 features and bug fixes.
- - Todo@Context
- - Edit page on double click (based on Mark Reid's patch to Instiki)
- - Possibility to require edit password for each edit
- - Persist user changes to free-wiki menu content
- - Numerous bug fixes.
-
-1.3.092 New features and bug fixes release
- - Updated to RedCloth v3.0.0.
- - Fixed problem with incorrect handling of some complex link formats and
- <pre> tags. (Justin)
- - Expanded search to look also in Bliki entries.
- - Can now show diff between Bliki entry versions.
- - Editing left-side menu is now password protected.
- - Added capacity in Mind Map to filter displayed pages by category and/or
- filter leaf nodes (i.e. pages that do not have links to other pages). This
- cuts down on the anount of visual information to give a bit more topical
- view of the web.
- - Added custom symbols/elements: <:cbx> and <:cbxc> to display a checkbox
- (and a checked checkbox).
- - Added customization options through "Edit Web":
- - Added capacity to set the prefered size of the Mind Map image.
- - Customizable mapping of symbols/elements (in progress).
- - Added capacity for custom link formats (in progress).
-
-1.2.092 Bug-fix and minor enhancements release
- - Fixed problem with free-content of menu. (Mark S)
- - Fixed problem in persisting menu-type changes.
- - Fixed broken images in Mind Map under Firefox 1.0
-
-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
-
+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]].
+* c2 Wiki links, via [c2[PageName]]. If you run multiple webs within Pimki, you
+ can now link between them using [web_address[PageName]].
+* 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.
+* Lots of web customization and administration options through the edit_web template.
+* 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
+* Added Glossary function: shows all acronyms defined in the web
+* Expanded Search:
+ * Search also tries to match the page names (not just contents).
+ * Now showing part of sentance around match in search-results page
+* Advanced Search
+ * Case sensitivity
+ * Search as regex, phrase or words
+ * Search pages and bliki entries
+ * Search in page names / contents
+ * Limit search to selected categories
+ * Limit search to selected authors
+* Removed unnecessary (for me) stuff from the nav-bar: RSS, authors, export.
+ Moved to bottom of Home Page.
+* Minor stylesheet tweaks.
+
+
+Command-line options:
+Run "ruby pimki.rb --help"
+
+History:
+
+1.8.092 Bug Fixes & New features
+ - Many small & not-so-small bug fixes
+ - Still based on Instiki 0.9.2 for storage compatibility
+
+1.7.092 Bug Fixes & New features
+ - Better control on multiple webs, including web administration and links between webs via [web_address[PageName]]
+ - Added Glossary function: shows all acronyms defined in the web
+ - Better export in anticipation of Pimki2
+ - Moved things back to the nav-bar
+ - Even more and better things at the web setup (edit_web) template
+ - Lots of bug fixes
+
+1.6.092 Mainly bug fixes with some minor enhancements
+ - Squashed horrible restart bug
+ - Several bug fixes
+ - Upgraded to RedCloth 3.0.3, which seems stable enough
+ - RSS includes Bliki
+ - Added capacity to stop server through the edit_web template
+ - Added an error reporting template
+ - Can now display just the Mind Map image for printing
+ - Minor improvements to the publish interface, e.g. displaying menu
+
+1.5.092 Bug fixes & new features release
+ - Several bug fixes
+ - RedCloth is now defaulting to 2.0.11. Controllable thru commandline.
+ - Advanced Search
+ - c2 wiki links via [c2[PageName]]
+ - FavIcon (working in Firefox)
+ - Madeleine Snapshot Controls (thru edit_web)
+
+1.4.092 New features release
+ - Added a major/minor edit override for the default 'continous edit' when
+ revising a page.
+ - MarkDown can now be through RedCloth 3.0.0 (experimental) or BlueCloth.
+ - Integrated Instiki release 0.9.2 features and bug fixes.
+ - Todo@Context
+ - Edit page on double click (based on Mark Reid's patch to Instiki)
+ - Possibility to require edit password for each edit
+ - Persist user changes to free-wiki menu content
+ - Numerous bug fixes.
+
+1.3.092 New features and bug fixes release
+ - Updated to RedCloth v3.0.0.
+ - Fixed problem with incorrect handling of some complex link formats and
+ <pre> tags. (Justin)
+ - Expanded search to look also in Bliki entries.
+ - Can now show diff between Bliki entry versions.
+ - Editing left-side menu is now password protected.
+ - Added capacity in Mind Map to filter displayed pages by category and/or
+ filter leaf nodes (i.e. pages that do not have links to other pages). This
+ cuts down on the anount of visual information to give a bit more topical
+ view of the web.
+ - Added custom symbols/elements: <:cbx> and <:cbxc> to display a checkbox
+ (and a checked checkbox).
+ - Added customization options through "Edit Web":
+ - Added capacity to set the prefered size of the Mind Map image.
+ - Customizable mapping of symbols/elements (in progress).
+ - Added capacity for custom link formats (in progress).
+
+1.2.092 Bug-fix and minor enhancements release
+ - Fixed problem with free-content of menu. (Mark S)
+ - Fixed problem in persisting menu-type changes.
+ - Fixed broken images in Mind Map under Firefox 1.0
+
+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
+