Project element

First, let us change the front page of the help, by inserting a <Project> element into the help file, Tutorial1.help.xml. Paste the code marked below into the <Help> element:

CopyXML

<Help 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
    xmlns="http://schemas.planatechsolutions.com/xlp/601/help"> 
 
  <Project Title="XLL+ Tutorial">                                  
    <Description>                                                  
      <p>This add-in contains all the functions from the following 
      XLL+ Tutorial sections:                                      
      </p>                                                         
      <ul>                                                         
        <li>Getting Started</li>                                   
        <li>Basic Features</li>                                    
        <li>Intermediate Features</li>                             
      </ul>                                                        
    </Description>                                                 
  </Project>                                                       
  ...
</Help>

We've made two changes to the page here:

1. The main title of the help is now "XLL+ Tutorial".
2. We've added new content to the Description section of the page. All the HTML within the <Description> element will be inserted into the page just after the standard description.

Function element

Now we will enrich the help for the HISTVOL function. Paste the code marked below into the <Help> element:

CopyXML

<Help ...>
  ...
  <Function ExportedName="HISTVOL">                                     
    <Argument Name="Prices">                                            
      <Description>                                                     
        <p>Note that if any of the values in the series are 0 or less,  
        then the function will return #NUM!.</p>                        
      </Description>                                                    
    </Argument>                                                         
  </Function>                                                           
  ...    
</Help>

Here we have added an extra paragraph to the description of the Prices argument.

There are many other enhancements we might make to a function's help page, including:

• Adding text to the function's description.
• Adding a Remarks section.
• Adding See Also links to other pages.
• Suppressing some or all of the standard function or argument descriptions.

Other content

You can also add your own HTML files to the help system, using the AdditionalFile element. See Additional Files in the reference for more information on adding files to a help project.

You can use the Section element to enhance the content of the category pages.

See the Help Generator Reference for a complete list of the grammar of help files. The comments inserted in each new help file contain examples of most of the available elements.

Next: Testing the interactive help >>