====== keheiwiki:intro ======

===== Client Base =====

Here is who has used it:
  * Banks and Investment Management companies
  * Publishing houses (feed creators, trade magazines)
  * Defence and Aerospace contractors
  * Retail Store chains
  * Housing/Realty groups
  * Customer Support Organizations
  * Internal Support Organizations
  * Special Interest Groups (clubs)

And why:
  * "because it worked well inside our firewall yet still allowed us to delegate who can edit what.."
  * "we could track things specific to our customers and document tips easily for the support team [to deploy]"
  * "because our authors don't like or know HTML. No markup, they just want to write"
  * "saved us from getting embroiled in a whole database app or CRM solution"
  * "instead of an email flurry or blog you had to slog through... we got more and more quality to each refined page"
  

===== Features =====

=== Markup ===
  * no markup required, uses a WYSIWYG editor, however, markup available as below
  * section headings 
  * '''bold''', ''italic'', or both
  * links
    * internal: both Camel``Case and free links
    * external: full URLs, https: news: mailto: and ftp: 
  * horizontal rules
  * preformatted text
   * plain
  * lists
   * bullet
   * numbered (automatically in decimal)
  * category can constrain pages to use markup or WYSIWYG

=== Wiki base features ===
  * backups all page revisions 
   * Revision history depth is configurable
  * Recent  changes by category or per page
   * links to page info and the user home page of the editor[s]
  * '''subpages'''  /category/topic/subtopic/sub-sub-topic
  * author attribution (has authors, editors, readers)
  * optional per category templates
  * separate namespace per category
  * resolution of name space can traverse a specifiable path of categories
  * categories can automatically assign who may edit
  * admin may assign who can create categories
  * multiple admins each with separate password
  * apprenticeship model and full support for skills within category (ACLs) 
  * editors can add other editors to a page by name or skill
  * ghostwriter support
  * wiki page '''templates'''
  * read-only templates
  * configurable editor skills
  * simple page storage (simply stores exactly what you see in the editor into a directory in a file that is named like the page)
  * sub pages stay in same directory assigned to page storage
  * renaming of pages

=== Navigation ===
  * indexing schemes
   * Categories
   * Glossary
   * Automaic alphabetic topics list  if no category "home" page
   * Regex constrained topic list
  * A termpath variable, optionally per page, permits Wiki``Words to live in arbitrary categories or glossary
  * '''enhanced search function:''' title or full text search
  * '''search results may be included into wiki pages''' via tags
  * Page name visible in URL of page for readable book marks

=== Advanced Features ===
  * GUI (WYSIWYG including tables and images) and/or text (markup) editor  
  * '''email notification''', of page change edits with diff of text optionally included 
  * any page can become a blog page
  * self appending pages (often used for signup lists)
  * search results (and search terms) savable as wiki pages
  * '''underlay directory''' for storing read-only pages or global locking of pages
  * '''access control lists''' via skills controls
  * public pages mirror changes to private area instantly
  * optional login with username and password
  * can reuse authentication done by web server
  * page content can depend on who (configurable user type) is looking
  * page layout can depend on server name or who is looking
  * private messaging for next time a user views any page (not a popup)
  * all error messages use HTML templates which can switch on domain name
  * voting and scoring capabilities


 
=== Extensibility ===
  *  easily extensible, without changing Perl base executable
  *  written in Perl, allows for custom tags in plugins directory
 
== Plugins: ==

  * actions for top level control
  * macros for embedding results into wikipages
  * separate plugin for archiving content to database or RCS 

=== Environment ===
  * Written in Perl:
   * Linux/UNIX
  * simple to install
   * installer prompts for admin password, does the rest itself
   * installer fetches current modules from sourceforge
  * runs with:
   * standard CGI /cgi-bin/
   * per-directory cgi .../filename.cgi
   * or scriptaliased cgi dir