collective.cheatsheets

As Wikipedia says, cheatsheet "is a concise set of notes used for quick reference". Collective.cheatsheets provides lists of most common methods, variables and few code snippets usefull for Plone developers.

Project Description

Why distribute cheatsheets as a Plone product rather than a static PDF or some image? There are two reasons. First of all, you can easily add it to any site you are just making. Then, during work you don't need to search for this cheatsheet, nor even switch browser. Just type in browser address bar @@cs and voila, there it is.

Second reason is that there is a little javascript helper, allowing you to customize page layout. Most usefull methods and most often used variables are collected on few pages. However, it's not obvious which parts are important. Advanced developer probably doesn't need TAL commands, but beginner may find it usefull. Thanks customization everybody can change it, eg. remove unnecessary viewlets or use three column layout for widescreens.

Of course, if you still prefer static PDF version you can get it from here.

As a final word, keep in mind this is 0.1 version and it may still need more content (see TODO section in README). Feel free to extend it, it's 'collective' :)

 

Installation

Easiest to install with zc.buildout. In buildout.cfg put something like that:

[buildout]
find-links =
    ...
    http://dist.plone.org/packages

eggs =
    collective.cheatsheets

[instance]
zcml =
    collective.cheatsheets

Then run bin/buildout, restart Zope and add cheatsheets in portal_quickinstaller.

Current Release

No stable release available yet.