- Plone 3 Products Development Cookbook
- Juan Pablo Gimenez Marcos F.Romero
- 258字
- 2021-08-06 17:05:58
Discovering Zope/Plone APIs and docstrings with DocFinderTab
Although Zope and Plone documentation is really good, sometimes it's so comprehensive that we must read and browse lots of code before we get what we are looking for. DocFinderTab provides a great way of finding it.
How to do it…
- Add the
Products.DocFinderTabline in theeggsparameter of[buildout]part:[buildout] ... # Add additional eggs here eggs = iw.debug Products.DocFinderTab - Build your instance again and launch it:
./bin/buildout ./bin/instance fg
Now you can navigate to your ZMI (Zope Management Interface) instance to see a new Doc tab. For instance, browse to the URL http://localhost:8080/plone/showDocumentation to get the documentation tab as shown in the following screenshot:
You can also do this with a particular document, folder, or tool of your site:
http://localhost:8080/plone/front-page/showDocumentation.http://localhost:8080/plone/events/showDocumentation.http://localhost:8080/plone/portal_catalog/showDocumentation.
How it works…
DocF inderTab is an introspection tool to expose Zope and Plone documentation from inside the ZMI.
The following paragraph explains how DocFinderTab works:
It analyses any Zope object inside a running Zope, determines which classes have been used in the object's makeup and provides information about their class level attributes: name, allowed roles, arguments, documentation strings. It provides (read only) access to source code of Python implemented classes and methods.
The excerpt was taken from Dieter Maurer's website (http://www.dieter.handshake.de). He's the creator of DocFinder, the Zope product used by DocFinderTab.
There's more…
More information on DocFinderTab is available at: http://plone.org/products/docfindertab.
To learn about how DocFinder works visit http://www.dieter.handshake.de/pyprojects/zope/DocFinder.html.
If you are interested in more Python introspection, then visit http://diveintopython.org/power_of_introspection/index.html.
- 中文版SolidWorks 2015技術大全
- 鍵盤錄入技術（第2版）
- Adobe創意大學Illustrator產品專家認證標準教材（CS6修訂版）
- Drupal: Creating Blogs, Forums, Portals, and Community Websites
- ASP.NET 3.5 Application Architecture and Design
- Lighttpd
- Flash基礎與實戰教程
- PostgreSQL Replication
- 三維建模與3D打印從入門到精通
- Puppet權威指南
- Word-Excel-PowerPoint 2010三合一辦公應用實戰從入門到精通（超值版）
- Choosing an Open Source CMS: Beginner's Guide
- 跨境電商：速賣通搜索排名規則解析與SEO技術
- 3ds Max 2014/VRay效果圖制作實戰從入門到精通
- 前端函數式演進