Mastering Plone Documentation Release 1.2.5a Philip Bauer, Patrick Gerken September 23, 2015 Contents 1 About Mastering Plone 3 1.1 Upcoming Trainings...........................................3 1.2 Previous Trainings............................................3 1.3 Trainers..................................................3 1.4 Using the documentation for a training.................................4 1.5 Building the documentation locally...................................5 1.6 Contributing...............................................6 1.7 License..................................................6 2 Introduction 7 2.1 Who are you?...............................................7 2.2 What will we do?.............................................7 2.3 What will we not do?...........................................8 2.4 What to expect..............................................9 2.5 Classroom Protocol...........................................9 2.6 Documentation.............................................. 10 2.7 Further Reading............................................. 10 3 Installation & Setup 11 3.1 Installing Plone.............................................. 11 3.2 Hosting Plone.............................................. 12 3.3 Production Deployment......................................... 12 4 Installing Plone for the Training 13 4.1 Installing Plone without vagrant..................................... 13 4.2 Installing Plone with vagrant....................................... 14 5 The Anatomy of Plone 19 5.1 Zope2................................................... 19 5.2 Content Management Framework.................................... 20 5.3 Zope Toolkit / Zope3........................................... 20 5.4 Zope Component Architecture (ZCA).................................. 21 5.5 Pyramid.................................................. 21 6 The Case Study 23 6.1 Background................................................ 23 6.2 Requirements............................................... 23 7 The Features of Plone 25 i 7.1 Starting and Stopping Plone....................................... 25 7.2 Walkthrough of the UI.......................................... 26 7.3 Users................................................... 26 7.4 Configure a Mailserver.......................................... 27 7.5 Content-Types.............................................. 27 7.6 Folders.................................................. 28 7.7 Collections................................................ 28 7.8 Content Rules.............................................. 29 7.9 History.................................................. 29 7.10 Manage members and groups...................................... 29 7.11 Workflows................................................ 29 7.12 Working copy.............................................. 30 7.13 Placeful workflows............................................ 30 8 What’s New in Plone 5 31 8.1 Default Theme.............................................. 31 8.2 New UI and widgets........................................... 31 8.3 Folder Contents............................................. 32 8.4 Content Types.............................................. 32 8.5 Resource Registry............................................ 32 8.6 Chameleon template engine....................................... 32 8.7 Control panel............................................... 33 8.8 Date formatting on the client side.................................... 33 8.9 plone.app.multilingual.......................................... 33 8.10 New portlet manager........................................... 33 8.11 Remove portal_skins........................................... 34 9 Configuring and Customizing Plone “Through The Web” 35 9.1 The Control Panel............................................ 35 9.2 Portlets.................................................. 36 9.3 Viewlets................................................. 36 9.4 ZMI.................................................... 37 9.5 Summary................................................. 41 10 Extending Plone 43 10.1 Extension technologies.......................................... 43 10.2 What are components, what is ZCML.................................. 45 11 Extend Plone With Add-On Packages 47 11.1 How to find add-ons........................................... 47 11.2 Some noteable add-ons.......................................... 47 11.3 Installing Add-ons............................................ 48 11.4 PloneFormGen.............................................. 49 11.5 Add Photogallery with collective.plonetruegallery........................... 50 11.6 Internationalization............................................ 50 11.7 Summary................................................. 50 12 Theming 51 12.1 Diazo example.............................................. 51 12.2 Templating example........................................... 52 12.3 Choosing the right tool.......................................... 52 12.4 Want to really learn theming?...................................... 52 13 Dexterity I: “Through The Web” 55 13.1 What is a content type?.......................................... 55 ii 13.2 The makings of a Plone content type.................................. 55 13.3 Dexterity and Archetypes - A Comparison............................... 56 13.4 Modifying existing types......................................... 57 13.5 Creating content types TTW....................................... 57 13.6 Moving content types into code..................................... 58 13.7 Exercises................................................. 59 14 Buildout I 61 14.1 Syntax.................................................. 61 14.2 Recipes.................................................. 62 14.3 References................................................ 62 14.4 A real life example............................................ 62 14.5 Hello mr.developer!........................................... 66 14.6 Extensible................................................ 66 14.7 Be McGuyver.............................................. 67 15 Write Your Own Add-Ons to Customize Plone 69 15.1 Creating the package........................................... 69 15.2 Inspecting the package.......................................... 70 15.3 Including the package in Plone...................................... 71 16 Return to Dexterity: Moving Content Types into Code 73 16.1 Exercise 1................................................ 77 16.2 Exercise 2................................................ 78 17 Views I 79 17.1 A simple browser view.......................................... 79 18 Page Templates 81 18.1 TAL and TALES............................................. 82 18.2 Plone 5.................................................. 87 18.3 Exercise 1................................................ 87 18.4 METAL and macros........................................... 92 18.5 Accessing Plone from the template................................... 94 18.6 What we missed............................................. 94 18.7 Chameleon................................................ 95 19 Customizing Existing Templates 97 19.1 The view for News Items......................................... 97 19.2 The Summary View........................................... 99 19.3 Finding the right template........................................ 100 19.4 skin templates.............................................. 101 20 Views II: A Default View for “Talk” 103 20.1 View Classes............................................... 103 20.2 The default view............................................. 104 20.3 Exercise................................................. 107 21 Views III: A Talk List 109 21.1 Using portal_catalog........................................... 109 21.2 brains and objects............................................ 111 21.3 Querying the catalog........................................... 112 21.4 Exercises................................................. 112 21.5 The template for the listing........................................ 113 21.6 Setting a custom view as default view on an object........................... 116 iii 21.7 Adding some javascript (collective.js.datatables)............................ 116 21.8 Summary................................................. 118 22 Testing in Plone 119 22.1 Types of tests............................................... 119 22.2 Writing tests............................................... 120 22.3 Plone tests................................................ 121 22.4 Robot tests................................................ 126 23 Behaviors 129 23.1 Dexterity Approach........................................... 129 23.2 Names and Theory............................................ 129 23.3 Practical example............................................. 130 23.4 Adding it to our talk........................................... 131 24 Writing Viewlets 133 24.1 A viewlet for the social behavior..................................... 133 24.2 Social viewlet.............................................. 133 24.3 Exercise 1................................................ 135 24.4 Exercise 2................................................ 136 25 Programming Plone 139 25.1 plone.api................................................. 139 25.2 portal-tools................................................ 140 25.3 Debugging...............................................