This page is still a beta!

Chapter 1. EXT : Templavoila XML for Flash

Extension Key: tv_xml_for_flash

Copyright 2007, Alban Cousinié, <ace@mind2machine.com>

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.com

1.1. Introduction

What does it do?

There already exists several extensions capable of outputing Typo3 content to XML so it can be read by flash, but none supports templavoila and I found they were not stable enough to rely on them for production purposes.

This extension is capable of exporting the whole page tree as XML and the whole content of a given typo3 page including flexform data. It exports ALL information i could gather from 'pages' and  tt_content tables, thus generates pretty big XML files (they still load quickly though since there are no images), but in return you can make use of almost any typo3 information from flash, such as controlling if a page has a start / stop date, sorting information, creation date etc...

Several types of flexform fields are recognized during and processed  in order to be reverted from their Typo3 custom internal format to a format usable externaly.

Currently the extension knows how to deal with the following flexform editing types (eTypes) :

  1. bodytext edited with RTE including all type of links (open window, file link, internal link, external link). Images embeded from inside the RTE are not tested and likely not to be supported. Anyway I don't think flash supports including an image inside a text field.

  2. Input text

  3. image input

  4. link input

  5. content element

It is  easy to customize the PHP code in order to deal with more type of objects as explained in this documentation, but I haven't had enough time to cover all eTypes of contents present in typo3. The eTypes provided in standard should already cover most usages. If you add some content types, please send me your code so I can integrate it into the extension for the benefit of the community.

Currently this extension is limited to publish only one website, so you can't have multisite setups with Flash frontend unless you customize the extension. I assume the extension should however deal correctly with multiple languages but I haven't  tested it yet.

Important : web sites making use of this extension should have Typo3 and their mysql database configured for utf-8, as flash doesn't handle properly non utf-8 content.

Screenshots

The first website making use of templavoila XML for Flash is http://www.bandeapart.fr

This is a part of the XML output of the page structure :

This is a part of the XML output of a page data :