[doc-en] master: Fix typos and grammars in chmonly directory (#5894)

Author: Chun-Sheng, Li (peter279k) Committer: GitHub (web-flow) Pusher: lacatoire Date: 2026-09-29T08:53:28+02:00 Commit: https://github.com/php/doc-en/commit/4d624ced045b1f0012d9010351e250e8b2bbb755 Raw diff: https://github.com/php/doc-en/commit/4d624ced045b1f0012d9010351e250e8b2bbb755.diff Fix typos and grammars in chmonly directory (#5894) Thanks @peter279k Changed paths: M chmonly/aboutchm.xml M chmonly/integration.xml M chmonly/search.xml M chmonly/usingchm.xml Diff: diff --git a/chmonly/aboutchm.xml b/chmonly/aboutchm.xml index 556ef64a596e..1ce22242ba4f 100644 --- a/chmonly/aboutchm.xml +++ b/chmonly/aboutchm.xml @@ -3,17 +3,17 @@ <chapter xml:id="chm.about" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <title>About This Edition</title> - <para> + <simpara> The Windows HTML Help Edition of the PHP Manual is aimed at developers, who want the manual at hand every time, and would like to read manual pages and user notes without waiting for a remote web page 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 by the scripts we use to generate this + the viewer application, by the scripts we use to generate this format and by other contributors in the form of skins. - </para> + </simpara> - <para> + <simpara> 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). @@ -25,9 +25,9 @@ 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 + directory; it's generated the first time you use the index tab, and it contains an index with the manual's pages. - </para> + </simpara> <para> For those interested in technical details about Microsoft HTML Help, diff --git a/chmonly/integration.xml b/chmonly/integration.xml index 6a6541312488..4c491523f0e5 100644 --- a/chmonly/integration.xml +++ b/chmonly/integration.xml @@ -17,27 +17,27 @@ but you may need to know a few things about what the CHM contains to successfully integrate the manual into your environment. </para> - <para> + <simpara> The CHM is built using XSL style sheets from XML sources. This is unique currently in the PHP Manual family, as all other versions are - generated using DSSSL style sheets. This also means, that - non-intentional rendering differences may come up. A special - conversion script is run on the XSLT output, adding several cute + generated using DSSSL style sheets. This also means that + unintentional rendering differences may come up. A special + conversion script is run on the XSLT output, adding several useful features, and packing up the manual with the preferences files and skin examples. - </para> - <para> + </simpara> + <simpara> If you never worked with CHMs, you can think of them as compressed files with OS supported access for files inside and some added search - and index support. However CHMs can only be viewed using the HTML Help + and index support. However, CHMs can only be viewed using the HTML Help Viewer, you can directly access files inside them using a special URL prefix, the CHM file name and the file you request from inside. As all the help content is stored in HTML files, you can show pages of the CHM in Internet Explorer. - </para> + </simpara> <simpara> Assume that you placed your <filename>php_manual_en.chm</filename> to - <filename>c:\phpmanual</filename> the index file in the manual (which + <filename>c:\phpmanual</filename>, the index file in the manual (which you see the first time) can be accessed with the following URL: <literal>mk:@MSITStore:C:\phpmanual\php_manual_en.chm::/_index.html</literal>. Here <literal>mk:@MSITStore:</literal> is the special "protocol", @@ -87,12 +87,12 @@ help, and provide the IDE specified string as the parameter. An example for this is the UltraEdit 9 integration (see the edition's website). </para> - <para> + <simpara> The index of the manual (accessible via the index tab on the navigation - pane) can also be used for integrational purposes. All the HTML pages + pane) can also be used for integration purposes. All the HTML pages are included in the index with their titles as index terms (including function description pages). - </para> + </simpara> <para> If you are a desktop application developer and would like to tightly integrate the CHM into your program (such as displaying the TOC tree diff --git a/chmonly/search.xml b/chmonly/search.xml index e6d0dc5606cb..a09c7737aaae 100644 --- a/chmonly/search.xml +++ b/chmonly/search.xml @@ -26,14 +26,14 @@ tab. </para> - <para> + <simpara> The words found are highlighted on the current page in the Topic pane by default. You can turn off this feature by choosing the "Search - Highlight Off" menu item in the Options menu. To can get this feature + Highlight Off" menu item in the Options menu. You can get this feature back similarly. If you are viewing a long topic, only the first 500 instances of a search word or phrase will be highlighted, due to a limitation of the viewer. - </para> + </simpara> <sect1 xml:id="chm.search.rules"> <title>General searching rules</title> @@ -71,13 +71,13 @@ </para> <para> <note> - <para> + <simpara> If you are searching for a file name with an extension, you should group - the entire string in double quotes, ("filename.ext"). Otherwise, the period + the entire string in double quotes ("filename.ext"). Otherwise, the period will break the file name into two separate terms. The default operation - between terms is AND, so you will create the logical equivalent to + between terms is AND, so you will create the logical equivalent of "filename AND ext." - </para> + </simpara> </note> </para> </sect1> @@ -198,11 +198,11 @@ </para> <para> <note> - <para> - The |, &amp;, and ! characters can also be used in place of OR AND and + <simpara> + The |, &amp;, and ! characters can also be used in place of OR, AND and NOT respectively. This may not work if you use a very old version of the viewer. - </para> + </simpara> </note> </para> </sect1> @@ -261,7 +261,7 @@ 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. + preferences if you would not like to have more than one notes file. </simpara> </listitem> <listitem> @@ -278,7 +278,7 @@ </simpara> </listitem> </itemizedlist> - All these benefits lead us to provide the manual the way you can see it + All these benefits led 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, diff --git a/chmonly/usingchm.xml b/chmonly/usingchm.xml index 2a60943eb5b6..e74551c0adaf 100644 --- a/chmonly/usingchm.xml +++ b/chmonly/usingchm.xml @@ -3,8 +3,8 @@ <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 + <simpara> + When you double click on a CHM, an 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 @@ -13,22 +13,22 @@ 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 + You can adjust the horizontal layout by dragging the vertical border between the Navigation pane and the Topic pane. - </para> + </simpara> - <para> - Note, that when you open the CHM the first time, it may + <simpara> + 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 + tab. All of 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> + </simpara> <sect1 xml:id="chm.using.toolbar"> <title>The HTML Help Toolbar</title> @@ -113,14 +113,14 @@ 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 + you can pick a topic, and see its 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 favorites tab enables you to store your most-used + topics in an easily accessible list. 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 @@ -209,7 +209,7 @@ </entry> </row> <row> - <entry>Turn on or off search highlighting.</entry> + <entry>Turn on or off search highlighting</entry> <entry> <keycombo action='simul'> <keycap>ALT</keycap>