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 training of several development topics that can be split in two trainings:

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

• An advanced training (3 to 5 days) with additional advanced topics concerning the Plone backend.

Note

Mastering Plone 6 Development Training focuses on Plone backend architecture and topics of Volto development as long as the backend is involved.

We do not deal with pure Volto topics here. For Volto development see training Effective Volto.

We expect you to work with the Plone React frontend (former called Volto). Therefore we do not deal with Plone Classic topics here. For Plone Classic see training Plone 6 Classic UI Theming, training Mastering Plone 5 development and documentation Classic UI

Mastering Plone 6 Development

• 1. About Mastering Plone development
  • 1.1. The beginning and the continuation
  • 1.2. Upcoming trainings
  • 1.3. Watch the training video
  • 1.4. Trainers
  • 1.5. Optional topics without documentation
  • 1.6. Topics covered in other trainings and documentation
  • 1.7. License
  • 1.8. Using the documentation for a training
  • 1.9. Contributing
• 2. Introduction
  • 2.1. Who are you?
  • 2.2. Classroom
  • 2.3. Documentation
  • 2.4. Learn
  • 2.5. Further Reading
• 3. The Case Study
  • 3.1. Background
  • 3.2. Requirements
  • 3.3. Changing requirements
  • 3.4. Tasks
• 4. What is Plone?
  • 4.1. Core concepts
    • Traversal
    • Object publishing
    • Schema-driven content
    • Component Architecture
  • 4.2. Architecture
    • Python
    • Database (ZODB)
    • Zope
    • Plone content management system
    • REST API
    • Volto Frontend
    • Classic Frontend
• 5. Installation
  • 5.1. Technologies and Tools
  • 5.2. Set up
  • 5.3. Installing the backend
    • Prerequisites
    • Installation
  • 5.4. Installing the frontend
    • Option 1: Frontend from scratch
    • Option 2. Start with prepared training project volto-ploneconf with all code for the training
• 6. The Features of Plone
  • 6.1. Starting and stopping Zope
  • 6.2. Creating a Plone site
  • 6.3. Starting and stopping the frontend
    • Change ports
  • 6.4. Walkthrough of the UI
  • 6.5. Configure a mail server
  • 6.6. The site structure
  • 6.7. Default content types
  • 6.8. folderish content
  • 6.9. Content Rules
    • Exercise
  • 6.10. History
  • 6.11. Users and groups
    • Excursion
    • Exercise
    • Groups and users
  • 6.12. Workflows
    • Placeful workflows
  • 6.13. Publishing date and expiration date
  • 6.14. Sharing
  • 6.15. URL management
  • 6.16. Working copy
• 7. Configuring and Customizing Plone "Through The Web"
  • 7.1. The site setup
    • General
    • Content
    • Users
    • Security
    • Advanced
    • Add-ons
  • 7.2. ZMI (Zope management interface)
  • 7.3. Summary
• 8. Extending Plone with add-on packages
  • 8.1. How to find appropriate add-ons
  • 8.2. Installing Plone add-ons
    • Making a backend add-on package available to Zope
    • Enabling add-ons in your Plone site
  • 8.3. Summary
• 9. Extending Plone
  • 9.1. Extension technologies
  • 9.2. Component Architecture
  • 9.3. Configuring Zope Components with ZCML
  • 9.4. GenericSetup
• 10. Content types I
  • 10.1. What is a content type?
  • 10.2. The makings of a Plone content type
  • 10.3. Schemas, Fields and Values
  • 10.4. Behaviors
  • 10.5. Modifying existing types
  • 10.6. Creating content types TTW
  • 10.7. Exercises
    • Exercise 1
  • 10.8. Further reading
• 11. Develop
  • 11.1. IDE: Integrated development environment
  • 11.2. Tools
    • Browser Development Tools
    • Postman
  • 11.3. Tips
• 12. Content types II: Talk
  • 12.1. The type registration
  • 12.2. The FTI
  • 12.3. The schema
  • 12.4. The instance class
  • 12.5. Try the new type
  • 12.6. Summary
• 13. Content types: Reference
  • 13.1. Fields included in Plone
  • 13.2. How fields look like
  • 13.3. mixedfield (datagrid field)
    • Backend
    • Frontend
  • 13.4. Widgets
    • Determine frontend widget
  • 13.5. Directives
  • 13.6. Validation and default values
• 14. Customizing Volto components
  • 14.1. Component shadowing
  • 14.2. The footer
  • 14.3. The news item view
  • 14.4. Summary
• 15. Volto view component: A default view for a "Talk"
  • 15.1. Creating and registering a new view component
  • 15.2. Enhancing the view
  • 15.3. Summary
• 16. Behaviors
  • 16.1. Dexterity Approach
  • 16.2. Names and Theory
  • 16.3. Practical example
  • 16.4. Enabling the behavior on our talk
  • 16.5. Add an index for the new field
  • 16.6. Add a metadata column for the new field
  • 16.7. Exercise
• 17. Creating a dynamic front page with Volto blocks
  • 17.1. Add Index as collection criterion
  • 17.2. Add a listing block to show the featured content
  • 17.3. Outlook: Block variations
• 18. Programming Plone
  • 18.1. plone.api
  • 18.2. portal tools
  • 18.3. Debugging
  • 18.4. Exercise 1
  • 18.5. Exercise 2
  • 18.6. Exercise 3
• 19. Turning Talks into Events
  • 19.1. Add date fields
  • 19.2. Display the dates
  • 19.3. Hiding fields from certain users
    • Exercise
  • 19.4. Summary
• 20. Vocabularies, Registry-Settings and Control Panels
  • 20.1. Introduction
  • 20.2. The Registry
  • 20.3. Registry Records
  • 20.4. Accessing and modifying records in the registry
  • 20.5. Custom registry records
  • 20.6. Add a custom control panel
  • 20.7. Vocabularies
  • 20.8. Using vocabularies in a schema
  • 20.9. Adjust frontend according schema changes
  • 20.10. Summary
• 21. Custom Search
  • 21.1. Exercise
• 22. Testing
  • 22.1. Testing the rendering of a component
  • 22.2. Testing permissions, features and user interface topics
    • Preparing acceptance backend with add-ons
    • Run cypress tests
• 23. Content types III: Sponsors
  • 23.1. The Python schema
  • 23.2. The Factory Type Information, or FTI
  • 23.3. Summary
• 24. Upgrade steps
  • 24.1. Upgrade steps
  • 24.2. Add catalog index
  • 24.3. Add collection criteria
  • 24.4. Apply the new criterion to create a search block for talks
  • 24.5. Summary
• 25. Search block variation
  • 25.1. Create and register new block variation
• 26. Search for additional fields
• 27. The Sponsors Component
  • 27.1. A React component
  • 27.2. The Sponsors Component
    • Customizing the Footer
    • Getting the sponsors data
    • Connection of component and store
    • Presentation of the prepared data
  • 27.3. Exercise
  • 27.4. Summary
• 28. Using Volto add-ons
  • 28.1. Awesome Volto add-ons
  • 28.2. Install an add-on
  • 28.3. Complementing Volto with Plone add-ons
• 29. Extending Volto with a custom add-on package
  • 29.1. Enrich an existing project with your new released add-on
  • 29.2. Create a new project with your new released add-on
• 30. Creating a custom block
  • 30.1. Save your work to Github
• 31. Workflow, Roles and Permissions
  • 31.1. Self-registration
  • 31.2. Constrain types to be addable
  • 31.3. Grant local roles
  • 31.4. A custom workflow for talks
  • 31.5. Move the changes to the file system
    • Export and import the workflow
    • Enable self-registration
    • Grant local roles and constrain types to be addable
  • 31.6. Exercise
• 32. Relations
  • 32.1. Creating and configuring relations in a schema
    • Controlling what to relate to
  • 32.2. The widget
  • 32.3. Accessing and displaying related items
  • 32.4. Inspecting relations
  • 32.5. Programming with relations
    • Plone 5.2 and older
  • 32.6. Exercise 1
  • 32.7. Exercise 2
• 33. Roundtrip [The voting story] frontend, backend, and REST
  • 33.1. Complex behaviors [voting story]
    • Schema and annotation
    • The code
    • Enable the behavior
  • 33.2. REST API endpoints [voting story]
  • 33.3. Volto Actions and component state [voting story]
    • Requesting data from backend and displaying
    • Writing to the backend…
    • Component state
  • 33.4. Permissions [voting story]
    • Adding permissions
    • Using our permissions
    • Provide defaults
  • 33.5. Create a backend package
  • 33.6. Integrate backend package in training setup
  • 33.7. Create a Volto add-on
  • 33.8. Integrate frontend add-on in training setup
• 34. Releasing your code
  • 34.1. Releasing your backend add-on
  • 34.2. Releasing your frontend add-on
• 35. The code for the training
  • 35.1. The code-packages
  • 35.2. Getting the code for a certain chapter
  • 35.3. Moving from chapter to chapter
  • 35.4. Tags
  • 35.5. Updating the code-package
• 36. Trainer: Preparation
  • 36.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.