Package home | Report new bug | New search | Development Roadmap Status: Open | Feedback | All | Closed Since Version 1.2.4

Doc Bug #12273 End-user documentation is missing
Submitted: 2007-10-18 17:41 UTC
From: motin Assigned:
Status: Open Package: HTML_BBCodeParser (version 1.2.2)
PHP Version: 5.2.1 OS: All
Roadmaps: (Not assigned)    
Subscription  


 [2007-10-18 17:41 UTC] motin (Fredrik Motin)
Description: ------------ To make this great class available for more users, why not put some short code examples as end-user documentation. At first I had to look in the file system just to be able to get the require_once right! Then, I followed some examples in the main class phpDoc which got me half-way, but I had to hunt down how to get BBCodeParser to parse [url][/url] by looking at the source code. So the bug here is: I click on Documentation... Test script: --------------- Click on Documentation on the Package summary page... Expected result: ---------------- [The information from the phpDoc of the main class] Here is a brief code example to get you going: // Example: Parse BBCode with Links filter // We need to include the BB Code Parser class require_once 'HTML/BBCodeParser.php'; // We specify that we want to use the Links filter $options['filters'] = array('Links'); // Other filters include 'Email', 'Extended', 'Images' and 'Lists' // Initiate class $parser = new HTML_BBCodeParser($options); // Specify the text to be parsed $parser->setText('text with an [url]http://pear.php.net[/url]'); // Parse and echo out the return value $parser->parse(); echo $parser->getParsed(); Actual result: -------------- "No end-user documentation is available for this package."

Comments

 [2007-10-18 17:44 UTC] motin (Fredrik Motin)
Here is a great tutorial on how to use the class as well: http://www.sitepoint.com/article/bb-code-php-application