Extended CHM PHP Grammar Manual DIY_PHP Tutorial

Extended CHM PHP syntax manual for DIY

1. The main features of Extended CHM
Customizable right-click menu
PHP code blocks are displayed with syntax highlighting
Functions in PHP code blocks have Corresponding function manual link
Clearer manual interface
You can customize the appearance of the manual
Support skin-changing function
More detailed manual content
Comes with very practical user notes
Yes Integrated into most IDEs and editors
For details, please visit
<>



2. Why DIY
I don’t know why, such good stuff has not been updated on the official website of php for a long time (the latest official
version was released on 2003.9.6). Especially after the release of php5 In the future, a lot of content will not be found, so
I can only carry forward the DIY spirit and make my own. ^_^

3. Preliminary knowledge
Use of cvs client.
Basic operations in linux environment, as well as software compilation and installation.

4. Software requirements
cvs client software:
We need to obtain phpdoc through the cvs server of the php official website The latest version.
Wincvs Chinese version is recommended in Windows environment
<ncvs/>>
Unix camp operating system Generally, they come with their own cvs client.
You can type "cvs version" directly on the command line to check whether cvs is installed.
If it is not installed, please download it from
< of the cvs client from cvshome.org>>
Windows operating system:
You need to run Microsoft Html Help Workshop in the windows system to generate the chm file
You can also run it on linux Run wine under Windows to simulate windows
Microsoft Html Help Workshop
A tool released by Microsoft to generate chm files
<Workshop>>
Linux operating system:
We need to compile and install the manual and some necessary software packages here.
You can also use other unix camp systems,
or simply use cygwin, vmware and other software to simulate a linux under Windows Environment
PHP4.0 or above:
PHP is required when compiling and generating chm files, so you need to install php in both windows and linux environments
.
Environment used in this article:
Two PCs, respectively installed with redhat 9 and windows 2000 professional

5. Start DIY
First, install OpenJada and OpenSP in the linux machine
Enter the linux console

Code:--------------------------------------------- -------------------------------------
$mkdir /home/phpdoc
$ cd /home/phpdoc
$wget "http://prdownloads.sourceforge.net/openjade/openjade-1.3.2.tar.gz"
$wget "http://prdownloads.sourceforge.net/openjade /OpenSP-1.5.1.tar.gz"
$tar -zxvf *.tar.gz
$cd openjade-1.3.2
$./configure
$make
$make install
$cd ../OpenSP-1.5.1
$./configure
$make
$make install
$cd ../
------ -------------------------------------------------- -----------------------

Then, we need to obtain the latest version of phpdoc from php's official cvs server

Code:-------------------------------------------------- ----------------------------------
$export CVSROOT=:pserver:cvsread@cvs.php.net :/repository
$cvs -z9 checkout phpdoc
$cd phpdoc
$cvs update -dP -D"December 31, 2002 11:00pm" xsl
$cvs up -A xsl/version. xml xsl/docbook/html/chunker.xsl
---------------------------------------- -----------------------------------------------

Settings Compile parameters

Code:---------------------------------------- ------------------------------------------
$autoconf
$. /configure --with-chm=yes --with-lang=en
---------------------------------- --------------------------------------------------

At this time, some small corrections need to be made
Open /home/phpdoc/phpdoc/xsl/htmlhelp-db.xsl with an editor
Search for "@DOCBOOKXSL_HTML@" in this file,
Replace it with "./docbook/html/chunk.xsl", save and exit
Then open /home/phpdoc/phpdoc/xsl/html-common.xsl
Add the following code to the file At the end of the line , save and exit

Code:----------------------------- -------------------------------------------------- ---



select="'http://www.w3.org/TR/html4/loose.dtd'"/>
< ;xsl:param name="chunker.output.doctype-public" select="'-//W3C//DTD HTML
4.01 Transitional//EN'"/>
------ -------------------------------------------------- -----------------------

Then continue the compilation operation,

Code:------- -------------------------------------------------- -----------------------
$make chm_xsl
------------------ -------------------------------------------------- ------------

After the compilation is completed, we need to obtain the latest PHP mirror site list and user note file

code: ----------------------- -------------------------------------------------- -------
$cd htmlhelp
$wget "http://www.php.net/include/mirrors.inc"
$wget "http://www.php.net /backend/notes/all.bz2"
$bunzip2 all.bz2
cd ../
----------------------- -------------------------------------------------- -------

You can package the generated files and transfer them to the Windows machine

Code:---------------- -------------------------------------------------- ---------------
tar -czvf phpdoc.tar.gz ./htmlhelp
------------------ -------------------------------------------------- -----------

At this point, the operations that need to be performed on the linux platform are completed
Now the operation will be transferred to the windows environment
First, unzip the file just now The generated phpdoc.tar.gz
Because some of the files generated after compiling the version I obtained have errors in the links to related functions,
so I need to modify the htmlhelp/filter_files.php file
first Add the following code to its header

PHP code: ---------------------------------- ---------------------------------------------
// fix functions link error
function fix_function_link($m) {
$fname1 = 'function.'.strtolower(str_replace('_','-',$m[1])).'.html';
$fname2 = 'function.'.strtolower(str_replace('_','.',$m[1])).'.html';
if(file_exists("html/".$fname1 )) {
return ''.$m[1].'()';
}elseif(file_exists("html/".$fname2)) {
return ''.$m[1]. '()';
}else{
return ''.$ m[1].'()';
}
}

---------------- -------------------------------------------------- -------------

Then find the following code in the file

PHP code:------------ -------------------------------------------------- ------------------
// Read in the contents of the source file
$content = join("", file("$HTML_SRC/$filename "));

---------------------------------------- ------------------------------------------

Change it to

PHP code:----------------------------------------- ---------------------------------------
// Read in the contents of the source file
$content = join("", file("$HTML_SRC/$filename"));
$content = str_replace("»","»",$content);
$ reg_fix = '/'.preg_quote('', "/").'(w+)()'.preg_quote('< /a>', "/").'/is';
$content = preg_replace_callback($reg_fix,'fix_function_link',$content);
$reg_fix = '/'.preg_quote('', "/").'(w+)()'.preg_quote('', "/").'/is';
$content = preg_replace_callback($reg_fix,'fix_function_link',$content);

------------------------ -------------------------------------------------- -----

After saving, rename "htmlhelplocal_vars.php.src" to
"htmlhelplocal_vars.php"
Edit "htmlhelplocal_vars.php",
replace the Set the $HELP_WORKSHOP variable value to the installation directory of Html Help Workshop, save and exit
Exit
Add the directory where php.exe is located to the path environment variable.
Type cmd in "Run" to enter the console mode, and Enter the release directory of phpdoc.tar.gz

Code:--------------------------------- -----------------------------------------------
cd htmlhelp
make_chm.bat
--------------------------------------- -------------------------------------

Waiting for its execution After completion, the Extended CHM version of the php syntax manual is generated.
Save it in the htmlhelp/release directory
Download
<>, and save it in the manual directory
Execute this program to set the right-click menu, skin used, etc. in the manual.
After the settings are completed, double-click php_manual_en.chm to browse the manual. (Source: Viphot)