Creating help files for Parameter Schemas

To help users enter data correctly for parameters defined in Parameter Schemas, you can create HTML Web pages—that appear in Template Builder— that contains text explaining this parameter’s function, purpose and any other information you deem necessary.

Procedure

  1. Create an HTML file as follows:
    <html>
    	<head>
    		<title>My Template Building Block</title>
    	</head>
    	<style>
    		body {background-color: rgb(240,240,240)}
    		h1 { font-family: sans-serif; font-size: medium  }
    		h2 { font-family: sans-serif; font-size: small  }
    		p { font-family: sans-serif; font-size: x-small }
    		dt { font-family: sans-serif; font-weight: bolder; font-size: x-small }
    		dd { font-family: sans-serif; font-size: x-small }
    	</style>
    	<body>
    		<h1>My Template Building Block</h1>
    		<p>Description...</p>
    		<h2>Parameters</h2>
    		<dl>
    			<dt><a name="Parameter1XMLName">My parameter</a></dt>
    			<dd>Description....</dd>
    			<dt><a name="Parameter2XMLName">My second parameter</a></dt>
    			<dd>Description....</dd>
    		</dl>
    		<br/><br/><br/><br/><br/><br/>
    	</body>
    </html>
    For each parameter, add an anchor element whose name matches its XML element name followed by the parameter description:
    <h2>Parameters</h2>
    		<dl>
    			<dt><a name="Parameter1XMLName">My parameter</a></dt>
    			<dd>Description....</dd>
    		</dl>
  2. Save the help file to your SDL Tridion installation TempateParametersDescriptions folder, by default: C:/Program Files/Tridion/Web/TemplateBuilder/TempateParametersDescriptions.
  3. Connect the help file to the Parameters Schema, depending on the type of the Template Building Block:
    • For <cSharpTemplate>s, assuming that you have already embedded the Parameter Schema in the Template Building Block assembly, specify the HelpFileName class attribute.
    • For <dreamweaverTemplate>s and <compoundTemplate>s, open the XML setup file and specify helpFile attribute in the <parametersSchema> element.