Tip #826: PHP manual in VIM help format

tip karma

Rating 76/30, Viewed by 3947

Read and edit this tip on the Vim tip wiki. The wiki may have a more recent version of this tip.

created: November 20, 2004 4:11 complexity: intermediate

author: Jörn Horstmann as of Vim: 6.0

Download http://planetxml.de/php_manual.txt and put it into your vim/doc folder, then run :helptags [path to vim/doc]. Documentation for PHP functions can be shown by pressing K while the cursor is on a function name. The manual was created using a modified version of script found at http://www.phpvolcano.com/articles/manual/index.php.

<< Expand #* search to grep-find | XTerm and 256 Colors >>

Additional Notes

[email protected], November 20, 2004 6:47

Hallo Jörn, kann das von dir modifizierte Script auch ein deutschsprachiges PHP-Manual als Helpfile erstellen? Viele Grüße Lothar

Anonymous, November 20, 2004 8:46

Thank you for your good work.

[email protected], November 20, 2004 10:36

I have put a short description, the source code and a german version of the manual on my homepage at http://planetxml.de/vim-php-manual.php

Anonymous, December 3, 2004 9:13

Very nice work.... this will be a good bit of a time saver. I wouldn't mind slightly more lengthy descriptions from the online manual, but this will definitely cut down some visits to php.net

Anonymous, December 27, 2004 10:57

good

[email protected], June 24, 2005 5:21

Fantastic! This has inspired me to convert other manuals (glibc would be most useful) into the help system. :help has always been there, but thanks to this tip I realise the full impact of its power...

[email protected], August 7, 2005 15:10

There is a new Version available at http://blog.planetxml.de/uploads/vim-php-manual.tgz I added more text and examples from the manual and it is now split into one file per function. Installation has also changed, you have to create a folder named 'doc' somewhere and add this to your runtimepath. For example unpack it to c:\programme\vim\php\doc and add this to your .vimrc: runtimepath+=c:\programme\vim\php

Anonymous, November 2, 2005 18:07

Just in case this helps someone else, I also found it necessary to un set keywordprg (which I did in ftplugin/php.vim) so that the K defaults to the :help command (rather than :!man).




	If you have questions or remarks about this site, visit the vimonline development pages. Please use this site responsibly. Questions about Vim should go to the maillist. Help Bram help Uganda.