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

[PhilMcKrackon]

This looks great. One question though.

I understand that only templates that have been customized (changed) can be added to the TMS. Lets say I have a template setup like this.

Master Style
-- Default Style
-- Custom Fluid
-- Custom Fixed

I want to remove all the custom edits to the fluid and fixed styles and add them to the TMS.

If I add the edits needed to the fixed and fluid styles to match the hand edits I have already done, is it necessary to revert the fixed and fluid styles? Or, does TMS simply apply the edits to the originals and output the template correctly?

The reason I ask, is after trying a simple edit - I reverted the template and the 'test' failed.

Thank you,

[Andreas]

To convert manually modified templates to TMS:

1) Find out a single change in the affected template
2) In Template Modifications Manager select 'Add Template-Modification' from the MASTER style dropdown
3) Select the Template, enter a descriptive title (eg. Add link to Chat), a varname, search and replace text
4) Hit save

Repeat these steps as necessary.
Once you've done with all modifications, create a new style with no parent style.
Test the modifications. If they all pass, select the style in frontend and check if it does what it should do.
If so, you can revert the template.

[PhilMcKrackon]

Thanks for the fast reply.

Just another clarification if I may ask.

Using the example above.

Master Style
-- Default Style
-- Custom Fluid
-- Custom Fixed

If I change the Master Style, won't it affect all three other styles (default, fluid and fixed)? They all have different customizations.

Sorry if these questions are a little mundane, I can PHP code pretty well but I had my site style designed by a third party.

Thank you,

[Andreas]

Yes, it does. If you want different template modifications in different styles you must add or customized them there (whih means that the templates must be customized as well as otherwise the styles just use a virtual copy of the inherited template, eg. a real copy of the template does not exist in this case - which makes it impossible to apply modifications that are different from the inherited style).

[PhilMcKrackon]

Originally Posted by Andreas

Yes, it does. If you want different template modifications in different styles you must add or customized them there (whih means that the templates must be customized as well as otherwise the styles just use a virtual copy of the inherited template, eg. a real copy of the template does not exist in this case - which makes it impossible to apply modifications that are different from the inherited style).

Thanks for the confirmation, this is a great product!

[HossMon]

Amazing little tool!
One question...
What is the difference between the 1-1-4 and 1-1-5 engines?
It's not explained and I saw no real info on this anywhere in the thread.

[Smitty]

See the first post - If you use MySQL 4.1 series, MySQL 4.1.10 or higher is required
If you use MySQL 5.0 seriesn, MySQL 5.0.3 or higher is required

[Andreas]

@HossMon
Take a look at the first post @ Version History

[dartho]

I've just upgraded my live site to vBulletin 3.8.0 and also upgraded to TMS 1.1.5. (from 1.0.0)

And it all went well!

[S]I have a TMS rule at add the 'vbstatus' add-on code to my postbit_legacy template.

When I 'Test Template Modifications', it shows no tick in the test results column, and suggests I need to Edit this rule. However - the template edit rule is still being applied successfully. How can this be so? Even if I go in to edit it and save, still works even though I changed nothing and the test result is negative?

I'm sure I am missing something, but am unsure as to what...[/S]

[KevinL]

This is probably one of the best mods ever made. I honestly don't know how it's not a default part of vb