<%! import xml.sax.saxutils as su import os title = 'Registered Modules' %> <%inherit file="//layout/message.html" /> <%def name="css()"> <% parent.css() %> <%def name="header()">

${_('View module reference (Splunk %s [@%s])') % (cherrypy.config.get('version_label'), cherrypy.config.get('build_number'))}

<%doc> This block is activated via a URI param, so that docs can copy/paste this document into a media-wiki system % if show_wiki: <% output = [] currentGroup = None for pair in groupedNames: group, name = pair module = modules[name] if module['isAbstract'] or module['isPrototype']: continue if group != currentGroup: output.append('== %s ==\n\n' % group) currentGroup = group output.append('=== %s ===\n' % name.replace('Splunk.Module.', '')) if module['superClass']: output.append("(extends %s)\n" % module.get('superClass', '').replace('Splunk.Module.','')) output.append(module.get('description') or '') output.append('\n') requiredList = {} optionalList = {} for pname, param in module['params'].items(): if param.get('required'): requiredList[pname] = param else: optionalList[pname] = param output.append('==== required params ====\n') if len(requiredList) == 0: output.append('(none)\n') for pname, param in sorted(requiredList.items()): output.append('* %s' % pname) if param.get('values'): output.append(' = %s' % ' | '.join([str(x) for x in param['values']])) if param.get('label'): output.append('\n** %s' % su.escape(param.get('label') or '')) if param.get('default'): output.append('\n** defaults to: %s' % param['default']) output.append('\n') output.append('==== optional params ====\n') if len(optionalList) == 0: output.append('(none)\n') for pname, param in sorted(optionalList.items()): output.append('* %s' % pname) if param.get('values'): output.append(' = %s' % ' | '.join([str(x) for x in param['values']])) if param.get('label'): output.append('\n** %s' % su.escape(param.get('label') or '')) if param.get('default'): output.append('\n** defaults to: %s' % param['default']) output.append('\n') output.append('\n') %>

DocWiki alternate

% endif
% for i, name in enumerate(names): <% module = modules[name] mappingClass = 'mapping' if module['isAbstract']: mappingClass += ' abstract' %>

${module['class']|h} % if module['superClass']: extends ${module['superClass']|h} % endif

% if module['isAbstract']:

This is an abstract module and should not be directly referenced in a view!

% endif % if module['isPrototype']:

This is a prototype module. Its existence and parameters are subject to change without notice.

% endif

${module.get('description') or '(no description)' | h}

% if module['include']:

Includes

    % for include in module['include']:
  • ${include|h}
  • % endfor
% endif % if module['params']:

Parameters

% for pname, param in sorted(module['params'].items()):
${pname | h} ${'(required)' if param.get('required', False) else ''}

${param.get('label') or '(no description available)' | h}

% if param['values']:

Expected values

    % for val in sorted(param['values']):
  • ${val | h} ${'(default)' if param.get('default') == val else ''}
  • % endfor
% endif % if param.get('default'):

Default value: ${param.get('default') | h}

% endif
% endfor
% endif

Defined in ${module['path']|h}${os.sep}${module['filePrefix'] | h}.js

% endfor