Ok, I've figured this out. Let's remind us all what we're trying to do here .

The idea is that if you have a plugin that requires a template modification - that's a bad idea. You don't want users trying to mod their templates, not following instructions, messing things up, then running to you for support.

Also, another plugin may come along and try to modify the same template... plus, what about patches that alter templates?

My idea is that you should create a brand new template entirely. Then, there should be a way to, on-the-fly, use YOUR template instead of the default template, IF your product is active/installed.

Here we go, folks! In my case, I want to use a custom template named invite_forumrules instead of forumrules.

Hook Location: cache_templates

This caches my template.

Hook Location: global_start

This will replace the cached forumrules with the cached invite_forumrules. Now, any code that fetches the forumrules template will in fact fetch YOUR template, but only if your plugin is active.

I still have a remaining question: how do you package a custom template in an xml install/product file?

Ah, very nifty that... nice .

In reply to your adding templates question, you'll have to add this:
In between your install code tags and plugin tags in your installer of your Product (so basicly the .xml file).
If you want to add multiple templates you can do that like this:
If you'd like an example of a complete install script (with queries, phrases, etc), just ask and I'll type one up for you ;).

Btw, would you mind formulating that into a nice little howto with a link to this thread if you've got some spare time (the handling of custom templates)? It'd certainly be a nice addition to our how-to base .

__________________

What does the "username" attribute in the template element need to be? Or, does it just inform the user in their admincp who authored the template?

Tell you what - want to test my first released "product"? If all works, I'll release it here, and write up a HOW-TO.

Attached Files

product-tgreer_invite.zip (1.8 KB, 2 views)

The username attribute is the name of the user who last edited the template, or in the case of an import: created the template.

I'll gladly test it out now, will post back with my findings .

I don't know about this... I worked hard to figure it out, but I see problems with replacing entire templates wholesale, on the fly. What about other hacks that might have made changes to the template?

So I think a method based on str_replace() might be better.

Alright, I've tested it on my local installation and the message is showing up fine.. there's one issue though: the box takes up about 3/4th of my page (horizontally), heh.

You can fix this by replacing:
with
I'd suggest either doing the above and removing the <p> tags, or doing the above but change the width, as it kinda messes up the design ;).

Unfortunately I currently don't have a public vB running so I can't test the search engine functions, but the rest works fine.

You can edit templates via the plugin system. You could use this below. It will look for $navbar in the forumhome templates and add $myvar under it. Hope this helps alittle. ;) Hook forumhome_start. Now everytime that hook is called and the plugin is active, it will alter the template, but it won't acually update the template. So the user will never see $myvar in the templates. The only downfall is when users want to custimize it, makes it alot harder.

__________________
Earnersforum.com - Learn how to make money online! New Look!

Ken Iovino / vBHackers.com
vBSEO 3.2.0 Launched - Maximum Overdrive for Your Web Traffic! Over 100 Instant SEO Optimizations

vBSEO Google Sitemap Generator - Version 2.2 Released Mandatory Upgrade for vBSEO 3.2.0 GOLD

6X Traffic - $1400 in One Day with vBSEO! Imagine What the vBSEO Patent Pending Technology Can Do For You.

Crawlability Network: vBulletin SEO | vBulletin Hackers

Yes, overwriting entire templates isn't the best option.

What about the automaticly adding the conditionals to the templates with the install script though? It would modify the template, but not replace it nor harm any currently installed mods.

Yeah that's what I ment. Didn't know you could use str_replace for that though .

I edited my above post to explain abit more

__________________
Earnersforum.com - Learn how to make money online! New Look!

Ken Iovino / vBHackers.com
vBSEO 3.2.0 Launched - Maximum Overdrive for Your Web Traffic! Over 100 Instant SEO Optimizations

vBSEO Google Sitemap Generator - Version 2.2 Released Mandatory Upgrade for vBSEO 3.2.0 GOLD

6X Traffic - $1400 in One Day with vBSEO! Imagine What the vBSEO Patent Pending Technology Can Do For You.

Crawlability Network: vBulletin SEO | vBulletin Hackers

We're on the right track. I'll work on this a bit more.

In my particular scenario, I need to "embed" forumrules within a new template that will be used instead of forumrules (hope that makes sense).