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

[Phaedrus]

Or you can wait until you upgrade, then make all the changes you need to reapply through the TMS system (this is what I did back in the day, my board is heavily modded). Once you have it done it is sooooo worth it. You will love any future upgrades. Of course, your next upgrade may be to 4.x.x... If such is the case you will want to wait until the product is migrated to the new platform (after the bug is fixed).

[Simon Lloyd]

Originally Posted by Phaedrus

Or you can wait until you upgrade, then make all the changes you need to reapply through the TMS system (this is what I did back in the day, my board is heavily modded). Once you have it done it is sooooo worth it. You will love any future upgrades. Of course, your next upgrade may be to 4.x.x... If such is the case you will want to wait until the product is migrated to the new platform (after the bug is fixed).

Thanks for the reply......i'm NEVER moving to 4.x it's been so buggy and had so many patches and updates in such a short space of time it proves they haven't thought it through properly and use the pying public as their testing ground, it's ridiculous for what they charge.......anyway that discussion is for another time , i appreciate the feedback and advice from you guys.

[Simon Lloyd]

Does anyone have an idea of how the performance would be or what the implications would be if i was to use the find and replace to find the entire contents of a template and replace the entire contents?

This way i wouldn't have to go through the 40 templates i have modified and countless moddifictions in each to try and find which mods i've made but then could revert the original templates as the whole modified templates would be in the TMS!

[Phaedrus]

Originally Posted by Simon Lloyd

Does anyone have an idea of how the performance would be or what the implications would be if i was to use the find and replace to find the entire contents of a template and replace the entire contents?

This way i wouldn't have to go through the 40 templates i have modified and countless moddifictions in each to try and find which mods i've made but then could revert the original templates as the whole modified templates would be in the TMS!

It would make it slightly more difficult to add any mods. You'd have to copy the entire template into the "find" box, then copy the entire modified one into the other box with the "replace with"...

I wonder if it would cause time delays? I can't see how, we have it replacing stuff all the time...

[Simon Lloyd]

I have tried it and it does work but not in my scenario, i have 3 styles none of them child styles, using this it sets up a master and the styles are child styles if i revert the template (normally) it doesn't show up in that particular style in the Template Manager so i have to apply the edit to ALL styles that defeats the object or am i missing something?

Lets say that in Default syle nothing is changed, in Style1 i have added a box to the header template and in Style2 i have added a box and coloured it, if inow copy those header templates and then revert the header templates in those styles and go to Templat manager, when i look at Style 1 and Style2 there there is no longer a Header template which means in order to put my template edits in place i have to edit the master style and it is then applied to all styles????

How would i edit on a per style basis if i have reverted the templates?

[fly]

Originally Posted by Simon Lloyd

I have tried it and it does work but not in my scenario, i have 3 styles none of them child styles, using this it sets up a master and the styles are child styles if i revert the template (normally) it doesn't show up in that particular style in the Template Manager so i have to apply the edit to ALL styles that defeats the object or am i missing something?

Lets say that in Default syle nothing is changed, in Style1 i have added a box to the header template and in Style2 i have added a box and coloured it, if inow copy those header templates and then revert the header templates in those styles and go to Templat manager, when i look at Style 1 and Style2 there there is no longer a Header template which means in order to put my template edits in place i have to edit the master style and it is then applied to all styles????

How would i edit on a per style basis if i have reverted the templates?

Because of the way it works, TMS can only apply template changes to the Master template, or templates that have been modified in a child style.

And in answer to your earlier question, you can do 10,000 template edits with TMS and there is ZERO performance impact.

[Phaedrus]

Originally Posted by Simon Lloyd

I have tried it and it does work but not in my scenario, i have 3 styles none of them child styles, using this it sets up a master and the styles are child styles if i revert the template (normally) it doesn't show up in that particular style in the Template Manager so i have to apply the edit to ALL styles that defeats the object or am i missing something?

Lets say that in Default syle nothing is changed, in Style1 i have added a box to the header template and in Style2 i have added a box and coloured it, if inow copy those header templates and then revert the header templates in those styles and go to Templat manager, when i look at Style 1 and Style2 there there is no longer a Header template which means in order to put my template edits in place i have to edit the master style and it is then applied to all styles????

How would i edit on a per style basis if i have reverted the templates?

You simply apply it directly in TMS to the style you want to change instead of the Master Template, it would only apply it to that style. Basically, make the change in the Master, then go into each style and revert it in that style only. (At least I think it would work that way, all my changes apply to all my styles.)

[Phaedrus]

Anyway, I upgraded to 4.1.2. I simply disabled the hack, upgraded, then enabled it. It's working for my purposes that way.

[Videx]

Originally Posted by Phaedrus

Anyway, I upgraded to 4.1.2. I simply disabled the hack, upgraded, then enabled it. It's working for my purposes that way.

So maybe you can tell us. Is this built into 4.1 or not? What are the differences?

[Phaedrus]

Originally Posted by Videx

So maybe you can tell us. Is this built into 4.1 or not? What are the differences?

I ran my test site without the mod and I saw no "Master Template" option, changes are applied directly to styles in 4.1.x. After an upgrade I would have had to revert and change all my styles all over again.

As for the additional.css template that is empty. I was able to add functions to that area simply by leaving the top box empty and selecting "add below" then adding the stuff I wanted into it. It worked swimmingly. I do not know if you want to try to install it directly into any 4.x version, when I tried that on the test site I got some errors and it didn't appear to work. Somehow it worked when I simply enabled an already installed mod.