Difference between revisions of "Template:TemplateDocumentation"

From DDO Compendium
Line 92: Line 92:
|parameter25description =  
|parameter25description =  
|parameter25values =  
|parameter25values =  
|parameter26name =
|parameter26description =
|parameter26values =
|parameter27name =
|parameter27description =
|parameter27values =
|parameter28name =
|parameter28description =
|parameter28values =
|parameter29name =
|parameter29description =
|parameter29values =
|parameter30name =
|parameter30description =
|parameter30values =
}}
}}
</pre>
</pre>
Line 98: Line 113:
{{{description}}}{{#if: {{{example1|}}} |<table width=100% border=1 style="border: solid 1px white;color:white;"><tr><td colspan=2 style="padding:3px; font-size:16px; text-align: center; background-color:#c4c4c4; color:black;">Example Usage</td></tr><tr><td width=40% style="padding:3px">{{{example1}}}</td><td style="padding:3px">{{{example1output}}}</td></tr>{{#if: {{{example2|}}} | <tr><td style="padding:3px">{{{example2}}}</td><td style="padding:3px">{{{example2output}}}</td></tr>}}{{#if: {{{example3|}}} | <tr><td style="padding:3px">{{{example3}}}</td><td style="padding:3px">{{{example3output}}}</td></tr>}}{{#if: {{{example4|}}} | <tr><td style="padding:3px">{{{example4}}}</td><td style="padding:3px">{{{example4output}}}</td></tr>}}</table>}}
{{{description}}}{{#if: {{{example1|}}} |<table width=100% border=1 style="border: solid 1px white;color:white;"><tr><td colspan=2 style="padding:3px; font-size:16px; text-align: center; background-color:#c4c4c4; color:black;">Example Usage</td></tr><tr><td width=40% style="padding:3px">{{{example1}}}</td><td style="padding:3px">{{{example1output}}}</td></tr>{{#if: {{{example2|}}} | <tr><td style="padding:3px">{{{example2}}}</td><td style="padding:3px">{{{example2output}}}</td></tr>}}{{#if: {{{example3|}}} | <tr><td style="padding:3px">{{{example3}}}</td><td style="padding:3px">{{{example3output}}}</td></tr>}}{{#if: {{{example4|}}} | <tr><td style="padding:3px">{{{example4}}}</td><td style="padding:3px">{{{example4output}}}</td></tr>}}</table>}}
=== Usage ===
=== Usage ===
{{#if: {{{usesnamedparameters|}}} | | <nowiki>{{</nowiki>{{{name}}}{{#if: {{{parameter1name|}}}| &#x007C;({{{parameter1name|}}})}}{{#if: {{{parameter2name|}}}| &#x007C;({{{parameter2name|}}})}}{{#if: {{{parameter3name|}}}| &#x007C;({{{parameter3name|}}})}}{{#if: {{{parameter4name|}}}| &#x007C;({{{parameter4name|}}})}}{{#if: {{{parameter5name|}}}| &#x007C;({{{parameter5name|}}})}}{{#if: {{{parameter6name|}}}| &#x007C;({{{parameter6name|}}})}}{{#if: {{{parameter7name|}}}| &#x007C;({{{parameter7name|}}})}}{{#if: {{{parameter8name|}}}| &#x007C;({{{parameter8name|}}})}}{{#if: {{{parameter9name|}}}| &#x007C;({{{parameter9name|}}})}}{{#if: {{{parameter10name|}}}| &#x007C;({{{parameter10name|}}})}}{{#if: {{{parameter11name|}}}| &#x007C;({{{parameter11name|}}})}}{{#if: {{{parameter12name|}}}| &#x007C;({{{parameter12name|}}})}}{{#if: {{{parameter13name|}}}| &#x007C;({{{parameter13name|}}})}}{{#if: {{{parameter14name|}}}| &#x007C;({{{parameter14name|}}})}}{{#if: {{{parameter15name|}}}| &#x007C;({{{parameter15name|}}})}}{{#if: {{{parameter16name|}}}| &#x007C;({{{parameter16name|}}})}}{{#if: {{{parameter17name|}}}| &#x007C;({{{parameter17name|}}})}}{{#if: {{{parameter18name|}}}| &#x007C;({{{parameter18name|}}})}}{{#if: {{{parameter19name|}}}| &#x007C;({{{parameter19name|}}})}}{{#if: {{{parameter20name|}}}| &#x007C;({{{parameter20name|}}})}}{{#if: {{{parameter21name|}}}| &#x007C;({{{parameter21name|}}})}}{{#if: {{{parameter22name|}}}| &#x007C;({{{parameter22name|}}})}}{{#if: {{{parameter23name|}}}| &#x007C;({{{parameter23name|}}})}}{{#if: {{{parameter24name|}}}| &#x007C;({{{parameter24name|}}})}}{{#if: {{{parameter25name|}}}| &#x007C;({{{parameter25name|}}})}}<nowiki>}}</nowiki>}}
{{#if: {{{usesnamedparameters|}}} | | <nowiki>{{</nowiki>{{{name}}}{{#if: {{{parameter1name|}}}| &#x007C;({{{parameter1name|}}})}}{{#if: {{{parameter2name|}}}| &#x007C;({{{parameter2name|}}})}}{{#if: {{{parameter3name|}}}| &#x007C;({{{parameter3name|}}})}}{{#if: {{{parameter4name|}}}| &#x007C;({{{parameter4name|}}})}}{{#if: {{{parameter5name|}}}| &#x007C;({{{parameter5name|}}})}}{{#if: {{{parameter6name|}}}| &#x007C;({{{parameter6name|}}})}}{{#if: {{{parameter7name|}}}| &#x007C;({{{parameter7name|}}})}}{{#if: {{{parameter8name|}}}| &#x007C;({{{parameter8name|}}})}}{{#if: {{{parameter9name|}}}| &#x007C;({{{parameter9name|}}})}}{{#if: {{{parameter10name|}}}| &#x007C;({{{parameter10name|}}})}}{{#if: {{{parameter11name|}}}| &#x007C;({{{parameter11name|}}})}}{{#if: {{{parameter12name|}}}| &#x007C;({{{parameter12name|}}})}}{{#if: {{{parameter13name|}}}| &#x007C;({{{parameter13name|}}})}}{{#if: {{{parameter14name|}}}| &#x007C;({{{parameter14name|}}})}}{{#if: {{{parameter15name|}}}| &#x007C;({{{parameter15name|}}})}}{{#if: {{{parameter16name|}}}| &#x007C;({{{parameter16name|}}})}}{{#if: {{{parameter17name|}}}| &#x007C;({{{parameter17name|}}})}}{{#if: {{{parameter18name|}}}| &#x007C;({{{parameter18name|}}})}}{{#if: {{{parameter19name|}}}| &#x007C;({{{parameter19name|}}})}}{{#if: {{{parameter20name|}}}| &#x007C;({{{parameter20name|}}})}}{{#if: {{{parameter21name|}}}| &#x007C;({{{parameter21name|}}})}}{{#if: {{{parameter22name|}}}| &#x007C;({{{parameter22name|}}})}}{{#if: {{{parameter23name|}}}| &#x007C;({{{parameter23name|}}})}}{{#if: {{{parameter24name|}}}| &#x007C;({{{parameter24name|}}})}}{{#if: {{{parameter25name|}}}| &#x007C;({{{parameter25name|}}})}}{{#if: {{{parameter26name|}}}| &#x007C;({{{parameter26name|}}})}}{{#if: {{{parameter27name|}}}| &#x007C;({{{parameter27name|}}})}}{{#if: {{{parameter28name|}}}| &#x007C;({{{parameter28name|}}})}}{{#if: {{{parameter29name|}}}| &#x007C;({{{parameter29name|}}})}}{{#if: {{{parameter30name|}}}| &#x007C;({{{parameter30name|}}})}}<nowiki>}}</nowiki>}}
{{#if: {{{parameter1name|}}}{{{parameter2name|}}}{{{parameter3name|}}}{{{parameter4name|}}}{{{parameter5name|}}}{{{parameter6name|}}}{{{parameter7name|}}}{{{parameter8name|}}}{{{parameter9name|}}}{{{parameter10name|}}}{{{parameter11name|}}}{{{parameter12name|}}}{{{parameter13name|}}}{{{parameter14name|}}}{{{parameter15name|}}}{{{parameter16name|}}}{{{parameter17name|}}}{{{parameter18name|}}}{{{parameter19name|}}}{{{parameter20name|}}}{{{parameter21name|}}}{{{parameter22name|}}}{{{parameter23name|}}}{{{parameter24name|}}}{{{parameter25name|}}} |
{{#if: {{{parameter1name|}}}{{{parameter2name|}}}{{{parameter3name|}}}{{{parameter4name|}}}{{{parameter5name|}}}{{{parameter6name|}}}{{{parameter7name|}}}{{{parameter8name|}}}{{{parameter9name|}}}{{{parameter10name|}}}{{{parameter11name|}}}{{{parameter12name|}}}{{{parameter13name|}}}{{{parameter14name|}}}{{{parameter15name|}}}{{{parameter16name|}}}{{{parameter17name|}}}{{{parameter18name|}}}{{{parameter19name|}}}{{{parameter20name|}}}{{{parameter21name|}}}{{{parameter22name|}}}{{{parameter23name|}}}{{{parameter24name|}}}{{{parameter25name|}}}{{{parameter26name|}}}{{{parameter27name|}}}{{{parameter28name|}}}{{{parameter29name|}}}{{{parameter30name|}}} |
<table width=100% border=1 style="border: solid 1px white;color:white;">
<table width=100% border=1 style="border: solid 1px white;color:white;">
<tr><td colspan=2 style="padding:3px; font-size:16px; text-align: center; background-color:#c4c4c4; color:black;">Parameter Documentation</td>
<tr><td colspan=2 style="padding:3px; font-size:16px; text-align: center; background-color:#c4c4c4; color:black;">Parameter Documentation</td>
Line 153: Line 168:
{{{parameter24values}}} }}</td></tr>}}{{#if: {{{parameter25name|}}} | <tr><td style="padding:3px">{{{parameter25name}}}</td><td style="padding:3px">{{{parameter25description}}}{{#if: {{{parameter25values|}}} | <br>'''Possible Values:'''  
{{{parameter24values}}} }}</td></tr>}}{{#if: {{{parameter25name|}}} | <tr><td style="padding:3px">{{{parameter25name}}}</td><td style="padding:3px">{{{parameter25description}}}{{#if: {{{parameter25values|}}} | <br>'''Possible Values:'''  


{{{parameter25values}}} }}</td></tr>}}</table>}}
{{{parameter25values}}} }}</td></tr>}}{{#if: {{{parameter26name|}}} | <tr><td style="padding:3px">{{{parameter26name}}}</td><td style="padding:3px">{{{parameter26description}}}{{#if: {{{parameter26values|}}} | <br>'''Possible Values:'''
=== Template ===
 
{{{parameter26values}}} }}</td></tr>}}{{#if: {{{parameter27name|}}} | <tr><td style="padding:3px">{{{parameter27name}}}</td><td style="padding:3px">{{{parameter27description}}}{{#if: {{{parameter27values|}}} | <br>'''Possible Values:'''
 
{{{parameter27values}}} }}</td></tr>}}{{#if: {{{parameter28name|}}} | <tr><td style="padding:3px">{{{parameter28name}}}</td><td style="padding:3px">{{{parameter28description}}}{{#if: {{{parameter28values|}}} | <br>'''Possible Values:'''
 
{{{parameter28values}}} }}</td></tr>}}{{#if: {{{parameter29name|}}} | <tr><td style="padding:3px">{{{parameter29name}}}</td><td style="padding:3px">{{{parameter29description}}}{{#if: {{{parameter29values|}}} | <br>'''Possible Values:'''
 
{{{parameter29values}}} }}</td></tr>}}{{#if: {{{parameter30name|}}} | <tr><td style="padding:3px">{{{parameter30name}}}</td><td style="padding:3px">{{{parameter30description}}}{{#if: {{{parameter30values|}}} | <br>'''Possible Values:'''
 
{{{parameter30values}}} }}</td></tr>}}</table>}}

Revision as of 17:19, 15 May 2018

How To Use This Template[edit]

This template is to add documentation to a template. It should be included at the top of the template before the onlyinclude section


{{Template:TemplateDocumentation
|name = 
|description = 
|usesnamedparameters = <does the template require named parameters>
|example1 = 
|example1output = 
|example2 = 
|example2output = 
|example3 = 
|example3output = 
|example4 = 
|example4output = 
|parameter1name = 
|parameter1description = 
|parameter1values = 
|parameter2name = 
|parameter2description = 
|parameter2values = 
|parameter3name = 
|parameter3description = 
|parameter3values = 
|parameter4name = 
|parameter4description = 
|parameter4values = 
|parameter5name = 
|parameter5description = 
|parameter5values = 
|parameter6name = 
|parameter6description = 
|parameter6values = 
|parameter7name = 
|parameter7description = 
|parameter7values = 
|parameter8name = 
|parameter8description = 
|parameter8values = 
|parameter9name = 
|parameter9description = 
|parameter9values = 
|parameter10name = 
|parameter10description = 
|parameter10values = 
|parameter11name = 
|parameter11description = 
|parameter11values = 
|parameter12name = 
|parameter12description = 
|parameter12values = 
|parameter13name = 
|parameter13description = 
|parameter13values = 
|parameter14name = 
|parameter14description = 
|parameter14values = 
|parameter15name = 
|parameter15description = 
|parameter15values = 
|parameter16name = 
|parameter16description = 
|parameter16values = 
|parameter17name = 
|parameter17description = 
|parameter17values = 
|parameter18name = 
|parameter18description = 
|parameter18values = 
|parameter19name = 
|parameter19description = 
|parameter19values = 
|parameter20name = 
|parameter20description = 
|parameter20values = 
|parameter21name = 
|parameter21description = 
|parameter21values = 
|parameter22name = 
|parameter22description = 
|parameter22values = 
|parameter23name = 
|parameter23description = 
|parameter23values = 
|parameter24name = 
|parameter24description = 
|parameter24values = 
|parameter25name = 
|parameter25description = 
|parameter25values = 
|parameter26name = 
|parameter26description = 
|parameter26values = 
|parameter27name = 
|parameter27description = 
|parameter27values = 
|parameter28name = 
|parameter28description = 
|parameter28values = 
|parameter29name = 
|parameter29description = 
|parameter29values = 
|parameter30name = 
|parameter30description = 
|parameter30values = 
}}

{{{name}}}[edit]

{{{description}}}

Usage[edit]

{{{{{name}}}}}