Nintendo Wii forums Forum for writers phpBB mods Essays on copyright Dating advice Narnia forums

phpBB Better Breadcrumbs

Overview
Requirements
License
Manual installation
Patch installation
Patch upgrade
Troubleshooting
Changelog
Feedback
Logo

Overview

This is phpBB Better Breadcrumbs, version 2.0, released March 22, 2005. Copyright © 2005 by Tony Boyd.

The phpBB breadcrumb trail (the navigation) has a shortcoming: it shows the forums as the top level. This is fine if phpBB is your site's main home page. But what if it's not? Once you're in the forums, how do you navigate back up to the REAL home page? With a default install of phpBB, you don't. But with this patch, you can. I went through the subSilver .tpl files, and changed the breadcrumb from this:

sitename Forum Index

to this:

Home -> Forums

"Home" takes you up one level above your phpBB forums, presumably to a home page. "Forums" takes you to your main phpBB page. That was pretty much all version 1 did.

For version 2, I've included a lot of hand-made tweaks. The breadcrumb trail isn't just "Home -> Forums" anymore – for example, if you're in your private messages inbox, the breadcrumb trail will show "Home -> Forums -> Private messages -> Inbox." I really tried to make the breadcrumb trail helpful and informative. Here is a screenshot of what the breadcrumb trail looks like in a new topic page now:

breadcrumb trail example

Requirements

To make the changes manually, you'll need a brain. :) To use one of the two patch files, you'll need a patch utility, such as the one built into Linux.

License

My code is licensed to you under a GPL license, which should have been included with all these files.  The general summary of the GPL license is that you can use my code for free, even in a commerical business.  And you can modify my code.  But you must keep the license, keep the attribution, and any changes you sell or give away must also be GPL.  It is not public domain.  Do not remove license.txt.

Manual Installation

  1. Backup your forum directory.
  2. Open the file breadcrumb_install.txt and follow the directions.
  3. Although breadcrumb_install.txt only outlines how to change the subSilver template, you can also update other template directories, if they retained the subSilver-style breadcrumbs. Simply redo the appropriate steps for each template directory.

Patch Installation

  1. Backup your forum directory.
  2. Copy "patch_2.0.13_to_breadcrumb.txt" to the same place as your phpBB directory. In other words, don't put the patch IN your phpBB folder, but at the same level as your phpBB folder.
  3. If you're using a point-and-click tool for patches, lucky you, you're on your own at this point. Run the patch however you do it. But if you're using Linux or Unix, open a shell/telnet prompt and get to the directory that contains phpBB and the patch file.
  4. Issue this command at the prompt (all one line):
    patch -cl -d [PHPBB DIRECTORY] -p1 < patch_2.0.13_to_breadcrumb.txt
    (where "[PHPBB DIRECTORY]" should be the name of your phpBB directory).
  5. Watch for HUNK FAILED comments. If you get any such failures, you can examine the .rej files to determine what failed where and make manual adjustments to the relevant source.
  6. Delete the patch file after use.
  7. This will only update your subSilver templates. If you would like to run this patch on other template directories, it's possible to do so. You would need to open the patch in a text editor, remove the changes to usercp_register.php (the first 13 lines or so), and do a find and replace to change "/subSilver/" to whatever the new template directory is. But that's going to be error-prone unless you know what you're doing, and there is no guarantee that those other templates even HAVE a breadcrumb trail the patch can find & modify. A safer method would be to use step #3 from the manual install instructions.

Patch Upgrade

If you have already installed version 1.0.1 of phpBB Better Breadcrumbs, you can run the patch, "patch_old_breadcrumb_to_new.txt" to get your system up to version 2. Here's how:

  1. Backup your forum directory.
  2. Copy "patch_old_breadcrumb_to_new.txt" to the same place as your phpBB directory. In other words, don't put the patch IN your phpBB folder, but at the same level as your phpBB folder.
  3. If you're using a point-and-click tool for patches, lucky you, you're on your own at this point. Run the patch however you do it. But if you're using Linux or Unix, open a shell/telnet prompt and get to the directory that contains phpBB and the patch file.
  4. Issue this command at the prompt (all one line):
    patch -cl -d [PHPBB DIRECTORY] -p1 < patch_old_breadcrumb_to_new.txt
    (where "[PHPBB DIRECTORY]" should be the name of your phpBB directory).
  5. Watch for HUNK FAILED comments. If you get any such failures, you can examine the .rej files to determine what failed where and make manual adjustments to the relevant source.
  6. Delete the patch file after use.
  7. This will only update your subSilver templates. If you would like to run this patch on other template directories that have had the breadcrumb 1.0.1 changes applied already, it's possible to do so. You would need to open the patch in a text editor, remove the changes to usercp_register.php (the first 13 lines or so), and do a find and replace to change "/subSilver/" to whatever the new template directory is. But that's going to be error-prone unless you know what you're doing. A safer method would be to use step #3 from the manual install instructions.

Troubleshooting

I think I screwed up the files, how do I fix it?
Restore from the backup you were supposed to do before making changes.

Changelog

CHANGES FROM 1.0.1 to 2.0
  • Extended the breadcrumb trail beyond "Home -> Forums" to now show much more detail, depending upon whichever page you are viewing.
CHANGES FROM 1.0 to 1.0.1
  • Bugfixes.
1.0
  • Initial release.

Feedback

Please note that no support is provided by the developer.  However, there is a community-based forum for discussion.  If you have questions, bug reports, code improvements to share, feedback, and/or feature requests, go here:

http://www.outshine.com/forums/

phpBB Better Breadcrumb logo

The phpBB Better Breadcrumb logo is copyright 2005 by Anthony Boyd. It may not be used for other purposes.