• Part I: Why User-Defined Functions (UDFs)?
• Part II: Recommended UDF Format
• Part III: Example based on the Recommended UDF Format
• Part IV: UDF Template
• Part V: Implementing UDFs into your code
  

;FUNCTION      Name_of_UDF

;

;ACTION        Short description of purpose

;

;AUTHOR        Name of author

;

;CONTRIBUTORS  Name(s) of contributor(s)

;

;VERSION       UDF version

;

;DATE CREATED  YYYY/MM/DD

;

;DATE MODIFIED YYYY/MM/DD

;

;KIXTART       Minimum required Kixtart version

;

;SYNTAX        NAME_OF_UDF(PARAMETER 1, PARAMETER2 [, PARAMETER3])

;

;PARAMETERS    PARAMETER1

;              Description of first parameter

;

;              PARAMETER2

;              Description of second parameter

;

;              PARAMETER3

;              Description of optional first parameter

;

;RETURNS       Type of return value

;

;REMARKS       Additional remarks about the UDF

;

;DEPENDENCIES  DependUDF @ http://www.kixtart.org/board/...

;              Name and URL of UDFs that this UDF depends on

;

;EXAMPLE       A short functional example demonstrating the UDF

;

;KIXTART BBS   http://www.kixtart.org/cgi-bin/ultimatebb.cgi?ubb=get_topic;f=12;t=000000

;              URL the UDF was posted under

;

function Name_of_UDF($parameter 1, $parameter2, optional $parameter3)

endfunction