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 pathindex.html
More file actions
171 lines (166 loc) · 7.55 KB
/
index.html
File metadata and controls
171 lines (166 loc) · 7.55 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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
<!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>Index File</title>
<link rel="stylesheet" type="text/css" href="../jhug.css" title="Style">
</head>
<body bgcolor="#ffffff">
<h2>Index File</h2>
<p>
The index file describes to the index
navigator the content and layout of the index. The format of
the index file is based on the World Wide Web Consortium
Extended Markup Language (XML). The following is a very small example
of an index file:
</p>
<pre><?xml version='1.0' encoding='ISO-8859-1' ?>
<!DOCTYPE index
PUBLIC
"-//Sun Microsystems Inc.//DTD
JavaHelp Index Version 2.0//EN"
"http://java.sun.com/products/javahelp/index_2_0.dtd">
<index version="2.0">
<indexitem text=".prof extension (profile data)"
target="prof.profile" />
<indexitem text="accelerators (keyboard), see 'keyboard commands'" />
<indexitem text="adding existing portfolio" target="proj.import" />
<indexitem text="adding existing project">
<indexitem text="naming project" target="proj.importdirectory" />
<indexitem text="naming storage directory"
target="proj.importdirectory" />
<indexitem text="procedures for" target="proj.importproject2" />
</indexitem>
<indexitem text="analyzing program performance, see 'profiler'" />
<indexitem text="Java Applets"><br> <indexitem text="overview" target="applet_over"<br> presentationtype="javax.help.SecondaryWindow
presentationname="mainsw"><br> <indexitem text="editing in content page"
target="applet_editing">
<indexitem text="inserting in content page"
target="applet_insert"><br> </indexitem>
</index></pre>
<p>
<h4>The Index Tags</h4>
<p>
The following table describes the index tags:
<table width=98% border=0 cellpadding=5>
<tr valign="top">
<td width=100 nowrap><code><index></code> </td>
<td> Defines the index. It can contains <code><indexitem></code> tags and
the following optional attributes. <br>
<table width=100% border=0 cellpadding=5>
<tr valign="top">
<td width=60> <code>xml:lang="lang"</code></td>
<td> Language for the index. Use the standard locale-country-variant
format.<br>
<dl>
<dt>Some examples:</dt>
<dd><code>xml:lang="de"</code></dd>
<dd><code>xml:lang="en"</code></dd>
<dd><code>xml:lang="en-US"</code></dd>
</dl>
</tr>
<tr valign="top">
<td> <code>version="1.0"|"2.0"</code></td>
<td> Version of JavaHelp software.</td>
</tr>
</table>
. </td>
</tr>
<tr valign="top">
<td nowrap><code><indexitem></code> </td>
<td>
Defines an index entry. Nesting <i>entry1</i> within <i>entry2</i> defines
<i>entry2</i> to be hierarchically contained within <i>entry1</i>. Uses
the following attributes:
<!-- Begin Nested table -->
<!-- End Nested table -->
<br><br>
<table width="100%" border="0" cellpadding="5">
<tr valign="top">
<td width=60> <code>xml:lang="lang"</code></td>
<td> Language for the index item. Use the standard locale-country-variant
format.<br>
<dl>
<dt>Some examples:</dt>
<dd><code>xml:lang="de"</code></dd>
<dd><code>xml:lang="en"</code></dd>
<dd><code>xml:lang="en-US"</code></dd>
</dl> </td>
</tr>
<tr valign="top">
<td width=60> <code>text=</code>"<i>string</i>" </td>
<td> Specifies the text that displays in the index. </td>
</tr>
<tr valign="top">
<td><code>target=</code>"<i>string</i>"</td>
<td>(<i>optional</i>) Specifies the map ID of the topic that displays
when the entry is chosen by the user. IDs are defined (associated
with a URL) in the <a href="map.html">map file</a>. If this attribute
is not used, the index entry does not link to a topic (probably because
it's being used to group sub-entries).</td>
</tr>
<tr valign="top">
<td width="20%"><code>mergetype</code>="<i>class"</i></td>
<td width="80%"> (<i>optional</i>) The path to a valid merge class for
the view. The default merge type for an index is <code>javax.help.AppendMerge</code>.
<br>
<dl> <dt>The merge classes are:</dt>
<dd><code>javax.help.UniteAppendMerge</code></dd>
<dd><code>javax.help.SortMerge</code></dd>
<dd><code>javax.help.AppendMerge</code></dd>
<dd><code>javax.help.NoMerge</code></dd>
</dl>
<p>For more information, see <a href="merge.html">Merging Helpsets</a>.</p>
</td>
</tr>
<tr valign="top">
<td nowrap><code>expand="true|false"</code></td>
<td>(<i>optional</i>) Specifies whether to expand the index item and
its subitems when the index initially opens. The default setting is
<code>"none"</code>, a setting that expands only the top
level items.</td>
</tr>
<tr valign="top">
<td width=60> <code>presentationtype</code> </td>
<td>(<i>optional</i>) Specifies the type of window in which the topic
will be displayed (defined in the <code><presentation></code> section
of the <code>.hs</code> file). For more information, see the presentation
feature in <a href="helpset.html#presentationtag">Helpset File</a>.</td>
</tr>
<tr valign="top">
<td> <code>presentationname</code></td>
<td> (<i>optional</i>) Specifies the name of the window in which the
topic will be displayed. </td>
</tr>
</table>
</td>
</tr>
</table>
<img src="../../images/hg_see.gif" width="18" height="13"><b>See also:</b>
<dl>
<dd><a href="helpset.html">The Helpset File</a>
<dd><a href="map.html">Map File</a>
<dd><a href="jar.html">JAR Files</a>
<dd><a href="toc.html">Table of Contents File</a>
<dd><a href="glossary.html">Glossary File</a>
<dd><a href="favorites.html">Favorites File</a>
<dd><a href="search.html">Creating the Full-Text Search Database</a>
<!-- <dd><A HREF="../jhugTOC.html">Table of Contents</A> -->
</dl>
<p>
</body>
</html>