Bricolage Documentation

[ Home | Download | Documentation | Screenshots | Mail Lists | Bugzilla | Subversion | Templates ]

WWW Bricolage Site

Bricolage is documented in a format called POD inside the Bricolage source files. If you have Bricolage installed then you can read the documentation using the perldoc command and a properly setup $PERL5LIB environment variable. For example:

$ PERL5LIB=/usr/local/bricolage perldoc Bric::Admin

If you don't have Bricolage installed you can read the documentation here. Be aware that this documentation comes from the CVS version of Bricolage (updated daily) and may not exactly match the version of Bricolage you're using. For information about what's changed between Bricolage releases see Bric::Changes.

Entry Points

Introduction

O'Reilly has published "Content Management with Bricolage" as an appendix to its Mason book. This introduction to Bricolage covers installation, concepts, element administration, and of course Mason templating.

Administration

• Bric::Admin - The Admin Guide - includes installation and configuration instructions.
• Bric::Security - Information about Bricolage security.
• Bric::DBA - The Database Admin Guide - care and feeding of the Postgres database made easy.

Usage

• Bric::ElementAdmin - The Element Admin Guide - learn how to create new Bricolage elements.
• Bric::AssetEditing - Learn how to enter content into Bricolage.
• Bric::Alert - The Bricolage Alert system explained.

Templating

• Bric::Templates - Learn to use the Mason templating system.
• Bric::AdvTemplates - Advanced material on the Mason templating system.
• Bric::HTMLTemplate - Introduction to the HTML::Template templating system.

Development

• Bric::Hacker - Join the Bricolage project!
• Bric::ToDo - Looking for something to do? Wondering what we're planning? This is it!
• Bric::SOAP - The Bricolage SOAP interface.

Odds and Ends

• Bric::FAQ - The beginnings of a Bricolage FAQ
• Bric::Changes - The Bricolage ChangeLog - contains information about changes between versions.
• Bric::License - The Bricolage License (new BSD)

Command-Line Programs

• bric_soap - The SOAP comman-line interface.
• bric_apachectl - The Bricolage startup script.
• bric_dist_mon - The Bricolage distribution monitor.
• bric_ftpd - The Bricolage virtual FTP server.

HOWTOS

• How to Include Images in Your Stories
• How to Run Bricolage on a Virtual Host and on Non-Standard Ports

Design Documents

• ElementRevision - The design and implementation documentation for the in-progress revision of the element system.
• MultiSite - The design and implementation documentation for the in-progress addition of true support for managing multiple sites in one Bricolage installation.

Browse The Tree

• Enter Here to browse the Bricolage documentation tree including all the documents listed above and the full API documentation.