Best Practices of Plone Development

More documents

Recommendations

Info

CONTENTS CONTENTS Contents 1 Best Practices for Plone Development 3 1.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 1.1.1 Handouts and Examples . . . . . . . . . . . . . . . . . . . . . . . 4 1.1.2 Why Do We Need This . . . . . . . . . . . . . . . . . . . . . . . 4 1.1.3 Safety . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 1.1.4 Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 1.1.5 Re-Usability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 1.1.6 Streamlined Development . . . . . . . . . . . . . . . . . . . . . . 5 1.2 Products . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 1.2.1 Concept . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 1.2.2 Products . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 1.2.3 Framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 1.2.4 Framework: config.py . . . . . . . . . . . . . . . . . . . . . . . . 7 1.2.5 Framework: content/ . . . . . . . . . . . . . . . . . . . . . . . . . 7 1.2.6 Framework: skins/ . . . . . . . . . . . . . . . . . . . . . . . . . . 8 1.2.7 Framework: Extensions . . . . . . . . . . . . . . . . . . . . . . . 8 1.2.8 Framework: doc/ . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 1.2.9 Framework: VERSION.txt . . . . . . . . . . . . . . . . . . . . . . 8 1.2.10 Framework: __init__.py . . . . . . . . . . . . . . . . . . . . . . . 9 1.2.11 Site Product Overview . . . . . . . . . . . . . . . . . . . . . . . . 9 1.2.12 ArchGenXML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 1.2.13 UML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 1.2.14 Converting UML . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 1.2.15 ArchGenXML Tips . . . . . . . . . . . . . . . . . . . . . . . . . . 10 1.2.16 Skeletor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 1.3 Filesystem Skins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 1.3.1 Through the Web Editing . . . . . . . . . . . . . . . . . . . . . . 12 1.3.2 More Web Editing Problems . . . . . . . . . . . . . . . . . . . . . 12 1.3.3 File-System Stored Skins . . . . . . . . . . . . . . . . . . . . . . . 13 1.3.4 Filenames Matter . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 2
CONTENTS CONTENTS 1.3.5 Sample foo_view.pt.metadata . . . . . . . . . . . . . . . . . . . . 14 1.3.6 Sample foo_edit.py . . . . . . . . . . . . . . . . . . . . . . . . . . 15 1.3.7 Complex foo_view.pt.metadata . . . . . . . . . . . . . . . . . . . 15 1.3.8 ZSQL Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 1.3.9 Skin Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 1.3.10 Placeful Skin Objects . . . . . . . . . . . . . . . . . . . . . . . . . 17 1.3.11 New FS-Stored Types . . . . . . . . . . . . . . . . . . . . . . . . 17 1.3.12 Atonement for Your Sins . . . . . . . . . . . . . . . . . . . . . . . 18 1.3.13 Allowing Modules Imports . . . . . . . . . . . . . . . . . . . . . 18 1.4 Form Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 1.4.1 CMFFormController . . . . . . . . . . . . . . . . . . . . . . . . . 19 1.4.2 Dispatching / Actions . . . . . . . . . . . . . . . . . . . . . . . . 19 1.4.3 Dispatching / Actions (2) . . . . . . . . . . . . . . . . . . . . . . . 20 1.4.4 Dispatching / Actions (3) . . . . . . . . . . . . . . . . . . . . . . . 20 1.4.5 Dispatching / Actions (4) . . . . . . . . . . . . . . . . . . . . . . . 20 1.4.6 Dispatching / Actions (5) . . . . . . . . . . . . . . . . . . . . . . . 21 1.4.7 Example Dispatching . . . . . . . . . . . . . . . . . . . . . . . . 21 1.4.8 Controlled Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . 21 1.4.9 Example Controlled Script . . . . . . . . . . . . . . . . . . . . . . 22 1.4.10 Example Controlled Script: Notice . . . . . . . . . . . . . . . . . 22 1.4.11 Dispatcher for Our Script . . . . . . . . . . . . . . . . . . . . . . 22 1.4.12 CMFFormController Docs . . . . . . . . . . . . . . . . . . . . . . 23 1.4.13 Storing Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . 23 1.4.14 Storing Actions/Validations on FS . . . . . . . . . . . . . . . . . 23 1.4.15 Stored on Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 1.4.16 FormController Types . . . . . . . . . . . . . . . . . . . . . . . . 24 1.5 Skinning Plone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 1.5.1 Possibilities for Skinning . . . . . . . . . . . . . . . . . . . . . . . 25 1.5.2 base_properties Site . . . . . . . . . . . . . . . . . . . . . . . . . 25 1.5.3 CSS Skinning Site . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 1.5.4 Integration Site: Public . . . . . . . . . . . . . . . . . . . . . . . . 25 1.5.5 Integration Site: Private . . . . . . . . . . . . . . . . . . . . . . . 25 3
Page 1: Best Practices for Development Nort
Page 5 and 6: CONTENTS CONTENTS 1.9.3 Limitations
Page 7 and 8: 1 BEST PRACTICES FOR PLONE DEVELOPM
Page 9 and 10: 1.1 Introduction 1 BEST PRACTICES F
Page 11 and 12: 1.2 Products 1 BEST PRACTICES FOR P
Page 17 and 18: 1.3 Filesystem Skins 1 BEST PRACTIC
Page 23 and 24: 1.4 Form Controller 1 BEST PRACTICE
Page 29 and 30: 1.5 Skinning Plone 1 BEST PRACTICES
Page 31 and 32: 1.5 Skinning Plone 1 BEST PRACTICES
Page 33 and 34: 1.6 Version Control 1 BEST PRACTICE
Page 35 and 36: 1.6 Version Control 1 BEST PRACTICE
Page 37 and 38: 1.8 Setup and Scaffolding 1 BEST PR
Page 39 and 40: 1.8 Setup and Scaffolding 1 BEST PR
Page 41 and 42: 1.9 Debugging 1 BEST PRACTICES FOR
Page 51 and 52: 1.10 Testing 1 BEST PRACTICES FOR P
Page 53 and 54:
1.11 Developing With Others 1 BEST
Page 55 and 56:
1.11 Developing With Others 1 BEST
show all

Best Practices of Plone Development

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?