|
Currently supported help types are Windows HTML Help and a simply Url.
The syntax of a thi file is like an ini file.
There are two sections: Options and Keys.
Options contains settings about the help type, keys as list of keys wit
filenames.
Syntax of the Options section:
[Options]
Title=<title>
Type=HTMLHELP|URL
HelpFile=<filename>
HelpTopicPath=<path>
URL=<URL>
Ext=<extension>
Index=<default page>
| Name |
Description |
| Title |
Title of the help, will display in the Help menu. |
| Type |
Type of the Help, valid values are HTMLHELP or URL. |
| HelpFile |
Only if type is HTMLHELP. Filename of the Windows HTML
Help file. Must be in the same directory as the thi file ! |
| HelpTopicPath |
Only if type is HTMLHELP. Path, will add to all filenames
as prefix. |
| URL |
Only if type is URL. Will add to all filenames as suffix. |
| Ext |
Extension, will be add to all filenames. |
| Index |
Default page, will open when the user clicks on the
item in the Help menu. It also use the key Ext. |
Syntax of the Keys section:
[keys]
<key>=<filename>
<key1>=<filename1>
<key2>=<filename2>
...
| Name |
Description |
| <key> |
Key must be in lower case. tsWebEditor search in this list for
the keyword. If found, it will open the <filename>.
If Ext in section options is not null then it will add as suffix
to the filename.
If you want to use more filenames to one key use | as seperator.
tsWebEditor will show a dialog to select a topic.
<key>=<filename>|<display value>|<filename>|<display
value>
Example: if=if.htm|if|ifelse.htm|if else|ifelseif.htm|if else if
If you use HTMLHELP as type and you don't use context numbers you
must add the prefix " to the filename.
Exmaples:
if=2904 will use the context number
if="if.htm will use the filename
Because if we don't use a ", 2904 can also be a filename and
you can't use context numbers.
|
Examples:
[Options]
Title=PHP (Online)
Type=URL
URL=http://www.php.net/manual/en/
Ext=.php
Index=index
[keys]
and=language.operators.logical
e_parse=language.constants
old_function=functions.old-syntax
e_error=language.constants
or=language.operators.logical
as=control-structures.foreach
If you use the keyword as, tsWebEditor will open the following URL:
| http://www.php.net/manual/en/ |
control-structures.foreach |
.php |
| URL from Options |
filename of the key |
Ext from options |
[Options]
Title=PHP (Windows HTML Help)
Type=HTMLHelp
HelpFile=php_manual_de.chm
HelpTopicPath=::/de/
Ext=
Index=index.html
[keys]
array_diff="function.array-diff.html
array_fill="function.array-fill.html
array_filter="function.array-filter.html
array_flip="function.array-flip.html
array_intersect="function.array-intersect.html
array_key_exists="function.array-key-exists.html
If you use the keyword array_flip, tsWebEditor will open the following
URL:
| php_manual_de.chm |
::/de/ |
function.array-flip.html |
| HelpFile from Options |
HelpTopicPath from Options |
filename of the key |
If you are ready with the thi file and you want to add it to CVS and
you have no CVS access, send the file to thaj@tigirs.org or if you have
any questions or something else send also an email to thaj@tigirs.org.
|
