Administrative and Maintenance Tools - Template Modification System

Template Modification System
Description
This modification allows easy management of template modifications.
Hack authors can define the necessary template modifications for their products.
When exporting a product, all template modifications assigned to this product
in MASTER style will be embedded into the product XML and imported on the
end-user vBulletin installation automatically if TMS is available.
Alternatively, it is also possible to create separate XML files for template modifications.
This way, 3rd parties can provide Template-Modification XML files for existing hacks.
Hack authors can also export standard template modification instructions as
textfiles to package them with their hacks, which allows users that do not
have TMS to also install them

In case the author defined modifications do not work (eg. the user uses a custom style),
the users can easily customize the modifications for their style(s).

TMS modified templates transparently, e.g. all Templates can still be modified
manually in style manager - they will appear unchanged there.


System Requirements
This Modification requires MySQL 4.1 or higher - it does not work with MySQL 4.0!
If you use MySQL 4.1 series, MySQL 4.1.10 or higher is required
If you use MySQL 5.0 series, MySQL 5.0.3 or higher is required
TMS 1.2.0 Beta 1 or higher requires vBulletin 4.1.5 or higher

vBulletin Compatibility
Versions up to and including 1.1.5 are compatible with vBulletin 3.6.X, 3.7.X and 3.8.X
Version 1.1.5 is partly compatible with vBulletin 4.0.X and 4.1.X
Version 1.2.0 Beta 1 or higher is compatible with vBulletin 4.1.5 or higher
vBulletin 4.1.11 or higher is currently not fully supported by TMS. If you use this version please apply the following patch: tms_patch120b4.zip

Branding:
Please note that TMS puts a small branding/copyright notice in footer - see readme.txt for further details.

Version History
1.2.0 Beta 4

• Bugfix: Database error when trying to add a template modification (this bug was introduced in TMS 1.2.0 Beta 3)

1.2.0 Beta 3

• Changed: Converted hardcoded text to phrases
• New Feature: Added doubleclick for editing style variables
• Bugfix: Database error when trying to add a template modification with an existing varname to a different style
• Changed: Fixed formatting of templateedits.php
• Bugfix: Fixed erors when manually modifying a template with template modifications

1.2.0 Beta 2

• Bugfix: Fixed errors in style variable editing code

1.2.0 Beta 1

• Changed: Ported to vBulletin 4.1
• New Feature: If an error occurs while trying to compile a template this error is now being disaplayed when trying to save the template modification
• New Feature: Styles variables used in templates can be edited via AJAX from the modify template screen

1.1.5

• Fixed Bug: Fixed incorrect variable type
• New Feature: Box 'Template-Modifications' (shown on editing a template) can now be collapsed/expanded

1.1.4

• Fixed Bug: Fixed HTML error/XSS in Template Modifications Manager

1.1.3

• Fixed Bug: Added missing phrase on ACP home

1.1.1

• Fixed Bug: Fixed Error with conflicting Template Modifications when importing a product
• Fixed Bug: Removed Pre-Selection of processing mode when adding new modifications
• Fixed Bug: Fixed Bug with zlib.output_compression AND vBulletin internal gzip being both turned on
• Fixed Bug: Display search results correctly
• Fixed Bug: Added missing phrase 'varname_x_already_exists'
• New Feature: Automatically rebuild template modifications after vBulletin Upgrade

1.0.0

• Changed: Several files renamed
• Fixed Bug: Fixed incorrect handling of product ids that contain only numbers
• New Feature: Search text can be search in template when editing a Template-Modification in Style Manager
• Changed: Multiple Template-Modifications can be loaded via AJAX
• First Release on vBulletin.org

1.0.0 RC 1

• Fixed Bug: All Bugs reported for Beta 4 have been fixed
• Changed: Display of modified Templates with HTML comments has been modified
• Changed: Debug-Mode is no longer required
• New Feature: It is now possible to export/import style-specific Template-Modifications

1.0.0 Beta 4

• Fixed Bug: All Bugs reported for Beta 3 have been fixed
• Changed: Sorting in Template Modifications Manager has been changed
• New Feature: When adding or editing a Template-Modification, the Template can now be displayed and searched via AJAX
• Changed: When exporting as Text, the original instructions (eg. insert below/above) are retained
• New Feature: It is now possible to test each Template-Modification
• New Feature: Testing improved. It is now being display if a Template is OK after applying a Template Modification
• New Feature: When editing a Template, it is possible to activate/deactvate multiple Template-Modifications
• New Feature: Template-Modifications can now also be exported and tested from withing Product Manager
• New Feature: Function to display a template with all Modifications applied.
  This function can also display embedded comments to make it easier to identify changed parts

1.0.0 Beta 3

• Fixed Bug: All Bugs reported for Beta 2 have been fixed
• New Feature: Simplified adding Template-Modifications by allowing to select how to handle replacement text (eg. replace or insert above/below)
• New Feature: Each Template-Modification can now be disabled
• Changed: Testing Template-Modifications has been reworked:
  Column ordering can now be set through vBulletin Options; column headers are clickable to sort results
  Output has been separated by styles
  It is now possible to test only selcted products
• New Feature: TMS now integrates with 'Style Manager' and 'Product Manager'
• New Feature: The language can be selected when exporting Template-Modifications
• New Feature: Weh TMS gets deactivated, all Template-Modifications will be deactivated too
• New Feature: Display of Template-Modifications while editing a Template in Style Manager has been improved:
  It is now being display if a Template-Modification could be applied
  Template-Modifications can be edited via AJAX

1.0.0 Beta 2
First public Beta

[Andreas]

It does not modify them as they would be if you were modifying them manually and it does not modify them on the fly

vBulletin keeps two version of the templates in database: The orginal version (that is being used for display and editing in style manager) and a compiled version (that is actually being used for displaying templates in frontend).

TMS hooks into the compile process and changes the templates just before they are being compiled.

This means, that the compiled version is changed, but the template is still considered unchanged - you also won't see changes in style manager.

[Boofo]

Ok, I see, It basically cuts out the middle man. A deeper version of on the fly, so to speak.

So any template changes I have already made I can undo and just do with all with this. I'm liking this already. Is there any noticeable difference in execution time the more templates you have edited through this? No matter really, as anything to keep from manually editing a template is an upgrade bonus for me. I can remember the day when we would have begged for a template change over a file change.

Nice job, buddy! You outdid yourself on this one.

[Andreas]

Is there any noticeable difference in execution time the more templates you have edited through this?

There is zero code being executed in frontend (eg. no performacne cost at all).
TMS code is only executed in ACP.

[Boofo]

You sold me. Where do I sign up?

Last question... will this hack be smart enough to catch template that change between version? Or is that something you have to keep on eye on your end? Knowing you I'm sure there is a built in safe-guard of some sort for dummies like me.

And this would be great to see in a future version of vb.

[Andreas]

When you upgrade vBulletin, TMS will detect this and check if templates for which you have made template modifications have been changed.

If this is the case, a message will appear on ACP home telling you that templates have been changed and that it is necessary to test if the modifications are still working.

When clicking the link, TMS will test and update those modifications that do still work.

Those modifications that do not work any longer (doesn't happen too often) will need manual adjustments.

[Boofo]

Aha! You've been caught! You did have dummy Boofo in mind when you wrote this.

For a hack that is not supposed to be supported, you are doing one hell of a job, my friend. Thanks for taking the time to answer all my questions, as simple as some of them must sound. As always, you continue to amaze me with the stuff you come up with. I'd install it twice if I could. Thank you, sir. And nice to see you hanging around the old farmstead. Looking forward to your next invention.

[rapidphim]

Originally Posted by Andreas

Don't modify any templates nmanually. Instead, take the instructions from the hack and insert them into TMS.

Should I also need to modify the Default template or just the custom/modify template that I just installed and leave the Default template untouch?

[Andreas]

?
Sorry, I don't understant your question
Just take the hack instructions and insert tihe modifications into TMS and you're done (assuming the modifications do work in all styles).

[rapidphim]

Let see:
1/ I am now having Default style (fresh, no hack yet) with brand new DB, forum (Master Template #1)
2/ I installed TMS
3/ Then, I will try to install another style (custom/modified... whatever it called) 2nd template (no children from master)
4/ Then, I will try to apply a hack for my forum that required template hack. Here, the question I am seaking for answer is that:
a/ Do I need to edit the Master(default) template by using tms and it will auto apply those edits to the 2nd template?
b/ Or, I leave the master template alone, and just edit the 2nd template by using TMS?
c/ what happen if I install 3rd template after all the template edits were done on the 2nd by using TMS? Will the 3rd template will auto adjust/fix with all the edits on the 2nd? Remember that I do not want to have any parent/child style.

Thanks so much for your help.

[Andreas]

Add your TMS modifications in MASTER style - they will affect child syles.
(In fact, it isn't even possible to add modifications in child styles if the template isn't customized there)