mx Sitemaps Auto link Add on for mxBB

---

Module name : mx Sitemaps Auto link Add on for mxBB

Module author : dcz / www.phpBB-SEO.com

MOD Description : This Add on mod creates Dynamic links to your mx_sitemaps Site Maps.

Module version : v0.1

Installation Level : Easy.

Installation Time : 2 Minutes.

Author's Notes :

---

This is the mxBB Portal version. phpBB users will prefer Auto Link Add On For phpBB.

You must install mx SiteMaps Module prior to use this Add On.

This code change will output links to your Site Maps in your Forum's and Portal's footer.
It will output a link to the Site Map Index, A link the the mxBB Page's Map as well as a link to the Forum Map.
When browsing a specific forum, an extra link to the specific forum map will be additionnaly outputted.

This Add On will enhance your site map as far as Search Engine Optimization. Bots will crawl upon those links and stick to the sitemap, discovering tons of new links to your pages.

---

Supported Languages :

English, French.

Demo :

phpBB "Vanilla" Installation
Site Map Index
Forum Map
The Forum n°2 Map

Running mxBB :

Download File :

There are three versions of this script in the package, one for "vanilla" url, one for the standalone mod (no mod_Rewrite) and one for when mod Rewrite Version is on.

Download the full package.

Current Features :

While Browsing portal's pages :
Will output a link to the Site Map Index as well as a link the the mxBB Page's Map in the footer.

While Browsing Forum :
Will output a link to the Site Map Index as well as a link the the Forum Map in the footer.

While Browsing a Forum :
Will add to the previous two an extra link to the specific forum's Map.

Planned features :

More type of outputs :
Plan to add more types of outputs, for example to be able to auto link in the header also.

Support :

English Support On this Thread. If you need some specific adaptation, please start a new thread in this Forum.
Support Francophone

mx Sitemaps Auto link Add On for mxBB Portal : "Vanilla Url Version"

This version of the Add On is ment to be used with mx Sitemaps running with mxBB Portal.
The proper set up for mx Sitemaps with this Add On version is when Standalone Mode is set to "NO", and thus mod Rewrite for Sitemaps too.

With this Add On, Sitemap's Url will be :

-http://www.example.com/mxBB/index.php?page=MX_PAGE_ID => Site Map Index

-http://www.example.com/mxBB/index.php?page=MX_PAGE_ID&mx => mxBB Page Map

-http://www.example.com/mxBB/index.php?page=MX_PAGE_ID&fim => Forum Index Map

-http://www.example.com/mxBB/index.php?page=MX_PAGE_ID&fmp=xx => Forum xx Map

Code: Select all

##############################################################
## MOD Title: mx Sitemaps Auto link Add on for mxBB Portal - Standalone Version
## MOD Author: dcz <n/a> http://www.phpbb-seo.com/
## MOD Description:  This Add on mod creates Dynamic links to your mx_sitemaps Site Maps.
## MOD Version: 0.0.1
##
## Installation Level:  Easy.
## Installation Time: 2 Minutes.
##
## Files To Edit: 4,
##      includes/page_tail.php
##      templates/subSilver/overall_footer.tpl
##      phpbb/includes/page_tail.php
##      phpbb/templates/subSilver/overall_footer.tpl
##
## Included Files: 0
##
## License: http://opensource.org/licenses/gpl-license.php GNU General Public License v2
##############################################################
## For security purposes, please check: http://www.phpbb.com/mods/
## for the latest version of this MOD. Although MODs are checked
## before being allowed in the MODs Database there is no guarantee
## that there are no security problems within the MOD. No support
## will be given for MODs not found within the MODs Database which
## can be found at http://www.phpbb.com/mods/
##############################################################
## Author Notes:
##    This code change will output links to your Site Maps in your Forum's footer.
##    It will output the link to the Site Maps as well as the link to the
##   Forum Map.
##   When browsing a specific forum, an extra link to the specific forum map
##   Will be outputed as well.
##
## NOT tested with EasyMod, but should work :-)
##############################################################
## MOD History:
##
##   2006-04-21 - Version 0.0.1
##      - This is the first version.
##   Fully tested working, no known bugs so far.
##
##############################################################
## Before Adding This MOD To Your Forum, You Should Back Up All Files Related To This MOD
##############################################################

This one goes like this :


For the mxBB php part, one file to edit :

Code: Select all

#
#-----[ OPEN ]------------------------------------------
#
includes/page_tail.php
#
#-----[ FIND ]------------------------------------------
#
//
// Show the overall footer.
//
#
#-----[ BEFORE, ADD ]------------------------------------------
# Be sure here to replace "PAGE_ID" with the actual page Id of the mxBB site map's page.
# Note : You can here set up the link titles also.

//Begin mx_Sitemaps Auto link Add On http://www.phpbb-seo.com/
$mx_page =( isset($HTTP_GET_VARS['page']) )? intval($HTTP_GET_VARS['page']) : 0;
if ( $mx_page == 2 )
{
   $mx_link_tmp = append_sid(PORTAL_URL . 'index.'. $phpEx .'?page=PAGE_ID&fim');
   $link_title = $page_row['page_name'].' - Map';
   $mx_sitemap_link = '<a href="'.$mx_link_tmp.'" class="copyright" title="'.$link_title.'">'.$link_title.'</a>';
   $mx_sitemap_link .= '<br /><a href="'.append_sid(PORTAL_URL . 'index.'. $phpEx .'?page=PAGE_ID&amp;mx').'" class="copyright" title="'.$portal_config['portal_name'].' : mxBB Pages Map">mxBB Map</a>';   
   $mx_sitemap_link .= '<br /><a href="'.append_sid(PORTAL_URL . 'index.'. $phpEx .'?page=PAGE_ID').'" class="copyright" title="'.$portal_config['portal_name'].' : Site Map">Site Map</a>';
}
else
{
   $mx_sitemap_link = '<a href="'.append_sid(PORTAL_URL . 'index.'. $phpEx .'?page=PAGE_ID&amp;mx').'" class="copyright" title="'.$portal_config['portal_name'].' : mxBB Pages Map">mxBB Map</a>';
   $mx_sitemap_link .= '<br /><a href="'.append_sid(PORTAL_URL . 'index.'. $phpEx .'?page=PAGE_ID').'" class="copyright" title="'.$portal_config['portal_name'].' : Site Map">Site Map</a>';
}
//End mx_Sitemaps Auto link Add On http://www.phpbb-seo.com/
#
#-----[ FIND ]------------------------------------------
#
$template->assign_vars(array(
#
#-----[ AFTER, ADD ]------------------------------------------
#
   'U_SITEMAPS' => $mx_sitemap_link,

In this part you have to make sure to put the proper PAGE_ID in the code. This is the ID of the page in wich your site map is installed in the portal.

And the mxBB Template part :

Code: Select all

#
#-----[ OPEN ]------------------------------------------
#

templates/subSilver/overall_footer.tpl

#
#-----[ FIND ]------------------------------------------
#
</span></div>
#
#-----[ REPLACE WITH ]------------------------------------------
#
</span><br />{U_SITEMAPS}<br /></div>

Which you can change upon your needs. {U_SITEMAPS} Stands for the complete html link to the sitemap, you can use it where you want in the overall_footer.tpl.

And now the phpBB part :

For the phpBB php part, one file to edit :

Code: Select all

#
#-----[ OPEN ]------------------------------------------
#
phpbb/includes/page_tail.php
#
#-----[ FIND ]------------------------------------------
#
//
// Show the overall footer.
//
#
#-----[ BEFORE, ADD ]------------------------------------------
# Make sure to change here "URL_TO_THE_FOLDER_WHERE_YOUR_SITEMAP_IS_INSTALLED" with the actual URL to the folder.
# Be sure here to replace "PAGE_ID" with the actual page Id of the mxBB site map's page.
# Note : You can here set up the link titles also.

//Begin mx_Sitemaps Auto link Add On http://www.phpbb-seo.com/
$mx_forum_id =( isset($HTTP_GET_VARS[POST_FORUM_URL]) )? intval($HTTP_GET_VARS[POST_FORUM_URL]) : 0;
$root_url = 'http://URL_TO_THE_FOLDER_WHERE_YOUR_SITEMAP_IS_INSTALLED/';
if ( $mx_forum_id != 0 )
{
   $mx_link_tmp = append_sid($root_url . 'index.'. $phpEx .'?page=PAGE_ID&fmp='. $mx_forum_id);
   $link_title = $forum_row['forum_name'].' - Map';
   $mx_sitemap_link = '<a href="'.$mx_link_tmp.'" class="copyright" title="'.$link_title.'">'.$link_title.'</a>';
   $mx_sitemap_link .= '<br /><a href="'.append_sid($root_url . 'index.'. $phpEx .'?page=PAGE_ID&amp;fim').'" class="copyright" title="'.$board_config['sitename'].' : Forum Map">Forum Map</a>';
   $mx_sitemap_link .= '<br /><a href="'.append_sid($root_url . 'index.'. $phpEx .'?page=PAGE_ID&amp;mx').'" class="copyright" title="mxBB Pages Map">mxBB Map</a>';
   $mx_sitemap_link .= '<br /><a href="'.append_sid($root_url . 'index.'. $phpEx .'?page=PAGE_ID').'" class="copyright" title="'.$board_config['sitename'].' : Site Map">Site Map</a>';
}
else
{
   $mx_sitemap_link = '<a href="'.append_sid($root_url . 'index.'. $phpEx .'?page=PAGE_ID&amp;fim').'" class="copyright" title="'.$board_config['sitename'].' : Forum Map">Forum Map</a>';
   $mx_sitemap_link .= '<br /><a href="'.append_sid($root_url . 'index.'. $phpEx .'?page=PAGE_ID&amp;mx').'" class="copyright" title="mxBB Pages Map">mxBB Map</a>';
   $mx_sitemap_link .= '<br /><a href="'.append_sid($root_url . 'index.'. $phpEx .'?page=PAGE_ID').'" class="copyright" title="'.$board_config['sitename'].' : Site Map">Site Map</a>';
}
//End mx_Sitemaps Auto link Add On http://www.phpbb-seo.com/

#
#-----[ FIND ]------------------------------------------
#
$template->assign_vars(array(
#
#-----[ AFTER, ADD ]------------------------------------------
#
   'U_SITEMAPS' => $mx_sitemap_link,


In this part you have to make sure to put the proper url to your sitemap's folder (the folder in which stands the sitemaps.php file). Be sure as well to replace "PAGE_ID" with the actual page Id of the mxBB site map's page.

And the phpBB Template part :

Code: Select all

#
#-----[ OPEN ]------------------------------------------
#

phpbb/templates/subSilver/overall_footer.tpl

#
#-----[ FIND ]------------------------------------------
#
</span></div>
#
#-----[ REPLACE WITH ]------------------------------------------
#
</span><br />{U_SITEMAPS}<br /></div>


#
#-----[ SAVE/CLOSE ALL FILES ]------------------------------------------
#
# EoM

Which you can change upon your needs. {U_SITEMAPS} Stands for the complete html link to the sitemap, you can use it where you want in the overall_footer.tpl.

mx Sitemaps Auto link Add On for mxBB Portal : "Vanilla Url Version - Standalone"

This version of the Add On is ment to be used with mx Sitemaps running with mxBB Portal.
The proper set up for mx Sitemaps with this Add On version is when Standalone Mode is set to "YES", and mod Rewrite for Site maps to "NO".

Remember to put your sitemaps.php file at the root level of your portal in order to use the Standalone Mode.
Since you are running in Standalone Mode you can use the show online feature of mx Sitemaps.

With this Add On, Sitemap's Url will be :

-http://www.example.com/mxBB/sitemap.php => Site Map Index

-http://www.example.com/mxBB/sitemap.php?mx => mxBB Page Map

-http://www.example.com/mxBB/sitemap.php?fim => Forum Index Map

-http://www.example.com/mxBB/sitemap.php?fmp=xx => Forum xx Map

The install is pretty much the same as for the Embed version, but you d'ont have to put the PAGE_ID, since the module is not integrated in the portal anymore.

Pros and cons are, using the sitemap in Standalone mod will not allow you to add extra blocks and such from within the Portal ACP, you will still be able to add a viewonline block as well as any other option of the Sitemap Module. But you will save some server ressources, and will have dynamic page titles, which is a very important Search Engine Optimization.

Two pages with the same title will not be well indexed, so if you don't use the standalone Mode, the Sitemap will be mostly be usefull to your members.

But the major improvement is to be able to use the mod Rewrite for Sitemaps.
No matter if you are using mod Rewrite for your forum, the use of rewrited links for your sitemaps will make it a better Search Engine Optimization.

For this you will need to use one of the mod Rewrite Version of this mod.

mx Sitemaps Auto link Add On for mxBB Portal : "mod Rewrite Version"

This version of the Add On is ment to be used with mx Sitemaps running with mxBB Portal.
The proper set up for mx Sitemaps with this Add On version is when Standalone Mode and mod Rewrite are set to "YES".

Remember to put your sitemaps.php file at the root level of your portal in order to use the Standalone Mode.
Since you are running in Standalone Mode you can use the show online feature of mx Sitemaps.

Two cases again here, if you use either the phpBB SEO Advanced or Mixed Mod Rewrite, titles will be injected in the forum's sitemaps links, if using any other, they wil be rewrited in a static manner.

Using either the phpBB SEO Advanced or Mixed Mod Rewrite:

-http://www.example.com/mxBB/sitemaps.html => Site Map Index

-http://www.example.com/mxBB/mx-map.html => mxBB Page Map

-http://www.example.com/mxBB/forum-map.html => Forum Index Map

-http://www.example.com/mxBB/forum-title-smpxx.html => Forum xx Map

Using any other Mod Rewrite:

-http://www.example.com/mxBB/sitemaps.html => Site Map Index

-http://www.example.com/mxBB/mx-map.html => mxBB Page Map

-http://www.example.com/mxBB/forum-map.html => Forum Index Map

-http://www.example.com/mxBB/forum-mapxx.html => Forum xx Map

So if you are using either the phpBB SEO Advanced or Mixed Mod Rewrite, please apply the files located in the phpBB_SEO_mod_Rewrites/ folder of this package, if not use the one located in the other_mod_rewrites/ folder instead.

In both cases the install is pretty much the same as for the standalone version, you just have to apply different code changes.

Support Follows

Same fix apply as for phpBB auto link add on :

You just have to do the following code change to the phpBB's page_tail.php.

Title Injection : Mixed & Advanced phpBB SEO mod Rewrite

mod phpBB SEO Advanced mod Rewrite & phpBB SEO Advanced mod Rewrite, user will have to apply the following code changes. Title will thus be injected in mx sitemaps links.

Code: Select all

#
#-----[ OPEN ]------------------------------------------
#
includes/page_tail.php
#
#-----[ FIND ]------------------------------------------
#

   $mx_link_tmp = append_sid($root_url . 'forum-map' . $mx_forum_id . '.html');

#
#-----[ REPLACE WITH ]------------------------------------------
#

   $mx_link_tmp = append_sid($root_url . format_url($forum_row['forum_name']) . '-fmp' .$mx_forum_id . '.html');

Here are the Rewriterules you will have to use :

Code: Select all

#########################################################
# MX SITEMAPS REWRITE RULES   ADVANCED                              #
#########################################################
# AUTHOR : dcz http://www.phpbb-seo.com/
# STARTED : 2006/04/28
########################################################
RewriteRule ^sitemaps([0-9]+)\.html$ /sitemaps.php?c=$1 [QSA,L]
RewriteRule ^sitemaps\.html$ /sitemaps.php [QSA,L]
RewriteRule ^forum-m\ap\.html$ /sitemaps.php?fim [QSA,L]
RewriteRule ^.+-fmp([0-9]+)-([0-9]+)\.html$ /sitemaps.php?fmp=$1&start=$2 [QSA,L]
RewriteRule ^.+-fmp([0-9]+)\.html$ /sitemaps.php?fmp=$1 [QSA,L]
RewriteRule ^.+-sc([0-9]+)\.html$ /sitemaps.php?c=$1 [QSA,L]
#########################################################
# END SITEMAPS REWRITE RULES            #
#########################################################

Or, if phpBB is installed in a sub folder :

Code: Select all

#########################################################
# MX SITEMAPS REWRITE RULES   ADVANCED                              #
#########################################################
# AUTHOR : dcz http://www.phpbb-seo.com/
# STARTED : 2006/04/28
########################################################
RewriteRule ^phpbb/sitemaps([0-9]+)\.html$ /phpbb/sitemaps.php?c=$1 [QSA,L]
RewriteRule ^phpbb/sitemaps\.html$ /phpbb/sitemaps.php [QSA,L]
RewriteRule ^phpbb/forum-m\ap\.html$ /phpbb/sitemaps.php?fim [QSA,L]
RewriteRule ^phpbb/.+-fmp([0-9]+)-([0-9]+)\.html$ /phpbb/sitemaps.php?fmp=$1&start=$2 [QSA,L]
RewriteRule ^phpbb/.+-fmp([0-9]+)\.html$ /phpbb/sitemaps.php?fmp=$1 [QSA,L]
RewriteRule ^phpbb/.+-sc([0-9]+)\.html$ /phpbb/sitemaps.php?c=$1 [QSA,L]
#########################################################
# END SITEMAPS REWRITE RULES            #
#########################################################

According to the specific hoster you are using, you might have to get rid of the "/" at the beginning of "phpbb/".
Make sure to change phpbb/ with the actual folder name where phpBB is installed.