📄 manual.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html lang="en">
<head lang="en">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<meta http-equiv="Content-Language" content="en">
<meta name="author" content="Gerold Veith">
<meta name="description" content="Manual of JADD - Just Another DelphiDoc">
<meta name="keywords" content="Manual, Help, DelphiDoc, KylixDoc, JADD, Just Another DelphiDoc, Delphi, Kylix, Documentation, HTML, RTF, TeX, LaTeX, PDF, Portable Document Format, XMI, UML, Diagram">
<meta name="DC.Language" content="en">
<title>
Manual of JADD - Just Another DelphiDoc
</title>
</head>
<body lang="en">
<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">
<h1>JADD - Just Another <em>DelphiDoc</em></h1>
<h2>Table of Contents</h2>
<ul>
<li><a href="#Usage">General Usage</a></li>
<li><a href="#GUIHelp">Generating Documentation as a help on a
Graphical User Interface (GUI)</a></li>
<li><a href="#GUI">The Graphical User Interface (GUI)</a> of this program</li>
<li><a href="#Parameters">Command Line Parameters</a></li>
<li>> <a href="comments.html">Comments</a></li>
<li><a href="#Format">Documentation Formats</a>
<ul>
<li><a href="#FormatHTML">HTML</a></li>
<li><a href="#FormatHTMLHelp">Windows HTML Help</a></li>
<li><a href="#FormatWinHelp">Windows Help Files</a></li>
<li><a href="#FormatLaTeX">L<small><sup>A</sup></small>T<small><sub>E</sub></small>X</a></li>
<li><a href="#FormatPDF">PDF - Portable Document Format</a></li>
<li><a href="#FormatUMLXMIExport">XMI - XML Metadata Interchange - UML export</a></li>
</ul>
</li>
<li>> <a href="options.html">Options of the Generators</a></li>
<li>> <a href="files.html">Files used by this Program</a></li>
</ul>
<h2><a name="Usage">Usage</a></h2>
<p>This is a very short description what to do to generate some
documentation. Please use the F1 key to access the corresponding
help.</p>
<p>When the program starts the welcome register is shown, with the tree
view on left another one of more then two dozen registers can be shown.
As can be seen from the layout of the tree view the program consists
roughly of two parts. With the first part under the main entry
"Acquire Parsed Data" some source code files can be parsed, on which in
the second part below "Generate Documentation" exactly this can be
done.</p>
<p>To parse new source files the register "Select Files" should be shown
and the source files be added to its list. This is simplest done by
dragging the project file, the <code>.dpr</code>-file, from the explorer
in the form and checking the new entry. After that is done on the
register "Parse" the button with the same caption can be used to parse
the source code. If conditional compiling is used within the project the
version of Delphi to emulate while parsing the source code can be
selected in the register "Compiler Options" before the code is
parsed.<p>
<p>Now the format of the documentation to be generated can be selected on
the register "Select Generator". The generators and all other objects
that are used to create the documentation have several (lots of)
<a href="options.html">options</a> to tweak the gathering of information
and the result. The button "By Category" will show a dialog to edit the
options of the generator.<br>
Then the register "Generate" should be selected. Here the directory to
generate the documentation to can be entered, it should be
<em>empty</em> because all files in it will be
<strong>overwritten</strong> when they are part of the new documentation
and already exist. The directory will be created if it does not exist.
All options of all objects used to generate the documentation can be
edited again with the button "Edit all Options by Category". And finally
the generation of the documentation can be started by pressing the
button "Generate Documentation".</p>
<h2><a name="GUIHelp">Generating Documentation as a help on a
Graphical User Interface (GUI)</a></h2>
<p>To generate documentation as a help on a GUI there are three steps to
do: Generating a log file, writing the documentation and generating
the final documentation in the target format.</p>
<p>In order to generate the log file the unit <code>UFormHelp</code> in
the directory GUI in the source tree has to be included in the
application. The unit will automatically show a window to generate a
log file of all visible components on a form of the application and
save a screen shot of it. The currently active window should
automatically be selected, if there is a page control on the page a
prefix of the currently active page should also automatically be set.
To use the window with modal dialogs there is also a button to re-show
the window after a few seconds after the modal window has been shown,
so it can still be accessed.<br>
When the generation of the log file is started it is generated in the
specified directory. The name of the file is assembled from the name
of the form, the prefix and the extension <code>.log</code>. The
screen shot is saved in a file with the same name but with the
extension <code>.bmp</code>.</p>
<p>The documentation of the GUI is written in simple text files, just
like additional user documentation. It has to be in a file with the
same name as the log file but with the extension <code>.txt</code>.
The documentation itself is in <code>~GUI</code> sections similar to
the additional user documentation's <code>~Page</code> sections.<br>
Other files may be included in <code>~GUIInclude</code> sections,
similar to the <code>~[userDoc ]</code> inline command. Aliases to let
several components use the same documentation can be defined in
<code>~GUIAlias</code> sections, additional regions in the screen shot
may be defined as links manually in <code>~GUIManual</code> sections.
Links to the documentation topics can be generated within this
documentation or the additonal user documentation with the
<code>~[linkGUI ]</code> inline command similar to the
<code>~[linkPage ]</code> command of the user documentation.<br>
Please see the documentation on <a href="comments.html">these sections
and the inline command</a>. Also notice the three special topics for the
<code>~GUI</code> sections.</p>
<p>In order to generate the documentation in the final format with
<em>DelphiDoc</em> the appropriate generator has to be chosen and
the log files of the GUIs to generate the documentation about be added
in the register "GUI Help Log Files". Then the button
"Generate Help on GUI" on the next register can be used.</p>
<p>As always you change some options of the generator before generating
the documentation, localize some used texts or define some files with
additional user documentation to include. There are four options
specific to this kind of documentation, first two for all generators
(in <code>TJaddCommentData</code> or <code>TFormatCommentDoc</code>),
the option <code>UseAutoAliases</code> to specify whether the
automatically generated aliases (from labels to the control they
describe (linked via their <code>FocusControl</code> property)) should
be used and the other <code>GUIHelpUseTopicAsLinkText</code> to
specify the alternative texts for the links inside the screen shot for
the HTML formats, if it is enabled the title of its comment will be
used instead of the name of the component.<br>
The two other options are specific to the PDF generator, more
precisely to the screen shot in this format:
<code>InterpolateGUIHelpImages</code> and
<code>MaxGUIHelpImageScale</code>. Take a look at
<a href="options.html">the descriptions of all options</a>.</p>
<p>The Windows Help file and the HTML Help file also use the
<code>HelpContext</code> property of the components and links the help
topics to them, so you can use the generated help file directly for
your application simply by specifying it in the project options.
Of course it would also be good to rename it to a fitting name for
your application (i.e. the same name as the executable with the
extension <code>.hlp</code> or <code>.chm</code>). The number of the
help context can also be defined manually in the comments with the
inline command <code>~[HelpContext <number>]</code>.<br>
<h2><a name="GUI">The Graphical User Interface (GUI)</a></h2>
<p>There is also a generated documentation for the GUI available. Choose
the window you want to read the help about and click on the image at the
top on the component you want. On the main window you may, as in the
original window, also click on in the tree at the left to change the
current page.</p>
<p>This documentation is now also included as a Windows HTML Help file
directly with the executable file, so you may simple press F1 in the
program as well.</p>
<ul>
<li>><a href="FormMain.html">The Main Window</a><br>
<i>Use the tree view at the left side to navigate through the pages
like in the original application.</i>
</li>
<li>><a href="FormShowSource.html">View parsed Source Code</a></li>
<li>><a href="FormAddInteractively.html">Interactive Parsing of Files</a></li>
<li>><a href="FormDefines.html">Compiler Options</a></li>
<li>><a href="FormCatExpert.html">Options by Category</a> and
> <a href="FormExpert.html">as a List</a></li>
<li>><a href="FormDiagram.html">Editor of Diagrams</a></li>
<li>><a href="FormComparison.html">Comparison of parsed Data</a></li>
<li>><a href="FormMessageFilter.html">Select Filter for Messages</a></li>
<li>><a href="FormGUITopics.html">Alternative Content for the Main Index</a></li>
<!-- <li>><a href="FormSelectParsedDirectory">Select Directory of parsed Files</a></li> -->
<!-- <li>><a href="FormAbout.html">About JADD - Just Another <em>DelphiDoc</em></a></li> -->
</ul>
<h2><a name="Parameters">Command Line Parameters</a></h2>
<p>Both, the GUI and the command line version support parameters specified
when starting the program. For the command line version these are
mandatory. Some of these options only work or only make sense for one of
the versions, in that case they'll be ignored by the other version.</p>
<p>The command line parameters have been completely revised in version
1.7.6.395. In most cases old parameters can still be used without much
change needed. The main difference in the concept is that now each
parameter is parsed one after another, each one is treated as a command
that will be executed directly, so parsing of the parameters works
much like a batch file. Previously first a <em>set</em> of parameters
where parsed, and only when the set was completely specified the whole
set was executed. The most obvious change in that regard will probably
be in the GUI version when the <code>-p</code> switch is used to load a
project file. While in the old version the source files were only parsed
when the set was finished (either by loading another file or with the
<code>-a</code> switch), now the files will be parsed directly. This has
also an effect on the order the parameters should be specified, while in
the old version a new set was started with the <code>-p</code> switch
and the options for the set had to be specified after it, now all
options pertaining the parsing have to be specified before the project
file is loaded.</p>
<p>The command line is also now parsed according to
<a href="http://msdn2.microsoft.com/en-us/library/ms880421.aspx">the
rules used by Microsoft</a>, avoiding the buggy <code>ParamStr</code>
and <code>ParamCount</code> functions. Additionally the parameters are
now specified similar to
<a href="http://www.gnu.org/software/libc/manual/html_node/Getopt.html">GNU's
implementation</a> of the
<a href="http://www.opengroup.org/onlinepubs/000095399/functions/getopt.html">getopt</a>
function defined in POSIX. This means that there is a long option for
each short option, and even some options for which only a long version
exists. Generally, the new long-options are recommend. The short options
are also now all case-sensitive, but they can be merged into a single
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -