Difference between pages "User:StDoodle/FunctionPage sandbox" and "Template:FunctionPage"

From Kolmafia
< User:StDoodle(Difference between pages)
Jump to navigation Jump to search
imported>StDoodle
m
 
imported>StDoodle
m
 
Line 1: Line 1:
−
<noinclude>This is template for a function page (for just a function line, see "Template:Function").</noinclude>
+
<noinclude><p>This is template for a function page (for just a function line, see "Template:Function").</p>
−
<includeonly>{{#customtitle:{{{name}}}()|{{{name}}}()}}
+
<p>The following is the full function call with all possible parameters. Please note that you would rarely, if ever, require everything shown.</p>
−
<!-- FILL OUT EVERYTHING IN CAPS WITH INFO FOR THIS PAGE (EXCEPT COMMENTS LIKE THIS LINE)-->
+
<pre>
−
{{#if: {{{function1|}}}|{{{function1}}}}}
+
{{FunctionPage|
−
{{#if: {{{function2|}}}|{{{function2}}}}}
+
page_name=FUNCTION_NAME|
−
{{#if: {{{function3|}}}|{{{function3}}}}}
+
function_category=CATEGORY|
−
{{#if: {{{function4|}}}|{{{function4}}}}}
+
function1_return_type=DATATYPE|
−
{{#if: {{{function5|}}}|{{{function5}}}}}
+
function1_returns_also=SECONDARY_DATAYPE_OR_DELETE|
−
{{#if: {{{code1|}}}|{{User:StDoodle/CodeStart_sandbox|{{{code1title}}}|{{{code1desc}}}{{{code1code}}}{{User:StDoodle/CodeEnd_sandbox}} }}
+
function1_parameter1={{Param|TYPE|SHORTDESC}}|
−
[[Category:Test Functions]]
+
function1_parameter1_desc=DESCRIPTION_OF_PARAM|
 +
function1_parameter2={{Param|TYPE|SHORTDESC}}|
 +
function1_parameter2_desc=DESCRIPTION_OF_PARAM|
 +
function1_parameter3={{Param|TYPE|SHORTDESC}}|
 +
function1_parameter3_desc=DESCRIPTION_OF_PARAM|
 +
function1_parameter4={{Param|TYPE|SHORTDESC}}|
 +
function1_parameter4_desc=DESCRIPTION_OF_PARAM|
 +
function1_parameter5={{Param|TYPE|SHORTDESC}}|
 +
function1_parameter5_desc=DESCRIPTION_OF_PARAM|
 +
function2_return_type=DATATYPE|
 +
function2_returns_also=SECONDARY_DATAYPE_OR_DELETE|
 +
function2_parameter1={{Param|TYPE|SHORTDESC}}|
 +
function2_parameter1_desc=DESCRIPTION_OF_PARAM|
 +
function2_parameter2={{Param|TYPE|SHORTDESC}}|
 +
function2_parameter2_desc=DESCRIPTION_OF_PARAM|
 +
function2_parameter3={{Param|TYPE|SHORTDESC}}|
 +
function2_parameter3_desc=DESCRIPTION_OF_PARAM|
 +
function2_parameter4={{Param|TYPE|SHORTDESC}}|
 +
function2_parameter4_desc=DESCRIPTION_OF_PARAM|
 +
function2_parameter5={{Param|TYPE|SHORTDESC}}|
 +
function2_parameter5_desc=DESCRIPTION_OF_PARAM|
 +
function3_return_type=DATATYPE|
 +
function3_returns_also=SECONDARY_DATAYPE_OR_DELETE|
 +
function3_parameter1={{Param|TYPE|SHORTDESC}}|
 +
function3_parameter1_desc=DESCRIPTION_OF_PARAM|
 +
function3_parameter2={{Param|TYPE|SHORTDESC}}|
 +
function3_parameter2_desc=DESCRIPTION_OF_PARAM|
 +
function3_parameter3={{Param|TYPE|SHORTDESC}}|
 +
function3_parameter3_desc=DESCRIPTION_OF_PARAM|
 +
function3_parameter4={{Param|TYPE|SHORTDESC}}|
 +
function3_parameter4_desc=DESCRIPTION_OF_PARAM|
 +
function3_parameter5={{Param|TYPE|SHORTDESC}}|
 +
function3_parameter5_desc=DESCRIPTION_OF_PARAM|
 +
function4_return_type=DATATYPE|
 +
function4_returns_also=SECONDARY_DATAYPE_OR_DELETE|
 +
function4_parameter1={{Param|TYPE|SHORTDESC}}|
 +
function4_parameter1_desc=DESCRIPTION_OF_PARAM|
 +
function4_parameter2={{Param|TYPE|SHORTDESC}}|
 +
function4_parameter2_desc=DESCRIPTION_OF_PARAM|
 +
function4_parameter3={{Param|TYPE|SHORTDESC}}|
 +
function4_parameter3_desc=DESCRIPTION_OF_PARAM|
 +
function4_parameter4={{Param|TYPE|SHORTDESC}}|
 +
function4_parameter4_desc=DESCRIPTION_OF_PARAM|
 +
function4_parameter5={{Param|TYPE|SHORTDESC}}|
 +
function4_parameter5_desc=DESCRIPTION_OF_PARAM|
 +
function5_return_type=DATATYPE|
 +
function5_returns_also=SECONDARY_DATAYPE_OR_DELETE|
 +
function5_parameter1={{Param|TYPE|SHORTDESC}}|
 +
function5_parameter1_desc=DESCRIPTION_OF_PARAM|
 +
function5_parameter2={{Param|TYPE|SHORTDESC}}|
 +
function5_parameter2_desc=DESCRIPTION_OF_PARAM|
 +
function5_parameter3={{Param|TYPE|SHORTDESC}}|
 +
function5_parameter3_desc=DESCRIPTION_OF_PARAM|
 +
function5_parameter4={{Param|TYPE|SHORTDESC}}|
 +
function5_parameter4_desc=DESCRIPTION_OF_PARAM|
 +
function5_parameter5={{Param|TYPE|SHORTDESC}}|
 +
function5_parameter5_desc=DESCRIPTION_OF_PARAM|
 +
function_description=DESCRIPTION_OF_FUNCTION|
 +
code1={{CodeSample|
 +
title=CODE EXAMPLE TITLE|
 +
description=DESCRIPTION OF CODE|
 +
code=
 +
<syntaxhighlight lang="c">
 +
CODE GOES HERE
 +
</syntaxhighlight>}}|
 +
code2={{CodeSample|
 +
title=CODE EXAMPLE TITLE|
 +
description=DESCRIPTION OF CODE|
 +
code=
 +
<syntaxhighlight lang="c">
 +
CODE GOES HERE
 +
</syntaxhighlight>}}|
 +
code3={{CodeSample|
 +
title=CODE EXAMPLE TITLE|
 +
description=DESCRIPTION OF CODE|
 +
code=
 +
<syntaxhighlight lang="c">
 +
CODE GOES HERE
 +
</syntaxhighlight>}}|
 +
code4={{CodeSample|
 +
title=CODE EXAMPLE TITLE|
 +
description=DESCRIPTION OF CODE|
 +
code=
 +
<syntaxhighlight lang="c">
 +
CODE GOES HERE
 +
</syntaxhighlight>}}|
 +
code5={{CodeSample|
 +
title=CODE EXAMPLE TITLE|
 +
description=DESCRIPTION OF CODE|
 +
code=
 +
<syntaxhighlight lang="c">
 +
CODE GOES HERE
 +
</syntaxhighlight>}}|
 +
see_also={{SeeAlso|FIRST|SECOND|ETC}}|
 +
cli_equiv=LIST CLI EQUIVALENT|
 +
more_info=A LINE TO NOTIFY OF EXTERNAL INFO|
 +
special=SPECIAL NOTES SUCH AS NOT-LOGGED-IN VALUE
 +
}}
 +
</pre>
 +
<p>Replace everything in CAPS with appropriate information for the given page.</p>
 +
[[Category:Basic Templates]]
 +
</noinclude>
 +
<includeonly>
 +
{| align="right"
 +
  | __TOC__
 +
  |}{{#customtitle:{{{page_name}}}()|{{{page_name}}}()}}<h2>Function Syntax</h2>{{#if: {{{function1_return_type|}}}|<p>{{Function|function_name={{{page_name}}}|returns={{{function1_return_type}}}|returns2={{{function1_returns_also|}}}|parameter1={{{function1_parameter1|}}}|parameter2={{{function1_parameter2|}}}|parameter3={{{function1_parameter3|}}}|parameter4={{{function1_parameter4|}}}|parameter5={{{function1_parameter5|}}}}}</p>}}{{#if: {{{function1_parameter1_desc|}}}|{{{function1_parameter1_desc}}}<br />}}{{#if: {{{function1_parameter2_desc|}}}|{{{function1_parameter2_desc}}}<br />}}{{#if: {{{function1_parameter3_desc|}}}|{{{function1_parameter3_desc}}}<br />}}{{#if: {{{function1_parameter4_desc|}}}|{{{function1_parameter4_desc}}}<br />}}{{#if: {{{function1_parameter5_desc|}}}|{{{function1_parameter5_desc}}}<br />}}{{#if: {{{function2_return_type|}}}|<p>{{Function|function_name={{{page_name}}}|returns={{{function2_return_type}}}|returns2={{{function2_returns_also|}}}|parameter1={{{function2_parameter1|}}}|parameter2={{{function2_parameter2|}}}|parameter3={{{function2_parameter3|}}}|parameter4={{{function2_parameter4|}}}|parameter5={{{function2_parameter5|}}}}}</p>}}{{#if: {{{function2_parameter1_desc|}}}|{{{function2_parameter1_desc}}}<br />}}{{#if: {{{function2_parameter2_desc|}}}|{{{function2_parameter2_desc}}}<br />}}{{#if: {{{function2_parameter3_desc|}}}|{{{function2_parameter3_desc}}}<br />}}{{#if: {{{function2_parameter4_desc|}}}|{{{function2_parameter4_desc}}}<br />}}{{#if: {{{function2_parameter5_desc|}}}|{{{function2_parameter5_desc}}}<br />}}{{#if: {{{function3_return_type|}}}|<p>{{Function|function_name={{{page_name}}}|returns={{{function3_return_type}}}|returns2={{{function3_returns_also|}}}|parameter1={{{function3_parameter1|}}}|parameter2={{{function3_parameter2|}}}|parameter3={{{function3_parameter3|}}}|parameter4={{{function3_parameter4|}}}|parameter5={{{function3_parameter5|}}}}}</p>}}{{#if: {{{function3_parameter1_desc|}}}|{{{function3_parameter1_desc}}}<br />}}{{#if: {{{function3_parameter2_desc|}}}|{{{function3_parameter2_desc}}}<br />}}{{#if: {{{function3_parameter3_desc|}}}|{{{function3_parameter3_desc}}}<br />}}{{#if: {{{function3_parameter4_desc|}}}|{{{function3_parameter4_desc}}}<br />}}{{#if: {{{function3_parameter5_desc|}}}|{{{function3_parameter5_desc}}}<br />}}{{#if: {{{function4_return_type|}}}|<p>{{Function|function_name={{{page_name}}}|returns={{{function4_return_type}}}|returns2={{{function4_returns_also|}}}|parameter1={{{function4_parameter1|}}}|parameter2={{{function4_parameter2|}}}|parameter3={{{function4_parameter3|}}}|parameter4={{{function4_parameter4|}}}|parameter5={{{function4_parameter5|}}}}}</p>}}{{#if: {{{function4_parameter1_desc|}}}|{{{function4_parameter1_desc}}}<br />}}{{#if: {{{function4_parameter2_desc|}}}|{{{function4_parameter2_desc}}}<br />}}{{#if: {{{function4_parameter3_desc|}}}|{{{function4_parameter3_desc}}}<br />}}{{#if: {{{function4_parameter4_desc|}}}|{{{function4_parameter4_desc}}}<br />}}{{#if: {{{function4_parameter5_desc|}}}|{{{function4_parameter5_desc}}}<br />}}{{#if: {{{function5_return_type|}}}|<p>{{Function|function_name={{{page_name}}}|returns={{{function5_return_type}}}|returns2={{{function5_returns_also|}}}|parameter1={{{function5_parameter1|}}}|parameter2={{{function5_parameter2|}}}|parameter3={{{function5_parameter3|}}}|parameter4={{{function5_parameter4|}}}|parameter5={{{function5_parameter5|}}}}}</p>}}{{#if: {{{function5_parameter1_desc|}}}|{{{function5_parameter1_desc}}}<br />}}{{#if: {{{function5_parameter2_desc|}}}|{{{function5_parameter2_desc}}}<br />}}{{#if: {{{function5_parameter3_desc|}}}|{{{function5_parameter3_desc}}}<br />}}{{#if: {{{function5_parameter4_desc|}}}|{{{function5_parameter4_desc}}}<br />}}{{#if: {{{function5_parameter5_desc|}}}|{{{function5_parameter5_desc}}}<br />}}
 +
{{#if: {{{function_description|}}}|<p>{{{function_description}}}</p>}}
 +
{{#if: {{{code1|}}}|{{{code1}}}}}{{#if: {{{code2|}}}|{{{code2}}}}}{{#if: {{{code3|}}}|{{{code3}}}}}{{#if: {{{code5|}}}|{{{code4}}}}}{{#if: {{{code5|}}}|{{{code5}}}}}{{#if: {{{cli_equiv|}}}|<h2>CLI Equivalent</h2><p>{{{cli_equiv}}}</p>}}{{#if: {{{see_also|}}}|{{{see_also|}}}}}{{#if: {{{more_info|}}}|<h2>More Information</h2><p>{{{more_info}}}</p>}}{{#if: {{{special|}}}|<h2>Special</h2><p>{{{special}}}</p>}}
 +
[[Category:Ash Functions]]
 +
{{#if: {{{function_category|}}}|[[Category:{{{function_category}}}]]}}
 
</includeonly>
 
</includeonly>

Revision as of 15:58, 25 February 2010

This is template for a function page (for just a function line, see "Template:Function").

The following is the full function call with all possible parameters. Please note that you would rarely, if ever, require everything shown.

{{FunctionPage|
page_name=FUNCTION_NAME|
function_category=CATEGORY|
function1_return_type=DATATYPE|
function1_returns_also=SECONDARY_DATAYPE_OR_DELETE|
function1_parameter1={{Param|TYPE|SHORTDESC}}|
function1_parameter1_desc=DESCRIPTION_OF_PARAM|
function1_parameter2={{Param|TYPE|SHORTDESC}}|
function1_parameter2_desc=DESCRIPTION_OF_PARAM|
function1_parameter3={{Param|TYPE|SHORTDESC}}|
function1_parameter3_desc=DESCRIPTION_OF_PARAM|
function1_parameter4={{Param|TYPE|SHORTDESC}}|
function1_parameter4_desc=DESCRIPTION_OF_PARAM|
function1_parameter5={{Param|TYPE|SHORTDESC}}|
function1_parameter5_desc=DESCRIPTION_OF_PARAM|
function2_return_type=DATATYPE|
function2_returns_also=SECONDARY_DATAYPE_OR_DELETE|
function2_parameter1={{Param|TYPE|SHORTDESC}}|
function2_parameter1_desc=DESCRIPTION_OF_PARAM|
function2_parameter2={{Param|TYPE|SHORTDESC}}|
function2_parameter2_desc=DESCRIPTION_OF_PARAM|
function2_parameter3={{Param|TYPE|SHORTDESC}}|
function2_parameter3_desc=DESCRIPTION_OF_PARAM|
function2_parameter4={{Param|TYPE|SHORTDESC}}|
function2_parameter4_desc=DESCRIPTION_OF_PARAM|
function2_parameter5={{Param|TYPE|SHORTDESC}}|
function2_parameter5_desc=DESCRIPTION_OF_PARAM|
function3_return_type=DATATYPE|
function3_returns_also=SECONDARY_DATAYPE_OR_DELETE|
function3_parameter1={{Param|TYPE|SHORTDESC}}|
function3_parameter1_desc=DESCRIPTION_OF_PARAM|
function3_parameter2={{Param|TYPE|SHORTDESC}}|
function3_parameter2_desc=DESCRIPTION_OF_PARAM|
function3_parameter3={{Param|TYPE|SHORTDESC}}|
function3_parameter3_desc=DESCRIPTION_OF_PARAM|
function3_parameter4={{Param|TYPE|SHORTDESC}}|
function3_parameter4_desc=DESCRIPTION_OF_PARAM|
function3_parameter5={{Param|TYPE|SHORTDESC}}|
function3_parameter5_desc=DESCRIPTION_OF_PARAM|
function4_return_type=DATATYPE|
function4_returns_also=SECONDARY_DATAYPE_OR_DELETE|
function4_parameter1={{Param|TYPE|SHORTDESC}}|
function4_parameter1_desc=DESCRIPTION_OF_PARAM|
function4_parameter2={{Param|TYPE|SHORTDESC}}|
function4_parameter2_desc=DESCRIPTION_OF_PARAM|
function4_parameter3={{Param|TYPE|SHORTDESC}}|
function4_parameter3_desc=DESCRIPTION_OF_PARAM|
function4_parameter4={{Param|TYPE|SHORTDESC}}|
function4_parameter4_desc=DESCRIPTION_OF_PARAM|
function4_parameter5={{Param|TYPE|SHORTDESC}}|
function4_parameter5_desc=DESCRIPTION_OF_PARAM|
function5_return_type=DATATYPE|
function5_returns_also=SECONDARY_DATAYPE_OR_DELETE|
function5_parameter1={{Param|TYPE|SHORTDESC}}|
function5_parameter1_desc=DESCRIPTION_OF_PARAM|
function5_parameter2={{Param|TYPE|SHORTDESC}}|
function5_parameter2_desc=DESCRIPTION_OF_PARAM|
function5_parameter3={{Param|TYPE|SHORTDESC}}|
function5_parameter3_desc=DESCRIPTION_OF_PARAM|
function5_parameter4={{Param|TYPE|SHORTDESC}}|
function5_parameter4_desc=DESCRIPTION_OF_PARAM|
function5_parameter5={{Param|TYPE|SHORTDESC}}|
function5_parameter5_desc=DESCRIPTION_OF_PARAM|
function_description=DESCRIPTION_OF_FUNCTION|
code1={{CodeSample|
title=CODE EXAMPLE TITLE|
description=DESCRIPTION OF CODE|
code=
<syntaxhighlight lang="c">
CODE GOES HERE
</syntaxhighlight>}}|
code2={{CodeSample|
title=CODE EXAMPLE TITLE|
description=DESCRIPTION OF CODE|
code=
<syntaxhighlight lang="c">
CODE GOES HERE
</syntaxhighlight>}}|
code3={{CodeSample|
title=CODE EXAMPLE TITLE|
description=DESCRIPTION OF CODE|
code=
<syntaxhighlight lang="c">
CODE GOES HERE
</syntaxhighlight>}}|
code4={{CodeSample|
title=CODE EXAMPLE TITLE|
description=DESCRIPTION OF CODE|
code=
<syntaxhighlight lang="c">
CODE GOES HERE
</syntaxhighlight>}}|
code5={{CodeSample|
title=CODE EXAMPLE TITLE|
description=DESCRIPTION OF CODE|
code=
<syntaxhighlight lang="c">
CODE GOES HERE
</syntaxhighlight>}}|
see_also={{SeeAlso|FIRST|SECOND|ETC}}|
cli_equiv=LIST CLI EQUIVALENT|
more_info=A LINE TO NOTIFY OF EXTERNAL INFO|
special=SPECIAL NOTES SUCH AS NOT-LOGGED-IN VALUE
}}

Replace everything in CAPS with appropriate information for the given page.


Retrieved from "https://wiki.kolmafia.us/index.php?title=User:StDoodle/FunctionPage_sandbox&oldid=3761"