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

[dartho]

Great Add-on (in theory - will find out very soon in practice)

One question - what sort of performance hit could one expect with this mod?

Thanks

[Andreas]

@All those having problems with ACP (style manager, product manager):
I can only assume that it has smth. to do with output buffering.
You can disable the plugins on admin_complete that deal with manipulating the output buffer to avoid this, however you will lose some functionality.
If anyone experiencing those problems wants a real fix, feel free to PM me an ACP login so I can track down this issue, as I am unable to reproduce it locally.

@dartho
There is no single line of code being executed or even loaded in the frontend.
=> No effect on frontend performance at all

[dartho]

Excellent! Installed a breeze on 3.6.8P1 :up:

[giovannicosta]

Originally Posted by Andreas

@All those having problems with ACP (style manager, product manager):
I can only assume that it has smth. to do with output buffering.
You can disable the plugins on admin_complete that deal with manipulating the output buffer to avoid this, however you will lose some functionality.
If anyone experiencing those problems wants a real fix, feel free to PM me an ACP login so I can track down this issue, as I am unable to reproduce it locally.

@dartho
There is no single line of code being executed or even loaded in the frontend.
=> No effect on frontend performance at all

CAn you save my admin panel, I cant even email users

[trigon]

works well on 3.6.8 PL1

[yoyoyoyo]

In addition to "replace" "add above" and "add below" it would be nice to have a "remove code" option - I know that you can get around this by the replace option, but it would be easier to use if there was simply a "remove code" option.

It would also be nice to have an option to globally disable/enable all of the template edits, similar to the one for the plugins.

Thanks again for such a great modification - I sure hope this becomes standard in vbulletin - it is an amazingly helpful modification.

[Andreas]

@yoyoyoyo
A 'Remove' option is surely possible, but it is the same as replace with nothing

You can disable all edits by disabling TMS, you can also disable all edits for a certain product by disabling the product.

@giovannicosta
As stated before, I can't reproduce those problems myself - therefore I am somewhat unable to provide a fix
Sorry.
However, feel free to PM me an ACP login and i'll take a look.

[2 X Viverridae]

Fantastic hack Andreas!

Thanks a bunch.

[yoyoyoyo]

Originally Posted by Andreas

@yoyoyoyo
A 'Remove' option is surely possible, but it is the same as replace with nothing

You can disable all edits by disabling TMS, you can also disable all edits for a certain product by disabling the product.

thanks.

One thing that I would really like to have is a "search all template edits" option, similar to the "search all templates."

[yoyoyoyo]

also - the reason I want the option to globally disable all of the template modifications at once is to troubleshoot possible troublesome template edits. I would like to have TMS set all template edits to disabled, but keep the plugin active, so I can choose to turn on the template edits one by one to see where the possible conflicts might be. I realize that I can do this on a template-by-template basis, or with phpmyadmin, but it would be nice to have the option to do so inside TMS.