# Twisted Documentation

Twisted currently needs a lot of documentation. This file is an index of all the things that we hope to have in it eventually.

The current working theme of this document for code examples is a "quote of the day" server. While we have no formal repository for such a server yet, it would be useful to structure your code examples as feature additions to this hypothetical service.

- Introduction
  - Overview
  - Feature Breakdown
    - Overview of Twisted Web
    - Overview of Twisted Spread
    - Overview of Twisted Enterprise
    - Overview of Twisted Internet
    - Tying them all together with Twisted Cred & Coil
    - Discussion of examples in Forum, Words, Mail
    - Twisted Python and other low-level frequently re-used code
- The Basics
  - Getting your Server Set Up
  - Platform support
    - UNIX
    - Windows
- High-Level Twisted
  - Asynchronous Programming
    - Abstract Concepts
    - Working with twisted.internet.defer
    - Examples of Systems Using Deferreds
  - Common Application Elements: Using Twisted Cred
    - Simulation model of services
    - Distinctions between similar concepts e.g. "plugin" and "service", "perspective" and "identity"
  - Web Applications
    - Resources, CGIs, Static Content and Linking in Twisted
    - Dynamic Content with DOMTemplate
    - Web Widgets
      - Gadgets, Widgets, Pages: introducing a common look and feel
      - Database queries with Widgets (maybe more space should be devoted to enterprise?)
    - Authentication on the Web
  - Interactive Applications
    - Connecting an instance direct to the 'net: simple examples with PB
    - Interchanging State: Jumping Into Jelly
    - Interfacing PB with a client-side toolkit
- Low-Level Twisted
  - Using the Reactor
    - TCP
    - UDP
    - SSL
    - Time
  - Protocols
    - Writing a server
    - Writing a client
  - Toolkits: Interfacing Twisted with your toolkit of choice
    - PyGTK
    - Tkinter
    - WxWindows
    - PyUI
    - MFC
  - Transports
    - Wrapping a new kind of select()able resource
    - Wrapping a new kind of crypto algorithm
  - Extending Twisted: keep it simple for the "end programmer"
- Administration and Deployment concerns (Note: Coil isn't actually done yet, but it may be useful to write this section based on what *should* be happening, to get requirements for it...)
  - Configuring a new service using Coil
  - Writing your service to be a Plugin
    - For COIL
    - For TAP
  - Writing your service to be configurable using Coil
  - Creating database interfaces, connecting things to them, etc...

Last modified: Thu Jun 20 05:23:15 CDT 2002

Go Home