Hide Notes 

Slide 1: THE PHP DOCUMENTOR OSScamp, Impetus Noida, Sept, ’07 Arunima Goswami Technical Sales Manager, OSSCube
Slide 2: INDEX What & Why of Documentation ? What , Why and How of PHP Documenter? Example
Slide 3: Documentation : A bird’s viewpoint WHY  Now a standard  Required in teams  Assisting new team members  Display how code is designed WHY NOT  Grueling process  Time consuming
Slide 4: What Is Documentation ? Recording in a particular format information that describes the code/product. Documentation is often divided into the following categories: – Installation – Reference – Tutorial
Slide 5: WHAT DOES ONE WANT ? End User  Instruction-style writing  Interface information only  Examples and tutorials Developer  How program elements interact  Where action occurs  How to extend the code
Slide 6: What is PHP Documenter ? A PHP code document generation tool which is a stand-alone professional documenter that is written in PHP designed to easily and efficiently generate PHP code documents in HTML from PHP project source code and/or external documentation.
Slide 7: WHY ? • Output in HTML, PDF (directly), CHM (with windows help compiler), XML DocBook • Very fast • Fully customizable output with Smarty-based templates • Recognizes JavaDoc-style documentation with special tags customized for PHP 4 • Automatic linking, class inheritance diagrams and intelligent override
Slide 8: Cont’d … • Customizable source code highlighting • Parses standard README/CHANGELOG/INSTALL/FAQ files and includes them directly in documentation • Linking between external manual and API documentation is possible at the sub-section level in all output formats • user.ini files can be used to control output, multiple outputs can be generated at once
Slide 9: Installation • Download from Pear.Php.net or Sourceforge.net • Have Apache and PHP installed • If using pear then simply run: $ pear install PhpDocumentor • You can then browse to http://localhost/pear/PhpDocumentor to have access to the web interface. • Else you can use third party tools such as ZEND studio which has php documenter in it
Slide 10: EXAMPLE
Slide 11: Thank you! For more information, contact us: OSSCube India: +91 995 809 0987 USA: +1 919 791 5427 Web: www.osscube.com Mail: info@osscube.com