Editing Template:Function

<noinclude>
__NOTOC__
{{Incomplete}}

This is a WIP, feedback is appreciated. To retain readability a lot of HTML comments are used, they shouldn't impact the working of the template, but could add to the confusion a bit. Example in the [[Sandbox#Function_Template_Test|Sandbox]].

 <nowiki>{{Function</nowiki>
  ''CSWikiPage''        = name of corresponding page on the [http://cs.elderscrolls.com/constwiki/index.php/Category:Functions TES CS Wiki]
  origin            = whether the function came from the GECK itself or was added by FOSE.
                      valid values: GECK1 (GECK 1.1), FOSE0001 (FOSE v0001)
  summary           = description of the function
  ''name''              = the name of the function. The page name is the default value.
  ''shortname''         = An abbreviated version of the function name that can be
                      used instead of the long name.
  ''returnVal ''        = what the function returns
  returnType        = the type of the returned value. Use void if there is no return value.
  ''referenceType''     = if appropriate, the type of reference that the function may be called
                      on with the dot syntax
  ''arguments''         = List of arguments specified using the [[Template:FunctionArgument]] template,
                      or any other wiki syntax.
  ''example''           = optionally, the function used as part of a script to serve as an example
  ''CategoryList''      = the list of categories to which the page belongs
 <nowiki>}}</nowiki>

=Example=

<pre>{{Function
|name = Test
|origin = GECK1
|shortname = tst
|summary = Does stuff
|returnType = void
|arguments = {{FunctionArgument
    |Name = Count
    |Type = int
  }}{{FunctionArgument
    |Name = Target
    |Type = ref
    |Optional = y
  }}
}}</pre>

=Result=

{{Function
|name = Test
|origin = GECK1
|shortname = tst
|summary = Does stuff
|returnType = void
|arguments = {{FunctionArgument
    |Name = Count
    |Type = int
  }}{{FunctionArgument
    |Name = Target
    |Type = ref
    |Optional = y
  }}
}}

</noinclude><includeonly><!--

Back to: link-->{{Bc|Category:Functions}}<!--

link to the CS Wiki page
-->{{ #if: {{{CSWikiPage|}}} | Link to TES4 Construction Set Wiki: [http://cs.elderscrolls.com/constwiki/index.php/{{{CSWikiPage}}} {{{CSWikiPage}}}].|<!-- no CSwiki page -->}}<!--

line about the origin of the function (GECK1, FOSE0001)
-->
{{ #switch: {{{origin}}}
| GECK1    = A function included in the GECK version 1.1.0.36.
| FOSE0001 = A function added by the [[Fallout Script Extender]].
| #default = {{Error|missing function origin info}}
}}<!--

short summary of the function: -->
== Description ==
{{{summary}}}

<!-- syntax starts here: -->
== Syntax ==

<!-- return value:
--><pre>{{ #ifeq: {{{returnType}}} | void |<!-- no Return Value -->|({{ #if: {{{returnVal|}}} | {{{returnVal}}}<nowiki>:</nowiki> |}}<!--

return type (short, float, base object, ref, something else?):
-->{{ #ifeq: {{{returnType|missing}}} | missing | '''missing return type!''' | {{{returnType}}})&nbsp; }} }}<!--

optional reference type (actor, activator, door, etc.):
-->{{ #if: {{{referenceType|}}} |''{{{referenceType}}}.''|<!-- no Reference Type -->}}<!--

the actual function:
-->{{{name|{{PAGENAME}}}}}<!--

arguments
-->{{ #if: {{{arguments|}}} | {{{arguments}}} |<!-- no Arguments -->}}</pre><!--

<!-- FOR ALIAS: return value:
-->{{ #if: {{{shortname|}}} | Or:
<pre>{{ #ifeq: {{{returnType}}} | void |<!-- no Return Value -->|({{ #if: {{{returnVal|}}} | {{{returnVal}}}<nowiki>:</nowiki> |}}<!--

return type (short, float, base object, ref, something else?):
-->{{ #ifeq: {{{returnType|missing}}} | missing | '''missing return type!''' | {{{returnType}}})&nbsp; }} }}<!--

optional reference type (actor, activator, door, etc.):
-->{{ #if: {{{referenceType|}}} |''{{{referenceType}}}.''|<!-- no Reference Type -->}}<!--

shortname:
-->{{{shortname}}}<!--

arguments
-->{{ #if: {{{arguments|}}} | {{{arguments}}} |<!-- no Arguments -->}} </pre>|<!-- no Alias -->}}<!--

example: -->
{{ #if: {{{example|}}} | == Example ==
 {{{example}}} |<!-- no Example -->}}<!--

categorization code (needs something clever): -->{{{CategoryList|}}}</includeonly>