Zotonic 0.74 documentation

Welcome to the Zotonic documentation! This describes Zotonic 0.74, last updated Jan 20, 2023.

The latest docs are also available in a PDF version.

User Guide

An non-technical introduction to the Zotonic CMS for end users.

• User Guide
  • CMS
  • The Zotonic data model
  • Domain model
  • User management
  • Issues and features

Developer Guide

The handbook for all Zotonic developers. It guides you through all aspects of the framework.

• Developer Guide
  • Introduction
  • Installation
  • Docker
  • Sites
  • Controllers
  • Dispatch rules
  • Resources
  • Templates
  • Forms and validation
  • Search
  • Translation
  • Access control
  • Modules
  • Notifications
  • Browser/server interaction
  • Publish/subscribe
  • API services
  • E-mail handling
  • Command-line shell
  • Testing sites
  • Deployment
  • Contributing to Zotonic
  • Release Notes
  • Upgrade notes
  • Extensions

Cookbook

A collection of recipes that show you how to solve reoccurring problems.

• Cookbooks
  • Create a custom action
  • Create a custom controller
  • Create a custom model
  • Custom pivots
  • Create a custom tag
  • Writing your own module
  • Execute tasks asynchronously using the task queue
  • Exometer metrics
  • Frontend cookbook
  • Admin cookbook
  • Shell cookbook
  • Just enough...

Best practices

Best practices as formulated by the Zotonic core team.

• Best Practices

Reference

A complete overview of all Zotonic components.

• Reference
  • Modules
  • Actions
  • Controllers
  • All dispatch rules
  • Filters
  • Models
  • Services
  • Builtin Tags
  • Custom Tags
  • Validators
  • Directory structure
  • Icons
  • Notifications
  • Installation requirements
  • Global configuration
  • Site configuration
  • The Status site
  • Command-line
  • Transport
  • Troubleshooting
  • EDoc reference

Indices and tables

• Index
• Glossary
• Search Page