Documentation Center

Creating help files for Parameter Schemas

To help users enter data correctly for parameters defined in Parameter Schemas, create HTML Web pages that contain text explaining each parameter’s function, purpose and any other information you deem necessary. The contents of the Web pages appear in Template Builder.

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 %TRIDION_HOME%\Web\TemplateBuilder\TemplateParametersDescriptions\.
  3. Connect the help file to the Parameters Schema, depending on the type of the Template Building Block:
    • For <cSharpTemplate> elements, assuming that you have already embedded the Parameter Schema in the Template Building Block assembly, set the HelpFileName class attribute to the name of your file.
    • For <dreamweaverTemplate> elements and <compoundTemplate> elements, open the XML setup file and in the <parametersSchema> element, set the helpFile attribute to the name of your file.