📄 formmain.mfguihelp.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-15">
<meta http-equiv="Content-Style-Type" content="text/css">
<title>Page Generate Help on a GUI - Help on GUI of JADD - Just Another DelphiDoc - JADD - Just Another DelphiDoc</title>
<meta name="keywords" content="Page Generate Help on a GUI">
<meta name="Generator" content="JADD - Just Another DelphiDoc">
<link rel="stylesheet" type="text/css" href="DelphiDoc.css" title="Style">
</head>
<body>
<table width="100%" class="headerlinks"><tbody><tr>
<td align="center"><a href="index.html">Index</a></td>
</tr></tbody></table>
<hr>
<p align="center">
<!-- local -->
<a href="http://sourceforge.net/"><img
src="sflogo.png"
width="210" height="62" border="0" alt="SourceForge.net Logo"
align="right"></a>
<!-- /local -->
<!-- public - -!
<a href="http://sourceforge.net/"><img
src="http://sourceforge.net/sflogo.php?group_id=113456&type=5"
width="210" height="62" border="0" alt="SourceForge.net Logo"
align="right"></a>
<!- - /public -->
Homepage: <a href="http://delphidoc.sourceforge.net/">http://delphidoc.sourceforge.net/</a><br>
Project-Page: <a href="http://sourceforge.net/projects/delphidoc/">http://sourceforge.net/projects/delphidoc/</a><br>
</p>
<br clear="all">
<div align="center"><a name="X.top" id="X.top">Click component for help:</a></div>
<div class="imgparagraph" align="center">
<map name="imagemap17" id="imagemap17"><area shape="rect" coords="4,42,148,58" alt="Main Form" title="Main Form" href="FormMain.html">
<area shape="rect" coords="4,58,148,74" alt="Page Acquire Parsed Data" title="Page Acquire Parsed Data" href="FormMain.MFAcquireParsedData.html">
<area shape="rect" coords="4,74,148,90" alt="Page Load and Save Parsed Data" title="Page Load and Save Parsed Data" href="FormMain.MFLoadParsedData.html">
<area shape="rect" coords="4,90,148,106" alt="Page Parsing Files Main" title="Page Parsing Files Main" href="FormMain.MFParseMain.html">
<area shape="rect" coords="4,106,148,122" alt="Page Select Files to Parse" title="Page Select Files to Parse" href="FormMain.MFSelectFiles.html">
<area shape="rect" coords="4,122,148,138" alt="Page Exclude Files from Parsing" title="Page Exclude Files from Parsing" href="FormMain.MFExcludeFromParsing.html">
<area shape="rect" coords="4,138,148,154" alt="Page Select Library Files" title="Page Select Library Files" href="FormMain.MFSelectLibraryFiles.html">
<area shape="rect" coords="4,154,148,170" alt="Page Compiler Options" title="Page Compiler Options" href="FormMain.MFCompilerOptions.html">
<area shape="rect" coords="4,170,148,186" alt="Page Load Project to Parse" title="Page Load Project to Parse" href="FormMain.MFLoadProject.html">
<area shape="rect" coords="4,186,148,202" alt="Page Parse Files" title="Page Parse Files" href="FormMain.MFParse.html">
<area shape="rect" coords="4,202,148,218" alt="Page Messages after Parsing" title="Page Messages after Parsing" href="FormMain.MFParseMessages.html">
<area shape="rect" coords="4,218,148,234" alt="Page Unknown Identifiers" title="Page Unknown Identifiers" href="FormMain.MFUnknownIdents.html">
<area shape="rect" coords="4,234,148,250" alt="Page Show Source Code" title="Page Show Source Code" href="FormMain.MFShowSource.html">
<area shape="rect" coords="4,250,148,266" alt="Page Keep and Select Parsed Data" title="Page Keep and Select Parsed Data" href="FormMain.MFKeepSelectData.html">
<area shape="rect" coords="4,266,148,282" alt="Page Generate Documentation Main" title="Page Generate Documentation Main" href="FormMain.MFGenerateMain.html">
<area shape="rect" coords="4,282,148,298" alt="Page Select the Generator" title="Page Select the Generator" href="FormMain.MFGenerator.html">
<area shape="rect" coords="4,298,148,314" alt="Page Select the Extractor of Comments" title="Page Select the Extractor of Comments" href="FormMain.MFExtractor.html">
<area shape="rect" coords="4,314,148,330" alt="Page Select the Evaluator of Texts" title="Page Select the Evaluator of Texts" href="FormMain.MFEvaluator.html">
<area shape="rect" coords="4,330,148,346" alt="Page Localization" title="Page Localization" href="FormMain.MFLocalization.html">
<area shape="rect" coords="4,346,148,362" alt="Page User Documentation" title="Page User Documentation" href="FormMain.MFUserDoc.html">
<area shape="rect" coords="4,362,148,378" alt="Page Generate the Documentation" title="Page Generate the Documentation" href="FormMain.MFGenerate.html">
<area shape="rect" coords="4,378,148,394" alt="Page Status Text of Generator" title="Page Status Text of Generator" href="FormMain.MFStatusText.html">
<area shape="rect" coords="4,394,148,410" alt="Page Messages of Generation" title="Page Messages of Generation" href="FormMain.MFGenerateMessages.html">
<area shape="rect" coords="4,410,148,426" alt="Page Select log files of GUIs" title="Page Select log files of GUIs" href="FormMain.MFGUIHelpFiles.html">
<area shape="rect" coords="4,426,148,442" alt="Page Generate Help on a GUI" title="Page Generate Help on a GUI" href="FormMain.MFGUIHelp.html">
<area shape="rect" coords="4,442,148,458" alt="Page Create Diagrams of Classes and Files" title="Page Create Diagrams of Classes and Files" href="FormMain.MFDiagrams.html">
<area shape="rect" coords="4,458,148,474" alt="Page Compare Sets of Parsed Data" title="Page Compare Sets of Parsed Data" href="FormMain.MFCompare.html">
<area shape="rect" coords="4,474,148,490" alt="Page Program Options" title="Page Program Options" href="FormMain.MFProgramOptions.html">
<area shape="rect" coords="4,42,148,474" alt="Tree View" title="Tree View" href="FormMain.html#TreeView">
<area shape="rect" coords="148,42,152,474" alt="Splitter" title="Splitter" href="FormMain.html#PanelSplitter">
<area shape="rect" coords="165,433,250,461" alt="Previous and Next" title="Previous and Next" href="FormMain.html#PanelButtons">
<area shape="rect" coords="502,433,587,461" alt="Previous and Next" title="Previous and Next" href="FormMain.html#PanelButtons">
<area shape="rect" coords="154,422,595,472" alt="Previous and Next" title="Previous and Next" href="FormMain.html#PanelButtons">
<area shape="rect" coords="4,474,597,493" alt="Status Bar" title="Status Bar" href="FormMain.html#StatusBar">
<area shape="rect" coords="4,23,32,41" alt="Menu File" title="Menu File" href="FormMain.html#MenuItemMenuFile">
<area shape="rect" coords="32,23,67,41" alt="Menu View" title="Menu View" href="FormMain.html#MenuItemMenuView">
<area shape="rect" coords="67,23,101,41" alt="Menu Help" title="Menu Help" href="FormMain.html#MenuItemMenuHelp">
<area shape="rect" coords="164,248,349,261" alt="Edit Path of Documentation" title="Edit Path of Documentation" href="FormMain.MFGUIHelp.html#EditDocPath">
<area shape="rect" coords="164,297,248,310" alt="File Name of Documentation" title="File Name of Documentation" href="FormMain.MFGUIHelp.html#EditFileName">
<area shape="rect" coords="164,347,267,360" alt="Name of the Project" title="Name of the Project" href="FormMain.MFGUIHelp.html#EditProjectName">
<area shape="rect" coords="164,67,585,175" alt="No specific Help" title="No specific Help" href="FormMain.MFGUIHelp.html#X.Default">
<area shape="rect" coords="164,196,344,226" alt="Generate Documentation" title="Generate Documentation" href="FormMain.MFGUIHelp.html#ButtonGenerate">
<area shape="rect" coords="164,263,544,284" alt="Edit Path of Documentation" title="Edit Path of Documentation" href="FormMain.MFGUIHelp.html#EditDocPath">
<area shape="rect" coords="547,263,571,284" alt="Browse Directory of Documentation" title="Browse Directory of Documentation" href="FormMain.MFGUIHelp.html#ButtonBrowseDocDir">
<area shape="rect" coords="164,362,570,383" alt="Name of the Project" title="Name of the Project" href="FormMain.MFGUIHelp.html#EditProjectName">
<area shape="rect" coords="164,312,304,333" alt="File Name of Documentation" title="File Name of Documentation" href="FormMain.MFGUIHelp.html#EditFileName">
<area shape="rect" coords="319,314,555,331" alt="Javadoc compatibility" title="Javadoc compatibility" href="FormMain.MFGUIHelp.html#CheckBoxUseJavadocCharacter">
<area shape="rect" coords="365,196,545,226" alt="Edit all Options By Category" title="Edit all Options By Category" href="FormMain.MFGUIHelp.html#ButtonEditAllOptions">
<area shape="rect" coords="154,57,595,438" alt="Page to generate Help on a GUI" title="Page to generate Help on a GUI" href="FormMain.MFGUIHelp.html#MFGUIHelp">
</map>
<img src="Img17_FormMain.MFGUIHelp.png" alt="Image of the Window" usemap="#imagemap17" border="0"></div>
<h1>Documentation of the Components</h1>
<h2><a name="ButtonEditAllOptions">Edit all Options By Category</a></h2>
Show all options of the generator and all helper objects sorted by their category.
<div align="right"><a href="#X.top">top</a></div>
<h2><a name="EditDocPath">Edit Path of Documentation</a></h2>
This edit field gives the path where the documentation should be generated to. The directory should be empty, because a lot of files are generated and all files with the same name are simply overwritten without any warning. If the directory doesn't exist it is created automatically.
<div align="right"><a href="#X.top">top</a></div>
<h2><a name="ButtonBrowseDocDir">Browse Directory of Documentation</a></h2>
Shows a dialog to select the directory where the documentation should be generated to.
<div align="right"><a href="#X.top">top</a></div>
<h2><a name="EditFileName">File Name of Documentation</a></h2>
If the generator supports it, the name of the finally generated file can be entered here. The appropriate file extension will be added automatically. If the generator doesn't support it, the edit field will be gray.
<div align="right"><a href="#X.top">top</a></div>
<h2><a name="CheckBoxUseJavadocCharacter">Javadoc compatibility</a></h2>
With this checkbox the special characters to be used inside comments can be changed to be compatible with Javadoc. <em>DelphiDoc</em> uses by default the tilde "~" and brackets, "[" and "]", to create sections and use inline commands to format text. When compatibility is enabled they are changed in the options to the at-sign "@" and normal braces, "(" and ")". When it is disabled it is changed back to the defaults of the program. If the check box is grayed, the options' values are incompatible with both, Javadoc and this program's defaults.
<div align="right"><a href="#X.top">top</a></div>
<h2><a name="EditProjectName">Name of the Project</a></h2>
The name or title of the project for which the documentation is generated. Will be inserted in the documentation.
<div align="right"><a href="#X.top">top</a></div>
<h2><a name="MFGUIHelp">Page to generate Help on a GUI</a></h2>
Documentation can be generated as a help on a GUI - Graphical User Interface. For that log files of the GUI have to be generated. JADD's source distribution contains in the subdirectory GUI the file UFormHelp, that can be included in any other Delphi project to create the log files. For each log file another file (same base name, but extension .txt) should be created and contain the help on each component.<p>
<p>
For more information please take a look at the manual. JADD's source files also include the files used to generate its help (you are currently looking at it).
<div align="right"><a href="#X.top">top</a></div>
<h2><a name="ButtonGenerate">Generate Documentation</a></h2>
Generates documentation as a help of a GUI - Graphical User Interface of a program. The log file of all components first have to generated, take a look at the file <code>GUI\UFormHelp.pas</code> in the source of this program. The files first have to be selected on <a href="FormMain.MFGUIHelpFiles.html">the previous page</a>. Specified user documentation will be used, too. <p>
Not all generators support this kind of documentation, currently Windows Help files, PDF files or sets of HTML files and HTML Help can be created with this kind of documentation. Windows Help and HMTL Help will also use the help contexts of the components.
<div align="right"><a href="#X.top">top</a></div>
<h2><a name="X.Default" id="X.Default">No specific Help</a></h2>
Please see one of the contained components for a more specific help.
<div align="right"><a href="#X.top">top</a></div>
</body>
</html>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -