Board Optimization - United-Forum CSS Sprites - ludicrous speed - NOW!

tl;dr Makes your forum faster.

Want an easy one-click installation for this addon? . Vote for this jira-entry

Add on currently is in beta stage

When visiting a website, speed is a very important factor not only for users but crawlers as well. Long loading times are a nuisance since your time is basically wasted during the waiting period. Hence, we are trying everything we can in order to speed up our site. One great way to improve loading times is by the use of css sprites. Unfortunately these are not implemented by vBulletin.

We therefore decided to develop our own css-sprite add on for vBulletin boards and want to share this code with the worldwide vBulletin community.

Live demo

The add on is permanently running in our vBulletin board ( > 2.000.000 posts), take a look:
http://www.united-forum.de

The add on will be supported via this thread. If you have any questions, issues, improvements or feedback regarding this add on, please feel free to post a comment or write us a pm at any time. We are happy to discuss

vBulletin performance using css sprites

Our tests are based on version 0.7.0. We used the analytic tools firebug network utility and the googlelabs.com page speed site

on the client side the following parameter were used:
download speed: 5.7 MBit/s
ping: 31ms

css sprites - what are they?

The intention behind css sprites is the bundling of many small graphics into one large graphic in order to decrease the number of required http requests. This shortens the loading times of the given website. In addition, the the accumulated size of all small graphics is higher than the size of the sprite due to reasons of compression.
You can find further information in a great article by Chris Coyier.

What is the gain in using css sprites?

Aside from the technical implementation, the question on how much one actually does gain by using css sprites is of the most interest. Obviously they decrease loading times - but how important are small loading times and what is the impact on vBulletin overall loading times?

A short time ago, Jasper Aguila pointed out that speed is one crucial stickiness factor in his blog on vBulletin.com.

Originally Posted by Jasper Aguila vBulletin Support

The internet has unfortunately contributed to the exponential decrease in attention span for many individuals. That's why this decade is seeing a trend in emerging technologies emphasizing the importance of speed request. It's crucial for your content to be promptly distributed in a timely manner, else bounce rate will increase - making you lose returning visitors. It's also important to note that slow sites may be penalized by search engines.

With better browsers, more powerful processors, and improved technologies constantly releasing each year, it's becoming quite difficult to provide excuses for slow loading pages. Therefore, try optimizing your server for speed. Read up and learn optimization techniques at vBulletin.com's Server Configuration forum.

In addition, the google ranking is influenced by the site speed as well.

Google Webmaster Central Blog

Originally Posted by 09.04.2010 - Google Webmaster Central Blog

You may have heard that here at Google we're obsessed with speed, in our products and on the web. As part of that effort, today we're including a new signal in our search ranking algorithms: site speed. Site speed reflects how quickly a website responds to web requests.

vBseo Webmaster Mert G?k?eimam

CSS sprites is a huge bonus for big boards , any big board owner definately should use it.

Last but not least, not only the user's loading time is reduced, but also does the server load decrease as the server will have to handle a lot less of http requests. This clears available connections and cpu time.

Add on features

In the current released beta version 0.7.2, sprites are available for FORUMHOME and FORUMDISPLAY. Coming up next SHOWTHREAD.

Sprites are created style based for all forum styles and saved in a folder which you can set via the imgdir_sprite stylevar. You have one additional button in the ACP (CSS-Sprites -> Refresh) which automatically creates all sprites, the according css definitions and includes those css definitions in the vBulletin css rollup files.

Installation

First of all, if you didnt want to change the templates manually, install the Template Modification System (TMS). Now proceed with the installation:

• upload the contents of the upload folder into your forum home directory.
• import the add on in the ACP
• upon installation a new stylevar imgdir_sprite will be created. Update this stylevar based on your file structure - default value is the vbulletin sprite directory. Make sure the folder is writable, else the sprites can't be saved!
• create the sprites via the ACP at CSS-Sprite using the Refresh option.
• If you have installed TMS, you are done now. This was an easy gained speed up, not? If you didnt installed TMS and didnt want to do it, proceed with the next point:
• in order to use the sprites, you then will have to edit some templates. The diffs (xou will find it in the do_not_upload folder show which parts you have to delete '<' and which parts to add '>' In addition, on top find the lines in which you will find the respective code.[/b]

[raymondblog]

A quick question.
While I was manually making the changes, I found that some of the lines which I should removed has been updated.

For example, at pagenav template:

Change this:

<span class="first_last"><a href="{vb:raw lastaddress}{vb:raw address2}<vb:if condition="$show['pagelinks']"><vb:if condition="$use_qmark">?<vb:else />&amp;</vb:if>page={vb:raw totalpages}</vb:if><vb:if condition="$anchor">#{vb:raw anchor}</vb:if>" title="{vb:rawphrase last_page} - {vb:rawphrase results_x_to_y_of_z, {vb:raw lastnumbers.first}, {vb:raw lastnumbers.last}, {vb:raw total}}">{vb:rawphrase last}<img src="{vb:stylevar imgdir_pagination}/last-{vb:stylevar right}.png" alt="{vb:rawphrase last}" /></a></span>

To this:

<span class="first_last"><a href="{vb:raw lastaddress}{vb:raw address2}<vb:if condition="$show['pagelinks']"><vb:if condition="$use_qmark">?<vb:else />&amp;</vb:if>page={vb:raw totalpages}</vb:if><vb:if condition="$anchor">#{vb:raw anchor}</vb:if>" title="{vb:rawphrase last_page} - {vb:rawphrase results_x_to_y_of_z, {vb:raw lastnumbers.first}, {vb:raw lastnumbers.last}, {vb:raw total}}">{vb:rawphrase last}<span class="pagination_last" title="{vb:rawphrase last}"></span></a></span>

However, the original code has been updated to the following:

<span class="first_last"><a href="{vb:raw lastaddress}<vb:if condition="$show['pagelinks']"><vb:if condition="$use_qmark">?</vb:if><vb:if condition="$use_amp">&amp;</vb:if>page={vb:raw totalpages}</vb:if>{vb:raw address2}<vb:if condition="$anchor">#{vb:raw anchor}</vb:if>" title="{vb:rawphrase last_page} - {vb:rawphrase results_x_to_y_of_z, {vb:raw lastnumbers.first}, {vb:raw lastnumbers.last}, {vb:raw total}}">{vb:rawphrase last}<img src="{vb:stylevar imgdir_pagination}/last-{vb:stylevar right}.png" alt="{vb:rawphrase last}" /></a></span>

Question is, should I replace the code or not?

[Osbes]

Hello raymondblog,

you are correct, the current replace-rules are not defined for vBulletin 4.1.10.

To gain the speedup using sprites you need to change the following part of the current original code:

Replace

<img src="{vb:stylevar imgdir_pagination}/last-{vb:stylevar right}.png" alt="{vb:rawphrase last}" />

with

<span class="pagination_last" title="{vb:rawphrase last}">

We are currently testing the upcomming version of our addon on our live forum for admins only (since we are doing virtual template edits, we can easily adjust our changes based on whatever we consider correct without actually changing the template) and in the next days, we will activate the virtual template changes for everyone.

Since vBulletin 4.1.10 is currently not available on vbulletin-germany.com, it will took at least 1-2 weeks until Mooff or me will upload the current version here, based on the assumption, that vBulletin 4.1.10 will be available within this week on the offi. german vBulletin site.

Best regards
Osbes

[raymondblog]

Thanks for the prompt response.

I actually found out that there were a few more that has been updated and require to manually update the code.

At least I understand the logic of this mod.

Love this mod, but hate TMS :P
I've actually installed this mod before but then removed because TMS was a little too confusing.
So I thought I should do it manually this time.

[heartsglad]

Hi,
I am interested in this Mod, but wanted to clear this question fist:
Can I Install it without installing TMS. If yes What changes in which template must I do? (I am Using VB 4.1.9 )

In downloaded folder "do_not_upload" I read Template changes file. The changes in that file were till Mod Version 0.7.1 . The latest MOD is 0.7.2.

Thanks in advance

Mfg,
Hearsglad

[Osbes]

Hello heartsglad,
first of all, if you currently doesnt use this addon, i would advise you to wait for our next version, assuming that you will updat yout forum to vB 4.1.10, since we requested a hook, which is implemented in vB 4.1.10 and gives us the possibility to automatically change the template without any manual changes or TMS needed.

If you dont want to wait and dont want to use the TMS, you need to make all the template changes that are listet in the "TEMPLATE_CHANGES" file in the "do_not_upload" folder. There are no changes for 0.7.2 since this version doenst introduces new changes but fixed some bugs.

So since you need to revert every of this changes for using the next version with its automatically changes, i advise you to wait until than. we are currently testing it in our live forum (see my last post), but we need to wait until vbulletin-germany.com releases vB 4.1.10 to make the last tests and upload it here.

Best regards
Sebastian

[raymondblog]

I've tried my best to replace the ones that are not exactly the same as in the diff file but near identical. However the ones below are not found at all. Any help would be much appreciated.

Template: FORUMDISPLAY
396,397c395,396
< <dt><img src="{vb:stylevar imgdir_statusicon}/thread_new-16.png" alt="{vb:rawphrase new_posts}" /></dt><dd>{vb:rawphrase new_posts}</dd>
< <dt><img src="{vb:stylevar imgdir_statusicon}/thread-16-{vb:stylevar right}.png" alt="{vb:rawphrase no_new_posts}" /></dt><dd>{vb:rawphrase no_new_posts}</dd>
---
> <dt><span class="sprite_statusicon_thread_new_16" title="{vb:rawphrase new_posts}"></span></dt><dd>{vb:rawphrase new_posts}</dd>
> <dt><span class="sprite_statusicon_thread_16" title="{vb:rawphrase no_new_posts}"></span></dt><dd>{vb:rawphrase no_new_posts}</dd>
399,400c398,399
< <dt><img src="{vb:stylevar imgdir_statusicon}/thread_hot_new-16.png" alt="{vb:rawphrase more_than_x_replies_or_y_views, {vb:raw vboptions.hotnumberposts}, {vb:raw vboptions.hotnumberviews}}" /></dt><dd>{vb:rawphrase hot_thread_with_new_posts}</dd>
< <dt><img src="{vb:stylevar imgdir_statusicon}/thread_hot-16.png" alt="{vb:rawphrase more_than_x_replies_or_y_views, {vb:raw vboptions.hotnumberposts}, {vb:raw vboptions.hotnumberviews}}" /></dt><dd>{vb:rawphrase hot_thread_with_no_new_posts}</dd>
---
> <dt><span class="sprite_statusicon_thread_hot_new_16" title="{vb:rawphrase more_than_x_replies_or_y_views, {vb:raw vboptions.hotnumberposts}, {vb:raw vboptions.hotnumberviews}}"></span></dt><dd>{vb:rawphrase hot_thread_with_new_posts}</dd>
> <dt><span class="sprite_statusicon_thread_hot_16" title="{vb:rawphrase more_than_x_replies_or_y_views, {vb:raw vboptions.hotnumberposts}, {vb:raw vboptions.hotnumberviews}}"></span></dt><dd>{vb:rawphrase hot_thread_with_no_new_posts}</dd>
402,403c401,402
< <dt><img src="{vb:stylevar imgdir_statusicon}/thread_lock-16.png" alt="{vb:rawphrase closed_thread}" /></dt><dd>{vb:rawphrase thread_is_closed}</dd>
< <dt><img src="{vb:stylevar imgdir_statusicon}/thread_dot-16-{vb:stylevar right}.png" alt="{vb:rawphrase thread_contains_a_message_written_by_you}" /></dt><dd>{vb:rawphrase you_have_posted_in_this_thread}</dd>
---
> <dt><span class="sprite_statusicon_thread_lock_16" title="{vb:rawphrase closed_thread}"></span></dt><dd>{vb:rawphrase thread_is_closed}</dd>
> <dt><span class="sprite_statusicon_thread_dot_16" title="{vb:rawphrase thread_contains_a_message_written_by_you}"></span></dt><dd>{vb:rawphrase you_have_posted_in_this_thread}</dd>


Template: navbar
134c125
< <span class="buttoncontainer"><span><input type="image" class="searchbutton" src="{vb:stylevar imgdir_button}/search<vb:if condition="$stylevar['textdirection'] == 'rtl'">_rtl</vb:if>.<vb:if condition="(is_browser('ie') AND !is_browser('ie', 7) AND !is_browser('ie', 8))">gif<vb:else />png</vb:if>" name="submit" onclick="document.getElementById('navbar_search'). submit;" tabindex="100"/></span></span>
---
> <span class="buttoncontainer"><span><input type="submit" class="sprite_button_search searchbutton" name="submit" value="" tabindex="100"/></span></span>

## Version 0.6.0 ##

Template: FORUMHOME
128c128
< <h3 class="blocksubhead"><img src="{vb:stylevar imgdir_misc}/legend.png" alt="{vb:rawphrase icon_legend}" />{vb:rawphrase icon_legend}</h3>
---
> <h3 class="blocksubhead"><span class="sprite_misc_legend" title="{vb:rawphrase icon_legend}" ></span>{vb:rawphrase icon_legend}</h3>



Template: memberaction_dropdown
5c5
< <img src="{vb:stylevar imgdir_siteicons}/profile.png" alt="" />
---
> <span class="sprite_siteicons_profile"></span>
12c12
< <img src="{vb:stylevar imgdir_siteicons}/forum.png" alt="" />
---
> <span class="sprite_siteicons_forum"></span>
20c20
< <img src="{vb:stylevar imgdir_siteicons}/message.png" alt="" />
---
> <span class="sprite_siteicons_message"></span>
29c29
< <img src="{vb:stylevar imgdir_siteicons}/blog.png" alt="" />
---
> <span class="sprite_siteicons_blog"></span>
38c38
< <img src="{vb:stylevar imgdir_siteicons}/homepage.png" alt="" />
---
> <span class="sprite_siteicons_homepage"></span>
47c47
< <img src="{vb:stylevar imgdir_siteicons}/article.png" alt="" />
---
> <span class="sprite_siteicons_article"></span>
56c56
< <img src="{vb:stylevar imgdir_siteicons}/add.png" alt="" />
---
> <span class="sprite_siteicons_add"></span>
65c65
< <img src="{vb:stylevar imgdir_siteicons}/email.png" alt="" />
---
> <span class="sprite_siteicons_email"></span>



## Version 0.5.0 ##

Template: FORUMHOME
131,134c131,134
< <dt><img src="{vb:stylevar imgdir_statusicon}/forum_new-16.png" alt="{vb:rawphrase new_posts_forum}" /></dt><dd>{vb:rawphrase new_posts_forum}</dd>
< <dt><img src="{vb:stylevar imgdir_statusicon}/forum_old-16.png" alt="{vb:rawphrase no_new_posts_forum}" /></dt><dd>{vb:rawphrase no_new_posts_forum}</dd>
< <dt><img src="{vb:stylevar imgdir_statusicon}/category-16.png" alt="{vb:rawphrase category_forum}" /></dt><dd>{vb:rawphrase category_forum}</dd>
< <dt><img src="{vb:stylevar imgdir_statusicon}/forum_link-16.png" alt="{vb:rawphrase link_forum}" /></dt><dd>{vb:rawphrase link_forum}</dd>
---
> <dt><span class="sprite_statusicon_forum_new_16"></span></dt><dd>{vb:rawphrase new_posts_forum}</dd>
> <dt><span class="sprite_statusicon_forum_old_16"></span></dt><dd>{vb:rawphrase no_new_posts_forum}</dd>
> <dt><span class="sprite_statusicon_category_16"></span></dt><dd>{vb:rawphrase category_forum}</dd>
> <dt><span class="sprite_statusicon_forum_link_16"></span></dt><dd>{vb:rawphrase link_forum}</dd>


Template: forumhome_subforumbit_nopost
2c2
< <img class="inlineimg" src="{vb:stylevar imgdir_statusicon}/subforum_{vb:raw forum.statusicon}.png" alt="" border="0" id="forum_statusicon_{vb:raw forum.forumid}" />
---
> <span id="forum_statusicon_{vb:raw forum.forumid}" class="inlineimg sprite_statusicon_subforum_{vb:raw forum.statusicon}"></span>


Template: forumhome_subforumbit_post
2c2
< <img class="inlineimg" src="{vb:stylevar imgdir_statusicon}/{vb:raw forum.imageprefix}subforum_{vb:raw forum.statusicon}-48.png" alt="" border="0" id="forum_statusicon_{vb:raw forum.forumid}" />
---
> <span id="forum_statusicon_{vb:raw forum.forumid}" class="inlineimg sprite_statusicon_{vb:raw forum.imageprefix}subforum_{vb:raw forum.statusicon}_48"></span>

[Osbes]

I am currently quite busy, therefor i can only give you a rather short answer for a problem that i sees immediately.

Template: forumhome_subforumbit_nopost
and
Template: forumhome_subforumbit_post

got merged by vBulletin to

Template: forumhome_subforums

###

Template: memberaction_dropdown
Seems to be in vBulletin 4.1.9 an i also found the icons (since i replaced them yesterday by our sprite). Dunno if they are missing in vBulletin 4.1.10 o are moved like the template forumhome_subforums, since - as you know - vB 4.1.10 is still not availible in vb-germany.com

Best regards
Sebastian

[raymondblog]

I just checked memberaction_dropdown and I believe the code to call the images are still there. However it is heavily modified and uses "class" to call the images.

Thanks, you guys deserves a donation from me. Let me try to get this sorted out first. Great job!

[raymondblog]

My forum @ http://www.raymond.cc/forum/

An update on the manual changes.
Some of them are not found because I manually removed the code because I found them unnecessary to load.

Now the only thing left is these codes which I couldn't figure it out how to make it work on my forum that is using a custom skin.

Template: navbar
134c125
< <span class="buttoncontainer"><span><input type="image" class="searchbutton" src="{vb:stylevar imgdir_button}/search<vb:if condition="$stylevar['textdirection'] == 'rtl'">_rtl</vb:if>.<vb:if condition="(is_browser('ie') AND !is_browser('ie', 7) AND !is_browser('ie', 8))">gif<vb:else />png</vb:if>" name="submit" onclick="document.getElementById('navbar_search'). submit;" tabindex="100"/></span></span>
---
> <span class="buttoncontainer"><span><input type="submit" class="sprite_button_search searchbutton" name="submit" value="" tabindex="100"/></span></span>




Template: memberaction_dropdown
5c5
< <img src="{vb:stylevar imgdir_siteicons}/profile.png" alt="" />
---
> <span class="sprite_siteicons_profile"></span>
12c12
< <img src="{vb:stylevar imgdir_siteicons}/forum.png" alt="" />
---
> <span class="sprite_siteicons_forum"></span>
20c20
< <img src="{vb:stylevar imgdir_siteicons}/message.png" alt="" />
---
> <span class="sprite_siteicons_message"></span>
29c29
< <img src="{vb:stylevar imgdir_siteicons}/blog.png" alt="" />
---
> <span class="sprite_siteicons_blog"></span>
38c38
< <img src="{vb:stylevar imgdir_siteicons}/homepage.png" alt="" />
---
> <span class="sprite_siteicons_homepage"></span>
47c47
< <img src="{vb:stylevar imgdir_siteicons}/article.png" alt="" />
---
> <span class="sprite_siteicons_article"></span>
56c56
< <img src="{vb:stylevar imgdir_siteicons}/add.png" alt="" />
---
> <span class="sprite_siteicons_add"></span>
65c65
< <img src="{vb:stylevar imgdir_siteicons}/email.png" alt="" />
---
> <span class="sprite_siteicons_email"></span>

[Gn_Snake]

first of all, if you currently doesnt use this addon, i would advise you to wait for our next version, assuming that you will updat yout forum to vB 4.1.10, since we requested a hook, which is implemented in vB 4.1.10 and gives us the possibility to automatically change the template without any manual changes or TMS needed.

Hello,
i am interested in this Mod, but i have installed vb4.1.10 and wait for the new version for this Mod.

You can find out when it happens?

Thanks
Alessandro