schlitt.info - php, photography and private stuff
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

:Author: 		Tobias Schlitt
:Date:			Thu, 27 Nov 2008 18:00:29 +0100
:Revision: 		2
:Copyright:		CC by-nc-sa


=================================
PHP Documentor for VIM documented
=================================

:Description:
    Because I had a talk about how to use VIM in respect to PHP source code
    editing, I took the time during the week, to write some extensive
    documentation for PDV, the PHP Documentor plugin for VIM. Additionally, I
    documented my VIM file type plugin, which is also available through the
    SVN of PDV. Take a look at the README.txt to learn more.

Because I had a talk about `how to use VIM in respect to PHP source code
editing`__, I took the time during the week, to write some extensive
documentation for PDV, the PHP Documentor plugin for VIM. Additionally, I
documented my VIM file type plugin, which is also available through the `SVN
of PDV`__. Take a look at the `README.txt`__ to learn more.

.. __: /opensource/blog/0511_phpugdo_upcoming_talks.html
.. __: http://svn.toby.phpugdo.de/PDV/
.. __: http://svn.toby.phpugdo.de/horde/chora/browse.php?f=%2FREADME.txt

**Update**:

For those looking for my .vimrc: It is in SVN, too, but splitted up in a
general `.vimrc`__ and a `file type plugin`__, which is only sourced for PHP
code. Installation instructions can be found in the `README.txt`__, too.

.. __: http://svn.toby.phpugdo.de/horde/chora/browse.php?f=%2F.vimrc
.. __: http://svn.toby.phpugdo.de/horde/chora/browse.php?f=.vim%2Fftplugin%2Fphp.vim
.. __: http://svn.toby.phpugdo.de/horde/chora/browse.php?f=%2FREADME.txt

**Update 2**:

I also added the repository to SVNServe now, so you can check it out using
"svn co svn://phpugdo.de/PDV".


..
   Local Variables:
   mode: rst
   fill-column: 79
   End: 
   vim: et syn=rst tw=79

Trackbacks
==========


Comments
========

- Jan at Fri, 01 Dec 2006 11:55:01 +0100

  Hello Tobias, can you please put your latest vimrc back online? The old
  links don't work anymore... Much appreciated!

- Toby at Fri, 01 Dec 2006 11:56:37 +0100

  It's also in SVN. It's just splitted into a general .vimrc and the file type
  plugin for PHP (see .vim/ftplugins/php.vim).

- Thomas Koch at Fri, 01 Dec 2006 14:14:07 +0100

  Hi Tobias,

  two questions: * Does PDV also actualize a comment if I've changed variables
  or the function name or ... * Is it possible to have php files opened with
  all functions automaticaly folded?

  Thanks, Thomas Koch

- Toby at Fri, 01 Dec 2006 22:42:15 +0100

  Hi Thomas!

  Regarding your questions:

  1. No, PDV does not parse docs again and update them, if you change anything
  in your code. That would be a bit too hard, without writing a real parser
  for the doc blocks and the code. Sorry.

  2. That is possible. You can choose foldmethod=syntax and then give a regex
  for fold start and end. The basic idea can be grabbed from here:

  http://www.vim.org/tips/tip.php?tip_id=1376

  Regards, Toby

- Matthew Weier O'Phinney at Fri, 01 Dec 2006 22:57:21 +0100

  Tobias -- could you put the source for the vimgrep script up somewhere?

- Toby at Fri, 01 Dec 2006 22:58:55 +0100

  I'll definitly do that. But it will take some more time, since it has some
  flaws. Stay tuned.

- Evert at Thu, 04 Jan 2007 16:39:03 +0100

  Is there are new location for the repository? I was going to see if there
  were any updates.. but then I found out the current svn:// link is broken..

- Toby at Thu, 04 Jan 2007 19:14:39 +0100

  There is: http://svn.toby.phpugdo.de/PDV/

  For checkout info see:
  http://svn.toby.phpugdo.de/horde/chora/co.php?r=30&f=CHECKOUT.txt

- Evert at Thu, 04 Jan 2007 20:05:34 +0100

  Thanks! got it

- Toby at Tue, 16 Feb 2010 08:55:18 +0100

  Note that PDV is now named VIP and hosted on github. For details, please
  refer to http://schlitt.info/opensource/blog/0719_pdv_vip_now_on_github.html