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]

So with this MOD are template edits done within TMS and no longer by pulling up the template from the appropriate style and then doing the edits? Also, after each template edit, are you supposed to export the template edit to use in the future should there be upgrades to the vBulletin software, thus not needing to redo all of your previous template edits?

Also, I noticed that the only style I have on my board is the Default style; I do not see a Master style. Should I have both?

Finally, on my board so far I have the following MODs installed along with all of the required template (and file) edits:
Thread Prefixes
Move Display Options Above Threads
Change Thread Prefix Inline
ibProArcade
vBadvanced CMPS
vBCredits
vBCredits with ibProArcade
Vb Save Drafts (MOD from vBHackers.com)
Project Tools

Do I need to uninstall these MODs beofre installing TMS or is there something I need to do with them after I install TMS?

[Andreas]

Originally Posted by Junkie

So with this MOD are template edits done within TMS and no longer by pulling up the template from the appropriate style and then doing the edits?

TMS applies template modifications to compiled templates; the template source is not being modified.
If you use TMS for all your template modifications, it is not necessary to manually edit templates.

Also, after each template edit, are you supposed to export the template edit to use in the future should there be upgrades to the vBulletin software, thus not needing to redo all of your previous template edits?

You do not have to export template edits. This is only necessary if you want to copy template edits to another vBulletin installation or share them with other users.

Also, I noticed that the only style I have on my board is the Default style; I do not see a Master style. Should I have both?

MASTER style is only visible in debug mode, but it is not necessary to turn on debug mode to add template modifications in MASTER style.

Do I need to uninstall these MODs beofre installing TMS or is there something I need to do with them after I install TMS?

Do NOT uninstall these modifications! If you do so, you will loose the data.
However, you can undo the template edits you did manually for those modifications and add them to TMS instead. This is recommended to avoid having to manually update templates on vBulletin upgrades.

[NFLfbJunkie]

Do NOT uninstall these modifications! If you do so, you will loose the data.
However, you can undo the template edits you did manually for those modifications and add them to TMS instead.

I don't quite understand what it means to "add them to TMS instead" after I undo (revert) the template edits I have done manually. Should I revert all of my templates that I have edited? And if so, afterwards, what do I have TMS do? I am not familiar with TMS just yet so any guidance would be appreciated.

[NFLfbJunkie]

One other question I have is this MOD has nothing to do with files (i.e., .php files) that are edited as a result of adding MODs, correct? These will have to be re-edited regardless if an upgrade is done to the vBulletin software?

[Andreas]

See FAQ:
https://vborg.vbsupport.ru/showpost....59&postcount=2

This explains what to do with manually applied template modifications.

[NFLfbJunkie]

In some case the code that you are asked to search for may not be exactly what is in your template, so what should one do in these cases. For instance if I add a Template-Modification and put something in the for the search and replace text fields, what happens if the search text doesn't exactly match what the existing template has?

[Andreas]

Then it won't work
If the instructions do not work for your Template, it most likely means your template has been customized.
So you have to modify the search/replace text to meet the requirements for your template - as you would do if you are manually editing templates.

[NFLfbJunkie]

Are plugins & products supposed to be uploaded through the Plugins & Products sections of the AdminCP, while Template Modifications get uploaded through this MOD. Also, and maybe this question is off target, but when importing plugins, aren't template modifications being made, and if so, how are these edits separated from the edits a Template MOD makes?

[Andreas]

You can import & export templates modifications through Styles & Templates / Template-Modifications Manager.
However, if a product directly supports TMS you don't have to do anything - the template edits are contained within the product XML and will be imported as well.

[Funboy]

Great Mod, Thx for your hard work Andreas.

Regards
Funboy