This repository was archived by the owner on Jan 30, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 14
Expand file tree
/
Copy pathauthor.html
More file actions
76 lines (75 loc) · 3.35 KB
/
author.html
File metadata and controls
76 lines (75 loc) · 3.35 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<!--
* Copyright © 2003 Sun Microsystems, Inc
* All rights reserved.
* Notice of copyright on this source code
* product does not indicate publication.
*
* RESTRICTED RIGHTS LEGEND: Use, duplication, or disclosure by
* the U.S. Government is subject to restrictions as set forth
* in subparagraph (c)(1)(ii) of the Rights in Technical Data
* and Computer Software Clause at DFARS 252.227-7013 (Oct. 1988)
* and FAR 52.227-19 (c) (June 1987).
* Sun Microsystems, Inc., 4150 Network Circle,
* Santa Clara, California 95054, U.S.A.
*
-->
<html>
<head>
<title>Authoring Help Information</title>
<link rel="stylesheet" type="text/css" href="../jhug.css" title="Style">
</head>
<body bgcolor="#ffffff">
<h1>Authoring Help Information</h1>
<p> The topics in this chapter of the <i>JavaHelp System User's Guide</i> describe
the aspects of the JavaHelp software that are of primary interest to online
help authors. These topics assume that the author is responsible for creating
the metadata files that the JavaHelp software uses to present information, as
well as the topics that inform the application's users. Together the metadata
and topic files are referred to as a <i>helpset</i>.
<table width="95%">
<tr valign="top">
<td nowrap width="2%"><img src="../../images/hg_note.gif" width="18" height="13">
<td width="98%">If you use a help authoring tool to create your help system,
some of the details described in this chapter are managed for you by the
tool.
</table>
<p> The following list summarizes the tasks required to create a helpset. All
these tasks are described in this chapter of the <i>JavaHelp System User's Guide</i>:
<ul type="circle">
<li>Create HTML topics
<li>Create a helpset file
<li>Create a map file
<li>Create a table of contents file
<li>Create an index file
<li>Create a full-text search database
<li>Compress and encapsulate the help files into a JAR
file for delivery to customers
</ul>
<p>
Consider the following strategy as a way to
get started:
<ol>
<li>Use the <a href="../release/demos.html">demonstration programs</a> included
with the release to acquaint yourself with JavaHelp system features. The most
useful demo for this purpose is <code>idehelp</code>. This program demonstrates
a fully functional help system.
<li>Read the remainder of this chapter of the <i>JavaHelp System User's Guide</i>,
and explore the helpset files created for the <code>idehelp</code> demo (extract
the files in <code>demos\hsjar\idehelp.jar</code>).
<li>Create your own helpset as follows:
<ol>
<li type="a">Create HTML topics using an editor of your choosing.
<li>Copy the metadata files you extracted from <code>demos\hsjar\idehelp.jar</code>
(<code>IdeHelp.hs</code>, <code>IdeHelpIndex.xml</code>, <code>IdeHelpTOC.xml</code>,
and <code>Map.jhm</code>) to the folder that contains your topic files
and rename them appropriately.
<li>Edit the metadata files to match your help information.
<li>Optionally create a full-text search database.
<li>Use the <a href="viewing.html"><code>hsviewer</code></a> command to
display your helpset.
</ol>
</ol>
<p>
</body>
</html>