PHP Doc System Usability Enhancement

Posted in: PHP Doc System

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. :)

Popularity: 3% [?]

Posted April 18th, 2004 @ 10:13 AM

Add a Comment

Please note: Use of a non-personal web site or blog in the field below and/or comments that are off-topic, personal attacks, or support requests will likely be removed at my discretion.

Note: This post is over 4 years old. You may want to check later in this blog to see if there is new information relevant to your comment.

A word of advice… » « Around the web

About This Site

This is the personal web site of Alex King, a web developer in Denver, Colorado USA. More...


Crowd Favorite

Crowd Favorite is my software and web development business.

We build web applications, design and develop custom WordPress themes and plugins, and build custom sites using WordPress as a CMS.


I also have a tumblog that aggregates my online content from other services (Twitter, Flickr, del.icio.us. etc.).

I'm voting for Barack Obama

Ads