EXT: t3mootools¶

Table of Contents¶

EXT: t3mootools 1

Introduction 1

What does it do? 1

Screenshots 1

Users manual 3

Analyze the .js of a Mootools extension 3

Process and Analyze t3mootools.txt in extensions 4

Create a custom Mootools JS Libraray 4

Configuration 4

t3mootools.txt what is this? 5

t3mootools.txt example: 5

Known problems 5

To-Do list 5

You like the extension? 5

Thanks to 5

Changelog 5

Introduction¶

Users manual¶

To use the extension you need to follow these steps:

Install the extension.

Reload the Backend to access the backend module (e.g. press F5 to reload the page or logout & login again).

Enter the Backend module “Mootools Setup” (last entry in the section “Tools”).

Use one of the 3 entries in the dropdown menu at the top right corner. (If the “Extension Development Evaluator” [extkey: extdeveval] extension is installed, a 4 ^th entry will be added to the drowdown, which gives you quick access to displaying the t3mootools API docs)

Follow the steps below.

Configuration¶

If you want to use t3mootools for your own extension, you need just some several lines which look like this:

// checks if t3mootools is loaded
if (t3lib_extMgm::isLoaded('t3mootools'))    {
   require_once(t3lib_extMgm::extPath('t3mootools').'class.tx_t3mootools.php');
}
// if t3mootools is loaded and the custom Library had been created
if (defined('T3MOOTOOLS')) {
        tx_t3mootools::addMooJS();
// if none of the previous is true, you need to include your own library
// just as an example in this way
} else {
        $GLOBALS['TSFE']->additionalHeaderData['rgsmoothgallery'] =   '<script src="'.$this->getPath($this->conf['pathToMootools']).'" type="text/javascript"></script>';
}

You are done!

It is also possible to load and use the API from Typoscript, like this:

includeLibs.t3mootools = EXT:t3mootools/class.tx_t3mootools.php
page.10 = USER
page.10.userFunc = tx_t3mootools->addMooJS

A special function (for Typoscript use) is included in the API, for adding extra Javascript AFTER the mootools.js.This is needed in some situations because headerdata added with "page.headerData" is placed BEFORE the headerdata which is added using PHP.

The function accepts 2 parameters “ jsfile ” and/or “ jsdata ”, both with stdWrap support.

“ jsfile ” is a path/filename of a javascript file.

“ jsdata ” is a piece of javascript code.

Note: If you use this function, it is not necessary to add the mootools.js using the tx_t3mootools->addMooJS function, as this function automatically adds the mootools.js if it is not already added.

Example:

10 = USER
10.userFunc = tx_t3mootools->addJS
10.jsfile = fileadmin/testscript.js
10.jsdata = alert('Hello World!');

script = res/scripts/slimbox_ex_uncompressed.js,res/scripts/slimbox_pf_uncompressed.js
components=Window.DomReady

Known problems¶

This extension just includes the library and nothing more! So if 2 extensions do have still a conflict, this is not the fault of t3mootools.

To-Do list¶

- Automatic look up for the js files of extensions.Done

You like the extension?¶

If you like this extension, you can do one or more of the following things:

• Write me a mail with some nice words.
• Rate the extension in the Repository: http://typo3.org/extensions/ search for t3mootools, click on the title and then at “Ratings” (You need to be registered and logged in at typo3.org)

Thanks to¶

I want to thank the following people

• Georg Ringer for writing the initial manual, german translation, bugtesting and tons of good ideas.
• Martin Fluer for kicking my butt to get the 1.2.1 update released and for bugtesting and various fixes.

Changelog¶

• 1.3.0 Extension is now updated for Mootools v1.2.1 usage. This required major changes in the analyzer script.
• 1.2.0 Fixed problem in the Process and Analyze t3mootools.txt mode, where only the local extension dir was checked.Now it works correctly with Local, Global and System extension folders. Thanks to Jesse Adler for reporting this.Added a new function to the API, named “addJS” which is a small wrapper for adding javascripts script after theMootools Library. This is needed in some situations because headerdata added with "page.headerData" is placed BEFORE the headerdata which is added using PHP.Extension is now marked Stable.
• 1.1.0 New function to process and analyze t3mootools.txt files located inside extension dirs. This makes it much easier to generate the mootools library with the correct dependencies. Big thanks to Georg Ringer for writing the initial manual a bugreports.
• 1.0.1. Some clean up, german language files.
• 1.0.0. Initial release

EXT: t3mootools - 5