The Zope Book

Attention

This document was written for Zope 2.

Welcome to The Zope Book. This book is designed to introduce you to Zope, an open-source web application server.

• 1. Preface
  • 1.1. Preface to the 2.12 edition
  • 1.2. How the Book Is Organized
• 2. Introducing Zope
  • 2.1. The Static Web Site Dilemma
  • 2.2. What Is A Web Application?
  • 2.3. How You Can Benefit From Using An Application Server
  • 2.4. Why Use Zope Instead of Another Application Server
  • 2.5. Zope Audiences and What Zope Isn’t
  • 2.6. Introduction to Zope Maintenance and The Zope Community
  • 2.7. Zope’s Terms of Use and License
  • 2.8. Zope History
• 3. Zope Concepts and Architecture
  • 3.1. Fundamental Zope Concepts
  • 3.2. Fundamental Zope Components
• 4. Installing and Starting Zope
  • 4.1. Downloading Zope
  • 4.2. Installing Zope
  • 4.3. Starting Zope
  • 4.4. Using Zope With a Web Server
  • 4.5. Starting Zope on Windows
  • 4.6. Starting Zope on UNIX
  • 4.7. Your Zope Installation
  • 4.8. Logging In
  • 4.9. Controlling the Zope Process with the Control Panel
  • 4.10. Controlling the Zope Process from the Command Line
  • 4.11. Customizing your Zope instance
  • 4.12. Troubleshooting and Caveats
• 5. Object Orientation
  • 5.1. Objects
  • 5.2. Attributes
  • 5.3. Methods
  • 5.4. Messages
  • 5.5. Classes and Instances
  • 5.6. Inheritance
  • 5.7. Object Lifetimes
  • 5.8. Summary
• 6. Using the Zope Management Interface
  • 6.1. Introduction
  • 6.2. How the Zope Management Interface Relates to Objects
  • 6.3. ZMI Frames
  • 6.4. Creating Objects
  • 6.5. Moving and Renaming Objects
  • 6.6. Transactions and Undoing Mistakes
  • 6.7. Undo Details and Gotchas
  • 6.8. Reviewing Change History
  • 6.9. Using Object Properties
  • 6.10. Logging Out
• 7. Using Basic Zope Objects
  • 7.1. Basic Zope Objects
  • 7.2. Content Objects: Folders, Files, and Images
  • 7.3. Presentation Objects: Zope Page Templates
  • 7.4. Logic Objects: Script (Python) Objects and External Methods
  • 7.5. Creating a Basic Zope Application Using Page Templates and Scripts
• 8. Acquisition
  • 8.1. Acquisition vs. Inheritance
  • 8.2. Acquisition Is about Containment
  • 8.3. Say What?
  • 8.4. Providing Services
  • 8.5. Getting Deeper with Multiple Levels
  • 8.6. Summary
• 9. Basic Zope Scripting
  • 9.1. Calling Methods From the Web
  • 9.2. Using Python-based Scripts
  • 9.3. Calling ZPT from Scripts
  • 9.4. Returning Values from Scripts
  • 9.5. The Zope API
• 10. Using Zope Page Templates
  • 10.1. HTML Page Templates
  • 10.2. XML Page Templates
  • 10.3. Macros
  • 10.4. Using Templates with Content
• 11. Creating Basic Zope Applications
  • 11.1. Goals for the Zope Zoo Web Site
  • 11.2. Beginning with a Folder
  • 11.3. Designing a Navigable Zoo
  • 11.4. Modifying a Subsection of the Site
  • 11.5. Creating a File Library
  • 11.6. Building “Instance-Space” Applications
  • 11.7. Instance-Space Applications vs. Python packages
  • 11.8. The Next Step
• 12. Users and Security
  • 12.1. Introduction to Zope Security
  • 12.2. Review: Logging In and Logging Out of the Zope Management Interface
  • 12.3. Zope’s “Stock” Security Setup
  • 12.4. Identification and Authentication
  • 12.5. Authorization, Roles, and Permissions
  • 12.6. Managing Users
  • 12.7. Protecting Against Password Snooping
  • 12.8. Managing Custom Security Policies
  • 12.9. Security Usage Patterns
  • 12.10. Different Levels of Access with Roles
  • 12.11. Performing Security Checks
  • 12.12. Advanced Security Issues: Ownership and Executable Content
  • 12.13. Summary
• 13. Advanced Page Templates
  • 13.1. Advanced TAL
  • 13.2. Expressions
  • 13.3. Caching Templates
  • 13.4. Page Template Utilities
  • 13.5. Conclusion
• 14. Advanced Zope Scripting
  • 14.1. Warning
  • 14.2. Calling Scripts
  • 14.3. Using External Methods
  • 14.4. Advanced Acquisition
  • 14.5. Passing Parameters to Scripts
  • 14.6. Script Security
  • 14.7. Python versus Page Templates
  • 14.8. Remote Scripting and Network Services
  • 14.9. Conclusion
• 15. Zope Services
  • 15.1. Access Rule Services
  • 15.2. Temporary Storage Services
  • 15.3. Caching Services
  • 15.4. Outbound Mail Services
  • 15.5. Error Logging Services
  • 15.6. Virtual Hosting Services
  • 15.7. Searching and Indexing Services
  • 15.8. Sessioning Services
• 16. Basic DTML
  • 16.1. How DTML Relates to Similar Languages and Templating Facilities
  • 16.2. When To Use DTML
  • 16.3. When Not To Use DTML
  • 16.4. The Difference Between DTML Documents and DTML Methods
  • 16.5. Details
  • 16.6. DTML Tag Syntax
  • 16.7. DTML Tag Names, Targets, and Attributes
  • 16.8. Creating a “Sandbox” for the Examples in This Chapter
  • 16.9. Examples of Using DTML for Common Tasks
  • 16.10. Common DTML Tags
  • 16.11. Summary
• 17. Advanced DTML
  • 17.1. How Variables are Looked up
  • 17.2. DTML Namespaces
  • 17.3. Rendering Variables
  • 17.4. Modifying the DTML Namespace
  • 17.5. DTML Namespace Utility Functions
  • 17.6. DTML Security
  • 17.7. Safe Scripting Limits
  • 17.8. Advanced DTML Tags
  • 17.9. The Call Tag
  • 17.10. The Comment Tag
  • 17.11. The Tree Tag
  • 17.12. The Return Tag
  • 17.13. The Sendmail Tag
  • 17.14. The Mime Tag
  • 17.15. The Unless Tag
  • 17.16. Batch Processing With The In Tag
  • 17.17. Other useful examples
  • 17.18. Conclusion
• 18. Searching and Categorizing Content
  • 18.1. Getting started with Mass Cataloging
  • 18.2. Creating a ZCatalog
  • 18.3. Configuring ZCatalogs
  • 18.4. Searching ZCatalogs
  • 18.5. Searching and Indexing Details
  • 18.6. Advanced Searching with Records
  • 18.7. Automatic Cataloging
  • 18.8. Advanced Catalog Topics
  • 18.9. Conclusion
• 19. Relational Database Connectivity
  • 19.1. Common Relational Databases
  • 19.2. Database Adapters
  • 19.3. Setting up a Database Connection
  • 19.4. Z SQL Methods
  • 19.5. Examples of ZSQL Methods
  • 19.6. Displaying Results from Z SQL Methods
  • 19.7. Providing Arguments to Z SQL Methods
  • 19.8. Dynamic SQL Queries
  • 19.9. Advanced Techniques
  • 19.10. Further help
  • 19.11. Summary
• 20. Virtual Hosting Services
  • 20.1. Virtual Host Monster
  • 20.2. Arranging for Incoming URLs to be Rewritten
  • 20.3. Virtual Hosting Considerations for Content classes
  • 20.4. “Inside-Out” Virtual Hosting
• 21. Session Management
  • 21.1. Terminology
  • 21.2. Session Managers
  • 21.3. Session Manager Components
  • 21.4. Using Session Data
  • 21.5. Default Configuration
  • 21.6. Advanced Development Using Sessioning
  • 21.7. Configuration and Operation
  • 21.8. Concepts and Caveats
  • 21.9. Alternative Server Side Session Backends for Zope 4 and higher
• 22. Scalability and ZEO
  • 22.1. What is ZEO?
  • 22.2. When you should use ZEO
  • 22.3. Installing and Running ZEO
  • 22.4. How to Distribute Load
  • 22.5. Ongoing Maintenance
  • 22.6. ZEO Caveats
  • 22.7. Conclusion
• 23. Managing Zope Objects Using External Tools
  • 23.1. General Caveats
  • 23.2. WebDAV
  • 23.3. Other Integration Facilities
• 24. Maintaining Zope
  • 24.1. Starting Zope Automatically at Boot Time
  • 24.2. Installing New Products
  • 24.3. Server Settings
  • 24.4. Monitoring
  • 24.5. Log Files
  • 24.6. Packing and Backing Up the FileStorage Database
  • 24.7. Database Recovery Tools
• 25. Appendix A: DTML Reference
  • 25.1. call: Call a method
  • 25.2. comment: Comments DTML
  • 25.3. functions: DTML Functions
  • 25.4. if: Tests Conditions
  • 25.5. in: Loops over sequences
  • 25.6. let: Defines DTML variables
  • 25.7. mime: Formats data with MIME
  • 25.8. raise: Raises an exception
  • 25.9. return: Returns data
  • 25.10. sendmail: Sends email with SMTP
  • 25.11. sqlgroup: Formats complex SQL expressions
  • 25.12. sqltest: Formats SQL condition tests
  • 25.13. sqlvar: Inserts SQL variables
  • 25.14. tree: Inserts a tree widget
  • 25.15. try: Handles exceptions
  • 25.16. unless: Tests a condition
  • 25.17. var: Inserts a variable
  • 25.18. with: Controls DTML variable look up
• 26. Appendix B: API Reference
  • 26.1. Introduction
  • 26.2. Sorry
• 27. Appendix C: Zope Page Templates Reference
  • 27.1. TAL Overview
  • 27.2. attributes: Replace element attributes
  • 27.3. condition: Conditionally insert or remove an element
  • 27.4. content: Replace the content of an element
  • 27.5. define: Define variables
  • 27.6. switch and case: Set up a switch statement
  • 27.7. omit-tag: Remove an element, leaving its contents
  • 27.8. on-error: Handle errors
  • 27.9. repeat: Repeat an element
  • 27.10. replace: Replace an element
  • 27.11. TALES Overview
  • 27.12. TALES Exists expressions
  • 27.13. TALES Nocall expressions
  • 27.14. TALES Not expressions
  • 27.15. TALES Path expressions
  • 27.16. TALES Python expressions
  • 27.17. TALES String expressions
  • 27.18. METAL Overview
  • 27.19. define-macro: Define a macro
  • 27.20. define-slot: Define a macro customization point
  • 27.21. fill-slot: Customize a macro
  • 27.22. use-macro: Use a macro
  • 27.23. ZPT-specific Behaviors
• 28. Appendix D: Zope Resources
  • 28.1. Zope Web Sites
  • 28.2. Zope Documentation
  • 28.3. (Other) Zope Books
  • 28.4. Mailing Lists
  • 28.5. Python Information
• 29. Appendix E: DTML Name Lookup Rules
• 30. Contributions