Template:BSLfuncinfo: Difference between revisions

m
replaced font style underlined with heavy
(we need to put all breaks and pipes inside #ifs or else we're still creating empty cells)
m (replaced font style underlined with heavy)
(6 intermediate revisions by one other user not shown)
Line 4: Line 4:
|{{{type|}}}<!--
|{{{type|}}}<!--
-->{{#if:{{{arg1name|}}}|<br />
-->{{#if:{{{arg1name|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{{arg1type|}}} {{#if:{{{arg1alttype|}}}|<u>or</u> {{{arg1alttype|}}}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{#if:{{{arg1optional|}}}|''|}}{{{arg1type|}}} {{#if:{{{arg1alttype|}}}|<span style="font-weight:1000;">or</span> {{{arg1alttype|}}}}}|<br />
{{Pipe}}[[{{{name}}}|[edit]]]}}<!--
{{Pipe}}[[Image:Edit-pencil.png|link={{{name}}}|Edit this info]]}}<!--
-->{{#if:{{{arg2name|}}}|<br />
-->{{#if:{{{arg2name|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{{arg2type|}}} {{#if:{{{arg2alttype|}}}|<u>or</u> {{{arg2alttype|}}}}}|{{#if:{{{arg1name|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{#if:{{{arg2optional|}}}|''|}}{{{arg2type|}}} {{#if:{{{arg2alttype|}}}|<span style="font-weight:1000;">or</span> {{{arg2alttype|}}}}}|{{#if:{{{arg1name|}}}|<br />
{{Pipe}}[[{{{name}}}|[edit]]]}}|}}<!--
{{Pipe}}[[Image:Edit-pencil.png|link={{{name}}}|Edit this info]]}}|}}<!--
-->{{#if:{{{arg3name|}}}|<br />
-->{{#if:{{{arg3name|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{{arg3type|}}} {{#if:{{{arg3alttype|}}}|<u>or</u> {{{arg3alttype|}}}}}|{{#if:{{{arg2name|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{#if:{{{arg3optional|}}}|''|}}{{{arg3type|}}} {{#if:{{{arg3alttype|}}}|<span style="font-weight:1000;">or</span> {{{arg3alttype|}}}}}|{{#if:{{{arg2name|}}}|<br />
{{Pipe}}[[{{{name}}}|[edit]]]}}|}}<!--
{{Pipe}}[[Image:Edit-pencil.png|link={{{name}}}|Edit this info]]}}|}}<!--
-->{{#if:{{{arg4name|}}}|<br />
-->{{#if:{{{arg4name|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{{arg4type|}}} {{#if:{{{arg4alttype|}}}|<u>or</u> {{{arg4alttype|}}}}}|{{#if:{{{arg3name|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{#if:{{{arg4optional|}}}|''|}}{{{arg4type|}}} {{#if:{{{arg4alttype|}}}|<span style="font-weight:1000;">or</span> {{{arg4alttype|}}}}}|{{#if:{{{arg3name|}}}|<br />
{{Pipe}}[[{{{name}}}|[edit]]]}}|}}<!--
{{Pipe}}[[Image:Edit-pencil.png|link={{{name}}}|Edit this info]]}}|}}<!--
-->{{#if:{{{arg5name|}}}|<br />
-->{{#if:{{{arg5name|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{{arg5type|}}} {{#if:{{{arg5alttype|}}}|<u>or</u> {{{arg5alttype|}}}}}|{{#if:{{{arg4name|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{#if:{{{arg5optional|}}}|''|}}{{{arg5type|}}} {{#if:{{{arg5alttype|}}}|<span style="font-weight:1000;">or</span> {{{arg5alttype|}}}}}|{{#if:{{{arg4name|}}}|<br />
{{Pipe}}[[{{{name}}}|[edit]]]}}|}}<!--
{{Pipe}}[[Image:Edit-pencil.png|link={{{name}}}|Edit this info]]}}|}}<!--
-->{{#if:{{{arg6name|}}}|<br />
-->{{#if:{{{arg6name|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{{arg6type|}}} {{#if:{{{arg6alttype|}}}|<u>or</u> {{{arg6alttype|}}}}}|{{#if:{{{arg5name|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{#if:{{{arg6optional|}}}|''|}}{{{arg6type|}}} {{#if:{{{arg6alttype|}}}|<span style="font-weight:1000;">or</span> {{{arg6alttype|}}}}}|{{#if:{{{arg5name|}}}|<br />
{{Pipe}}[[{{{name}}}|[edit]]]}}|}}<!--
{{Pipe}}[[Image:Edit-pencil.png|link={{{name}}}|Edit this info]]}}|}}<!--
-->{{#if:{{{arg7name|}}}|<br />
-->{{#if:{{{arg7name|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{{arg7type|}}} {{#if:{{{arg7alttype|}}}|<u>or</u> {{{arg7alttype|}}}}}|{{#if:{{{arg6name|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{#if:{{{arg7optional|}}}|''|}}{{{arg7type|}}} {{#if:{{{arg7alttype|}}}|<span style="font-weight:1000;">or</span> {{{arg7alttype|}}}}}|{{#if:{{{arg6name|}}}|<br />
{{Pipe}}[[{{{name}}}|[edit]]]}}|}}<!--
{{Pipe}}[[Image:Edit-pencil.png|link={{{name}}}|Edit this info]]}}|}}<!--
-->{{#if:{{{arg8name|}}}|<br />
-->{{#if:{{{arg8name|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{{arg8type|}}} {{#if:{{{arg8alttype|}}}|<u>or</u> {{{arg8alttype|}}}}}|{{#if:{{{arg7name|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{#if:{{{arg8optional|}}}|''|}}{{{arg8type|}}} {{#if:{{{arg8alttype|}}}|<span style="font-weight:1000;">or</span> {{{arg8alttype|}}}}}|{{#if:{{{arg7name|}}}|<br />
{{Pipe}}[[{{{name}}}|[edit]]]}}|}}
{{Pipe}}[[Image:Edit-pencil.png|link={{{name}}}|Edit this info]]}}|}}
|-
|-
|'''{{{name}}}('''<!--
|'''{{{name}}}('''<!--
Line 33: Line 33:
-->{{#if:{{{arg1optional|}}}|''|}}<!--                              start italics if optional arg
-->{{#if:{{{arg1optional|}}}|''|}}<!--                              start italics if optional arg
-->{{{arg1name|}}}<!--                                              print arg name
-->{{{arg1name|}}}<!--                                              print arg name
-->{{#if:{{{arg1altname|}}}|&nbsp;<u>or</u> {{{arg1altname|}}}}}<!-- print " or " and alternate arg name if supplied
-->{{#if:{{{arg1altname|}}}|&nbsp;<span style="font-weight:1000;">or</span> {{{arg1altname|}}}}}<!-- print " or " and alternate arg name if supplied
-->{{#if:{{{arg1optional|}}}|''|}}<!--                              end italics if optional arg
-->{{#if:{{{arg1optional|}}}|''|}}<!--                              end italics if optional arg
-->{{#if:{{{arg2name|}}}|, |}}|<br /><!--                            and if there is a next arg, print a comma -->
-->{{#if:{{{arg2name|}}}|, |}}|<br /><!--                            and if there is a next arg, print a comma -->
Line 41: Line 41:
-->{{#if:{{{arg2optional|}}}|''|}}<!--
-->{{#if:{{{arg2optional|}}}|''|}}<!--
-->{{{arg2name|}}}<!--
-->{{{arg2name|}}}<!--
-->{{#if:{{{arg2altname|}}}|&nbsp;<u>or</u> {{{arg2altname|}}}}}<!--
-->{{#if:{{{arg2altname|}}}|&nbsp;<span style="font-weight:1000;">or</span> {{{arg2altname|}}}}}<!--
-->{{#if:{{{arg2optional|}}}|''|}}<!--
-->{{#if:{{{arg2optional|}}}|''|}}<!--
-->{{#if:{{{arg3name|}}}|, |}}|{{#if:{{{arg1name|}}}|<br />
-->{{#if:{{{arg3name|}}}|, |}}|{{#if:{{{arg1name|}}}|<br />
Line 49: Line 49:
-->{{#if:{{{arg3optional|}}}|''|}}<!--
-->{{#if:{{{arg3optional|}}}|''|}}<!--
-->{{{arg3name|}}}<!--
-->{{{arg3name|}}}<!--
-->{{#if:{{{arg3altname|}}}|&nbsp;<u>or</u> {{{arg3altname|}}}}}<!--
-->{{#if:{{{arg3altname|}}}|&nbsp;<span style="font-weight:1000;">or</span> {{{arg3altname|}}}}}<!--
-->{{#if:{{{arg3optional|}}}|''|}}<!--
-->{{#if:{{{arg3optional|}}}|''|}}<!--
-->{{#if:{{{arg4name|}}}|, |}}|{{#if:{{{arg2name|}}}|<br />
-->{{#if:{{{arg4name|}}}|, |}}|{{#if:{{{arg2name|}}}|<br />
Line 57: Line 57:
-->{{#if:{{{arg4optional|}}}|''|}}<!--
-->{{#if:{{{arg4optional|}}}|''|}}<!--
-->{{{arg4name|}}}<!--
-->{{{arg4name|}}}<!--
-->{{#if:{{{arg4altname|}}}|&nbsp;<u>or</u> {{{arg4altname|}}}}}<!--
-->{{#if:{{{arg4altname|}}}|&nbsp;<span style="font-weight:1000;">or</span> {{{arg4altname|}}}}}<!--
-->{{#if:{{{arg4optional|}}}|''|}}<!--
-->{{#if:{{{arg4optional|}}}|''|}}<!--
-->{{#if:{{{arg5name|}}}|, |}}|{{#if:{{{arg3name|}}}|<br />
-->{{#if:{{{arg5name|}}}|, |}}|{{#if:{{{arg3name|}}}|<br />
Line 65: Line 65:
-->{{#if:{{{arg5optional|}}}|''|}}<!--
-->{{#if:{{{arg5optional|}}}|''|}}<!--
-->{{{arg5name|}}}<!--
-->{{{arg5name|}}}<!--
-->{{#if:{{{arg5altname|}}}|&nbsp;<u>or</u> {{{arg5altname|}}}}}<!--
-->{{#if:{{{arg5altname|}}}|&nbsp;<span style="font-weight:1000;">or</span> {{{arg5altname|}}}}}<!--
-->{{#if:{{{arg5optional|}}}|''|}}<!--
-->{{#if:{{{arg5optional|}}}|''|}}<!--
-->{{#if:{{{arg6name|}}}|, |}}|{{#if:{{{arg4name|}}}|<br />
-->{{#if:{{{arg6name|}}}|, |}}|{{#if:{{{arg4name|}}}|<br />
Line 73: Line 73:
-->{{#if:{{{arg6optional|}}}|''|}}<!--
-->{{#if:{{{arg6optional|}}}|''|}}<!--
-->{{{arg6name|}}}<!--
-->{{{arg6name|}}}<!--
-->{{#if:{{{arg6altname|}}}|&nbsp;<u>or</u> {{{arg6altname|}}}}}<!--
-->{{#if:{{{arg6altname|}}}|&nbsp;<span style="font-weight:1000;">or</span> {{{arg6altname|}}}}}<!--
-->{{#if:{{{arg6optional|}}}|''|}}<!--
-->{{#if:{{{arg6optional|}}}|''|}}<!--
-->{{#if:{{{arg7name|}}}|, |}}|{{#if:{{{arg5name|}}}|<br />
-->{{#if:{{{arg7name|}}}|, |}}|{{#if:{{{arg5name|}}}|<br />
Line 81: Line 81:
-->{{#if:{{{arg7optional|}}}|''|}}<!--
-->{{#if:{{{arg7optional|}}}|''|}}<!--
-->{{{arg7name|}}}<!--
-->{{{arg7name|}}}<!--
-->{{#if:{{{arg7altname|}}}|&nbsp;<u>or</u> {{{arg7altname|}}}}}<!--
-->{{#if:{{{arg7altname|}}}|&nbsp;<span style="font-weight:1000;">or</span> {{{arg7altname|}}}}}<!--
-->{{#if:{{{arg7optional|}}}|''|}}<!--
-->{{#if:{{{arg7optional|}}}|''|}}<!--
-->{{#if:{{{arg8name|}}}|, |}}|{{#if:{{{arg6name|}}}|<br />
-->{{#if:{{{arg8name|}}}|, |}}|{{#if:{{{arg6name|}}}|<br />
Line 89: Line 89:
-->{{#if:{{{arg8optional|}}}|''|}}<!--
-->{{#if:{{{arg8optional|}}}|''|}}<!--
-->{{{arg8name|}}}<!--
-->{{{arg8name|}}}<!--
-->{{#if:{{{arg8altname|}}}|&nbsp;<u>or</u> {{{arg8altname|}}}}}<!--
-->{{#if:{{{arg8altname|}}}|&nbsp;<span style="font-weight:1000;">or</span> {{{arg8altname|}}}}}<!--
-->{{#if:{{{arg8optional|}}}|''|}}|{{#if:{{{arg7name|}}}|<br />
-->{{#if:{{{arg8optional|}}}|''|}}|{{#if:{{{arg7name|}}}|<br />
{{Pipe}}''' ); |}}}}
{{Pipe}}''' ); |}}}}
Line 96: Line 96:
-->{{#if:{{{arg1default|}}}|<br />
-->{{#if:{{{arg1default|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{{arg1default|}}}|{{#if:{{{arg1name|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{{arg1default|}}}|{{#if:{{{arg1name|}}}|<br />
{{Pipe}} --|}}|}}<!--
{{Pipe}}align="center"{{Pipe}} --|}}|}}<!--
-->{{#if:{{{arg2default|}}}|<br />
-->{{#if:{{{arg2default|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{{arg2default|}}}|{{#if:{{{arg2name|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{{arg2default|}}}|{{#if:{{{arg2name|}}}|<br />
{{Pipe}} --|}}|}}<!--
{{Pipe}}align="center"{{Pipe}} --|}}|}}<!--
-->{{#if:{{{arg3default|}}}|<br />
-->{{#if:{{{arg3default|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{{arg3default|}}}|{{#if:{{{arg3name|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{{arg3default|}}}|{{#if:{{{arg3name|}}}|<br />
{{Pipe}} --|}}|}}<!--
{{Pipe}}align="center"{{Pipe}} --|}}|}}<!--
-->{{#if:{{{arg4default|}}}|<br />
-->{{#if:{{{arg4default|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{{arg4default|}}}|{{#if:{{{arg4name|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{{arg4default|}}}|{{#if:{{{arg4name|}}}|<br />
{{Pipe}} --|}}|}}<!--
{{Pipe}}align="center"{{Pipe}} --|}}|}}<!--
-->{{#if:{{{arg5default|}}}|<br />
-->{{#if:{{{arg5default|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{{arg5default|}}}|{{#if:{{{arg5name|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{{arg5default|}}}|{{#if:{{{arg5name|}}}|<br />
{{Pipe}} --|}}|}}<!--
{{Pipe}}align="center"{{Pipe}} --|}}|}}<!--
-->{{#if:{{{arg6default|}}}|<br />
-->{{#if:{{{arg6default|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{{arg6default|}}}|{{#if:{{{arg6name|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{{arg6default|}}}|{{#if:{{{arg6name|}}}|<br />
{{Pipe}} --|}}|}}<!--
{{Pipe}}align="center"{{Pipe}} --|}}|}}<!--
-->{{#if:{{{arg7default|}}}|<br />
-->{{#if:{{{arg7default|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{{arg7default|}}}|{{#if:{{{arg7name|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{{arg7default|}}}|{{#if:{{{arg7name|}}}|<br />
{{Pipe}} --|}}|}}<!--
{{Pipe}}align="center"{{Pipe}} --|}}|}}<!--
-->{{#if:{{{arg8default|}}}|<br />
-->{{#if:{{{arg8default|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{{arg8default|}}}|{{#if:{{{arg8name|}}}|<br />
{{Pipe}}align="center"{{Pipe}}{{{arg8default|}}}|{{#if:{{{arg8name|}}}|<br />
{{Pipe}} --|}}|}}
{{Pipe}}align="center"{{Pipe}} --|}}|}}
|}</includeonly><noinclude>'''BSLfuncinfo''' allows for standardized listing of BSL functions. Since BSL allows for functions to take up to eight arguments, and each argument can be described here by up to six parameters, this makes '''BSLfuncinfo''' the most complex template on the wiki. However, you'll rarely need to use more than a few of these parameters to describe an average function.
|}</includeonly><noinclude>'''BSLfuncinfo''' allows for standardized listing of BSL functions. Since BSL allows for functions to take up to eight arguments, and each argument can be described here by up to six parameters, this makes '''BSLfuncinfo''' the most complex template on the wiki. However, you'll rarely need to use more than a few of these parameters to describe an average function.


Line 151: Line 151:
:If a BSL function can take more than one kind of data in a given argument position, give the second argument name here.
:If a BSL function can take more than one kind of data in a given argument position, give the second argument name here.


Below is a default blank call for all parameters up through the fourth function argument, to save some time. You can omit any parameters you don't need when adding this template to a page. However, you may find it easier to use the GUI for this template that is provided by [[XEB]].
Below is a default blank call for all parameters up through the fourth function argument, to save some time. You can omit any parameters you don't need when adding this template to a page.


  <nowiki>{{</nowiki>BSLfuncinfo
  <nowiki>{{</nowiki>BSLfuncinfo
8,524

edits