MODX :: Installer TV .tpl files

327

rx2 Reply #1, 2 years, 1 month ago

Link to this post#1

Quote from: garryn at Mar 29, 2010, 11:53 AM

Quote from: sottwell at Mar 29, 2010, 07:29 AM
How are you handling the assignment of the TVs to their respective templates? I just added this to SkinGraft, but that's only with one template being installed ...
Well, you can see how the TVs are handled in the installer by viewing this changeset.

Basically, the TV definition file (placed in the /install/assets/tvs/ folder) would look like this (note, some of my values are sheer gobblydegook) :
/**
 * My Test TV
 * 
 * My Description for my TV
 *
 * @category        tv
 * @name            testTV
 * @internal        @caption My Test TV
 * @internal        @input_type richtext
 * @internal        @input_options x==1||y==2
 * @internal        @input_default x
 * @internal        @output_widget datagrid
 * @internal        @output_widget_params x=1&y=2&z=3
 * @internal        @lock_tv 1
 * @internal        @template_assignments MODxHost
 * @internal        @modx_category Test
 */
A comma-separated list of @template_assignments would assign that TV to each of those templates.

Excellent. How do we find out the name of the input types? For example I want to install a number of TVs we use for blogging. One allows the user to select how many recent articles are shown:

/**
 * Articles Summary
 * 
 * Summary Count for Articles
 *
 * @category        tv
 * @name            articlesummaries
 * @internal        @caption Article Summaries
 * @internal        @description How Many Articles Summaries Per Page?
 * @internal        @input_type drop 
 * @internal        @input_options 1||2||3||4||5||6||7||8||9||10||11||12||13||14||15||16||17||18||19||20
 * @internal        @input_default 3
 * @internal        @output_widget 
 * @internal        @output_widget_params
 * @internal        @lock_tv
 * @internal        @template_assignments blog-index,Blog,Video Blog
 * @internal        @modx_category Ditto
 */

This is a drop down list menu. But what is the name of that input type for this? It's probably not drop as indicated below. Is there documentation about what each list type is called?

 * @internal        @input_type drop

Also I added this:

 * @internal        @description How Many Articles Summaries Per Page?

As it was not in your original description. Is that valid as well? We have about 30 TVs to create in this manner so we want to get it right.

12,071

Ryan Thrash

MODX Co-Founder & Leader of Awesomeness

MODX Revolution

Your Content, Your Way.

Issues | Documentation | Git the Source

Need help? Help us help you.

rthrash Reply #2, 2 years, 1 month ago

Link to this post#2

(admin note: split from another thread)

327

rx2 Reply #3, 2 years, 1 month ago

Link to this post#3

Quote from: rthrash at Apr 06, 2010, 05:22 PM

(admin note: split from another thread)

Thanks Ryan. This would be useful information to have to take advantage of this fabulous feature.

15,111

How MODx Evo Works

Log in to an Evo Manager username guest, password guestuser.

sottwell Reply #4, 2 years, 1 month ago

Link to this post#4

Probably the best source for information in which is what would be the manager/includes/tmplvars*.php files; there are three of them.

tmplvars.inc.php handles basic TV stuff, like making the fields. This is the one you are interested in; it has a switch() statement where you can find all of the input types.

tmplvars.commands.inc.php handles @ bindings.

tmplvars.format.inc.php handles the output widgets.

Unfortunately the mutate_content.dynamic.php file is mixed HTML and PHP, with the TV fields for the template being generated on the fly, so you can't use a plugin with the OnDocFormPrerender event to create custom TVs. While you can use snippets to provide custom output widgets, there is no way to have custom input types without hacking the tmplvars.inc.php file.

1,451

Garry Nutting
Senior Developer, Complete Support Team
MODX, LLC

Email: support@modx.com Twitter: @garryn
Web: modx.com Twitter: @modxcms Facebook: modxcms

Garry Nutting - MODX Complete Team Reply #5, 2 years, 1 month ago

Link to this post#5

Input Types
The input types that can be used are:

text: Text

textarea: Textarea

textareamini: Textarea (Mini)

richtext: RichText

dropdown: DropDown List Menu

listbox: Listbox (Single-Select)

listbox-multiple: Listbox (Multi-Select)

option: Radio Options

checkbox: Check Box

image: Image

file: File

url: URL

email: Email

number: Number

date: Date

Output Widgets
The possible output widgets are:

Widgets

datagrid: Data Grid

floater: Floater

marquee: Marquee

richtext: RichText

ticker: Ticker

viewport: View Port

[/list]

Formats

htmlentities: HTML Entities

date: Date Formatter

unixtime: Unixtime

delim: Delimited List

htmltag: HTML Generic Tag

hyperlink: Hyperlink

image: Image

string: String Formatter

[/list]

Description

Also I added this:

* @internal        @description How Many Articles Summaries Per Page?

That is unneeded, as the description is pulled from the top part of the docblock (the line below the title of the TV), so in your example, the description would be set to:

Summary Count for Articles

15,111

How MODx Evo Works

Log in to an Evo Manager username guest, password guestuser.

sottwell Reply #6, 2 years, 1 month ago

Link to this post#6

I am in the middle of an email exchange with somebody who just managed to get the "file" input type to point the resource browser to the assets/flash folder; I haven't gotten his response to my plea for the explanation of how he did it.

327

rx2 Reply #7, 2 years, 1 month ago

Link to this post#7

Thanks for the info. I will proceed to redefine our standard base install without the need for a base database. Great stuff!

15,111

How MODx Evo Works

Log in to an Evo Manager username guest, password guestuser.

sottwell Reply #8, 2 years, 1 month ago

Link to this post#8

All he did was change the "type" designation in the javascript for the Files case in the tmplvars.inc.php file. I've posted an improvement in Jira for two simple changes to add a "flash" input type for TVs.

57

christian seel - www.christianseel.com
web developer & designer at chsmedien.de
twitter: @christianseel / @chsmedien

christianseel Reply #9, 2 years, 1 month ago

Link to this post#9

hey. i have some trouble with my tv file during the install...

/**
 * meta-robots
 * 
 * Robots
 *
 * @category        tv
 * @name            meta-robots
 * @internal        @caption Meta Robots
 * @internal        @input_type dropdown
 * @internal        @input_options index,follow||noindex,follow||noindex,nofollow||index,nofollow
 * @internal        @input_default index,follow
 * @internal        @template_assignments standardTpl
 * @internal        @modx_category Meta
 */

Error Msg:

You have an error in your SQL syntax; check the manual that corresponds to your MySQL server version for the right syntax to use near ''index,follow||noindex,follow||noindex,nofollow||index,nofollow','','','index,fo' at line 1

any hints?

327

rx2 Reply #10, 1 year, 11 months ago

Link to this post#10

Quote from: Seel-Media at Apr 13, 2010, 09:36 AM

hey. i have some trouble with my tv file during the install...
/**
 * meta-robots
 * 
 * Robots
 *
 * @category        tv
 * @name            meta-robots
 * @internal        @caption Meta Robots
 * @internal        @input_type dropdown
 * @internal        @input_options index,follow||noindex,follow||noindex,nofollow||index,nofollow
 * @internal        @input_default index,follow
 * @internal        @template_assignments standardTpl
 * @internal        @modx_category Meta
 */
Error Msg:

You have an error in your SQL syntax; check the manual that corresponds to your MySQL server version for the right syntax to use near ''index,follow||noindex,follow||noindex,nofollow||index,nofollow','','','index,fo' at line 1

any hints?

I have a similar error though it's not as specific, it simply ends on "to use."
Has anyone successfully been able to use TVs on an install?