DEPRECATION WARNING

This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.

EXT: Readable name of your extension

Created:2010-02-18T17:33:18
Changed:2011-05-09T11:46:49
Classification:extensionkey
Description:The keywords help with categorizing and tagging of the manuals. You can combine two or more keywords and add additional keywords yourself. Please use at least one keyword from both lists. If your manual is NOT in english, see next tab "language" ---- forEditors (use this for editors / german "Redakteure") forAdmins (use this for Administrators) forDevelopers (use this for Developers) forBeginners (manuals covering TYPO3 basics) forIntermediates (manuals going into more depth) forAdvanced (covering the most advanced TYPO3 topics) see more: http://wiki.typo3.org/doc_template#tags ----
Keywords:keywords comma-separated
Author:Author Name
Email:your@email.com
Info 4:
Language:en

img-1 EXT: Ajax Loader- ag_ajaxload

EXT: Ajax Loader

Extension Key: ag_ajaxload

Language: en

Keywords: ajax, jquery, content loading

Copyright 2000-2010, Tomaz Zaman, <support@agenda.si>

This document is published under the Open Content License

available from http://www.opencontent.org/opl.shtml

The content of this document is related to TYPO3

- a GNU/GPL CMS/Framework available from www.typo3.org

Table of Contents

EXT: Ajax Loader 1

`Introduction 3 <#__RefHeading__722_2028123520>`_

What does it do? 3

Screenshots 3

`Users manual 4 <#__RefHeading__728_2028123520>`_

`Administration 5 <#__RefHeading__730_2028123520>`_

`Configuration 6 <#__RefHeading__732_2028123520>`_

Reference 6

`Tutorial 7 <#__RefHeading__736_2028123520>`_

`Known problems 8 <#__RefHeading__738_2028123520>`_

`To-Do list 9 <#__RefHeading__740_2028123520>`_

`ChangeLog 10 <#__RefHeading__742_2028123520>`_

Introduction

What does it do?

  • This extension allows you to display content from other pages asynchronously – with a little help of jQuery. It can do so in intervals (good for checking changes in content – such as logs) and it can also display content from as many pages as you want and put it different elements on your page.
  • jQuery is loaded from google's CDN but you can easily override that and even include your own library and use that one.

Screenshots

img-2

Users manual

  • This extension allows you to pull content from another page and puts it in desired HTML element. Multiple plugins on the same page are possible as well, which means you can have different HTML elements displaying content from variuos pages. This extension was written to display logs and refreshing the data every few seconds.
  • When adding a new plugin to the page, two fields are mandatory: the page with the content and id of the HTML element (div) you want to put fetched content in.
  • Interval can be set (in miliseconds) that refreshes that content
  • Template can be chosen for the snippet that gets included on the page

Administration

  • After installing the extension make sure to include typoscript templates
  • The page with the content we are pulling should have Content page (ag_ajaxload) TS template included
  • The page we are displaying the pulled content in should have Display page (ag_ajaxload) TS template included
  • That's it!

Configuration

  • The most important part of the extension is included in the TS template 'Display page' that holds headerData array
  • You are free to override that array with your own JS code
  • 'Content page' TS template is used to remove the header code, body tags, xml declaration, leaving just the content
  • Multiple plugins are possible on the same page, even with different refresh intervals

Reference

templateFile

Property

templateFile

Data type

resource

Description

The template file, can be set for each plugin individually or site- wide

Default

EXT:ag_ajaxload/res/template.html

[tsref:plugin.tx_agajaxload_pi1]

Tutorial

  • Install the extension, include BOTH TS templates (Content page, Display page)
  • Before adding the plugin, make sure you have the placeholder element, i.e. some div with id, that you will use
  • On the page you want the content (from another page) displayed on, add a new Content Element and select Ajax Loader
  • In flexform, enter placeholder's id (without #) and select the page you want the content fro
  • Optionally select interval (in microseconds) that you want the content to be refreshed in
  • Optionally select a custom template file

Known problems

None so far. Be sure to drop me a line ( support@agenda.si ) if you find one.

To-Do list

Nothing yet. Will add if something comes up.

ChangeLog

0.0.1

Version

0.0.1

Changes

Initial release.

10