# Zoints SEO 2.2.2
# Copyright (C) 2006  Zoints Inc
# 
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
# 
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# Lesser General Public License for more details.
# 
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
# 

                USAGE
________________________________________

Installing the product adds a new category to the Admin Control Panel under the
"vBulletin Options" category titled "Zoints SEO." This category contains several
links:
	a. SEO Options
		This is a shortcut to the Options also accessible through the "vBulletin
		Options" menu. This page contains a lot of settings that are necessary
		to configure the SEO Package. Each option has an individual description
		under the title.
	b. Meta Keywords
		If you have enabled the "Use custom meta keywords" option, you can use
		this link in order to add custom meta keywords for each individual
		forum. To add a new set of keywords, select the forum where you want
		the keywords to show up and enter the text on the line below. Then
		hit "Add."
	c. Meta Description
		If you have enabled the "Use custom meta descriptions" option, you can
		use this link in order to add custom meta descriptions for each forum.
		This page behaves exactly like the "Meta Keywords" page, see above for
		further explanation.
	d. Dynamic Guest Messages
		If you have enabled dynamic guest messages, use this link in order to
		set them. See "Meta Keywords" for usage instructions.
	e. 'No Permission' Messages
		If you have enabled custom 'no permission' messages you can enter them
		here. To add new ones you can either enter a title / message pair, or
		you can check the box in order to inherit from the dynamic guest
		messages. What this does is use the dynamic guest message as the title
		/ message pair. If it does not find a guest message for that specific
		forum, it will use the parent forum's (or the default one, if no more
		parent forums are found).
	f. Archive Ads
		With this page you can add ads into many different locations in the archive.
		The form to add a new ad is located at the bottom of the overview page. You
		can choose to display more than one ad in any given placement, they will be
		displayed sequentially on new lines.
		The ad code allows any HTML and some variables ($foruminfo, $threadinfo), as
		well as Zoints Adsense Sharing ads, such as $zointsads[Keyword]. 



              INSTALLATION
________________________________________

1. Upload the files
========================================
Upload all of the files included in the /upload/ directory of this zip file to your
forum directory. 

	/upload/admincp/zseo.php				=> <forum dir>/admincp/zseo.php
	/upload/includes/xml/cpnav_zointsseo.xml		=> <forum dir>/includes/xml/cpnav_zointsseo.xml
	/upload/includes/functions_zseo.php			=> <forum dir>/includes/functions_zseo.php
	/upload/includes/functions_zseo_archive.php	=> <forum dir>/includes/functions_zseo_archive.php
	/upload/sitemap/						=> <forum dir>/sitemap/ (create new folder)
	/upload/sitemap/index.php				=> <forum dir>/sitemap/index.php


2. Import the product
========================================
Import the product "product-zointsseo-2.2.2.xml" in the vBulletin product manager.

	AdminCP > Plugin System > Manage Products > [Add/Import Product]
	(Set "Allow Overwrite" to "Yes")


3. .htaccess edit (required for the mod_rewrite option)
========================================
This step is only necessary if you are planning on using the mod_rewrite option to
rewrite the URLs. Please note that you will have to have mod_rewrite support enabled
on your server.

File: /.htaccess (If it does not exist, create it)

If the following two lines already exist, then skip ahead to the next edit, otherwise
add them at the end of the file

----------------------------------------
Options +FollowSymlinks
RewriteEngine on
----------------------------------------

Add the following lines at the end of the file
----------------------------------------
RewriteRule ^([a-z0-9_\-]*-(f|all)[0-9]+(p[0-9]+|/index[0-9]*)?\.html)$ forumdisplay.php/$1 [QSA,L]
RewriteRule ^([a-z0-9_\-]*-(t|p)[0-9]+(p[0-9]+|/index[0-9]*)?\.html)$ showthread.php/$1 [QSA,L]
RewriteCond %{REQUEST_URI} !(index\.php|\.css) [NC]
RewriteRule ^(archive|sitemap)/(.*)$ $1/index.php/$2 [QSA,L]
----------------------------------------





4. Template Edits
========================================

These only need to be done in case the automatic template modification code fails.

a. The "Display Options" on forumdisplay.php do not use the keywords in url.

	Follow the instructions provided in the file /templates/FORUMDISPLAY.txt of 
	this archive file. (1 edit)

b. The keywords in url do not show up on forumdisplay.php or search.php (using the 
   "view threads" option)

	Follow the instructions provided in the file /templates/threadbit.txt of 
	this archive file. (6 edits)

c. The keywords in url do not show up on index.php or forumdisplay.php in the last
   'last post by' column.

	Follow the instructions provided in the file /templates/forumhome_lastpostby.txt of 
	this archive file. (3 edits)

d. The keywords in url do not show up on search.php (using the "view posts" option)

	Follow the instructions provided in the file /templates/search_results_postbit.txt 
	of this archive file. (3 edits)


e. The custom meta keywords and/or description do not show up:

Edit template: headinclude
==================================================
		FIND
==================================================
<if condition="$show['threadinfo']">
<meta name="keywords" content="$threadinfo[title], $vboptions[keywords]" />
<meta name="description" content="<if condition="$pagenumber>1"><phrase 1="$pagenumber">$vbphrase[page_x]</phrase>-</if>$threadinfo[title] $foruminfo[title_clean]" />
<else />
	<if condition="$show['foruminfo']">
<meta name="keywords" content="$foruminfo[title_clean], $vboptions[keywords]" />
<meta name="description" content="<if condition="$pagenumber>1"><phrase 1="$pagenumber">$vbphrase[page_x]</phrase>-</if>$foruminfo[description_clean]" />
	<else />
<meta name="keywords" content="$vboptions[keywords]" />
<meta name="description" content="$vboptions[description]" />
	</if>
</if>
==================================================
		REPLACE WITH
==================================================
<meta name="keywords" content="$vboptions[keywords]" />
<meta name="description" content="$vboptions[description]" />
===================================================

===================================================



f. The links on the forum front page do not use the keywords in url.
(6 edits)


Edit template: forumhome_forumbit_level1_nopost
==================================================
		FIND
==================================================
			<a href="forumdisplay.php?$session[sessionurl]f=$forum[forumid]">$forum[title]</a>
==================================================
		REPLACE WITH
==================================================
			<a href="<if condition="$show['zointsurl']">$forum[zointsurl]<else />forumdisplay.php?$session[sessionurl]f=$forum[forumid]</if>">$forum[title]</a>
==================================================

==================================================


Edit template: forumhome_forumbit_level1_post
==================================================
		FIND
==================================================
				<a href="forumdisplay.php?$session[sessionurl]f=$forum[forumid]"><strong>$forum[title]</strong></a>
==================================================
		REPLACE WITH
==================================================
				<a href="<if condition="$show['zointsurl']">$forum[zointsurl]<else />forumdisplay.php?$session[sessionurl]f=$forum[forumid]</if>"><strong>$forum[title]</strong></a>
==================================================

==================================================



Edit template: forumhome_forumbit_level2_nopost
==================================================
		FIND
==================================================
		<a href="forumdisplay.php?$session[sessionurl]f=$forum[forumid]">$forum[title]</a>
==================================================
		REPLACE WITH
==================================================
		<a href="<if condition="$show['zointsurl']">$forum[zointsurl]<else />forumdisplay.php?$session[sessionurl]f=$forum[forumid]</if>">$forum[title]</a>
==================================================

==================================================



Edit template: forumhome_forumbit_level2_post
==================================================
		FIND
==================================================
			<a href="forumdisplay.php?$session[sessionurl]f=$forum[forumid]"><strong>$forum[title]</strong></a>
==================================================
		REPLACE WITH
==================================================
			<a href="<if condition="$show['zointsurl']">$forum[zointsurl]<else />forumdisplay.php?$session[sessionurl]f=$forum[forumid]</if>"><strong>$forum[title]</strong></a>
==================================================

==================================================


Edit template: forumhome_subforumbit_post
==================================================
		FIND
==================================================
<a href="forumdisplay.php?$session[sessionurl]f=$forum[forumid]">$forum[title]</a>
==================================================
		REPLACE WITH
==================================================
<a href="<if condition="$show['zointsurl']">$forum[zointsurl]<else />forumdisplay.php?$session[sessionurl]f=$forum[forumid]</if>">$forum[title]</a>
==================================================

==================================================


Edit template: forumhome_subforumbit_nopost
==================================================
		FIND
==================================================
<a href="forumdisplay.php?$session[sessionurl]f=$forum[forumid]">$forum[title]</a>
==================================================
		REPLACE WITH
==================================================
<a href="<if condition="$show['zointsurl']">$forum[zointsurl]<else />forumdisplay.php?$session[sessionurl]f=$forum[forumid]</if>">$forum[title]</a>
==================================================

==================================================


g. The following template edit only needs to be done if you have dynamic guest 
messages enabled and the default guest message on FORUMHOME still shows up

Edit template: FORUMHOME
==================================================
		FIND
==================================================
	<if condition="$show['guest']">
	<!-- guest welcome message -->
	<tr>
		<td class="tcat" colspan="<if condition="$vboptions['showmoderatorcolumn']">6<else />5</if>"><phrase 1="$vboptions[bbtitle]">$vbphrase[welcome_to_the_x]</phrase></td>
	</tr>
	<tr>
		<td class="alt1" colspan="<if condition="$vboptions['showmoderatorcolumn']">6<else />5</if>">
			<phrase 1="faq.php$session[sessionurl_q]" 2="register.php$session[sessionurl_q]">$vbphrase[first_visit_message]</phrase>
		</td>
	</tr>
	<!-- / guest welcome message -->
	</if>
==================================================
		REMOVE IT
==================================================


h. The keywords in url do not show up in the similar threads

	Follow the instructions provided in the file /templates/showthread_similarthreadbit.txt
	of this archive file. (1 edit)