Custom HTML markup in your topics

Of course you can also add custom markup into your topic content. Because Help Builder eventually renders to HTML it makes sense that you should be able to embed HTML into your topic content as well.

Help Builder uses a special format of HTML that we call Formatted HTML in its content fields. This formatted HTML uses double chevrons ( <<tag>> ), rather than single chevrons ( <tag> ) for embedding HTML into your document.

Why, you might ask? Well, when you enter text into Help Builder you're entering content NOT HTML. If we provided only HTML input a lot of text would have to be created. So, rather we assume the text you type is content and you want all text to be converted into HTML. This means when you type something like like this:

<smile>

we assume you actually want to display <smile> in your help text and not have the help file interpret the text as HTML. So, when you type you can type anything you want and Help Builder will take care of the conversion into proper HTML - linebreaks are automatically added and all text is automatically encoded.

But what if I really want to embed some HTML into my content?

We allow you to do that by using one of two ways:

Embedding double chevrons

Note that if you really have to embed double chevrons into the document you will have to format them specially either with an extra space like so: < < > > or by encoding them with (minus the spaces):

& lt;< tag >& gt;




  Last Updated: 1/19/2005 | © West Wind Techologies, 2007