Mastering Plone 6 Development

Mastering Plone Development is intended as a training to learn proven practices of Plone development. It's both, an online course and a sketch for an on-the-spot training.

The story of a conference platform provides a week-long training of several development topics that can be split in two trainings:

• A beginner training (2 to 3 days) covering the essentials of Plone and Plone Volto.

• An advanced training (3 to 5 days) with additional advanced topics.

Note

This is the Mastering Plone 6 Development Training.

Mastering Plone 6 Development Training supplements Mastering Plone 5 Development with known best practices for customizing and developing Plone 6: Plone Classic + frontend.

In chapters handling Volto React frontend is a link to a chapter that covers the corresponding tasks in Plone Classic, and vice versa.

Plone 6 is not yet released and thus the training is a work in-progress and there are still some rough edges.

Mastering Plone 6 Development

• 1. About Mastering Plone
  • 1.1. The beginning and the continuation
  • 1.2. Upcoming Trainings
  • 1.3. Previous Trainings
  • 1.4. Trainers
  • 1.5. License
  • 1.6. Using the documentation for a training
  • 1.7. Contributing
• 2. Watch the Training Video
• 3. Introduction
  • 3.1. Who are you?
  • 3.2. Classroom Protocol
  • 3.3. Documentation
  • 3.4. Further Reading
• 4. The Case Study
  • 4.1. Background
  • 4.2. Requirements
  • 4.3. Changing requirements
  • 4.4. Tasks
  • 4.5. Technologies and Tools
• 5. Optional topics without documentation
  • 5.1. Topics covered in other trainings and documentation
• 6. What is Plone?
  • 6.1. Core concepts
  • 6.2. Architecture
• 7. Set up Plone
• 8. Set up Plone for the Training
  • 8.1. Installing the backend
  • 8.2. Installing the frontend
• 9. The Features of Plone
  • 9.1. Starting and Stopping Plone
  • 9.2. Creating a Plone Site
  • 9.3. Starting and Stopping the frontend
  • 9.4. Walkthrough of the UI
  • 9.5. Users
  • 9.6. Configure a Mailserver
  • 9.7. The site structure
  • 9.8. Default content types
  • 9.9. Containers
  • 9.10. Content Rules
  • 9.11. History
  • 9.12. Manage members and groups
  • 9.13. Workflows
  • 9.14. Working copy
  • 9.15. Placeful workflows
• 10. What's New in Plone?
  • 10.1. Plone 5.0
  • 10.2. Plone 5.1
  • 10.3. Plone 5.2
  • 10.4. Plone 6
• 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. Customizing Volto Components
  • 12.1. Component shadowing
  • 12.2. The Logo
  • 12.3. The Footer
  • 12.4. The News Item View
  • 12.5. The Listing Block
  • 12.6. Summary
• 13. Semantic UI
• 14. Theming in Volto
• 15. Extending Plone
  • 15.1. Extension technologies
• 16. Extending Plone With Add-on Packages
  • 16.1. Some notable Plone add-ons for a classic Plone setup without Volto frontend
  • 16.2. How to find add-ons
  • 16.3. Installing Plone Add-ons
  • 16.4. collective.easyform
  • 16.5. Add page layout management with plone.app.mosaic
  • 16.6. Internationalization
  • 16.7. Summary classic Plone
• 17. Write Your Own Python Add-On to Customize Plone
  • 17.1. Creating the package
  • 17.2. Volto Add-ons
  • 17.3. Eggs
  • 17.4. Inspecting the new package
  • 17.5. Including the package in Plone
  • 17.6. Exercises
  • 17.7. Summary
• 18. Dexterity I: Content types
  • 18.1. What is a content type?
  • 18.2. The makings of a Plone content type
  • 18.3. Schemas, Fields and Values
  • 18.4. Behaviors
  • 18.5. Modifying existing types
  • 18.6. Creating content types TTW
  • 18.7. Exercises
• 19. Dexterity II: Talks
  • 19.1. The type registration
  • 19.2. The FTI
  • 19.3. The schema
  • 19.4. The instance class
  • 19.5. Try the new type
  • 19.6. Summary
• 20. Dexterity: Reference
  • 20.1. Fields included in Plone
  • 20.2. How fields look like
  • 20.3. 3rd party fields
  • 20.4. Datagrid Field
  • 20.5. mixedfield
  • 20.6. Widgets
  • 20.7. Directives
• 21. Volto App Development
  • 21.1. Editor
  • 21.2. Tools
  • 21.3. Tips
• 22. Volto View Component: A Default View for a "Talk"
  • 22.1. Summary
• 23. Behaviors
  • 23.1. Dexterity Approach
  • 23.2. Names and Theory
  • 23.3. Practical example
  • 23.4. Enabling the behavior on our talk
  • 23.5. Add an index for the new field
  • 23.6. Add a metadata column for the new field
  • 23.7. Exercise
• 24. Creating a dynamic frontpage with Volto blocks
  • 24.1. Add Index as collection criterion
  • 24.2. Add a listing block to show the featured content
  • 24.3. Outlook: block variations
• 25. Programming Plone
  • 25.1. plone.api
  • 25.2. portal tools
  • 25.3. Debugging
  • 25.4. Exercise
• 26. IDEs and Editors
• 27. Turning Talks into Events
  • 27.1. Add date fields
  • 27.2. Display the dates
  • 27.3. Hiding fields from certain users
  • 27.4. Summary
• 28. Vocabularies, Registry-Settings and Control Panels
  • 28.1. Introduction
  • 28.2. The Registry
  • 28.3. Registry Records
  • 28.4. Accessing and modifying records in the registry
  • 28.5. Custom registry records
  • 28.6. Add a custom control panel
  • 28.7. Vocabularies
  • 28.8. Using vocabularies in a schema
  • 28.9. Summary
• 29. Custom Search
  • 29.1. Custom Search in Volto
  • 29.2. Custom Search in Plone Classic
• 30. Upgrade-steps
  • 30.1. Upgrade steps
  • 30.2. Browserlayers
  • 30.3. Add catalog indexes
  • 30.4. Query for custom indexes
  • 30.5. Exercise 1
  • 30.6. Add collection criteria
  • 30.7. Add versioning through GenericSetup
  • 30.8. Summary
• 31. Testing in Plone
  • 31.1. Testing permissions, features and UI topics
  • 31.2. Testing the rendering of a component
• 32. Using Third-Party Behaviors
  • 32.1. Add Teaser With collective.behavior.banner
• 33. Dexterity Types III: Sponsors
  • 33.1. The Python schema
  • 33.2. The Factory Type Information, or FTI
  • 33.3. Summary
• 34. The Sponsors Component
  • 34.1. A React component
  • 34.2. The Sponsors Component
  • 34.3. Exercise
  • 34.4. Summary
• 35. Using Volto add-ons
  • 35.1. Awesome Volto Add-ons
  • 35.2. Install an add-on
  • 35.3. Complementing Volto with Plone add-ons
• 36. Extending Volto With Custom Add-on Package
  • 36.1. Enrich an existing project with your new released add-on
  • 36.2. Create a new project with your new released add-on
  • 36.3. Footnotes
• 37. Extending Volto With a FAQ Block Type
  • 37.1. Save your work to Github
• 38. Workflow, Roles and Permissions
  • 38.1. Self-registration
  • 38.2. Constrain types
  • 38.3. Grant local roles
  • 38.4. A custom workflow for talks
  • 38.5. Move the changes to the file system
• 39. Relations
  • 39.1. Creating and configuring relations in a schema
  • 39.2. RelationFields through the web or in xml
  • 39.3. Using different widgets for relations
  • 39.4. Accessing and displaying related items
  • 39.5. Inspecting relations
  • 39.6. Programming with relations
  • 39.7. Relationfields without relations
  • 39.8. The stack
• 40. Reusable Features packaged in add-ons
  • 40.1. Create backend package
  • 40.2. Integrate package in training setup
  • 40.3. Create Volto add-on
• 41. Complex Behaviors
  • 41.1. Schema and Annotation
  • 41.2. The Code
• 42. REST API Endpoints
• 43. Volto Actions and Component State
  • 43.1. Requesting data from backend and displaying
  • 43.2. Writing to the backend…
  • 43.3. Component State
• 44. Permissions
  • 44.1. Adding permissions
  • 44.2. Using our permissions
  • 44.3. Provide defaults
• 45. Releasing Your Code
• 46. Using plone.restapi without Volto
  • 46.1. Installing plone.restapi
  • 46.2. Explore the API
  • 46.3. Implementing the talklist
  • 46.4. Submit lightning talks
  • 46.5. Exercise
• 47. Using the code for the training
  • 47.1. The code-packages
  • 47.2. Getting the code for a certain chapter
  • 47.3. Moving from chapter to chapter
  • 47.4. Tags
  • 47.5. Updating the code-package
• 48. Trainer: Preparation
  • 48.1. Technical set up to do before a training

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

We attempt to include the most important parts of what we teach in the training. But reading it here can not be considered equal to attending a training.