VTML Tips and Techniques: Tagdescription

On this page:

Where's the help?
Contributions!

Although the TAGDESCRIPTION section can actually appear anywhere between or before the other sections of a tag editor file (even before the EDITORLAYOUT section if you want!) the most usual place is at the end, a fact reflected by the order in which I'm summing up the sections of the VTML Tips and Techniques.

When you specify either a help file, or include a body text, the result will be an extra area on the editor window with a line and two buttons; if you have only an empty TAGDESCRIPTION tag, that area won't appear, and if you refer to a non-existing file, it won't appear either (which can be a clue you've made a typo somewhere!). This is what it should look like, using my TAG tag editor as an example:

It is there because I had written a documentation file for the TAG tag, and I wanted to include that into the TAG tag editor.

But I had an awful lot of trouble getting it to appear; I triple-checked everything, and could not find why it didn't: the tag was syntactically correct, it was in a correct place, and it correctly referred to an existing file. It worked in every other tag editor, just not in the TAG tag editor. And if it worked everywhere else it couldn't really be a bug, could it? Solving that problem actually did not involve the TAGDESCRIPTION section at all, but only the TAGLAYOUT section. That's also the section where I'll explain the problem and the solution which turned out to be a new technique.

Do you have any VTML Tips or Techniques to share? If it's for the Tagdescription section, use the following email link, otherwise go to the page corresponding to the section it's about and use the Contributions! mail link from there, so your mail will have the correct subject.

Please explain why it's such a good tip, and illustrate with example code where appropriate. Also let me know whether you want you email address mentioned here, or only your name.

Send your contribution to: VTML Tips and Techniques Contributions

The VTML Tips and Techniques sections are:

• General
• Editorlayout section
• Attributes section
• Taglayout section
• Tagdescription section
• Tag Chooser