-
List of manuals
last modified April 25, 2009 by geeklibrarian
Tentative list of future official manuals suitable for our current documentation set available at plone.org.
I suggest we follow the paradigms other CMSes and web framework have out there, so the developers feel more familiar. Let's not separate Zope 3 from other stuff, since the separation have become irrelevant when new Plones roll out. Doctest format has proven to be very succesfully with Zope 3 documentation and integrates nicely with Sphinx. (mikko).
Developer reference guide
- HTTP request and response
- Views
- Registering
- Subclassing
- BrowserView
- ZODB and Archetypes schema model
- Creating objects
- Accessing objects
- Setting variables
- Transaction lifecycle
- Traversing and acquisition
- When it is applied
- Zope and Plone object hierarchy
- aq_parent
- aq_inner
- Acquisiton properties
- Lack of Middleware concept and alternatives
- Searching and listing content
- Accessing container children
- Listing folder contents (restricted)
- Listing folder contents (unrestricted)
- Appending container children
- Deleting container children
- Catalog vs. primary copy
- Interfaces, adapters and component architecture
- Creating and interface
- Querying by interface
- Querying by interface name
- Adding an adapter
- Overriding an adapter
- Overriding an utility
- Viewlets
- Adding
- Subclassing
- Overriding
- Catalog
- Indexes
- Searching
- Forms
- Z3C form
- Creating forms
- Add form
- Custom widgets
- Custom fields
- Non-recommended methods: raw HTML, CMFFormController
- Content types
- Content type elements
- Run-time initialization (Five)
- GenericXML
- Schema
- Class variables
- Creating content types
- Extending contenttypes
- Publishing properties
- Archetypes machinery
- Creating widgets
- Creating fields
- Storages
- Schematas
- Views
- Aliases
- Default AT templates
- Security and permissions
- Roles and their relationship with users and workflows
- Setting class security
- Setting module security
- Setting view security
- Member management
- Adding and deleting users
- Reading user properties
- Getting active roles
- Granting local role
- Removing local role
- Workflows
- Creating
- Extending
- Querying workflows
- Quering workflow states
- Triggering state transition
- Content rules
- Creating actions
- Creating triggers
- Assigning programmatically
- Events
- Listening
- Firing
- Cancelling
- Getting subscribers
- KSS
- Performing KSS triggered action
- Adding custom operation
- Authentication
- Logging in
- Logging out
- Authentication backends
- Registries
- CSS
- Javascript
- KSS
- Portlets
- Caching
- Cookies
- Setting cookie
- Reading cookie
- Session data
- Session life cycle
- Setting session variables
- Reading session variables
- Modifying session properties
- Data transformations
- Streaming and large files
- Python scripts and RestrictedPython
- When it is applied
- Magic behind
- Differences to normal Python code
- Non-HTTP serving
- FTP
- WebDAV
- Testing
- Basic unit tests
- Functional testing
- Security testing
Development manual
- paster
- buildout
- pdb
- eclipse
References
These should be generated from sources. Lots of custom scripting and new microformats needed for this, though...
- ZCML
- TAL, TALES and METAL (integrated)
- DTML
- GenericSetup XML
- Archetypes widgets
- Archetypes fields
- Stock content contes
- Stock CSS declarations
- Stock Javascripts
- Stock TAL slots
- Stock viewlets
- Stock portlets
- Stock events
- Stock interfaces
- Stock adapters
- Stock utilities
- Stock content rules
- Stock cookies
- Stock session data
- Stock Python scripts
Theming
for current overview of plans for theme reference - theme-reference-overview- Templating (TAL, TALES and METAL)
- How to modify Plone's theme
- How to develop a theme for Plone (there is a document that is very well written and is all you need in order to do the job of Plone theming)
Integration with other systems, real-world configuration
- LDAP
- Relational databases
- Cache systems (CacheFu, Varnish and Squid)
- Apache rewriting
Content management topics (Darci's Take)
Manuals
- Exporting and Importing Content and Member/User Accounts
- Includes working WebDAV solutions, Enfold Desktop, etc.
- Keep an eye on http://plone.org/products/plone/roadmap/187 which may be resurfacing as soon as Plone 3.4
See: http://lists.plone.org/pipermail/framework-team/2009-April/002817.html for more info
- Forms (primarily through PloneFormGen)
- Handling Large Files
- We have several add-on products that address this issue in various ways:
- plone.app.blob - http://plone.org/products/plone.app.blob
- FileSystemStorage - http://plone.org/products/filesystemstorage
- Reflecto - http://plone.org/products/reflecto
- Tramline - http://plone.org/products/tramline
- Plone 4, the next major version of Plone, is likely to include plone.app.blob
- Advanced Content Management
- Using Collections (expand on User Manual)
- Using/Managing Portlets (looking for feedback on this? here or in Visual Design? in both?)
- Portlets that "do" content without "theming", e.g. Configure a static portlet to show the weather and similar how-tos
- Not to include creating new Portlets or theming Portlets
- Using Content Rules
- Not to include creating new triggers or actions
Knowledge Base
- Integrating External Content
- Uploading and Embedding Multimedia Content
- Includes content hosted at Flickr, MySpace, YouTube and uploading multimedia (audio, Flash, etc) directly into Plone
- Syndication
- In, out, creating content objects, CMFSin, feedmixer, etc
- Customizing RSS templates
Navigating content with Plone
- Add Google Sitemap
- Querying your Plone website and managing indexes
- Changing tabs
- Managing the Plone Calendar
- Customizing the navigation portlet In Plone 3
Add your section and/or proposed manuals!
OLD STUFF for historical background:
Content management (see above for updated version)
- Export member data to CSV files
- Batch-adding users to Plone using CSV (Excel) files
- Using the Zope Undo system to “roll back” content
- How to manage portlets in Plone 3
- How to integrate external content into Plone
- How to Embed flickr, YouTube, or MySpace Content
- Creating content rule conditions and actions
- Publish Plone search queries on other web sites using syndication
- Using collections
- How to handle Flash content
- Versioning, history and revising content
- How to handle large files in Plone
- We have several add-on products that address this issue in various
ways:
plone.app.blob - http://plone.org/products/plone.app.blob
FileSystemStorage - http://plone.org/products/filesystemstorage
Reflecto - http://plone.org/products/reflecto
Tramline - http://plone.org/products/tramline
Plone 4, the next major version of Plone, is likely to include
plone.app.blob - This question is repeated monthly in plone-users
- How to handle Unicode errors
- This question is repeated monthly in plone-users