Introduction
Welcome
Overview
Release Notes and Version information
Time2HELP 1.0.45 Release Notes
Version History
Check if you have the latest version
Getting Started
Getting started
Tutorial
Create a new source code documentation project
Build a specific output
Create a WinHelp help file
Create a HTML Help help file
Create plain HTML output
Write in-source documentation
Write documentation in external files
Time2HELPs documentation model
About Building
About Outputs
About Projects
Creating and Managing Projects
About projects
Create a new source code documentation project
Create a new Application Help Project
Open a project
Save a project
Files you need to take backup of
Adding and Removing Source Files
About Delphi Source Directories
Adding and removing source files from a Delphi Source Directory
Add a source directory to the project
Remove a source directory form the project
Separating Events from Properties
Separating events from properties
Setting project options
Set search paths
Set compiler version
Set default Delphi version
Hiding and including elements
Hide a class, procedure or function
Define a symbol
How to create documentation for private and protected items
How to inherit documentation for properties and events
Writing Source Code Documentation
Time2HELP's Documentation Model
Writing In-Source Documentation
In-Source Documentation (DocComments)
Summary and Description
Including variables and fields
JavaDoc support
Overview of supported JavaDoc style tags
The @Author Tag
The @Bug Tag
The @Category Tag
The @Component Tag
The @CPP Tag
The @Deprecated Tag
The @Desc Tag
The @Enum Tag
The @Event Tag
The @Example Tag
The @Exclude Tag
The @Param tag
The @Precondition Tag
The @Postcondition Tag
The @Raises (@exception, @throws) Tag
The @Returns (@result, @return) Tag
The @SeeAlso Tag
The @Summary Tag
The @Todo Tag
Writing External Documentation
External Documentation (UnitDoc files)
Writing Code Documentation
Parameter types for methods
Creating and Opening UnitDoc files
Create a file for external documentation
Open a file for external documentation
Open a file for external documentation with synchronization
Open a file for external documentation without synchronization
Synchronizing the UnitDoc file with the source file
Using Categories
About Categories
Specifying category file location
Managing Components
About Components
Marking classes as components in DocComments
Marking classes as components in UnitDocs
Adding Component links to the Table of Contents
Writing [Source Code] Independent Topics
About topic Files
Writing Topic Files
Write/build introductory topics
Topic ID's generated by Time2HELP
Build a Contents (.CNT) file
Include images in the help file
Using keywords
Creating and Managing Topic Files
Create a topic file
Open a topic file
Add a topic file to the project
Building Outputs
About Building
Select an output to build
Set default output for the project
Build a specific output
Build all outputs
Batch/Command Line Builds
Using Logging
Creating and Managing Outputs
About Outputs
Create a new output
Creating WinHelp Output
Create a new WinHelp Output
Set the WinHelp compiler location
Creating HTML Help Output
Create a new HTML Help Output
About MS HTML Help and Time2HELP
Set the MS HTML Help compiler location
Creating Plain HTML Output
Create a new Plain HTML Output
Customizing Outputs
Customizing WinHelp Outputs
Change the colors of the help file
Using Templates
About Templates
Default Templates location
Delphi Output Template
Delphi output template
Turn off browse sequences
Change the implementation heading style
Template Objects Overview
Integrating Help Files with Delphi
Integrate a Help file with Delphi's Help
Preparing the help file for integration with Delphi IDE
Adding the help file to the Delphi IDE
About the .als file
Creating Application Help Files
About Application Help Files
Creating context sensitive help for applications in Time2HELP
Map Files
Creating Database Documentation
Database Schema Documentation
Install a database driver
Create database schema documentation
Using the Editor
About the Editor
Keyboard Shortcuts
Setting editor charset
Checking Spelling
About Spelling Check
Install a dictionary
Install a thesaurus
Document Type Definitions
DLHelpSource Document Schema (DTD)
DLHelpSource Document Schema Overview
Element Types
A Element
B Element
BH Element
Big Element
Body Element
Br Element
BrowseSequence Element
Button Element
Caption Element
CategoryTOC Element
Code Element
CodeBlock Element
Col Element
Contents Element
Default Element
DelphiCode Element
DelphiTypeDecl Element
Div Element
DLHelpSource Element
EM Element
Filename Element
Font Element
H1 Element
H2 Element
H3 Element
H4 Element
H5 Element
H6 Element
HR Element
I Element
IfHTML Element
IfWinHelp Element
IMG Element
InlineCode Element
InlineDelphiCode Element
Jump Element
JumpTarget Element
LI Element
Note Element
NSR Element
OL Element
P Element
Popup Element
PopupTopic Element
Pre Element
RawData Element
RawHTML Element
RawRTF Element
RawXML Element
Related Element
Section Element
See Element
SimpleSection Element
Small Element
Span Element
Strong Element
Style Element
Table Element
TD Element
TH Element
Tip Element
Title Element
TOCLinkGenerator Element
Topic Element
TopicBook Element
TopicEx Element
TopicFileLink Element
TopicLink Element
TR Element
U Element
UL Element
Warning Element
WT Element
Deprecated Element Types
ClassTopic Element
Color Element
ColorDef Element
EventTopic Element
Group Element
PropertyTopic Element
Raw Element
RTF Element
Tab Element
WriteToFile Element
DLUnitDoc Document Schema (DTD)
DLUnitDoc Document Schema Overview
Element Types
A Element
Author Element
Authors Element
B Element
BH Element
Big Element
Body Element
Br Element
Button Element
Caption Element
CatRef Element
CatRefs Element
Class Element
Classes Element
Code Element
CodeBlock Element
Col Element
Const Element
Constants Element
DelphiCode Element
DelphiTypeDecl Element
Desc Element
Div Element
DLUnitDoc Element
EM Element
Enumeration Element
EnumItem Element
Event Element
Events Element
Example Element
Examples Element
Exception Element
Exceptions Element
Filename Element
Font Element
H1 Element
H2 Element
H3 Element
H4 Element
H5 Element
H6 Element
HR Element
I Element
IfHTML Element
IfWinHelp Element
Img Element
InlineCode Element
InlineDelphiCode Element
Interface Element
Interfaces Element
Jump Element
JumpTarget Element
LI Element
Method Element
Methods Element
Note Element
NSR Element
OL Element
P Element
Param Element
Params Element
Popup Element
PopupTopic Element
Pre Element
Properties Element
Property Element
RawData Element
RawHTML Element
RawRTF Element
RawXML Element
Related Element
Returns Element
Routine Element
Routines Element
Section Element
See Element
SeeAlso Element
SimpleSection Element
Small Element
Span Element
Strong Element
Style Element
Summary Element
Table Element
TD Element
TH Element
Tip Element
Title Element
TR Element
Type Element
Types Element
U Element
UL Element
Var Element
Variables Element
Warning Element
Deprecated Element Types
Color Element
ColorDef Element
Group Element
Raw Element
RTF Element
Tab Element
xJump Element
DLCategoryDoc Document Schema (DTD)
DLCategoryDoc Document Schema Overview
Element Types
br Element
Category Element
Desc Element
DLCategoryDoc Element
Doc Element
p Element
SubCategories Element
Summary Element
Title Element
DLDatabaseSchemaDoc Document Schema (DTD)
DLDatabaseSchemaDoc Document Schema Overview
Element Types
AutoProperties Element
BH Element
Br Element
DBColumn Element
DBColumns Element
DBTable Element
DBTables Element
Desc Element
DLDatabaseSchemaDoc Element
Doc Element
LI Element
OL Element
P Element
Property Element
Summary Element
UL Element
Time2HELP properties
Global Properties
Global Properties
Company Name
WinHelp Compiler Location (HCRTF.EXE)
MS HTML Help Compiler Location (HHC.EXE)
Templates Directory
Global Cache Directory
Handle Double Byte Characters in Delphi Source Comments
Default UnitDoc Directory
Global Category Documentation File Location
Common Delphi Search Path
Delphi 1 Search Path
Delphi 2 Search Path
Delphi 3 Search Path
Delphi 4 Search Path
Delphi 5 Search Path
Delphi 6 Search Path
Delphi 7 Search Path
Delphi 8 Search Path
Delphi 2005 Win32 Search Path
Delphi 2005 .Net Search Path
Unit Name Prefix
Constant Prefix
Default Delphi Version
HTML Viewer
Editor Charset
Project Properties
Project Properties
Project Name
Project Title
Compiler Version
Inherit Property/Event Documentation
Output Properties
Output Properties
Max Visibility/Scope
Include Implementation
Delphi Output Template Name
Database Schema Output Template Name
Page Style Output Template Name
Element Style Output Template Name
Include keywords for properties, methods and events (in main index)
Include list of introduced properties, methods and events (in class topics)
Build D1 and D2 keyword (.kwf) file
WinHelp Project File
Build Map Files
Use PNG
Background color in 'Non-Scrolling Region'
Background color in 'Body Region'
MS HTML Help Project File
Default Topic Type
Custom Default Topic
Enable Full Text Search
Legal Information
Licence, copyright and disclaimer
The Time2HELP Evaluation Version
Contact and Product Information
How to Order
Technical Support
Upgrades