goba Tue Aug 27 15:13:46 2002 EDT
Modified files:
/phpdoc/en/chmonly aboutchm.xml search.xml skins.xml
specialities.xml usingchm.xml
Log:
Several small corrections and adding information
about on the fly context menu switching
(new in the next sample coming ;)
Index: phpdoc/en/chmonly/aboutchm.xml
diff -u phpdoc/en/chmonly/aboutchm.xml:1.4 phpdoc/en/chmonly/aboutchm.xml:1.5
--- phpdoc/en/chmonly/aboutchm.xml:1.4 Sun Aug 25 10:36:39 2002
+++ phpdoc/en/chmonly/aboutchm.xml Tue Aug 27 15:13:45 2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
<chapter id="chm.about">
<title>About This Edition</title>
@@ -9,8 +9,8 @@
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 and by the scripts we use to generate this
- format.
+ the viewer application by the scripts we use to generate this
+ format and by other contributors in the form of skins.
</para>
<para>
Index: phpdoc/en/chmonly/search.xml
diff -u phpdoc/en/chmonly/search.xml:1.3 phpdoc/en/chmonly/search.xml:1.4
--- phpdoc/en/chmonly/search.xml:1.3 Sun Aug 11 13:37:32 2002
+++ phpdoc/en/chmonly/search.xml Tue Aug 27 15:13:45 2002
@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<chapter id="chm.search">
<title>The Full Text Search</title>
<para>
This edition of the PHP Manual includes an advanced full text
- search possibilty provided the viewer application. This enables
+ search possibilty provided by the viewer application. This enables
users to to search through every word in the help file to find a
match. For example, if a user does a full-text search on the word
"Apache", every topic that contains the word "Apache" will be listed.
@@ -16,7 +16,7 @@
<para>
The usage of the search feature is fairly straightforward. Click on
- the search tab, type in the desired words and press ENTER (or click
+ the search tab, type in the desired words and press ENTER (or click
on "List Topics"). Then you'll receive a list of matches from the
PHP Manual (and the notes). You can use the button with a right
arrow on it to add boolean operators to your search (or you can type
@@ -103,7 +103,7 @@
<row>
<entry>A single word</entry>
<entry>select</entry>
- <entry>Topics that contain the word "select." (You will also find its
grammatical variations, such as "selector" and "selection".)</entry>
+ <entry>Topics that contain the word "select". (You will also find its
+grammatical variations, such as "selector" and "selection".)</entry>
</row>
<row>
<entry>A phrase</entry>
@@ -230,7 +230,7 @@
<simpara>
If a query does not contain a nested expression, it is evaluated from left to
right.
For example: "mail NOT pop3 OR smtp" finds topics containing the word "mail"
without
- the word "pop3" or topics containing the word "smtp" On the other hand, "mail
NOT
+ the word "pop3" or topics containing the word "smtp". On the other hand, "mail
+NOT
(pop3 OR smtp)" finds topics containing the word "mail" without either of the
words
"pop3" or "smtp".
</simpara>
Index: phpdoc/en/chmonly/skins.xml
diff -u phpdoc/en/chmonly/skins.xml:1.3 phpdoc/en/chmonly/skins.xml:1.4
--- phpdoc/en/chmonly/skins.xml:1.3 Wed Aug 14 09:10:44 2002
+++ phpdoc/en/chmonly/skins.xml Tue Aug 27 15:13:45 2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<chapter id="chm.skins">
<title>Skin development</title>
@@ -20,7 +20,7 @@
<para>
A skin must have at least two files, a skin loader JavaScript file and
- a CSS file. The two inline skins have thes files inside the CHM. The
+ a CSS file. The two inline skins have these files inside the CHM. The
skin loader JS should at least load in the CSS file and display the
page contents to the viewer. Theoretically there are two kinds of skins:
CSS skins and Full skins. CSS skins only modify the CSS and does not
@@ -75,8 +75,8 @@
<listitem>
<simpara>
At last <filename>_script.js</filename> loads in the preferences
- file from outside the CHM (in <filename>c:\phpmanual</filename> in
- our example). This JS file defines the preference variables, and
+ file from outside the CHM
+(<filename>c:\phpmanual\php_manual_prefs.js</filename>
+ in our example). This JS file defines the preference variables, and
calls back <literal>prefHandler()</literal> which is also defined in
<filename>_script.js</filename>.
</simpara>
@@ -184,7 +184,7 @@
user notes (itself loaded in from another HTML file by JS). It contains
a heading, and then a <literal><div></literal> without ID for
every user note and spans in that divs for every element of a user
- note (with email, date and text IDs respectively).
+ note (with "email", "date" and "text" IDs respectively).
</simpara>
</listitem>
<listitem>
Index: phpdoc/en/chmonly/specialities.xml
diff -u phpdoc/en/chmonly/specialities.xml:1.1 phpdoc/en/chmonly/specialities.xml:1.2
--- phpdoc/en/chmonly/specialities.xml:1.1 Mon Aug 12 08:42:31 2002
+++ phpdoc/en/chmonly/specialities.xml Tue Aug 27 15:13:45 2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<chapter id="chm.specialities">
<title>Specialities of this Edition</title>
@@ -41,10 +41,12 @@
</para>
<para>
- The context menu settings enables you to override the system default
- context menu provided by the HTML Help Viewer and define your own
- by selecting from a list of predefined menu elements. Three special
- types of context menu items exist:
+ The context menu settings enables you to choose which context menu
+ you prefer. This application provides you with an option to define
+ your own context menu adding elements to it from a predefined set.
+ You can have this custom context menu for the right click of your
+ mouse, and have the original menu for CTRL+right click, or the
+ opposite way. Three special types of custom context menu items exist:
<table>
<title>Context menu items</title>
<tgroup cols="3">
@@ -84,7 +86,7 @@
These are displayed as HTML forms, where you can enter search
keywords, press ENTER, and receive a new window with the search
issued in the appropriate search engine. Currently there is no
- way to extend specialy displayed context menu items.
+ way to extend the set of specialy displayed context menu items.
</entry>
</row>
</tbody>
@@ -104,11 +106,11 @@
skins, or from any user defined skins. The Low skin is optimized to
display correctly at any small size, the High skin is optimized for
your viewing pleasure. Other skins may be developed according to our
- skins development guide. The recommended place for skins on the file
- system is the <filename>skins/SKINNAME</filename> subfolder of the PHP
- Manual directory. Though this is not required, some skins may define
- other rules (not recommended). We included sample skins for you to
- see examples of how to develop skins for the PHP Manual.
+ <link linkend="chm.skins">skins development guide</link>. The recommended
+ place for skins on the file system is the <filename>skins/SKINNAME</filename>
+ subfolder of the PHP Manual directory. Though this is not required, some
+ skins may define other rules (not recommended). We included sample
+ skins for you to see examples of how to develop skins for the PHP Manual.
</para>
<para>
Index: phpdoc/en/chmonly/usingchm.xml
diff -u phpdoc/en/chmonly/usingchm.xml:1.4 phpdoc/en/chmonly/usingchm.xml:1.5
--- phpdoc/en/chmonly/usingchm.xml:1.4 Thu Aug 8 16:23:58 2002
+++ phpdoc/en/chmonly/usingchm.xml Tue Aug 27 15:13:45 2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
<chapter id="chm.using">
<title>Using PHP Manual CHM Edition</title>
@@ -44,7 +44,7 @@
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 contents).
+ in the table of contents tree view).
</simpara>
</listitem>
<listitem>
@@ -77,7 +77,7 @@
<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
+ all provide different methods to access a topic in the
help file.
<itemizedlist>
<listitem>
@@ -88,7 +88,9 @@
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.
+ 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>
@@ -122,7 +124,9 @@
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.
+ 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>
@@ -134,7 +138,7 @@
<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
+ use these keyboard shortcuts to access topics, instead of
clicking.
</para>
<para>
@@ -177,7 +181,7 @@
<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>Return to the help file home page</entry>
<entry>ALT+O, and then H</entry>
</row>
<row>
@@ -189,7 +193,7 @@
<entry>TAB</entry>
</row>
<row>
- <entry>Display context (right click) menu</entry>
+ <entry>Display context (right click) menu [see the <link
+linkend="chm.specialities.prefs">User Preferences section</link>]</entry>
<entry>SHIFT+F10</entry>
</row>
</tbody>
--
PHP Documentation Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
