TagDocs

TagDocs is a documentation definition that consists of a header in each custom tag file.

The TagDocs header (defined as everything between the opening and closing Tagdocs statement) can be parsed by a custom tag (CTDump) which extracts information from the header. If there is no information, that means that the TagDocs were not defined.

Developers who add to or modify itPage custom tags will find this format very easy to use.

Purpose

The purpose of the TagDocs definition is to make it very easy to document custom tags. As long as this simple format is used, the tags will be automatically documented and the information defined in the tag can be easily extracted. The TagDocs definition's sole purpose is for documentation.

Syntax

The syntax is a an opening "Tagdocs", a series of name/value pair surrounded by braces and separated by an equal sign, and a closing "/Tagdocs". Multiple lines are allowed. Please restrict your usage of the name/value pairs to those in the example below. Note that even if there is no input the whole header should be used, although it is not required. Also note that there is no space between the element name and the equal sign.

Example

Following is an example of correct TagDocs formatting for one of the itPage custom tags. Note that this is enclosed in a block comment, which prevents Lasso from parsing it as code. Feel free to use this example in your code:

/*
Tagdocs;
	{Tagname=		Debug }
	{Description=		Creates a debug container }
	{Author=		Eric Landmann }
	{AuthorEmail=		support@iterate.ws }
	{ModifiedBy=		}
	{ModifiedByEmail=	}
	{Date=			6/23/08 }
	{Usage=			Debug;
					'SomeVar = ' $SomeVar '
				/Debug; }
	{ExpectedResults=	If $svDebug = Y, contents of debug container will be output
				If $svDebug != Y, nothing will output }
	{Dependencies=		$svDebug must be set. It is set in siteconfig.lasso, but can also be set anywhere upstream of where Debug is called. }
	{DevelNotes=		Optional parameter "Quiet" is not finished. }
	{ChangeNotes=		4/2/08
				First implementation }
/Tagdocs;
*/

Custom Tag Dump

The page http://www.itpage.ws/wiki/taglist contains a dump of the output produced from CTDump, which processes the TagDocs header.