Hello community,
If you always wanted to help to write documentation, now it's your opportunity!
We need to build a manual to gather all documentation about how to use the portal_catalog tool in Plone. ZCatalogs are already extensively documented in The Zope Book, so we should be explaining only the Plone specific bits here:
- quick start,
- how to create indexes through GenericSetup and using the Python API,
- most important available index types,
- basic searching, including searching for interfaces,
- reference of default portal catalog indexes (should this be auto-generated from code)
- anything else you think is worth it
Feel free to modify the list above.
There's an existent doc you can use as basis,
Using Catalogs, which includes a page about new advanced indexing strategies available using the upcoming plone.indexer package.
You can (and should) reuse existing docs about the portal_catalog to compose the "Indexing and Searching" manual. See the
development section assessment.
Btw, if you find a more appropriate title for the manual than "Indexing and Searching", don't hesitate to propose it. The purpose of using a title problem-oriented rather than technology-oriented is two-fold: be friendlier to newcomers, who may doesn't know what "portal catalog" is, and leave place for future indexing technologies (RDBMS?).
If you're interested on that, please mail the list or me directly, or comment
this associated bug.
Thanks for your time,
israel
------------------------------------------------------------------------------
Create and Deploy Rich Internet Apps outside the browser with Adobe(R)AIR(TM)
software. With Adobe AIR, Ajax developers can use existing skills and code to
build responsive, highly engaging applications that combine the power of local
resources and data with the reach of the web. Download the Adobe AIR SDK and
Ajax docs to start building applications today-
http://p.sf.net/sfu/adobe-com_______________________________________________
Plone-docs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/plone-docsIsrael Saeta Pérez
