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

[rapidphim]

sorry for my stupidity... that means that I will have to edit the master template (default), and other template will be effected automatically?

[Andreas]

Once again:
Do not manually modify MASTER templates - never-ever!

Just go to Styles & Templates / Templates Modifications Manager, select Add Template Modification from the dropdown in MASTER style and fill out the form.

Repeat this for all your modifications and you're done (unless your do have customized templates where the modifications defined for MASTER templates do not work).
In this case you will have to customize the template modifications as well.

[rapidphim]

Yes of course I will not manually edit the master template but if I used the tms to do the editing, will all of other styles be edited automatically?

[rapidphim]

Originally Posted by Andreas

Once again:
Do not manually modify MASTER templates - never-ever!

Just go to Styles & Templates / Templates Modifications Manager, select Add Template Modification from the dropdown in MASTER style and fill out the form.

Repeat this for all your modifications and you're done (unless your do have customized templates where the modifications defined for MASTER templates do not work).
In this case you will have to customize the template modifications as well.

Andreas,
I am testing this on 3.7.0 b4 but nothing happened when I select Add Template Modification in the Master style from the dropdown menu?

[JokeAss]

Too bad this won't be updated...

Will it work with 3.7?

[Icy]

This works fine for me on vBulletin 3.7 beta 5

[Black Tiger]

I have this one tagged for some time.
Now I wanted to install this, but I had to uninstall it for the time being.
I'm running vBulletin 3.7 beta 5, but when clicking on "Template modifications Manager" I get a java erro saying:
Line: 120
Sign: 55
Error: Id is expected
and the url points to /admincp/templateedits.php.

Same goes when clicking on "add template modification" but then the error is:
Line: 74
Sign: 1
Error: Object is expected
Code: 0
Same url.

I'm working with IE6 fully fixed and updated from Microsoft Update.

With Firefox portable all is going OK, but I'm working with IE6 and not interested in using Firefox. Is it possible to fix this?

[Icy]

Try the fix

[Black Tiger]

Thanks for the fix Icy, it's working great.
Marked as installed again!
But now a couple of questions rise. I presume all new template edits should be made now in the new "Master" style?

1.) How about template edits already made by hacks which were installed before installing TMS. Can this be integrated in TMS globally some way?
Or do I have to do them all manually piece by piece, so reverting first, and then putting them back in via the TMS system?

2.) When upgrading vbulletin, often templates need to be reverted. How does this work with upgrading vBulletin? Do I still have to do all template changes of the reverted templates again, or does this system "remember" the changes somehow and is able to put them back after the reverting?

3.) I would like the notice "Template modifikationen durch" changed in "Template modifications by", so from German to English, were can I do that?

[Icy]

If you add a new template modification to Master style then it will inherit all the styles. So you don't have to add template modification to any other styles.

1. As far as I'm concern, you will have to do everything manually.

2. The TMS will test & show a stat if any of the template modification need to be changed/reverted. It works like vBulletin's "Find Updated Template" option.

3. You can't. The only option you have is that buy a branding free.