Alternate Parameter Types for Custom Tools

Next topic

Author	Message
Eric Weik	Sunday 12 December 2004 9:18:05 pm I recently added some new tools to a toolbar list using the method described here: http://www.ez.no/ez_publish/documentation/customization/components/toolbars/adding_new_tools_to_toolbar_list Worked like a charm. However, I cannot figure out how to use alternate types for my tool parameters. For example, the "node_list" tool that comes with 3.4/3.5 has a boolean value ("Fetch whole tree"), some object browsers ("Item source" and "Show in subtree"), etc. I'm assuming this result can be accomplished through an admin override template, but I cannot figure out which one(s). Any tips on this? Thanks, Eric
Eric Weik	Tuesday 14 December 2004 11:24:51 am Well, I'll take a stab at answering my own question. :-) In looking at /design/toolbar.tpl, it looks like tool parameters can have 6 types, the default (a simple text field), note, classidentifier, classidentifiers, and subtree. The type is specified by ending the parameter name with _type the toolbar override, like so: [Tool_exampletool] parameter1_node= parameter2_classidentifier= parameter3_classidentifiers= parameter4_subtree= parameter5_check=yes <i>As of 3.5rc2, if you do not set parameter5_check to default as either yes or no, it will not render as a checkbox. </i> Presumably you can add more types (i.e. "textarea", etc.) by overriding /design/toolbar.tpl for your admin siteaccess. I personally have not had any success with this method, but it is likely due to my own relative inexperience with the override system.

Author

Message

Sunday 12 December 2004 9:18:05 pm

I recently added some new tools to a toolbar list using the method described here:
http://www.ez.no/ez_publish/documentation/customization/components/toolbars/adding_new_tools_to_toolbar_list

Worked like a charm. However, I cannot figure out how to use alternate types for my tool parameters. For example, the "node_list" tool that comes with 3.4/3.5 has a boolean value ("Fetch whole tree"), some object browsers ("Item source" and "Show in subtree"), etc.

I'm assuming this result can be accomplished through an admin override template, but I cannot figure out which one(s). Any tips on this?

Thanks,
Eric

Eric Weik

Tuesday 14 December 2004 11:24:51 am

Well, I'll take a stab at answering my own question. :-)

In looking at /design/toolbar.tpl, it looks like tool parameters can have 6 types, the default (a simple text field), note, classidentifier, classidentifiers, and subtree. The type is specified by ending the parameter name with _type the toolbar override, like so:

[Tool_exampletool]
parameter1_node=
parameter2_classidentifier=
parameter3_classidentifiers=
parameter4_subtree=
parameter5_check=yes

<i>As of 3.5rc2, if you do not set parameter5_check to default as either yes or no, it will not render as a checkbox. </i>

Presumably you can add more types (i.e. "textarea", etc.) by overriding /design/toolbar.tpl for your admin siteaccess. I personally have not had any success with this method, but it is likely due to my own relative inexperience with the override system.

eZ debug

Timing:	Jan 31 2025 01:25:35
Script start
Timing:	Jan 31 2025 01:25:35
Module start 'layout'
Timing:	Jan 31 2025 01:25:35
Module start 'content'
Timing:	Jan 31 2025 01:25:35
Module end 'content'
Timing:	Jan 31 2025 01:25:35
Script end

Main resources:

Total runtime	0.0244 sec
Peak memory usage	6,144.0000 KB
Database Queries	3

Timing points:

Checkpoint	Start (sec)	Duration (sec)	Memory at start (KB)	Memory used (KB)
Script start	0.0000	0.0060	588.2656	151.2266
Module start 'layout'	0.0060	0.0043	739.4922	220.7188
Module start 'content'	0.0104	0.0124	960.2109	997.9609
Module end 'content'	0.0227	0.0016	1,958.1719	29.9922
Script end	0.0244		1,988.1641

Time accumulators:

Accumulator	Duration (sec)	Duration (%)	Count	Average (sec)
Ini load
Load cache	0.0027	10.9412	14	0.0002
Check MTime	0.0011	4.5471	14	0.0001
Mysql Total
Database connection	0.0010	3.9549	1	0.0010
Mysqli_queries	0.0028	11.2881	3	0.0009
Looping result	0.0000	0.0782	1	0.0000
Template Total	0.0012	4.7	1	0.0012
Template load	0.0009	3.5210	1	0.0009
Template processing	0.0003	1.1922	1	0.0003
Override
Cache load	0.0006	2.4753	1	0.0006
General
dbfile	0.0003	1.2010	8	0.0000
String conversion	0.0000	0.0401	4	0.0000
Note: percentages do not add up to 100% because some accumulators overlap

Templates used to render the page:

Usage	Requested template	Template	Template loaded	Edit	Override
1	print_pagelayout.tpl	<No override>	extension/community/design/community/templates/print_pagelayout.tpl
Number of times templates used: 1 Number of unique templates used: 1

Time used to render debug report: 0.0001 secs