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

[fly]

^Oh! Good to know!

[Phaedrus]

Where is this voting on vbulletin.com that they are talking about? There are Template modification systems in vb4, but none as good as this one.

*edit: I found it, and voted for it. Come on... we need this thing people go and vote.

[Videx]

Originally Posted by Phaedrus

*edit: I found it, and voted for it. Come on... we need this thing people go and vote.

Nice of you to give the link then.

After updating to 4.1.2 and seeing most all my edits carried over, I'm wondering if this isn't actually included in vb now? Maybe not, as I don't have any styles that aren't parented to the default style.

[Phaedrus]

Originally Posted by Videx

Nice of you to give the link then.

After updating to 4.1.2 and seeing most all my edits carried over, I'm wondering if this isn't actually included in vb now? Maybe not, as I don't have any styles that aren't parented to the default style.

Actually it's on the side next to the reported bug, it's been linked to several times on the thread.

[Simon Lloyd]

Hi i'm using vb3.8.6, i currently have tons of manual template modifications, there's no way i can revert all those templates and then add them to this system, i want to use this system as it will be easier to keep track of the modifications in future, could someone tell me what i need to do to keep ALL my current edits but have them managed by this system so i can revert the templates?

[Phaedrus]

Originally Posted by Simon Lloyd

Hi i'm using vb3.8.6, i currently have tons of manual template modifications, there's no way i can revert all those templates and then add them to this system, i want to use this system as it will be easier to keep track of the modifications in future, could someone tell me what i need to do to keep ALL my current edits but have them managed by this system so i can revert the templates?

Personally I think this mod is worth it. I even paid to remove the links in the footer.

It will make it so you can upgrade without having to revert, save, etc. modifications you make to the templates as they are made in a "Master Template" that will simply apply the changes you make at upgrade. It makes upgrading simple and quick. As long as you are in the 3.x.x version you will have the easiest upgrades you will ever have. If you have many styles and mods this is the mod for you.

What I would do is take each modified template and copy them into a file (you can export them but then you'd have to open and read them to do this), print them out and apply them in the Master Template which copies all the modifications to all the styles. Once you have it done, you are golden.

[Simon Lloyd]

So you are saying that i DO have to find every modification i've ever done, save them seperately . revert the templates and then add all those back?? that would be weeks of work as i have made many many changes over the years.

[fly]

Originally Posted by Simon Lloyd

So you are saying that i DO have to find every modification i've ever done, save them seperately . revert the templates and then add all those back?? that would be weeks of work as i have made many many changes over the years.

That's exactly what you'd have to do. Don't you essentially do that already when you upgrade?

The other option is to just leave those edits, and use this system going forward...

[Simon Lloyd]

Originally Posted by fly

That's exactly what you'd have to do. Don't you essentially do that already when you upgrade?

The other option is to just leave those edits, and use this system going forward...

Yes i have done that previously which is why i know it took a very long time , but you gave me the answer i was looking for, i can simply use this tool for all future edits or modifications.

One last thing, how about if i export the style, install this mod and then re-import the style, would that work?

[fly]

Originally Posted by Simon Lloyd

Yes i have done that previously which is why i know it took a very long time , but you gave me the answer i was looking for, i can simply use this tool for all future edits or modifications.

One last thing, how about if i export the style, install this mod and then re-import the style, would that work?

That wouldn't help you. You need to use the TMS UI to make template edits. The reason for this, if I remember correctly, is that TMS makes the changes to the default (hidden) base templates.