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

[yoyoyoyo]

Originally Posted by Andreas

What does "customized template support" mean?

@yoyoyo
Smth. like 'Download Plugins' is already planned.

cool

"customized template support" refers to templates that are specific to a certain style

[Icy]

Originally Posted by Andreas

What does "customized template support" mean?

Sorry for the missunderstanding. I recheck & finally understand how it works. In master style I'll find all templates & in normal style I'll find only those templates which has been customized/edited.

Anyway I believe there is a bug. When I enable the TMS I can edit templates but I can't save it because there is no Save or Save & Reload button. If I disable TMS then everything go back to normal. I've attached 2 screenshot. I reproduced the problem both in Firefox & Opera. I have not try Internet Explorer though.

[Andreas]

@yoyoyo
Erm, TMS works just fine with custom/customized templates?

Do you want to create "virtual" templates, eg. advise TMS to apply modification X to template foo in style Y only, without template foo being customized in style Y?
That is (and most likely never will be) possible: If a template is not customized in a certain style, it does not physically exist - it's just a reference to the inherited template.

@Icy
Sorry, but I can't help you (without an ACP login for you board) as I am unable to reproduce the problem locally.

[Icy]

Originally Posted by Andreas

@Icy
Sorry, but I can't help you (without an ACP login for you board) as I am unable to reproduce the problem locally.

PM sent

[Andreas]

@All those having problems with TMS in ACP (Style Manager & Product Manager)
Could you check if the attached plugin fixes the problems?

[nyunyu]

Sorry, this might not be any useful post as I just wanted to know if this hack can be use in 3.5.4 version of vbulletin?

Thanks

[nyunyu]

maybe I was dumb...I installed this hack on 3.5.4 and it give me this error

Database error in vBulletin 3.5.4:

Invalid SQL:

### INSERT QUERY GENERATED BY fetch_query_sql() ###
INSERT INTO plugin
	(`active`, `executionorder`, `title`, `hookname`, `phpcode`, `product`)
VALUES
	('1', '5', 'Event-Handler: Produkt aktivieren/deaktivieren', 'admin_complete', '// Handle enabling/disabling Product \r\nif (($_REQUEST[\'do\'] == \'productenable\' OR $_REQUEST[\'do\'] == \'productdisable\') AND $vbulletin->GPC[\'productid\'] AND $vbulletin->adminloggedin AND can_administer(\'canadminplugins\'))\r\n{\r\n	global $product_update;\r\n	if (is_array($product_update) AND !empty($product_update))\r\n	{\r\n		require_once(DIR . \'/includes/adminfunctions_templateedits.php\');\r\n		if ($_REQUEST[\'do\'] == \'productenable\' OR !in_array(\'tms\', $product_update))\r\n		{\r\n			$templates = array();\r\n			$templatesq = $vbulletin->db->query_read(\"SELECT template FROM \" . TABLE_PREFIX . \"templateeditlocation WHERE product IN (\'\" . implode(\"\', \'\", $product_update) . \"\') GROUP BY template\");\r\n			while ($templateedit = $vbulletin->db->fetch_array($templatesq))\r\n			{\r\n				$templates[] = $templateedit[\'template\'];\r\n			}	\r\n		}\r\n		else\r\n		{\r\n			define(\'TMSDEACTIVATED\', true);\r\n			$templates = \'\';\r\n		}\r\n		rebuild_template_edits(\'\', $templates);\r\n	}\r\n}', 'tms');

MySQL Error  : Unknown column 'executionorder' in 'field list'
Error Number : 1054
Date         : Monday, November 19th 2007 @ 03:48:36 AM
Script       : http://nyunyu.info/animeproject/admincp/plugin.php
Referrer     : http://nyunyu.info/animeproject/admincp/plugin.php?do=productadd
IP Address   : 121.xxx.xxx.xxx
Username     : nyunyu
Classname    : vb_database

how to revert back?

[dartho]

Edit: Confirmed by Andreas that it will not be compatible

[S]you may be able to get it running under 3.5.4 by editing the product-tms.xml file and replace all occurences.

BUT - If there are 3.6.x code dependent hooks, it likely will not work and you may need to disable all plugins so you can then uninstall. AFter looking through all the posts in this thread, there is no menation of people NOT being able to get it working on 3.5.x..... yet[/s]
[s]<plugin active="1" executionorder="5">[/s]
with
[s]<plugin active="1">[/s]
[s]then try and install again?[/s]




Otherwise the uninstallation instructions in the readme.txt file are:

Originally Posted by readme.txt

Uninstallation
--------------
1) Uninstall product'Template Modification System' in ACP 'Products & Plugins / Manage Products'
2) Delete the following files
- includes/xml/cpnav_tms.xml
- admincp/templateedits.php
- includes/adminfunctions_templateedits.php
- clientscript/tms_templateeditmgr.js
- clientscript/tms_ajax.js
- includes/md5_sums_tms.php

You won't need to do step 1 if the install is failing

[Andreas]

Due to the fact that there are no "always execute" installation codes (eg. version = *) in vBulletin 3.5.x, you won't be able to get this working properly on 3.5.x.

[yoyoyoyo]

Originally Posted by Andreas

@yoyoyo
Erm, TMS works just fine with custom/customized templates?

Do you want to create "virtual" templates, eg. advise TMS to apply modification X to template foo in style Y only, without template foo being customized in style Y?
That is (and most likely never will be) possible: If a template is not customized in a certain style, it does not physically exist - it's just a reference to the inherited template.

OK - that makes sense - it would be nice to be able to customize modified templates in certain styles, though, but I can see how that would be a problem.