goba Thu Aug 8 16:05:48 2002 EDT
Modified files:
/phpdoc/en/chmonly aboutchm.xml credits.xml usingchm.xml
Log:
Adding much more info on files, panes, shortcuts, etc. More is coming
on FTS (full text search), and the PHP Manual specific parts (like the
preferences application, skins, and advise for IDE authors)
Index: phpdoc/en/chmonly/aboutchm.xml
diff -u phpdoc/en/chmonly/aboutchm.xml:1.1 phpdoc/en/chmonly/aboutchm.xml:1.2
--- phpdoc/en/chmonly/aboutchm.xml:1.1 Tue Feb 5 09:30:18 2002
+++ phpdoc/en/chmonly/aboutchm.xml Thu Aug 8 16:05:48 2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<chapter id="chm.about">
<title>About This Edition</title>
@@ -9,7 +9,22 @@
to read manual pages and user notes without waiting for a remote
webpage to download. This edition gives you the full content of the
manual plus the user notes, with some great features provided by
- the viewer application.
+ the viewer application and by the scripts we use to generate this
+ format.
+ </para>
+
+ <para>
+ This distribution of the PHP Manual contains many files, including the
+ main manual file <filename>php_manual_en.chm</filename>. You can view
+ the manual by double clicking on this file (as you already guessed).
+ The user notes are in <filename>php_manual_notes.chm</filename>. You
+ only need to have one copy of this file on your computer, regardless
+ of how many languages you use to read the PHP Manual. The only
+ requirement is that you need to have all <filename>php_manual_LANG.chm<filename>
+ files in one directory with <filename>php_manual_notes.chm</filename>.
+ You may also see a <filename>php_manual_en.chw</filename> file in the
+ directory, it's generated the first time you use the index tab, and
+ it contains an index with the manual's pages.
</para>
</chapter>
Index: phpdoc/en/chmonly/credits.xml
diff -u phpdoc/en/chmonly/credits.xml:1.3 phpdoc/en/chmonly/credits.xml:1.4
--- phpdoc/en/chmonly/credits.xml:1.3 Wed Jul 3 15:08:09 2002
+++ phpdoc/en/chmonly/credits.xml Thu Aug 8 16:05:48 2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<chapter id="chm.credits">
<title>CHM Edition Credits</title>
@@ -17,8 +17,7 @@
<listitem>
<simpara>
Gonzalo De la Pena Andreu, who added many comments on how
- it would be ideal to provide the skinnable interface (still
- needs to be implemented)
+ it would be ideal to provide the skinnable interface
</simpara>
</listitem>
<listitem>
Index: phpdoc/en/chmonly/usingchm.xml
diff -u phpdoc/en/chmonly/usingchm.xml:1.2 phpdoc/en/chmonly/usingchm.xml:1.3
--- phpdoc/en/chmonly/usingchm.xml:1.2 Thu May 9 11:59:32 2002
+++ phpdoc/en/chmonly/usingchm.xml Thu Aug 8 16:05:48 2002
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<chapter id="chm.using">
- <title>Using the HTML Help Viewer</title>
+ <title>Using PHP Manual CHM Edition</title>
<para>
When you double click on a CHM, a HTML Help Viewer window
@@ -9,9 +9,12 @@
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 third pane is the toolbar, which is located below the
- help window title bar.
+ 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>
@@ -69,7 +72,294 @@
</para>
</sect1>
+ <sect1 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 the 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.
+ </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.
+ </simpara>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </sect1>
+ <sect1 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 topic, 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>ALT+F4</entry>
+ </row>
+ <row>
+ <entry>Display the Options menu</entry>
+ <entry>ALT+O</entry>
+ </row>
+ <row>
+ <entry>Hide or show the Navigation pane</entry>
+ <entry>ALT+O, and then T</entry>
+ </row>
+ <row>
+ <entry>Print a topic</entry>
+ <entry>ALT+O, and then P</entry>
+ </row>
+ <row>
+ <entry>Move back to the previous topic</entry>
+ <entry>ALT+LEFT ARROW</entry>
+ </row>
+ <row>
+ <entry>Move forward to the next topic (provided you have viewed it just
+previously)</entry>
+ <entry>ALT+RIGHT ARROW</entry>
+ </row>
+ <row>
+ <entry>Turn on or off search highlighting.</entry>
+ <entry>ALT+O, and then O</entry>
+ </row>
+ <row>
+ <entry>Return to the home page (help authors can specify a home page for a
+help system)</entry>
+ <entry>ALT+O, and then H</entry>
+ </row>
+ <row>
+ <entry>Switch between the Navigation pane and the Topic pane</entry>
+ <entry>F6</entry>
+ </row>
+ <row>
+ <entry>Scroll through all the links in a topic or through all the options on
+a Navigation pane tab</entry>
+ <entry>TAB</entry>
+ </row>
+ <row>
+ <entry>Display context (right click) menu</entry>
+ <entry>SHIFT+F10</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>ALT+C</entry>
+ </row>
+ <row>
+ <entry>Open and close a book or folder</entry>
+ <entry>PLUS SIGN and MINUS SIGN, or LEFT ARROW and RIGHT ARROW</entry>
+ </row>
+ <row>
+ <entry>Select a topic</entry>
+ <entry>DOWN ARROW and UP ARROW</entry>
+ </row>
+ <row>
+ <entry>Display the selected topic</entry>
+ <entry>ENTER</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>ALT+N</entry>
+ </row>
+ <row>
+ <entry>Type a keyword to search for</entry>
+ <entry>ALT+W, and then type the word</entry>
+ </row>
+ <row>
+ <entry>Select a keyword in the list</entry>
+ <entry>UP ARROW and DOWN ARROW</entry>
+ </row>
+ <row>
+ <entry>Display the associated topic</entry>
+ <entry>ENTER or ALT+D</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>ALT+S</entry>
+ </row>
+ <row>
+ <entry>Type a keyword to search for</entry>
+ <entry>ALT+W, and then type the word</entry>
+ </row>
+ <row>
+ <entry>Start a search</entry>
+ <entry>ALT+L</entry>
+ </row>
+ <row>
+ <entry>Select a topic in the results list</entry>
+ <entry>ALT+T, and then UP ARROW and DOWN ARROW</entry>
+ </row>
+ <row>
+ <entry>Display the selected topic</entry>
+ <entry>ENTER or ALT+D</entry>
+ </row>
+ <row>
+ <entry>Search for a keyword in the result list of a prior search</entry>
+ <entry>ALT+U</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>ALT+M</entry>
+ </row>
+ <row>
+ <entry>Only search through topic titles</entry>
+ <entry>ALT+R</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>ALT+I</entry>
+ </row>
+ <row>
+ <entry>Add the currently displayed topic to the Favorites list</entry>
+ <entry>ALT+A</entry>
+ </row>
+ <row>
+ <entry>Select a topic in the Favorites list</entry>
+ <entry>ALT+P, and then UP ARROW and DOWN ARROW</entry>
+ </row>
+ <row>
+ <entry>Display the selected topic</entry>
+ <entry>ENTER or ALT+D</entry>
+ </row>
+ <row>
+ <entry>Remove the selected topic from the list</entry>
+ <entry>ALT+R</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 F1</entry>
+ </row>
+ <row>
+ <entry>Refresh page</entry>
+ <entry>F5</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </para>
+ </sect1>
+
</chapter>
<!-- Keep this comment at the end of the file
--
PHP Documentation Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
