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

[baz_kingfish]

ahhhh, thanks for the clarification. That makes more sense...glad to know that MASTER mod I accidentally made is of no real consequence.

Sorry for being a DA.
KF

[baz_kingfish]

I am trying to install NuRatings template mods using the TMS, but when I test a few of them, I get a check mark under test, but nothing under results? Also, when I review the Template code, I do not see the New Ratings mods in the template. Here is an example of the first one that is reacting this way.

Adding NuRatings' Post Ratings to each post in each post shown in the View Thread Page

--------------------------------------------------------------------------------
Product: NuRatings
Template: postbit
Title: Add NR Post Ratings to each post
Variable: addnrpostratingstopost

Search Text: <!-- controls --> which works.

Add BEFORE search text:
<if condition="$show['moderated']">
<td class="alt2" align="$stylevar[right]" style="border-left: 0px; border-top: 0px">
<else />
<td class="alt1" align="$stylevar[right]" style="border-left: 0px; border-top: 0px">
</if>

$post[nu_ratings_postbit]

<!-- controls -->
<if condition="$post['editlink']">

Any ideas? Should the product be set to vBulletin instead of NuRatings given that is where the postbit template resides? I have made other mods successfully using TMS, and do not have enough experience to know why/where/if this one is breaking. Does the fact that I am not getting a check mark unders results when I test mean it is not working?

Also, there are other mods that I need to make to the MEMBERINFO, SHOWTHREAD, navbar, and threadbit templates, but they are not available in the TMS drop down list when "Adding Template Modifications". What am I doing wrong here?

Any help is appreciated. I don't plan on enabling NuRatings until I can successfully implement the template changes through TMS.
Thanks,
KF

UPDATE: I figured out the other templates noted above need to be modified in the MASTER, so those problems are solved; however, I still can NOT get the above postbit modifications to TEST with a check in the Results field. That is all I lack to be finished...any ideas?
Thanks

Last UPDATE: Found the error -
<!-- controls -->
<if condition="$post['editlink']">
was in the template twice. It is working now...just not displaying the way I would like it to...but that is not a TMS problem. Please disregard my plea for help!
Thanks.

[|Jordan|]

Does this hack add any database queries?

[Boofo]

Andreas, excellent work, sir. Just what I needed. Thank you very much.

[Andreas]

Originally Posted by |Jordan|

Does this hack add any database queries?

There is no code being executend in frontend scripts, only in AdminCP.

[rapidphim]

question for you... I am trying to install a fresh 3.7.0 beta4. Should I install this hack very first thing with only Default style before I install any other hacks/custom/modified styles?

[Andreas]

Yes, that would be best.

[rapidphim]

Thanks. Next, after that, I installed another custom/modified styles:
1/ will it or does it have any effect to Default style?
2/ now, I install another hack that require template edit, should I edit the Default template and it will automatically edit the second style that I just installed?

[Andreas]

Don't modify any templates nmanually. Instead, take the instructions from the hack and insert them into TMS.

[Boofo]

Does this actually modify them as you would manually or on the fly like the string replace?