Uses of Interface
lumis.portal.documentation.IDocumentationTemplate

Packages that use IDocumentationTemplate

Package	Description
lumis.content.documentation.generator
lumis.doui.documentation.generator
lumis.portal.documentation
lumis.portal.documentation.generator
lumis.portal.documentation.template.standard

Uses of IDocumentationTemplate in lumis.content.documentation.generator

Methods in lumis.content.documentation.generator with parameters of type IDocumentationTemplate

Modifier and Type	Method and Description
protected String	ContentServiceDocumentationGenerator.getDefaultServiceDetailedDescription(ServiceConfig serviceConfig, IResource resource, Locale locale, IDocumentationTemplate template, ITransaction transaction)
protected String	ContentServiceInterfaceDocumentationGenerator.getDefaultServiceInterfaceDetailedDescription(ServiceInterfaceConfig serviceInterfaceConfig, IResource resource, Locale locale, IDocumentationTemplate template)
protected String	ContentServiceInterfaceDocumentationGenerator.getImageUrl(String filePath, ServiceInterfaceConfig serviceInterfaceConfig, String serviceInstanceId, Locale locale, IDocumentationTemplate template)

Uses of IDocumentationTemplate in lumis.doui.documentation.generator

Methods in lumis.doui.documentation.generator with parameters of type IDocumentationTemplate

Modifier and Type	Method and Description
protected void	DouiServiceInterfaceDocumentationGenerator.addServiceImageToTemplate(String pathToImage, ServiceInterfaceConfig serviceInterfaceConfig, Locale locale, IDocumentationTemplate template)
protected void	DouiServiceDocumentationGenerator.documentationSetTemplateSections(ServiceConfig serviceConfig, IResource resource, Locale locale, IDocumentationTemplate template, ITransaction transaction) Includes source information to the documentation.
protected void	DouiServiceInterfaceDocumentationGenerator.documentationSetTemplateSections(ServiceInterfaceConfig serviceInterfaceConfig, IResource resource, Locale locale, IDocumentationTemplate template)
protected String	DouiServiceInterfaceDocumentationGenerator.generateDocumentationImagesForServiceInterface(ServiceInterfaceConfig serviceInterfaceConfig, IResource resource, Locale locale, IDocumentationTemplate template)
protected void	DouiServiceInterfaceDocumentationGenerator.generateImage(ServiceInterfaceConfig serviceInterfaceConfig, File tempFile, String serviceInstanceId, IDocumentationTemplate template, Locale locale)
protected void	DouiServiceInterfaceDocumentationGenerator.generateLinksDocumentation(Node rootNode, DouiServiceInterfaceInstanceDefinition dsiid, IResource resource, Locale locale, XPath xPath, ServiceInterfaceConfig serviceInterfaceConfig, IDocumentationTemplate template)
protected String	DouiServiceInterfaceDocumentationGenerator.getImageUrl(String filePath, ServiceInterfaceConfig serviceInterfaceConfig, String serviceInstanceId, Locale locale, IDocumentationTemplate template)
protected IDocumentationTemplate.DocumentationSection	DouiServiceInterfaceDocumentationGenerator.getLinksDocumentationSection(IResource resource, Locale locale, ServiceInterfaceConfig serviceInterfaceConfig, IDocumentationTemplate template)
static IDocumentationTemplate.DocumentationSection	DouiDocumentationUtil.renderSource(Node sourceNode, String parentId, IResource resource, Locale locale, IDocumentationTemplate template) Given a source node this method adds a new documentation section to the template related to the source.

Uses of IDocumentationTemplate in lumis.portal.documentation

Methods in lumis.portal.documentation with parameters of type IDocumentationTemplate

Modifier and Type	Method and Description
void	IServiceDocumentationGenerator.generateDocumentationForService(String serviceId, Locale locale, IDocumentationTemplate template) Generates HTML documentation for the service.
void	IServiceInterfaceDocumentationGenerator.generateDocumentationForServiceInterface(String interfaceId, IResource docResource, Locale locale, boolean reGenerateImages, IDocumentationTemplate documentationTemplate) Generates HTML documentation for the service interface
void	IServiceDocumentationGenerator.generateDocumentationForServiceInterface(String interfaceId, Locale locale, boolean reGenerateImages, IDocumentationTemplate documentationTemplate) Generates HTML documentation for the given service interface.

Uses of IDocumentationTemplate in lumis.portal.documentation.generator

Methods in lumis.portal.documentation.generator with parameters of type IDocumentationTemplate

Modifier and Type	Method and Description
protected void	GenericServiceInterfaceDocumentationGenerator.addServiceImageToTemplate(String pathToImage, ServiceInterfaceConfig serviceInterfaceConfig, Locale locale, IDocumentationTemplate template)
protected String	GenericServiceDocumentationGenerator.documentationGetServiceDescription(ServiceConfig serviceConfig, IResource resource, Locale locale, IDocumentationTemplate template, ITransaction transaction) Returns the HTML detailed description of the service.
protected String	GenericServiceInterfaceDocumentationGenerator.documentationGetServiceInterfaceDescription(ServiceInterfaceConfig serviceInterfaceConfig, IResource resource, Locale locale, IDocumentationTemplate template)
protected String	GenericServiceInterfaceDocumentationGenerator.documentationGetServiceInterfaceName(ServiceInterfaceConfig serviceInterfaceConfig, IResource resource, Locale locale, IDocumentationTemplate template)
protected String	GenericServiceInterfaceDocumentationGenerator.documentationGetServiceInterfaceSummary(ServiceInterfaceConfig serviceInterfaceConfig, IResource resource, Locale locale, IDocumentationTemplate template)
protected String	GenericServiceDocumentationGenerator.documentationGetServiceName(ServiceConfig serviceConfig, IResource resource, Locale locale, IDocumentationTemplate template, ITransaction transaction)
protected String	GenericServiceDocumentationGenerator.documentationGetServiceSummary(ServiceConfig serviceConfig, IResource resource, Locale locale, IDocumentationTemplate template, ITransaction transaction)
protected void	GenericServiceDocumentationGenerator.documentationSetTemplateSections(ServiceConfig serviceConfig, IResource resource, Locale locale, IDocumentationTemplate template, ITransaction transaction) Generates the documentation sections for the service principal documentation.
protected void	GenericServiceInterfaceDocumentationGenerator.documentationSetTemplateSections(ServiceInterfaceConfig serviceInterfaceConfig, IResource resource, Locale locale, IDocumentationTemplate template)
void	GenericServiceDocumentationGenerator.generateDocumentationForService(String serviceId, Locale locale, IDocumentationTemplate template)
void	GenericServiceInterfaceDocumentationGenerator.generateDocumentationForServiceInterface(String interfaceId, IResource docResource, Locale locale, boolean reGenerateImages, IDocumentationTemplate template)
void	GenericServiceDocumentationGenerator.generateDocumentationForServiceInterface(String interfaceId, Locale locale, boolean reGenerateImages, IDocumentationTemplate template)
protected String	GenericServiceInterfaceDocumentationGenerator.generateDocumentationImageForServiceInterface(String imageSuffix, ServiceInterfaceConfig serviceInterfaceConfig, IResource resource, Locale locale, IDocumentationTemplate template)
protected String	GenericServiceInterfaceDocumentationGenerator.generateDocumentationImagesForServiceInterface(ServiceInterfaceConfig serviceInterfaceConfig, IResource resource, Locale locale, IDocumentationTemplate template)
protected void	GenericServiceInterfaceDocumentationGenerator.generateImage(ServiceInterfaceConfig serviceInterfaceConfig, File tempFile, String serviceInstanceId, IDocumentationTemplate template, Locale locale)
protected String	GenericServiceDocumentationGenerator.getDefaultServiceDetailedDescription(ServiceConfig serviceConfig, IResource resource, Locale locale, IDocumentationTemplate template, ITransaction transaction) Used by inherited Classes (ex.
protected String	GenericServiceInterfaceDocumentationGenerator.getDefaultServiceInterfaceDetailedDescription(ServiceInterfaceConfig serviceInterfaceConfig, IResource resource, Locale locale, IDocumentationTemplate template)
protected String	GenericServiceInterfaceDocumentationGenerator.getImageUrl(String filePath, ServiceInterfaceConfig serviceInterfaceConfig, String serviceInstanceId, Locale locale, IDocumentationTemplate template)

Uses of IDocumentationTemplate in lumis.portal.documentation.template.standard

Classes in lumis.portal.documentation.template.standard that implement IDocumentationTemplate

Modifier and Type	Class and Description
class	StandardDocumentationTemplate