Help:Generating documentation 1.6.0 - 1.7.0

From semantic-mediawiki.org
Jump to: navigation, search


This documentation page applies to all SMW versions from 1.6.0 to 1.7.0.
Other versions: ≥ 1.7.1       Other languages: zh-hans

Help:Generating documentation en 1.6.0 1.7.0


Generating documentation 1.6.0 - 1.7.0
Generate parameter documentation for a result format
Further Information
Provided by: Semantic MediaWiki
Minimum version: 1.6.0
Maximum version: still supported
Function: yes
Tag: no
Name:
  1. smwdoc

Table of Contents


The parser function #smwdoc allows for automatic parameter documentation generation for all result formats.

Syntax

{{#smwdoc:format name}}
{{#smwdoc:format name|language=lang code}}

Examples

{{#smwdoc:table}}
Parameter Type Default Description
class text sortable wikitable smwtable An additional CSS class to set for the table
transpose yes/no no Display table headers vertically and results horizontally
sep text empty The separator for values
{{#smwdoc:map|language=nl}}

A fatal error occurred in the #smwdoc parser function