User Defined Functions Public Build Templates

This Page contains instructions on using the BuildTemplates Application:

This version of the application is trimmed down from the one I use that helps me not miss any steps in getting the UDFs submitted.

This is for those who wish to check the includes they are going to submit.

The below seems like a lot of work to get an include file submitted but in the long run it saves a lot of time and trouble.

Download: Build Templates Application

Instructions for setting up include file(s)

1. The include file will need some custom sections/Tokens for the application to work correctly
2. The header information needs to be formatted so that text to be displayed starts on column 20
3. Flags in Headers:
• + in column 20 is the continuation flag for the previous line (used in Parameters, Return Values)
• | in column 20 is a new line in the right side of the table when the help file is generated (used in Parameters, Return Values)
• - in column 20 will create new row in the table, used for things like Defaults for a style (used in Parameters, Return Values)
• + in column 2 of Remarks is a blank line
4. Tokens that the application processes:
• 1st Token must be the ; #INDEX# 
• 1st line after the token must contain the Title line for example:

• ; Title .........: Array

• Any lines after the above line in the index section is ignored
• 2nd Token  must be the ; #CURRENT#
• each line after the token is the function names to process with a ; in the 1st column and the function name starting in the 2nd column
• to end this section place ; with at least 1 space after it after the last function in the list
• Function tokens can be 1 of 2 tokens:
• ; #FUNCTION#
• Note functions using token must be in the same order as in the ; #CURRENT#
• Only Parameters, Return Values, and Remarks can have multiple lines
• Parameters and Return Values
• Variable name starts on column 20
• followed by at least 1 space and - and another space followed by the description of the variable, for Example:

• ; Parameters ....: $hWnd - Handle to the control ;                         $aItems - Array with the following format: ;                         |[0][0] - Item 1 Text ;                         |[0][1] - Item 1 Subitem 1 text ;                         |[0][2] - Item 1 Subitem 2 text ;                         |[0][n] - Item 1 Subitem n text ;                         |[1][0] - Item 2 Text ;                         |[1][1] - Item 2 Subitem 1 text ;                         |[1][2] - Item 2 Subitem 2 text ;                         |[1][n] - Item 2 Subitem n text

• ; #INTERNAL_USE_ONLY#
• Functions with these tokens will be skipped by the application
• be sure these are NOT in the ; #CURRENT# section
• These functions can be any where in the file after the ; #CURRENT# section
5. Not all the UDF include files have this format at this time, but when I have to work on one it will be converted over to use this process
6. Look at an include if not sure, a good example would be EventLog.au3