phpDocumentor
[ class tree: phpDocumentor ] [ index: phpDocumentor ] [ all elements ]

Procedural File: PackagePageElements.inc

Source Location: /phpDocumentor/PackagePageElements.inc



Classes:

parserCData
Represents <![CDATA[ ]]> sections.
parserXMLDocBookTag
a standard XML DocBook Tag
parserEntity
a standard entity like &rdquo;


Page Details:

Data structures used in parsing XML DocBook-based tutorials

Conversion of DocBook-based tutorials is performed using special Converter class methods. By default, these methods simply retrieve simple rules for replacement of tags and slight re-ordering from the options.ini file present for every template.

In future versions, there may be utilization of xslt or other more powerful protocols. However, for most situations, the power of these classes will be more than sufficient to handle very complex documentation.

Note that an entire tutorial is contained in a single parserXMLDocBookTag, matching the document model for DocBook. The top-level tag, <refentry>, contains every other tag and all text.

phpDocumentor :: automatic documentation generator

PHP versions 4 and 5

Copyright (c) 2002-2008 Gregory Beaver

LICENSE:

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA




Tags:

tutorial:  phpDocumentor Tutorials
author:  Gregory Beaver <[email protected]>
version:  CVS: $Id: PackagePageElements.inc 253643 2008-02-24 04:27:54Z ashnazg $
copyright:  2002-2008 Gregory Beaver
link:  http://pear.php.net/PhpDocumentor
link:  http://www.phpdoc.org
todo:  CS cleanup - change package to PhpDocumentor
since:  1.2.0
license:  LGPL








Documentation generated on Tue, 06 Dec 2011 07:14:22 -0600 by phpDocumentor 1.4.4