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

[NFLfbJunkie]

I have just a few more questions so I can understand exactly what this MOD does before I install it. From what everyone else is saying it seems like this MOD is a must have for vBulletin owners considering the constant upgrades with this software. If this MOD saves board adminstrators the time it takes to redo template edits after an upgrade, then it should be included with the vBulletin software package.

1. If a MOD calls for more than one template edit does each one need to be added separtely as a Template-Modification; and if one template needs to have more than one edit applied to it do these need to be added separately as well?
2. How exactly does the Template-Modification system work when a vBulletin upgrade is performed? Stated in the release notes is the fact that edited templates aren't affected when an upgrade is done. So does this mean that a board with MODs is running off of the edited and original templates?
3. Don't some MODs have a plugin that you need to install and also have template edits that need to be done for the MOD? For these MODs, I would assume you would add the edits through TMS. But how are the template edits that are done from the plugin added in to TMS?

Hopefully I am not sounding too confused with the above questions. Again, just trying to figure out what seems to be a very handy tool when it comes to template editing.

[Mazinger]

Thanks. This is very useful addon for those who edit templates much.

I'll give it a try later.

[Alfa1]

Originally Posted by tuwebfacil

This should be standard on vBulletin!

Great Idea!

Agreed.

Can someone please share the Template-Modification XML file for Thread prefixes

[Wulfnoth]

The xml-file is included in the .zip-file of TMS.

[Alfa1]

That is amazing. Thanks!

[patrickb]

This IS great!

Installed!

Would it be possible to provide an English version of the demos? Shouldn't be too hard...only rename the different edits.

[slyreptile]

Am I understanding this correctly?

If I have a mod that needs manual template edits....

1. I must add it to the MASTER template, thus eliminating the need to perform manual template edits.

OR

2. Add the manual entries directly to the template, then Add them to the template we want it used on in the Manager? Obviously, the mod doesn't show as being there until it's directly added manually to the template.

[Andreas]

Originally Posted by Junkie

If a MOD calls for more than one template edit does each one need to be added separtely as a Template-Modification; and if one template needs to have more than one edit applied to it do these need to be added separately as well?

Just like you would apply templay modifications manually:
If a mod required edits for 2 templates - you have to add 2 template modifications.
If it requires 2 modifications in 1 template, you have to add 2 template modifications, etc.

How exactly does the Template-Modification system work when a vBulletin upgrade is performed? Stated in the release notes is the fact that edited templates aren't affected when an upgrade is done. So does this mean that a board with MODs is running off of the edited and original templates?

TMS detects if a vBulletin upgrade was performed and template for which there are template modifications are defined in TMS. If there are sucgh templates, a warning mesage is being displayed on ACP home.
By clicking the link, those template modifications will be tested if the do still work.
If not you must modify the template modifications (this happens when search text is modified in the new vBulletin version and can't be found anymore).

Don't some MODs have a plugin that you need to install and also have template edits that need to be done for the MOD? For these MODs, I would assume you would add the edits through TMS. But how are the template edits that are done from the plugin added in to TMS?

There are products that edit templates at runtime.
You can either leave that as-is, or disable the plugin and add the necessary template modifications to TMS.

Originally Posted by slyreptile

If I have a mod that needs manual template edits....

As stated in the FAQ:
1. Click Styles & Template / Template-Modifications Manager
2. Next to the Style where you want to add the template-modification (normally this would be MASTER) select 'Add Template-Modification'
3. Select the Template and Product
Set Active to Yes
Enter a varname and descriptive Title
4. Paste the seach text from the mod instructions into the 1st textarea
5. Paste the replace text from the mod instructions into the 2nd textare and choose the appropirate method as stated in teh instructions (eg. replace, insert above/below)
5. Click Save

Repeat these steps for all necessary template modifications.

Done.

Would it be possible to provide an English version of the demos? Shouldn't be too hard...only rename the different edits.

Rename the titles?
Not really

[BigDog56]

I can't get it to work on 3.6.8 I click on the Template mod. manager, clik on the master style, add template mod. and nothing happens. On the bottom left corner of IE I have an "Error on page" Message..

[Andreas]

See post # 19.