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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<chapter xml:id="chm.using" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Using PHP Manual CHM Edition</title>
<para>
When you double click on a CHM, a HTML Help Viewer window
opens with three panes. On the left side of the window is
the Navigation pane. It contains four navigational tabs:
the Contents, Index, Search and Favorites tabs. On the right
side of the window is the Topic pane. It displays the
selected help topic, or the default help topic on startup.
The help pages are all separate HTML files, your Internet
Explorer displays the pages in the Topic pane. The third pane
is the toolbar, which is located below the help window title bar.
You can adjust the horizontal layout with dragging the vertical
border between the Navigation pane and the Topic pane.
</para>
<para>
Note, that when you open the CHM the first time, it may
appear in a strange position and size. From then, Windows
remembers the window position, size and the last opened
tab. All these including your favorites are stored in a
file named <filename>hh.dat</filename>. If you move your
file to another directory, all these remembered settings
will be lost (including your favorites listing!). If you
replace your CHM file with a new one, with the same name,
this is not a problem though. The file names and path
values are stored in <filename>hh.dat</filename>.
</para>
<sect1 xml:id="chm.using.toolbar">
<title>The HTML Help Toolbar</title>
<para>
The HTML Help Toolbar contains the following icons,
when you view the PHP Manual:
<itemizedlist>
<listitem>
<simpara>Hide/Show - Hides/shows the navigation pane.</simpara>
</listitem>
<listitem>
<simpara>
Locate - Locates a topic in the contents tab (in
case you reached a topic with search, index or
favorites, and would like to see where it is
in the table of contents tree view).
</simpara>
</listitem>
<listitem>
<simpara>Back - Goes back in the history.</simpara>
</listitem>
<listitem>
<simpara>Forward - Goes forward in the history.</simpara>
</listitem>
<listitem>
<simpara>Refresh - Reloads the current page.</simpara>
</listitem>
<listitem>
<simpara>Home - Opens the startup page of the CHM.</simpara>
</listitem>
<listitem>
<simpara>Print - Opens the print dialog box.</simpara>
</listitem>
<listitem>
<simpara>Options - Provides a dropdown with more options.</simpara>
</listitem>
</itemizedlist>
Using this toolbar is really easy, many of the toolbar
icons are strongly related to their Internet Explorer
equivalents.
</para>
</sect1>
<sect1 xml:id="chm.using.navpane">
<title>The Navigation Pane</title>
<para>
The Navigation Pane contains four navigational tabs:
the Contents, Index, Search and Favorites tabs. These
all provide different methods to access a topic in the
help file.
<itemizedlist>
<listitem>
<simpara>
The contents tab reveals a tree like table of contents,
where you can navigate to the desired topic by opening
and closing parts of the tree. You can even access the
deepest sections using this TOC. If you right click on
an item here and choose "Print...", you'll have the option
to print the selected topic or the selected topic and
all subtopics. However printing is not the initial goal
of this representation of the manual (the PDF version is
suitable for printing).
</simpara>
</listitem>
<listitem>
<simpara>
The index tab lists a huge number of "keywords" (actually
manual page titles). You can pick one, or start to type
a keyword, see the list adjusting to your input, and then
click on a topic, or press enter if the selected topic
is the one you would like to see.
</simpara>
</listitem>
<listitem>
<simpara>
The search tab shows one of the most powerful features of
the HTML Help Viewer, the full text search (also known as
FTS). Here you can type in your search expression,
optionally connecting words with AND/OR/NEAR/NOT. Before
you click 'List topics', you can also set some options
at the bottom. After the search results are displayed,
you'll realize that manual text and user note results are
separated. To sort out the two types, click on the
'Location' column header. Now from the search results list,
you can pick a topic, and see it's page. The keywords you
searched for are highlighted on the page.
</simpara>
</listitem>
<listitem>
<simpara>
The favorites tab enables you to store your most used
topics in a list, easily accessible. Here you can see
the list, add the current topic to it, remove one, or
display a selected item. You can also specify your own
title for the favorite, by typing it into the 'Current
topic:' box. The user note page titles are prepended
with a 'N:' string so you can distinguish them from
normal manual pages in the favorites listing.
</simpara>
</listitem>
</itemizedlist>
</para>
</sect1>
<sect1 xml:id="chm.using.keyshorts">
<title>Keyboard Shortcuts</title>
<para>
There are many keyboard shortcuts you can use to increase
your productivity. Many users find it more appropriate to
use these keyboard shortcuts to access topics, instead of
clicking.
</para>
<para>
<table>
<title>General Help Viewer Shortcuts</title>
<tgroup cols="2">
<thead>
<row>
<entry>To</entry>
<entry>Press</entry>
</row>
</thead>
<tbody>
<row>
<entry>Close the Help Viewer</entry>
<entry>
<keycombo action='simul'>
<keycap>ALT</keycap>
<keycap>F4</keycap>
</keycombo>
</entry>
</row>
<row>
<entry>Display the Options menu</entry>
<entry>
<keycombo action='simul'>
<keycap>ALT</keycap>
<keycap>O</keycap>
</keycombo>
</entry>
</row>
<row>
<entry>Hide or show the Navigation pane</entry>
<entry>
<keycombo action='simul'>
<keycap>ALT</keycap>
<keycap>O</keycap>
</keycombo>,
and then <keycap>T</keycap>
</entry>
</row>
<row>
<entry>Print a topic</entry>
<entry>
<keycombo action='simul'>
<keycap>ALT</keycap>
<keycap>O</keycap>
</keycombo>,
and then <keycap>P</keycap>
</entry>
</row>
<row>
<entry>Move back to the previous topic</entry>
<entry>
<keycombo action='simul'>
<keycap>ALT</keycap>
<keycap>LEFT ARROW</keycap>
</keycombo>
</entry>
</row>
<row>
<entry>Move forward to the next topic (provided you have viewed it just previously)</entry>
<entry>
<keycombo action='simul'>
<keycap>ALT</keycap>
<keycap>RIGHT ARROW</keycap>
</keycombo>
</entry>
</row>
<row>
<entry>Turn on or off search highlighting.</entry>
<entry>
<keycombo action='simul'>
<keycap>ALT</keycap>
<keycap>O</keycap>
</keycombo>,
and then <keycap>O</keycap>
</entry>
</row>
<row>
<entry>Return to the help file home page</entry>
<entry>
<keycombo action='simul'>
<keycap>ALT</keycap>
<keycap>O</keycap>
</keycombo>,
and then <keycap>H</keycap>
</entry>
</row>
<row>
<entry>Switch between the Navigation pane and the Topic pane</entry>
<entry><keycap>F6</keycap></entry>
</row>
<row>
<entry>Scroll through all the links in a topic or through all the options on a Navigation pane tab</entry>
<entry><keycap>TAB</keycap></entry>
</row>
<row>
<entry>Display context (right click) menu</entry>
<entry>
<keycombo action='simul'>
<keycap>SHIFT</keycap>
<keycap>F10</keycap>
</keycombo>
</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>Contents Tab Shortcuts</title>
<tgroup cols="2">
<thead>
<row>
<entry>To</entry>
<entry>Press</entry>
</row>
</thead>
<tbody>
<row>
<entry>Display the Contents tab</entry>
<entry>
<keycombo action='simul'>
<keycap>ALT</keycap>
<keycap>C</keycap>
</keycombo>
</entry>
</row>
<row>
<entry>Open and close a book or folder</entry>
<entry>
<keycap>+</keycap> and <keycap>-</keycap>
or <keycap>LEFT ARROW</keycap> and <keycap>RIGHT ARROW</keycap>
</entry>
</row>
<row>
<entry>Select a topic</entry>
<entry>
<keycap>DOWN ARROW</keycap> and <keycap>UP ARROW</keycap>
</entry>
</row>
<row>
<entry>Display the selected topic</entry>
<entry><keycap>ENTER</keycap></entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>Index Tab Shortcuts</title>
<tgroup cols="2">
<thead>
<row>
<entry>To</entry>
<entry>Press</entry>
</row>
</thead>
<tbody>
<row>
<entry>Display the Index tab</entry>
<entry>
<keycombo action='simul'>
<keycap>ALT</keycap>
<keycap>N</keycap>
</keycombo>
</entry>
</row>
<row>
<entry>Type a keyword to search for</entry>
<entry>
<keycombo action='simul'>
<keycap>ALT</keycap>
<keycap>W</keycap>
</keycombo>,
and then type the word
</entry>
</row>
<row>
<entry>Select a keyword in the list</entry>
<entry>
<keycap>UP ARROW</keycap> and <keycap>DOWN ARROW</keycap>
</entry>
</row>
<row>
<entry>Display the associated topic</entry>
<entry>
<keycap>ENTER</keycap> or
<keycombo action='simul'>
<keycap>ALT</keycap>
<keycap>D</keycap>
</keycombo>
</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>Search Tab shortcuts</title>
<tgroup cols="2">
<thead>
<row>
<entry>To</entry>
<entry>Press</entry>
</row>
</thead>
<tbody>
<row>
<entry>Display the Search tab</entry>
<entry>
<keycombo action='simul'>
<keycap>ALT</keycap>
<keycap>S</keycap>
</keycombo>
</entry>
</row>
<row>
<entry>Type a keyword to search for</entry>
<entry>
<keycombo action='simul'>
<keycap>ALT</keycap>
<keycap>W</keycap>
</keycombo>,
and then type the word
</entry>
</row>
<row>
<entry>Start a search</entry>
<entry>
<keycombo action='simul'>
<keycap>ALT</keycap>
<keycap>L</keycap>
</keycombo>
</entry>
</row>
<row>
<entry>Select a topic in the results list</entry>
<entry>
<keycombo action='simul'>
<keycap>ALT</keycap>
<keycap>T</keycap>
</keycombo>,
and then
<keycap>UP ARROW</keycap> and <keycap>DOWN ARROW</keycap>
</entry>
</row>
<row>
<entry>Display the selected topic</entry>
<entry>
<keycap>ENTER</keycap> or
<keycombo action='simul'>
<keycap>ALT</keycap>
<keycap>D</keycap>
</keycombo>
</entry>
</row>
<row>
<entry>Search for a keyword in the result list of a prior search</entry>
<entry>
<keycombo action='simul'>
<keycap>ALT</keycap>
<keycap>U</keycap>
</keycombo>
</entry>
</row>
<row>
<entry>
Search for words similar to the keyword.
For example, to find words like "running" and "runs" for the keyword "run"
</entry>
<entry>
<keycombo action='simul'>
<keycap>ALT</keycap>
<keycap>M</keycap>
</keycombo>
</entry>
</row>
<row>
<entry>Only search through topic titles</entry>
<entry>
<keycombo action='simul'>
<keycap>ALT</keycap>
<keycap>R</keycap>
</keycombo>
</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>Favorites Tab Shortcuts</title>
<tgroup cols="2">
<thead>
<row>
<entry>To</entry>
<entry>Press</entry>
</row>
</thead>
<tbody>
<row>
<entry>Display the Favorites tab</entry>
<entry>
<keycombo action='simul'>
<keycap>ALT</keycap>
<keycap>I</keycap>
</keycombo>
</entry>
</row>
<row>
<entry>Add the currently displayed topic to the Favorites list</entry>
<entry>
<keycombo action='simul'>
<keycap>ALT</keycap>
<keycap>A</keycap>
</keycombo>
</entry>
</row>
<row>
<entry>Select a topic in the Favorites list</entry>
<entry>
<keycombo action='simul'>
<keycap>ALT</keycap>
<keycap>P</keycap>
</keycombo>,
and then
<keycap>UP ARROW</keycap> and <keycap>DOWN ARROW</keycap>
</entry>
</row>
<row>
<entry>Display the selected topic</entry>
<entry>
<keycap>ENTER</keycap> or
<keycombo action='simul'>
<keycap>ALT</keycap>
<keycap>D</keycap>
</keycombo>
</entry>
</row>
<row>
<entry>Remove the selected topic from the list</entry>
<entry>
<keycombo action='simul'>
<keycap>ALT</keycap>
<keycap>R</keycap>
</keycombo>
</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>Topic Pane Shortcuts</title>
<tgroup cols="2">
<thead>
<row>
<entry>To</entry>
<entry>Press</entry>
</row>
</thead>
<tbody>
<row>
<entry>Index Lookup</entry>
<entry>
Select the words you would like to look up and press
<keycap>F1</keycap>
</entry>
</row>
<row>
<entry>Find on page</entry>
<entry>
<keycombo action='simul'>
<keycap>CTRL</keycap>
<keycap>F</keycap>
</keycombo>,
and then adjust options
</entry>
</row>
<row>
<entry>Refresh page</entry>
<entry><keycap>F5</keycap></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</sect1>
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
