<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html lang="en-us" xml:lang="en-us"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta name="security" content="public" /> <meta name="Robots" content="index,follow" /> <meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' /> <meta name="DC.Type" content="reference" /> <meta name="DC.Title" content="Example: Creating the Help Document" /> <meta name="abstract" content="" /> <meta name="description" content="" /> <meta name="copyright" content="(C) Copyright IBM Corporation 2006" /> <meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 2006" /> <meta name="DC.Format" content="XHTML" /> <meta name="DC.Identifier" content="helpex" /> <meta name="DC.Language" content="en-us" /> <!-- All rights reserved. Licensed Materials Property of IBM --> <!-- US Government Users Restricted Rights --> <!-- Use, duplication or disclosure restricted by --> <!-- GSA ADP Schedule Contract with IBM Corp. --> <link rel="stylesheet" type="text/css" href="./ibmdita.css" /> <link rel="stylesheet" type="text/css" href="./ic.css" /> <title>Example: Creating the Help Document</title> </head> <body id="helpex"><a name="helpex"><!-- --></a> <!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script> <h1 class="topictitle1">Example: Creating the Help Document</h1> <div><p></p> <div class="section"><p>Creating help files with GUI Builder is simple. On the properties panel for the file you are working with, set "Generate help" to true.</p> <p><strong>Figure 1: Setting the Generate Help property on the GUI Builder Properties panel</strong> <img src="rzahh049.gif" alt="Setting the Generate Help property on the GUI Builder Properties panel" /> </p> <p>The GUI Builder creates an HTML framework called a Help Document, which you can <a href="helpinfo.htm#helpinfo">edit</a>.</p> <p id="helpex__help2htm"><a name="helpex__help2htm"><!-- --></a>In order to be used at runtime, the topics within the PDML file need to be separated into individual HTML files. When you run <strong>Help Document to HTML Processing</strong>, the topics are broken into individual files and put into a subdirectory named after the Help Document and PDML file. The runtime environment expects the individual HTML files to be in a subdirectory with the same name as the Help Document and PDML file. The <strong>Help Document to HTML Processing</strong> dialog gathers the information needed and calls the HelpDocSplitter program to do the processing:</p> <p><strong>Figure 2: Help Document to HTML Processing dialog</strong> <img src="rzahh060.gif" alt="Help Document to HTML Processing dialog" /></p> <p>The Help Document to HTML Processing is started from a command prompt by typing:</p> <pre> jre com.ibm.as400.ui.tools.hdoc2htmViewer</pre> <p>Running this command requires that your <a href="pdmlbeg.htm#pdmlbeg__clpath">classpath be set up correctly</a>.</p> <p>To use the Help Document to HTML Processing, you first select the Help Document that has the same name as the PDML file. Next, you specify a subdirectory with the same name as the Help Document and PDML file for output. Select "Process" to complete the processing.</p> <p>You can split up the help document from the command line with the following command:</p> <pre> jre com.ibm.as400.ui.tools.HelpDocSplitter "helpdocument.htm" [output directory]</pre> <p>This command runs the processing that breaks up the file. You provide the name of the Help Document as input along with an optional output directory. By default, a subdirectory of the same name as the Help Document is created and the resulting files are put in that directory.</p> <p>This is an example of what a help file may look like:</p> <p><strong>Figure 3: GUI Builder help file example</strong> <img src="rzahh014.gif" alt="GUI Builder help file example" /></p> </div> </div> </body> </html>