nutshell outliner Files

 --------------------------------------------------------------------------
 May 27, 2009                                                  Version 0.14

                 n u t s h e l l   R e a d m e   F i l e

 Copyright(c) 2007-2009, John Forkosh Associates, Inc. All rights reserved.
 --------------------------------------------------------------------------

                            by: John Forkosh
                  john@forkosh.com     www.forkosh.com

          This file is part of nutshell, which is free software.
          You may redistribute and/or modify it under the terms
          of the GNU General Public License, version 3 or later,
          as published by the Free Software Foundation. See
                  http://www.gnu.org/licenses/gpl.html

          nutshell is discussed and illustrated online by
          the nutshell manual at its homepage
                   http://www.forkosh.com/nutshell.html
          Or you can follow the Installation instructions in
          Section II below to immediately install nutshell on
          your own server.


I.   INTRODUCTION
------------------------------------------------------------------------
  Nutshell, licensed under the gpl, is a cgi program
  that's a kind of html outliner.  Web pages that use
  nutshell let readers collapse or expand displayed text
  by clicking menus like "Less ( < | > > > ) More Detail"
  or by clicking more traditional outlines like  "<"
      expanded text displayed when you
      click a nutshell outline anchor
  which are both illustrated on your copy of nutshell.html,
  or online at http://www.forkosh.com/nutshell.html
  Both these pages contain the complete nutshell manual,
  which you should see for additional information.

  Writers of nutshell web pages control the amount of detail
  displayed with special <nutshell> tags like
    <nutshell if="level>3">
       text displayed if your variable level is greater than 3
    <else>
       text displayed otherwise
    </nutshell>
  The "<else> text displayed otherwise" clause is optional.
  And for short snippets of text you can just write
    <nutshell if="level>3" "text if level greater than 3" />
  level is any variable name you choose.  You can have
  as many variables as you like, and nutshell provides
  many arithmetic features to manipulate and test them.

  Corresponding menus are displayed using tags like
    <nutshell menu="level" />
  which lets users decrease or increase your variable
  named level, and then nutshell adjusts the displayed
  text accordingly.

  Nutshell also provides several additional features
  that further improve the usefulness of your pages
    o New text revealed at higher detail levels
      is redlined the first time it appears.
    o Optional index generation helps readers find
      content they're interested in.
    o Nutshell's macro facility lets you easily write
      your own new features, like the dynamic paragraph
      numbering in nutshell.html

  See either your own copy of nutshell.html, or the
  online copy at http://www.forkosh.com/nutshell.html
  for the complete nutshell manual, which contains much
  additional information.


II.  INSTALLATION
------------------------------------------------------------------------
  To compile and install nutshell on your own server...
       +---
       | download nutshell
       +------------------
       * download  http://www.forkosh.com/nutshell.zip
         and  unzip nutshell.zip  in any convenient working
         directory.  Your working directory should now contain
              nutshell.zip   your downloaded gnu zipped nutshell distribution
              README         this file (see nutshell.html for demo/tutorial)
              COPYING        GPL license, under which you may use nutshell
              nutshell.c     nutshell source program and all functions
              nutshell.html  nutshell users manual
       +---
       | Compile and Install nutshell
       +-----------------------------
       * To compile an executable nutshell image
              cc nutshell.c -o nutshell.cgi
         Additional command-line switches that you may find useful
         are discussed at  http://www.forkosh.com/nutshell.html
       * Then,
              mv nutshell.cgi to your server's cgi-bin/ directory,
              chmod its permissions as necessary (typically 755),
         and you're all done.
       +---
       | Test installed image
       +---------------------
       * To quickly test your installed nutshell.cgi,
              mv nutshell.html to your server's htdocs/ directory,
         and then type a url into your browser's locator window
         something like
              http://www.yourdomain.com/cgi-bin/
              nutshell.cgi?../htdocs/nutshell.html
         which should display the same nutshell user's manual
         that you see at
              http://www.forkosh.com/nutshell.html
         If you do see the same nutshell user's manual from
         your own domain link, then you've completed a successful
         nutshell installation.

  Any problems with the above?
        Read the more detailed instructions on nutshell's homepage
              http://www.forkosh.com/nutshell.html


III. REVISION HISTORY
------------------------------------------------------------------------
  See  http://www.forkosh.com/nutshellchangelog.html  for a detailed
  discussion of nutshell revisions.
      o 27 May 2009 -- nutshell version 0.14 released.


IV.  CONCLUDING REMARKS
------------------------------------------------------------------------
  I hope you find nutshell useful.  If so, a contribution to the
  GNU project is suggested, especially if you're a company that's
  currently profitable.
========================= END-OF-FILE README ===========================