Standards:function - Revision history

Sandman at 22:27, 12 September 2007

Sandman — Wed, 12 Sep 2007 22:27:11 GMT

←Older revision		Revision as of 22:27, 12 September 2007
Line 5:		Line 5:


-	Click [[Template:function\|here]] to get the template for this standard.	+	Click [[Template:function\|here]] to get the template for this standard.<br>
		+	Click [[Function_example\|here]] to get an example of this standard.

	<pre>		<pre>

Sandman at 22:17, 2 September 2007

Sandman — Sun, 02 Sep 2007 22:17:31 GMT

←Older revision		Revision as of 22:17, 2 September 2007
Line 1:		Line 1:
		+	[[Category:Standards]]
		+
	[[Standards\|'''Up to Standards''']]		[[Standards\|'''Up to Standards''']]
		+	----
		+

	Click [[Template:function\|here]] to get the template for this standard.		Click [[Template:function\|here]] to get the template for this standard.
Line 5:		Line 9:
	<pre>		<pre>
	NOTE:		NOTE:
-	In the WikiCode, before a new section there is one empty line and after there is one or none.	+	In the WikiCode, before a new section there is one empty line and after
-	Categories can either be at the top or the bottom in the WikiCode, but preferred is top as most of the pages have that.	+	there is one or none. Categories can either be at the top or the bottom
-	Add a function to the category "functions" and to any other it applies (like "~~networkdllfunctions~~"):	+	in the WikiCode, but preferred is top as most of the pages have that.
		+	Add a function to the category "functions" and to any other it applies
		+	(like "networkdll"); if it is a native function, add it do the
		+	category "native":
	[[Category:functions]]		[[Category:functions]]

Line 26:		Line 33:
	Then a white line and then a more indepth story about the function.		Then a white line and then a more indepth story about the function.
	The "[]" indicate an optional parameter. Format WikiCode function definition:		The "[]" indicate an optional parameter. Format WikiCode function definition:
-	'''DATATYPE''' example_function ( ~~<'''PARAMETERTYPE''' parametername> ,~~ [<'''PARAMETERTYPE''' parametername>] )	+
-	Notice the spaces around the '(', ',' and ')'. The functionname is in all lower case. Datatypes are always all uppercase. Parameters can differ a little.	+	'''DATATYPE''' example_function ( [<'''PARAMETERTYPE''' parametername>] )
		+
		+	Notice the spaces around the '(', ',' and ')'. The functionname is in all
		+	lower case, unless otherwise stated by the creator of the function.
		+	Datatypes are always all uppercase. Parameters can differ a little, but
		+	are mostly only lowercase.
	</pre>		</pre>

Line 41:		Line 53:
	<pre>		<pre>
	NOTE:		NOTE:
-	Use a list, it will result in a much better look. The "-" could be left out, but actually looks nice.	+	Use a list, it will result in a much better look. The "-" could be left out,
		+	but actually looks nice.
	</pre>		</pre>

Line 63:		Line 76:

	== Errors ==		== Errors ==
-	List all [[error]]s which could be thrown by use of this function. If you don't know how or the function doesn't throw errors, just leave this section out. If you're certain it errors something, leave a notice that it errors something, but you don't know what.	+	List all [[error]]s which could be thrown by use of this function. If you
		+	don't know how or the function doesn't throw errors, just leave this section
		+	out. If you're certain it errors something, leave a notice that it errors
		+	something, but you don't know what.

	== Notes ==		== Notes ==
-	Here are some notes, which explains some parts in more depth. Mostly not needed, in which case it can be left out.	+	Here are some notes, which explains some parts in more depth. Mostly not
		+	needed, in which case it can be left out.

	== Example ==		== Example ==
Line 80:		Line 97:
	<pre>		<pre>
	NOTE:		NOTE:
-	Please keep "tabs" at 4 spaces. Try to make the code look tidy and readable. Under the code,	+	Please keep "tabs" at 4 spaces. Try to make the code look tidy and readable.
-	outside the pre-tags, list the functions used and possible other useful pages, like the page	+	Under the code, outside the pre-tags, list the functions used and possible
-	about pointers if the example relies on the knowledge of pointers. ~~Like so~~:	+	other useful pages, like the page about pointers if the example relies on the
		+	knowledge of pointers. First list the functions, then general pages and last
		+	language pages. The last two aren't commonly useful, meaning that a link to
		+	[[Begin]] for example is rarely needed. Consider this example:
		+
	Used in example: [[new_map]](), [[map_clear]](), [[pointer]]		Used in example: [[new_map]](), [[map_clear]](), [[pointer]]
	</pre>		</pre>

Sandman at 00:26, 24 July 2007

Sandman — Tue, 24 Jul 2007 00:26:39 GMT

←Older revision		Revision as of 00:26, 24 July 2007
Line 15:		Line 15:

	==Definition==		==Definition==
-	'''INT''' ~~Example_function~~ ( <'''INT''' example_int> , <'''WORD''' example_word> , [<'''STRING''' example_string>] )	+	'''INT''' example_function ( <'''INT''' example_int> , <'''WORD''' example_word> , [<'''STRING''' example_string>] )

	Does something.		Does something.
Line 26:		Line 26:
	Then a white line and then a more indepth story about the function.		Then a white line and then a more indepth story about the function.
	The "[]" indicate an optional parameter. Format WikiCode function definition:		The "[]" indicate an optional parameter. Format WikiCode function definition:
-	'''DATATYPE''' ~~Example_function~~ ( <'''PARAMETERTYPE''' parametername> , [<'''PARAMETERTYPE''' parametername>] )	+	'''DATATYPE''' example_function ( <'''PARAMETERTYPE''' parametername> , [<'''PARAMETERTYPE''' parametername>] )
-	Notice the spaces around the '(', ',' and ')'.	+	Notice the spaces around the '(', ',' and ')'. The functionname is in all lower case. Datatypes are always all uppercase. Parameters can differ a little.
	</pre>		</pre>

Sandman at 00:24, 24 July 2007

Sandman — Tue, 24 Jul 2007 00:24:01 GMT

←Older revision		Revision as of 00:24, 24 July 2007
Line 6:		Line 6:
	NOTE:		NOTE:
	In the WikiCode, before a new section there is one empty line and after there is one or none.		In the WikiCode, before a new section there is one empty line and after there is one or none.
-	Categories can either be at the top or the bottom in the WikiCode.	+	Categories can either be at the top or the bottom in the WikiCode, but preferred is top as most of the pages have that.
	Add a function to the category "functions" and to any other it applies (like "networkdllfunctions"):		Add a function to the category "functions" and to any other it applies (like "networkdllfunctions"):
	[[Category:functions]]		[[Category:functions]]
Line 25:		Line 25:
	"Does something" is a small summary of the function, in one sentence.		"Does something" is a small summary of the function, in one sentence.
	Then a white line and then a more indepth story about the function.		Then a white line and then a more indepth story about the function.
-	The "[]" indicate an optional parameter.	+	The "[]" indicate an optional parameter. Format WikiCode function definition:
		+	'''DATATYPE''' Example_function ( <'''PARAMETERTYPE''' parametername> , [<'''PARAMETERTYPE''' parametername>] )
		+	Notice the spaces around the '(', ',' and ')'.
	</pre>		</pre>

Line 44:		Line 46:
	== Returns ==		== Returns ==
	'''INT''' : Some int.		'''INT''' : Some int.
		+	{\|
		+	\| 0 \|\| - Error.
		+	\|-
		+	\| !0 \|\| - Success.
		+	\|}

	<pre>		<pre>
Line 56:		Line 63:

	== Errors ==		== Errors ==
-	List all [[error]]s which could be thrown by use of this function. If you don't know how or the function doesn't throw errors, just leave this section out.	+	List all [[error]]s which could be thrown by use of this function. If you don't know how or the function doesn't throw errors, just leave this section out. If you're certain it errors something, leave a notice that it errors something, but you don't know what.

	== Notes ==		== Notes ==

Sandman at 12:31, 1 May 2007

Sandman — Tue, 01 May 2007 12:31:15 GMT

←Older revision		Revision as of 12:31, 1 May 2007
Line 34:		Line 34:
	\| '''WORD''' example_word \|\| - Something about this word.		\| '''WORD''' example_word \|\| - Something about this word.
	\|-		\|-
-	\| ['''STRING''' example_string] \|\| - Something about this string.	+	\| ['''STRING''' example_string] \|\| - Something about this optional string.
	\|}		\|}

Sandman at 12:28, 1 May 2007

Sandman — Tue, 01 May 2007 12:28:21 GMT

←Older revision		Revision as of 12:28, 1 May 2007
Line 2:		Line 2:

	Click [[Template:function\|here]] to get the template for this standard.		Click [[Template:function\|here]] to get the template for this standard.
-
-	[[Category:functions]]

	<pre>		<pre>
Line 9:		Line 7:
	In the WikiCode, before a new section there is one empty line and after there is one or none.		In the WikiCode, before a new section there is one empty line and after there is one or none.
	Categories can either be at the top or the bottom in the WikiCode.		Categories can either be at the top or the bottom in the WikiCode.
-	Add a function to the category "functions" and to any other it applies (like "networkdllfunctions").	+	Add a function to the category "functions" and to any other it applies (like "networkdllfunctions"):
		+	[[Category:functions]]
		+
		+	When internally linking to a function, do it like so, using the "()":
		+	[[functionname]]()
	</pre>		</pre>

Line 52:		Line 54:
	\|}		\|}
	</pre>		</pre>
		+
		+	== Errors ==
		+	List all [[error]]s which could be thrown by use of this function. If you don't know how or the function doesn't throw errors, just leave this section out.

	== Notes ==		== Notes ==
Line 68:		Line 73:
	<pre>		<pre>
	NOTE:		NOTE:
-	Please keep "tabs" at 4 spaces. Try to make the code look tidy and readable.	+	Please keep "tabs" at 4 spaces. Try to make the code look tidy and readable. Under the code,
		+	outside the pre-tags, list the functions used and possible other useful pages, like the page
		+	about pointers if the example relies on the knowledge of pointers. Like so:
		+	Used in example: [[new_map]](), [[map_clear]](), [[pointer]]
	</pre>		</pre>

FCR at 11:37, 1 May 2007

FCR — Tue, 01 May 2007 11:37:19 GMT

←Older revision		Revision as of 11:37, 1 May 2007
Line 1:		Line 1:
	[[Standards\|'''Up to Standards''']]		[[Standards\|'''Up to Standards''']]

-	Click [[Template:function\|here]] to get the template.	+	Click [[Template:function\|here]] to get the template for this standard.

	[[Category:functions]]		[[Category:functions]]

FCR at 11:36, 1 May 2007

FCR — Tue, 01 May 2007 11:36:55 GMT

←Older revision		Revision as of 11:36, 1 May 2007
Line 1:		Line 1:
	[[Standards\|'''Up to Standards''']]		[[Standards\|'''Up to Standards''']]
		+
		+	Click [[Template:function\|here]] to get the template.

	[[Category:functions]]		[[Category:functions]]

Sandman at 15:12, 23 April 2007

Sandman — Mon, 23 Apr 2007 15:12:41 GMT

←Older revision		Revision as of 15:12, 23 April 2007
Line 1:		Line 1:
-	[[Category:functions]]
-
	[[Standards\|'''Up to Standards''']]		[[Standards\|'''Up to Standards''']]
		+
		+	[[Category:functions]]

	<pre>		<pre>
Line 11:		Line 11:

	==Definition==		==Definition==
-		+	'''INT''' Example_function ( <'''INT''' example_int> , <'''WORD''' example_word> , [<'''STRING''' example_string>] )
-	'''INT''' Example_function ( <'''INT''' example_int> , <'''WORD''' example_word> , <'''STRING''' example_string> )	+

	Does something.		Does something.
Line 22:		Line 21:
	"Does something" is a small summary of the function, in one sentence.		"Does something" is a small summary of the function, in one sentence.
	Then a white line and then a more indepth story about the function.		Then a white line and then a more indepth story about the function.
		+	The "[]" indicate an optional parameter.
	</pre>		</pre>

	== Parameters ==		== Parameters ==
-
	{\|		{\|
	\| '''INT''' example_int \|\| - Something about this int.		\| '''INT''' example_int \|\| - Something about this int.
Line 31:		Line 30:
	\| '''WORD''' example_word \|\| - Something about this word.		\| '''WORD''' example_word \|\| - Something about this word.
	\|-		\|-
-	\| '''STRING''' example_string \|\| - Something about this string.	+	\| ['''STRING''' example_string] \|\| - Something about this string.
	\|}		\|}

Line 40:		Line 39:

	== Returns ==		== Returns ==
-		+	'''INT''' : Some int.
-	{\|	+
-	\| '''INT''' : Some int.	+
-	\|}	+

	<pre>		<pre>
Line 53:		Line 49:
	\| another \|\| - yadayada		\| another \|\| - yadayada
	\|}		\|}
-	I would advise to always use a list, as the line gets indented a little, which looks nice and later additions can be done more easily.
	</pre>		</pre>

	== Notes ==		== Notes ==
-
	Here are some notes, which explains some parts in more depth. Mostly not needed, in which case it can be left out.		Here are some notes, which explains some parts in more depth. Mostly not needed, in which case it can be left out.

	== Example ==		== Example ==
-
	<pre>		<pre>
	Program example;		Program example;

Sandman at 00:36, 23 April 2007

Sandman — Mon, 23 Apr 2007 00:36:29 GMT

←Older revision		Revision as of 00:36, 23 April 2007
Line 5:		Line 5:
	<pre>		<pre>
	NOTE:		NOTE:
-	In the WikiCode, before a new section there ~~are two~~ empty ~~lines~~ and after there's one.	+	In the WikiCode, before a new section there is one empty line and after there is one or none.
	Categories can either be at the top or the bottom in the WikiCode.		Categories can either be at the top or the bottom in the WikiCode.
	Add a function to the category "functions" and to any other it applies (like "networkdllfunctions").		Add a function to the category "functions" and to any other it applies (like "networkdllfunctions").
	</pre>		</pre>
-

	==Definition==		==Definition==
Line 24:		Line 23:
	Then a white line and then a more indepth story about the function.		Then a white line and then a more indepth story about the function.
	</pre>		</pre>
-

	== Parameters ==		== Parameters ==
Line 40:		Line 38:
	Use a list, it will result in a much better look. The "-" could be left out, but actually looks nice.		Use a list, it will result in a much better look. The "-" could be left out, but actually looks nice.
	</pre>		</pre>
-

	== Returns ==		== Returns ==
Line 58:		Line 55:
	I would advise to always use a list, as the line gets indented a little, which looks nice and later additions can be done more easily.		I would advise to always use a list, as the line gets indented a little, which looks nice and later additions can be done more easily.
	</pre>		</pre>
-

	== Notes ==		== Notes ==

	Here are some notes, which explains some parts in more depth. Mostly not needed, in which case it can be left out.		Here are some notes, which explains some parts in more depth. Mostly not needed, in which case it can be left out.
-

	== Example ==		== Example ==