Tag Reference

SQLHelp provides a rich set of commands for use in the source SQL to produce formatted, professional compiled help. Each of these tags can appear more than once in a batch, but must appear within the create procedure portion of the batch to be processed.

If the identical tag name is encountered, the system will append (concatenate) the value to the previous value. This allows for greater readability of the source file, and ease of documentation.

Tags may make use of any valid HTML syntax to create more detailed help.

Tag	Description
##AT	Provides an "Applies To" description. The "Applies To" section allows the developer the capability to group functional procedures in the final compiled output. Note the default organization of returns data, transactional, updates data, and cursors remains. This tag may appear in the SQLHelp.ini file or the batch as required.
##BD	Provides a batch description.
##CO	Provides a copyright description. May only be used in the SQLHelp.ini file.
##CU	When working in annotation override mode, denotes a procedure which uses cursors.
##EP	Defines the purpose of a called procedure
##EX	Provides an example description. The example must be a fully self contained example of the intended use of the procedure.
##MD	When working in annotation override mode, denotes a procedure which modifies data.
##NOV	Reverses any override directive in effect. If no override directive is in effect, the ##NOV tag has no effect.
##OV	Denotes an overridden procedure. Overridden procedures do not have their return values or result sets parsed. Only the values explicitly named are included in the compiled help.
##PD	Provides a parameter description.
##PR	Provides a project description. All ##PR tags in the project are combined to make the final title page. Note: ##PR tags may only appear in the SQLHelp.ini file.
##RD	Provides a return value description.
##RS	Provides a result set return column description.
##RSD	Provides a result set description.
##SA	Provides a "See Also" link description.
##TR	When working in annotation override mode, denotes a procedure which is transactional.