index.rst

Symfony CMF Documentation

The Symfony2 Content Management Framework (CMF) project is organized by the Symfony community and has several sponsoring companies and prominent open source leaders implementing the philosophy of the decoupled CMS. You can learn more about the project on the about page.

This documentation is currently in development and far from complete. See Documentation planning for an overview of the work left to do. Want to help? Thank you, all help greatly appreciated! The source of the documentation is hosted on github.

Mission Statement

The Symfony CMF project makes it easier for developers to add CMS functionality to applications built with the Symfony2 PHP framework. Key development principles for the provided set of bundles are scalability, usability, documentation and testing.

Why another CMS?

Actually we consider this project to be a CMF, a content management framework, rather than a CMS, a content management system. The reason is that we are only providing the tools to build a custom CMS. There are clearly many CMS solutions available already, but they tend to be monolithic packages tailored towards end users. Many carry a certain amount of legacy baggage which make them less than ideal for developing highly custom applications, in contrast to what is possible with Symfony2.

What is our target audience?

There are basically two main target audiences:

1. Developers who have built an existing custom application with Symfony2 and need a fast way to add support for content management. Be it sophisticated CMS features like semantic content, inline editing, multi-channel delivery etc. or just a few content pages for things like the about/contact pages.
2. Developers that need to build a highly customized authoring and content delivery solution that no out-of-the-box CMS can properly provide through customization alone.

Getting started

Just started learning about the CMF? Want to know if the CMF fits your project? Start here.

getting_started/installing_symfony_cmf getting_started/routing getting_started/content getting_started/menu getting_started/simplecms

Tutorials

Want to know more about the CMF and how each part can be configured? There's a tutorial for each one.

tutorials/choosing_a_storage_layer tutorials/installing_cmf_core tutorials/installing_configuring_doctrine_phpcr_odm tutorials/installing_configuring_inline_editing tutorials/creating_cms_using_cmf_and_sonata tutorials/using_blockbundle_and_contentbundle tutorials/handling_multilang_documents

Bundles

Looking for some in depth information about a CMF Bundle? Want a list of all the configuration options of a bundle? Want to know if you can use a bundle independently and how to do it? In this case the reference is the right place for you.

bundles/block/index bundles/blog bundles/content bundles/core bundles/create bundles/phpcr_odm bundles/menu bundles/routing bundles/routing_auto bundles/search bundles/simple_cms bundles/doctrine_phpcr_admin bundles/tree_browser

Cookbook

Special solutions for specific use cases that go beyond standard usage.

cookbook/phpcr_odm_custom_documentclass_mapper cookbook/using_a_custom_route_repository cookbook/installing_cmf_sandbox

Components

Looking for some information about the low level components of the CMF?

components/routing components/testing

Contributing

contributing/code contributing/releases contributing/license