alexking.org » PHP Doc System | alexking.org http://alexking.org Alex King's blog - software, photography, sports, etc. Wed, 02 Jul 2008 19:51:08 +0000 http://wordpress.org/?v=2.2.3 en PHP Doc System 1.5.2 (Security Patch) http://alexking.org/blog/2006/04/05/phpdocsystem-152 http://alexking.org/blog/2006/04/05/phpdocsystem-152#comments Wed, 05 Apr 2006 23:09:59 +0000 Alex http://www.alexking.org/blog/2006/04/05/phpdocsystem-152/ SHARETHIS.addEntry({ title: "PHP Doc System 1.5.2 (Security Patch)", url: "http://alexking.org/blog/2006/04/05/phpdocsystem-152" });]]> I’ve released PHP Doc System version 1.5.2. This fixes the security vulnerability reported here. This vulnerability only affects people running PHP Doc System in “dynamic” mode on a public web site, not those (like me) who generate the static output and put that on their site.

It looks like this vulnerability was found back in Nov 2005, but I was just made aware of it recently (thanks visiblesoul). It is unfortunate when someone takes the time to post a vulnerability on SecurityFocus but doesn’t notify the developer.

ShareThis

]]> http://alexking.org/blog/2006/04/05/phpdocsystem-152/feed Search is Important http://alexking.org/blog/2005/03/20/search-is-important http://alexking.org/blog/2005/03/20/search-is-important#comments Sun, 20 Mar 2005 21:52:56 +0000 Alex http://www.alexking.org/blog/2005/03/20/search-is-important/ SHARETHIS.addEntry({ title: "Search is Important", url: "http://alexking.org/blog/2005/03/20/search-is-important" });]]> Note: this is one of a series of posts about the creation of the King Design web site.

One of the great benefits of using WordPress (or any CMS) to manage your web site is built in search capability. No matter how well you think you’ve structured your site, your site visitors will amaze you with creative ways to avoid finding the information you’ve tried to make available to them. Having search capabilities is one way to enable your visitors to get directly to what they are looking for.

WordPress provides searching for posts in the default configuration, but doesn’t support searching pages. I use pages for most a good deal of my site content, so it was important to me to have that content searchable as well. All it required was a little code change in wp-includes/classes.php (around line 490):

if (is_page()) {
$where .= ‘ AND (post_status = “static”‘;
} else {
$where .= ‘ AND (post_status = “publish”‘;
}
// Get private posts
if (isset($user_ID) && (” != intval($user_ID)))
$where .= ” OR post_author = $user_ID
AND post_status != ‘draft’
AND post_status != ’static’)”;
else
$where .= ‘)’;

becomes:

if (empty($_GET["s"])) {
if (is_page()) {
$where .= ‘ AND (post_status = “static”‘;
} else {
$where .= ‘ AND (post_status = “publish”‘;
}
// Get private posts
if (isset($user_ID) && (” != intval($user_ID)))
$where .= ” OR post_author = $user_ID
AND post_status != ‘draft’
AND post_status != ’static’)”;
else
$where .= ‘)’;
}
else {
$where .= ‘ AND
(post_status = “publish”
OR post_status = “static”)’;
}

(Note: Yes I asked Matt if this is a feature that would be good to include in the main codeline - the answer was no.)

I’ve added some additional code to present my search results grouped by type (Pages, FAQs and News) and also added options to search only FAQs and search only News. I’m not completely satisfied with the current implementation, but it was workable enough for an initial release of the site.

Currently, the Forums and the Tasks and Tasks Jr. documentation is not included in the main search, which is something I’ll likely work on over time. PunBB has its own search capabilities (that are frankly superior to the current WordPress capabilities), but it would be nice to integrate forum search results into the main search results. Since the Tasks and Tasks Jr. documentation is static HTML (created with PHP Doc System, I’ll need to integrate an additional system (likely PhpDig) to add search capabilities to that content. I tried an initial implementation when I was still developing the site, but never got it working as I wanted to.

I realize that Google (and probably others) provide other solutions, but I’d really like to keep the site interface consistent and Google doesn’t always have a current index of all of the content on a site. Perhaps there are other solutions I’m overlooking (comments are open).

ShareThis

]]> http://alexking.org/blog/2005/03/20/search-is-important/feed Searching for PHP Doc System http://alexking.org/blog/2004/11/03/searching-for-php-doc-system http://alexking.org/blog/2004/11/03/searching-for-php-doc-system#comments Wed, 03 Nov 2004 16:15:41 +0000 Alex http://www.alexking.org/blog/2004/11/03/searching-for-php-doc-system/ SHARETHIS.addEntry({ title: "Searching for PHP Doc System", url: "http://alexking.org/blog/2004/11/03/searching-for-php-doc-system" });]]> I’d like to add search capabilities to PHP Doc System output when it’s running on a web server. I also like being able to generate flat files for distribution (with a database backend).

Anyone have any bright ideas? Maybe an integration with a search project of sorts? Anyone want to tackle said integration?

ShareThis

]]> http://alexking.org/blog/2004/11/03/searching-for-php-doc-system/feed PHP Doc System Usability Enhancement http://alexking.org/blog/2004/04/18/php-doc-system-usability-enhancement http://alexking.org/blog/2004/04/18/php-doc-system-usability-enhancement#comments Sun, 18 Apr 2004 16:13:26 +0000 Alex http://www.alexking.org/blog/2004/04/18/php-doc-system-usability-enhancement/ SHARETHIS.addEntry({ title: "PHP Doc System Usability Enhancement", url: "http://alexking.org/blog/2004/04/18/php-doc-system-usability-enhancement" });]]> I added a little check to disable a link if the link is to the page currently being displayed. It’s a small change, but I think it’s an important one (and I don’t have immediate plans to add more features) so I’ve released this as PHP Doc System 1.5.1.

For example, you have a module ’sample_module’ and you include a link to that module in the module’s summary like this:

<p>This is a
<?php $sample_module->link(’sample module’); ?>
link in the summary.</p>

The link shows up when it is included in other modules, but not when showing the $sample_3 module. This technique is great because now whenever you display the summary as part of another module, it also includes a link back to the full page for that module.

Previously there was a problem with the page linking to itself. That is confusing, and documentation is one place it is important not to have confusion. :)

ShareThis

]]> http://alexking.org/blog/2004/04/18/php-doc-system-usability-enhancement/feed PHP Doc System 1.5 Released http://alexking.org/blog/2004/03/08/php-doc-system-15-released http://alexking.org/blog/2004/03/08/php-doc-system-15-released#comments Mon, 08 Mar 2004 14:18:10 +0000 Alex http://www.alexking.org/blog/2004/03/08/php-doc-system-15-released/ SHARETHIS.addEntry({ title: "PHP Doc System 1.5 Released", url: "http://alexking.org/blog/2004/03/08/php-doc-system-15-released" });]]> I’ve released PHP Doc System version 1.5. This includes the features and upgrades I made to the system when using it to build the Tasks Pro™ 1.0 documentation.

Here is a quick overview of the changes:

  • Added ‘Related Links’ sidebar
  • Created module generator page
  • Default and generated source is now XHTML compliant
  • More semantically accurate HTML
  • Re-did navigation links to be a single function

I’ve made the Tasks Pro 1.0 documentation source available for download as a sample project. I’d gotten several requests for a bigger sample project - this one should qualify. :mrgreen:

ShareThis

]]> http://alexking.org/blog/2004/03/08/php-doc-system-15-released/feed Drowning in Documentation http://alexking.org/blog/2004/02/11/drowning-in-documentation http://alexking.org/blog/2004/02/11/drowning-in-documentation#comments Thu, 12 Feb 2004 04:15:16 +0000 Alex http://www.alexking.org/blog/2004/02/11/drowning-in-documentation/ SHARETHIS.addEntry({ title: "Drowning in Documentation", url: "http://alexking.org/blog/2004/02/11/drowning-in-documentation" });]]> The last week now, I’ve spent most of my time writing documentation for Tasks Pro™. So far I’ve created 128 PHP Doc System modules (the static output is ~200k, zipped) in a cross-referenced mess that is about 2/3rds of where I need it to be and doesn’t have any screenshots yet. Ugh…

On the flip side, I’ve added some new features to PHP Doc System:

  • More semantically accurate HTML
  • Added ‘Related Links’ sidebar
  • Re-did navigation links to be a single function instead of separate functions
  • Created a module generator

The generator still needs a lot of polish, but that will wait until after I get Tasks Pro out the door. I’m tempted to throw a database behind this thing, but I like not having that requirement.

The best part is telling it to generate the static output and letting it chug away. :)

ShareThis

]]> http://alexking.org/blog/2004/02/11/drowning-in-documentation/feed PHP Doc System 1.2 Released http://alexking.org/blog/2003/11/10/php-doc-system-12-released http://alexking.org/blog/2003/11/10/php-doc-system-12-released#comments Tue, 11 Nov 2003 05:36:28 +0000 Alex http://www.alexking.org/blog/2003/11/10/php-doc-system-12-released/ SHARETHIS.addEntry({ title: "PHP Doc System 1.2 Released", url: "http://alexking.org/blog/2003/11/10/php-doc-system-12-released" });]]> I’ve released PHP Doc System version 1.2. The biggest change is the addition of Previous/Next links on each page. I’ll be updating my tasks and photos documentation to the latest version when I get a chance. Some of the changes in this version should make future upgrades easier.

This release includes some very nice contributions from John Asendorf who is using PHP Doc System to create new documentation for the Coppermine Photo Gallery. Thanks John!

ShareThis

]]> http://alexking.org/blog/2003/11/10/php-doc-system-12-released/feed PHP Doc System 1.1 Released http://alexking.org/blog/2003/09/25/php-doc-system-11-released http://alexking.org/blog/2003/09/25/php-doc-system-11-released#comments Fri, 26 Sep 2003 02:59:04 +0000 Alex http://www.alexking.org/blog/2003/09/25/php-doc-system-11-released/ SHARETHIS.addEntry({ title: "PHP Doc System 1.1 Released", url: "http://alexking.org/blog/2003/09/25/php-doc-system-11-released" });]]> I’ve done some minor clean-up on PHP Doc System and released it as version 1.1.

I’ve updated my tasks documentation and my photos documentation to use the latest version. Now you can see when each page in the docs was last modified.

ShareThis

]]> http://alexking.org/blog/2003/09/25/php-doc-system-11-released/feed Traffic http://alexking.org/blog/2003/05/22/traffic http://alexking.org/blog/2003/05/22/traffic#comments Fri, 23 May 2003 01:48:45 +0000 Alex http://www.alexking.org/blog/2003/05/22/traffic/ SHARETHIS.addEntry({ title: "Traffic", url: "http://alexking.org/blog/2003/05/22/traffic" });]]> PHP Doc System was the top item on the HotScripts PHP page today which resulted in a ton of traffic. I had over 850 1050 (updated 10:30pm) visits from there alone, add another 450 from Freshmeat and you’ve got a lot of people breezing through my site. It resulted in 250 downloads of PHP Doc System in the first 24 hours of the release which isn’t bad at all for a little developer tool like this.

ShareThis

]]> http://alexking.org/blog/2003/05/22/traffic/feed PHP Doc System 1.0 released http://alexking.org/blog/2003/05/21/php-doc-system-10-released http://alexking.org/blog/2003/05/21/php-doc-system-10-released#comments Wed, 21 May 2003 23:58:58 +0000 Alex http://www.alexking.org/blog/2003/05/21/php-doc-system-10-released/ SHARETHIS.addEntry({ title: "PHP Doc System 1.0 released", url: "http://alexking.org/blog/2003/05/21/php-doc-system-10-released" });]]> I’ve added a page for it to my site, just click on PHP Doc System in the software section.

I’m going to try running all the support and everything through the SourceForge project. If you’d like to contribute, head on over there and get to work. :)

ShareThis

]]> http://alexking.org/blog/2003/05/21/php-doc-system-10-released/feed PHP Doc System http://alexking.org/blog/2003/05/20/php-doc-system http://alexking.org/blog/2003/05/20/php-doc-system#comments Wed, 21 May 2003 05:20:08 +0000 Alex http://www.alexking.org/blog/2003/05/20/php-doc-system/ SHARETHIS.addEntry({ title: "PHP Doc System", url: "http://alexking.org/blog/2003/05/20/php-doc-system" });]]> I’m almost ready to put up version 1.0 of PHP Doc System, as I touched on in this post. It will be released under GPL and I’ve registered it as a project on SourceForge.net.

ShareThis

]]> http://alexking.org/blog/2003/05/20/php-doc-system/feed