goba Sun Aug 11 13:37:32 2002 EDT
Modified files:
/phpdoc/en/chmonly search.xml
Log:
Adding user note separation info to search results section
Index: phpdoc/en/chmonly/search.xml
diff -u phpdoc/en/chmonly/search.xml:1.2 phpdoc/en/chmonly/search.xml:1.3
--- phpdoc/en/chmonly/search.xml:1.2 Sun Aug 11 13:20:05 2002
+++ phpdoc/en/chmonly/search.xml Sun Aug 11 13:37:32 2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<chapter id="chm.search">
<title>The Full Text Search</title>
@@ -239,6 +239,53 @@
<simpara>You cannot nest expressions more than five levels deep.</simpara>
</listitem>
</itemizedlist>
+ </para>
+ </sect1>
+
+ <sect1 id="chm.search.notes">
+ <title>Manual Content and User Note Separation</title>
+ <para>
+ The manual content and the user notes are separated to
+ <filename>php_manual_LANG.chm</filename> and
+ <filename>php_manual_notes.chm</filename>. There were several resons
+ to do this, including:
+ <itemizedlist>
+ <listitem>
+ <simpara>
+ This way you can update the user notes and the manual independently
+ as you need.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ You can have more than one language of the manual, while only
+ need to have one notes file. All the CHM files need to be in the
+ same directory, and all translations need to share the same
+ preferences if you would not like to have more then one notes file.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ You can bookmark manual pages with notes, or just a notes part
+ of a page separately.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ You can "turn off" user note display and user note search results by
+ simply deleting <filename>php_manual_notes.chm</filename>, moving it
+ out of the directory or renaming it.
+ </simpara>
+ </listitem>
+ </itemizedlist>
+ All these benefits lead us to provide the manual the way you can see it
+ right now. This distribution had the effect on the full text search that
+ you get search results from the manual content and from the user notes
+ as separate ones. The "Location" column shows the source of the result,
+ also enabling you to "add precedence" to manual content results with
+ ordering the results by "Location". User note page titles are also
+ prefixed with "N:" to make them easily distinguisable in the favorites
+ list (there's no location info in the favorites list).
</para>
</sect1>
--
PHP Documentation Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
