Server Manager Documentation

Overview

This page describes the API to access documentation provided by server manager xml.

Description

• The documentation associated with filters was in GUI xmls in previous versions of ParaView, it has now been moved to the Server Manager xml.
• A new class vtkSMDocumentation has been added.
• Currently, documentation can be added in the server manager xml for any proxy as follows

 <Proxy .... >
   <Documentation short_help="short help text"  long_help="more elaborate help text">
     Far more detailed description for this filter goes here as the CDATA section of this element.
   </Documentation> 
   ...
 </Proxy>

• vtkSMProxy::GetDocumentation() returns the documentation object for the proxy.
• One can also query the ProxyManager using vtkSMProxyManager::NewProxyDocumentation(const char * groupName, const char * proxyName). Note that the groupName and proxyName are the names with which the proxy is defined in the XML not those with which a proxy is registered. This method creates a new vtkSMDocumentation object which must be Deleted by the caller.
• vtkSMDocumentation::GetShortHelp() provides the short help, if any, otherwise NULL.
• vtkSMDocumentation::GetLongHelp() provides the long help, if any, otherwise NULL.
• vtkSMDocumentation::GetDescription() provides the detailed description, if any, otherwise NULL.