durusmail: quixote-users: Quixote documentation
Quixote documentation
2001-03-21
Quixote documentation
Greg Ward
2001-03-21
Hi all --

I don't seem to have anything pressing at the moment, so I thought I'd sit
down and write some proper documentation for Quixote.  My thinking right now
is to create a "doc/" subdirectory and add two files (for now):

  install.txt
    everything you need to know to run a Quixote application (eg. the
    demo, a 3rd party app, or something you plan to write yourself):
      - installing Quixote
      - configuring Quixote apps
      - accessing the Quixote demo
      - configuring the web server for optimal use

  usage.txt
    everything you need to know to write Quixote applications yourself:
      - basic prinicples
      - the publishing loop: how to get your Python functions and
        objects on the web (or, how the Python namespace maps to
        the URL namespace)
      - PTL: a convenient syntax for generating text in Python
      - session management
      - writing the (Fast)CGI script and your app's config file

The README would then devolve to a simple "see doc/install.txt" instruction.

Does this seem like a reasonable organization?  Am I missing any obvious
major topics?

        Greg


reply