Package: zopeskel.diazotheme
Introduction============This is a ZopeSkel template package for creating a skeleton Plone add-onpackage. The skeleton package creates a Diazo (plone.app.theming) theme packageand associated css and js resources for use with plone.app.theming inPlone 4.2+.Use this package when you want to package a Diazo theme as a Plone add on,particularly if you need to override viewlet or skin templates in the process.This is a development tool. You should be familiar with Plone and buildout touse it.Installation============Add these lines into buildout::[buildout]parts =zopeskel[zopeskel]recipe = zc.recipe.eggeggs =ZopeSkelPastePasteDeployPasteScriptzopeskel.diazothemeAnd run the buildoutUsage======Add ons under development are typically created in your buildout's srcdirectory. Command line for creating a package named diazotheme.mytheme would be::../bin/zopeskel diazotheme diazotheme.mythemeThis will create a Python package with a directory structure like this::diazotheme.mytheme/|-- diazotheme|   +-- mytheme|       |-- diazo_resources|       |   +-- static|       |-- locales|       |-- profiles|       |   +-- default|       +-- template_overrides|-- diazotheme.mytheme.egg-info+-- docsThe typically customized parts are in the diazotheme.mytheme/diazotheme/mytheme subdirectory.diazo_resources---------------This is where you'll put your Diazo resources including a rules XML file andone or more template HTML files. You may wish to interactively develop thesetheme elements in the theming editor (for Plone 4.3+), then export theresources and add them here.A sample theme is included to use as a starting point. Just replace it if youdon't need it. The sample theme's key feature is that it makes use of all ofPlone's CSS and JavaScript as a starting point.Everything you put in this directory and its subdirectories is publiclyavailable at ++theme++namespace.package/resourcename.ext.NOTE: The Diazo theme will be available in Plone even if you have notinstalled the package. It will not be applied, though, until enabled in theTheme configlet of site setup.diazo_resources/static----------------------This is the conventional place to put static resources like CSS, JS and image files.There's nothing magic about "static". Remove or replace it if it fits your needs.Everything you put in this directory and its subdirectories is publiclyavailable at ++theme++namespace.package/static/resourcename.ext.locales-------If your templates include translatable messages, you may provide translationfiles in this directory. Ignore it if you don't need translations.profiles, profiles/default--------------------------This is the Generic Setup profile for the add on. The is applied when you usethe "add ons" configlet in site setup to install the package.This profile has a couple of important features:* It sets up a BrowserLayer, which insures tha template overrides and registrysettings do not affect other Plone installations unless this theme isinstalled.* It has sample resource registrations for CSS and JavaScript resourceregistries.   These allow you to incorporate static resources which are partof the theme into the Plone resource registries for efficient merging withother CSS and JS resources. The samples are commented out. If you remove thecomment markers and install/reinstall the theme, the main.css and main.jsfiles from your diazo_resources/static directory will be incorporated into theCSS and JS delivered by Plone -- even if the Diazo theme is not active.The alternative to adding your resources to the registries is to load themdirectly in your theme's index.html. This is a better approach if you don'tintend to use Plone's own CSS and JS resources. If you do, registering yourown resources will allow them to be merged for more efficient delivery.template_overrides------------------You may use this directory to override any Plone viewlet, portlet or skin template.To override a template, copy or create a template in this directory using thefull dotted name of the template you wish to override.For example, if you wish to override the standard Plone footer, you would find the original at::plone.app.layout/plone/app/layout/viewlets/footer.ptThe full, dotted name for this resource is::plone.app.layout.viewlets.footer.ptTemplate overrides are only applied when the BrowserLayer is installed byinstalling your package. So, they won't affect Plone installations where thispackage is not installed.A sample override for the Plone footer is included. Delete it if you don't need it.For details on template overrides, see the documentation for `z3c.jbot<https://pypi.python.org/pypi/z3c.jbot>`_.Changelog=========1.1 (2013-04-21)----------------- Added z3c.jbot to setup.py requires for created theme.- Changed ++resource++ to ++theme++ in profile/defaults.- Tuned up documentation.1.0 (2013-04-10)----------------* Initial release.