Mastering Plone 5 Development

This is the documentation for the "Mastering Plone 5" training.

Mastering Plone is intended as a week-long training for people who are new to Plone or want to learn about the current best practices of Plone development. It can be split in two trainings:

• A beginner training (2 to 3 days) that covers chapters 1-18.

• An advanced training (3 to 5 days) that covers the rest.

At conferences a shortened 2-day version of the advanced training with a slightly modified order is held.

Mastering Plone 5

• 1. About Mastering Plone
  • 1.1. Upcoming Trainings
  • 1.2. Previous Trainings
  • 1.3. Trainers
  • 1.4. License
  • 1.5. Using the documentation for a training
  • 1.6. Contributing
• 2. Introduction
  • 2.1. Who are you?
  • 2.2. What will we do?
  • 2.3. What will we not do?
  • 2.4. What to expect
  • 2.5. Classroom Protocol
  • 2.6. Documentation
  • 2.7. Further Reading
• 3. What is Plone?
  • 3.1. Core concepts
• 4. Installation & Setup
  • 4.1. Installing Plone
  • 4.2. Hosting Plone
  • 4.3. Production Deployment
• 5. Installing Plone for the Training
  • 5.1. Installing Plone without vagrant
  • 5.2. Installing Plone with Vagrant
• 6. What Vagrant is and does
• 7. The Case Study
  • 7.1. Background
  • 7.2. Requirements
• 8. The Features of Plone
  • 8.1. Starting and Stopping Plone
  • 8.2. Walkthrough of the UI
  • 8.3. Users
  • 8.4. Configure a Mailserver
  • 8.5. Content-Types
  • 8.6. Folders
  • 8.7. Collections
  • 8.8. Content Rules
  • 8.9. History
  • 8.10. Manage members and groups
  • 8.11. Workflows
  • 8.12. Working copy
  • 8.13. Placeful workflows
• 9. The Anatomy of Plone
  • 9.1. Database
  • 9.2. Zope
  • 9.3. Content Management Framework
  • 9.4. Zope Toolkit / Zope3
  • 9.5. Zope Component Architecture (ZCA)
  • 9.6. Pyramid
  • 9.7. Exercise
• 10. What's New in Plone 5, 5.1 and Plone 5.2
  • 10.1. Default Theme
  • 10.2. New UI and widgets
  • 10.3. Folder Contents
  • 10.4. Content Types
  • 10.5. Resource Registry
  • 10.6. Chameleon template engine
  • 10.7. Control panel
  • 10.8. Date formatting on the client side
  • 10.9. plone.app.multilingual
  • 10.10. New portlet manager
  • 10.11. Remove portal_skins
  • 10.12. Plone 5.1
  • 10.13. Plone 5.2
• 11. Configuring and Customizing Plone "Through The Web"
  • 11.1. The Control Panel
  • 11.2. Portlets
  • 11.3. Viewlets
  • 11.4. ZMI (Zope Management Interface)
  • 11.5. Summary
• 12. Theming
• 13. Extending Plone
  • 13.1. Extension technologies
• 14. Extend Plone With Add-On Packages
  • 14.1. Some notable add-ons
  • 14.2. How to find add-ons
  • 14.3. Installing Add-ons
  • 14.4. collective.easyform
  • 14.5. Add page layout management with plone.app.mosaic
  • 14.6. Internationalization
  • 14.7. Summary
• 15. Dexterity I: "Through The Web"
  • 15.1. What is a content type?
  • 15.2. The makings of a Plone content type
  • 15.3. Dexterity and Archetypes - A Comparison
  • 15.4. Modifying existing types
  • 15.5. Creating content types TTW
  • 15.6. Moving contenttypes into code
  • 15.7. Exercises
• 16. Buildout I
  • 16.1. Minimal Example
  • 16.2. Syntax
  • 16.3. Recipes
  • 16.4. References
  • 16.5. A real life example
  • 16.6. Mr. Developer
  • 16.7. Extensible
  • 16.8. Be McGuyver
• 17. Write Your Own Add-Ons to Customize Plone
  • 17.1. Creating the package
  • 17.2. Eggs
  • 17.3. Inspecting the package
  • 17.4. Including the package in Plone
  • 17.5. Exercises
  • 17.6. Summary
• 18. Return to Dexterity: Moving contenttypes into Code
  • 18.1. Changing a widget
  • 18.2. Protect fields with permissions
  • 18.3. Summary
• 19. Views I
  • 19.1. A simple browser view
• 20. Page Templates
  • 20.1. TAL and TALES
  • 20.2. Chameleon
  • 20.3. Exercise 1
  • 20.4. METAL and macros
  • 20.5. Accessing Plone from the template
  • 20.6. Exercise 2
  • 20.7. Accessing other views
  • 20.8. What we missed
• 21. Customizing Existing Templates
  • 21.1. The view for News Items
  • 21.2. The Summary View
  • 21.3. Finding the right template
  • 21.4. skin templates
  • 21.5. Summary
• 22. Views II: A Default View for "Talk"
  • 22.1. View Classes
  • 22.2. Browser Views
  • 22.3. Reusing Browser Views
  • 22.4. The default view
  • 22.5. Using helper methods from DefaultView
  • 22.6. The complete template for talks
  • 22.7. Behind the scenes
• 23. Views III: A Talk List
  • 23.1. Using portal_catalog
  • 23.2. brains and objects
  • 23.3. Querying the catalog
  • 23.4. Exercises
  • 23.5. The template for the listing
  • 23.6. Setting a custom view as default view on an object
  • 23.7. Summary
• 24. Testing in Plone
  • 24.1. Types of tests
  • 24.2. Writing tests
  • 24.3. Plone tests
  • 24.4. Robot tests
  • 24.5. More information
• 25. Behaviors
  • 25.1. Dexterity Approach
  • 25.2. Names and Theory
  • 25.3. Practical example
  • 25.4. Adding it to our talk
• 26. Writing Viewlets
  • 26.1. A viewlet for the featured behavior
  • 26.2. Featured viewlet
  • 26.3. Exercise 1
  • 26.4. Exercise 2
• 27. Programming Plone
  • 27.1. plone.api
  • 27.2. portal-tools
  • 27.3. Debugging
  • 27.4. Exercise
• 28. IDEs and Editors
• 29. Dexterity Types II: Growing Up
  • 29.1. Add a marker interface to the talk type
  • 29.2. Upgrade steps
  • 29.3. Add a browserlayer
  • 29.4. Add catalog indexes
  • 29.5. Query for custom indexes
  • 29.6. Exercise 1
  • 29.7. Add collection criteria
  • 29.8. Add versioning through GenericSetup
  • 29.9. Summary
• 30. Custom Search
  • 30.1. eea.facetednavigation
  • 30.2. collective.collectionfilter
• 31. Turning Talks into Events
  • 31.1. Exercise 1
  • 31.2. Exercise 2
• 32. User Generated Content
  • 32.1. Self-registration
  • 32.2. Constrain types
  • 32.3. Grant local roles
  • 32.4. A custom workflow for talks
  • 32.5. Move the changes to the file system
• 33. Resources
• 34. Using Third-Party Behaviors
  • 34.1. Add Teaser With collective.behavior.banner
• 35. Dexterity Types III: Python
  • 35.1. The Python schema
  • 35.2. The Factory Type Information, or FTI
  • 35.3. The view
  • 35.4. The viewlet
  • 35.5. The template for the viewlet
• 36. Dexterity: Reference
  • 36.1. Fields included in Plone
  • 36.2. How fields look like
  • 36.3. 3rd party fields
  • 36.4. Datagrid Field
  • 36.5. Widgets
  • 36.6. Directives
• 37. Relations
  • 37.1. Creating relations in a schema
  • 37.2. Accessing and displaying related items
  • 37.3. Creating RelationFields through the web
  • 37.4. The stack
  • 37.5. RelationValues
  • 37.6. Accessing relations and backrelations from code
• 38. Manage Settings with Registry, Control Panels and Vocabularies
  • 38.1. The Registry
  • 38.2. A setting
  • 38.3. Accessing and modifying values in the registry
  • 38.4. Add a custom control panel
  • 38.5. Vocabularies
• 39. Creating a Dynamic Front Page
  • 39.1. The Front Page
  • 39.2. The template
  • 39.3. Twitter
  • 39.4. Activating the view
• 40. Creating Reusable Packages
• 41. More Complex Behaviors
  • 41.1. Using Annotations
  • 41.2. Using Schema
  • 41.3. Writing Code
• 42. A Viewlet for the Votable Behavior
  • 42.1. Voting Viewlet
  • 42.2. Writing the Viewlet code
  • 42.3. The template
  • 42.4. JavaScript code
  • 42.5. Writing 2 simple view helpers
• 43. Making Our Package Reusable
  • 43.1. Adding permissions
  • 43.2. Using our permissions
  • 43.3. Provide defaults
• 44. Using starzel.votable_behavior in ploneconf.site
• 45. Releasing Your Code
• 46. Buildout II: Getting Ready for Deployment
  • 46.1. The Starzel buildout
  • 46.2. A deployment setup
  • 46.3. Other tools we use
• 47. Plone REST API
  • 47.1. Installing plone.restapi
  • 47.2. Explore the API
  • 47.3. Implementing the talklist
  • 47.4. Submit lightning talks
  • 47.5. Exercise
• 48. The Future of Plone
• 49. Optional
• 50. Using the code for the training
  • 50.1. The code-package
  • 50.2. Getting the code for a certain chapter
  • 50.3. Moving from chapter to chapter
  • 50.4. Tags
  • 50.5. Updating the code-package

Please note that this document is not complete without the spoken word of a trainer.

Even though we attempt to include the most important parts of what we teach in the narrative but reading it here can in no way be considered equal to attending a training.