But what the heck has “Dinner is served” to do with the Fleb Framework?
When I build a flebsite, I like to think of it as a table ready laid. If I want to have dinner, I will always find 3 things for sure: the table itself, a plate and some food on the plate. (Some of you might argue now that you can also eat on the floor without a plate, holding the food in your hands… Right. And you can also build websites by using SimpleText or Word… ) Okay, back to the point. Oh, I forgot two more things: the tablecloth or placemat and the menu card. But lets start with the table.

The table
Normally, you do not spend a thought about the table itself, but it is really important. If you remove it,  you will end up in a mess. It always has to be there, but once you have placed it somewhere in your house or flat, you probably will spend more time on the things you put on that table than the table itself. So to me as a flash website designer, I like to see the table as the necessary PHP/CSS/HTML/SEO construct I don’t want to care about every time I build a new flebsite.

The tablecloth or placemat
For a decent dinner, before I put a plate on the table, I want to have a tablecloth or at least a placemat. To me, the tablecloth/placemat represents the basic settings of a flebsite: all the things that are most likely not going to change during a session, like the background image or color, a footer, a logo, a sound on/off switch etc. The tablecloth stands for a fullscreen flebsite, whereas the placemat represents a fixed size flebsite. The placemat, for example, may or may not be moved around with the plate, whereas the tablecloth will certainly stay in place when I scale the table (ups, sorry, I mean the browser window…)

The plate and the food on it
The plate is the place where the action is happening: During a dinner, you may have a drink, followed by a salad or soup, then the main dishes and finally a dessert. The plate may or may not change for every course, but the food certainly does. You can share one plate for salad and soup (maybe you are having dinner at home and just don’t have more plates… ), while the main dishes are being served on different plates (even the shape and colors of the plates may change). The dessert will be served on a nice transparent glass plate.
Think of the plate as your content page. The SWF displaying your data. The food is the actual data source. So you can have one plate that holds different food (the dynamically loaded content). If the food (the content) will be completely different (e.g. a change from a contact form to a gallery), than you might want to change the plate as well (the SWF). Than you have the cutlery that may or may not change with the plate: You can use the same fork for the salad and for the main dish. But you surely prefer a smaller spoon for the dessert than for the soup.

Got the point?
While the table will not change at all and the tablecloth and placemat will remain the same during a “dinner session”, the plates, cutlery, glasses etc. will change, being moved around and emptied/filled up a lot.

One more: the menu card
To make this metaphor complete I like to think of the global navigation as the menu card. When you hold it in your hands, it is floating above the table. In your mind you “navigate” through the dinner by selecting your food just like clicking on the buttons of a website.

…and the last one: the waiter or “the brain”
Because I later refer to “the brain” when talking about “main.swf”, think of it as the person who knows everything about your dinner: the waiter. While your guests are the visitors of your flebsite, the waiter knows what to put on which plate, where to place it on the table, in which order the dishes have to be served, who has salad and who has the soup, who is vegetarian and has the risotto, when it is time to light the candles, clean up breadcrumbs, dim the lights, pump up the volume of the background music, help you with the chair if you need to go to the ladies’/men’s room, inform you about an incoming telephone call, when to ask you if the coffee may be served and so on….

Fleb Framework 1.2

What’s new?
As written in the introduction, the whole framework has been cleaned up and restructured. Now there is much less code in main.as and you can concentrate on the design etc… As the Fleb Framework is based on the Global Navigation, I have moved the navigation settings into structure.xml. So now the whole website structure is defined in a central place.

Flow
When base.swf (the “tablecloth/placemat”) is loaded, it starts loading main.swf (the “waiter” or “brain”). A preloader in base.swf shows the loading progress, main.swf will use 50% of the preloader bar. When main.swf is loaded, the navigation is initialised, which will use the other 50% of the preloader bar so it will reach 100% when main.swf and the navigation are completely initialised. Main.as will also create the pageHolder movieclip (the “plate”) and the navigationHolder movieclip (the “menu card”)

Examine the demosite

Example 1: Landing on the homepage of the site
Launch the demosite: http://www.flashcmsframework.com/flebsite_demo_v1.2
As you can see, there is kind of an intro before the navigation is animated into place. Of course it is up to you to have an intro. This is just an example.

Example 2: Deeplinking
An intro is nice if the user enters the site via the homepage. But what about a deeplink?
Try this:  http://www.flashcmsframework.com/flebsite_demo_v1.2/en/products/turbo-series
Now the user wants to get quickly to the content, so the intro is skipped.

Example 3: Deeplinking with parameters
Maybe you have an image gallery on your site. You want to be able to deeplink to a specific image, but, because the gallery gets updated often, you cannot define all links in structure.xml. They need to be dynamic.
Check this: http://www.flashcmsframework.com/flebsite_demo_v1.2/en/service/some/more/info
The address defined in structure.xml is “/en/service/”. Everything which is beyond this scope will be stored in an array called deeplink. That way you can set up an event listener in your SWF and do whatever is needed, for example loading a certain image. This even works without flash, so you can catch the deeplink in your PHP file to feed the search engines:
http://www.flashcmsframework.com/flebsite_demo_v1.2/noflash.php?swfaddress=/en/service/some/more/info

Show your clients the “no flash” version
Maybe you’ve noticed the noflash.php part in the previous sample link above.
Try this: http://www.flashcmsframework.com/flebsite_demo_v1.2/noflash.php
This is the site the user will see if he cancels the express install procedure. But at the same time it is really useful to easily show your clients the work “under the hood” without having them deactivate javascript.

Transitioning pages
Launch the demosite: http://www.flashcmsframework.com/flebsite_demo_v1.2. If you navigate to “About us”, then “Service”, you see that the pages are just fading in and out. Now click on “Static content”. Here the previous page will not only fade out, but also move to the right, then there is a pause, just before the “static content” page slides in from the left.In fact it is very easy to set up different transitioning modes.

SWFObject 2.2 / 2.1
While using the new SWFAddress version 2.4, there are problems with SWFObject 2.2 when you cancel ExpressInstall in Firefox on PC: you will end up with a blank screen. This issue is not occuring with SWFObject 2.1, so I will continue using this version for the time being.

How to start?
Download the Fleb Framework from the download section. It also contains the complete source of the demosite. Dive into the files and visit the documentation, I have spent some time updating it.

Happy coding!
Christian (the flebber….;-))

Unfortunatly when the users aborts the express install he will end up with a blank screen. Even if the user was shown the no javascript alternative content we would run into problems because of SWFAddress, which would again start the express install at the time of the next click in the navigation menu. For Fleb, this needed some rethinking.

SWFObject 2.1 together with SWFAddress 2.3
At first I wanted to upgrade to the newest SWFObject 2.2, but I ran into 2 problems. First, when I have SWFObject 2.2 installed, when I test in Firefox (3.0.13 and 3.5.2) on the PC I get a blank screen and an error in firebug: “Error calling method on NPObject“. So I switched back to SWFObject 2.1, which I have not encountered any problems on the tested browsers. And there is even another issue: The combination of SFWObject 2.2 and SWFAddress 2.3 causes FlashVars to be NULL. Read this for more info about this issue. Conclusion for the time being: I will stick to SWFObject 2.1 and SWFAddress 2.3.

expressInstall.swf changed to flebExpressInstall.swf
Here is what I did: In expressInstall.as I changed the function installStatus like this:

function installStatus(statusValue) {
switch (statusValue) {
case "Download.Complete":
// Installation is complete.
break;
case "Download.Cancelled":
getURL(baseURL+"/noflash.php");
break;
case "Download.Failed":
getURL(baseURL+"/noflash.php");
break;
}
}

If the user hits “No”, he will be rerouted to “noflash.php”, which is in fact the same page as index.php, but without SWFAddress. See the graphic below.

This page is not linked to from anywhere and has the metatags “noindex, nofollow”, so the search engines should not index it. This page is only for the user to have at least something if he cannot upgrade to the needed flash player. At the same time this is a great way to show your clients the NO FLASH version of their new flash website, without having them deactivate javascript (which they normally don’t have a clue how to do it… )

robots.txt
In this release version 1.1 of Fleb I also have added a robots.txt file, to prevent the search engines from indexing certain files. For example SWFs. Read this post for more info about SWFAddress and robots.txt.
Here is what it looks like:

User-agent: *
Disallow: /base.swf
Disallow: /main.swf
Disallow: /noflash.php
Disallow: /structure.xml
Disallow: /structure.php
Disallow: /content_source/
Disallow: /content_swf/

More improvements
Because there are now two php files that use the same info texts (index.php and noflash.php) I didn’t want to have redundant data, so I have created a new file named “noflash_text.php” with those pieces of text. Just have a look at it to see what I mean.

Making things variable
I took everything out of index.php that you had to set (e.g. flash version, background color) and placed it in structure.xml. Now you don’t have to touch the index.php file anymore, it’s all variable and defined in structure.xml. In the download files I have also added a structure.xml file that contains only one language, for you to compare.

Removed code from Main.as
I have placed all code for language handling in the navigationManager2 class, now Main.as is much clearer. The code that is left there has to be there. I mean, I could take even more code out and place it in seperate classes, but that would probably get in the way of your coding style. I want the Fleb Framework to remain as clear as possible. I have put a lot of comments in Main.as to explain every step. Please let me know if you have problems or suggestions.

You can download the Fleb Framework here.

Cheers,
Christian

What is the Fleb Framework and who needs it?
It’s an open source front-end framework for AS3 to help you build pure flash websites with full SEO support. It is based on the Global Navigation for Flash and the SWFAddress SEO Solution. You define the whole structure of the website (navigation, title, description, keywords, assets etc.) in an XML file which is parsed by your SWF files for your flash site and PHP files for the no-javascript SEO version of your site.

What does “Fleb” stand for?
Very simple: It is just a short form of “flash web” -> “fleb”. I prefer to build flebsites now…

Concentrate on Flash
All is done automatically: You don’t have to think about the layout of the no-javascript website any longer, just concentrate on the content, keywords and description in your structure.xml file. By using the global navigation you can create almost any navigation setup you can think of. Check it out.

Test it!
Let me demonstrate it. Start the Fleb Demosite. Navigate through the site and observe the address bar. Also use the browser back/forward buttons. At any point, reload the site to see how deeplinking is working. Speaking of deeplinking, try this: Add some additional parameters to the url, for example like so:

http://www.flashcmsframework.com/flebsitedemo/#/en/products/ultra-power/1/2/3/

As you can see the parameters are split into an array. Whenever there are parameters in the URL an event is dispatch which you can listen to from anywhere and react accordingly.

SEO, please!
Now comes the interesting part: Turn off JavaScript to see what the search engines get.

The navigation is created automatically by parsing the same XML file that is used for your flebsite (structure.xml). You can easily adjust the colors of the sidebar, header, content background etc. in a separate css file, if needed. But remember, this no javascript version will almost no one ever see! . Please navigate around and watch the address bar. As you can see, the “#” has gone, you have clean URLs for the search engines. Also look at the source text of the website to see the content of the metatags “keywords” and “description”. Now turn javascript back on and reload. SWFAddress will automatically insert a “#” and you will be taken to the right location inside your flash website.

Since my last post about the fleb framework I have merged the 2 PHP files “seonavig.php” and “datasource.php” into one file, “structure.php” to make it easier. Please visit the docs for an in-depth explanation of each file.

Open and very flexible
Besides the use of the Global Navigation you are completely free how you create/code your site. The Fleb Demosite (included in the download) is just a suggestion and shows the way I use to create websites. The main part of your code will be in main.swf. This is the place where the navigation and SWFAddress are initialized and where the loading/unloading of content is organized. Anyway, there are some techniques and classes involved I like to explain. Remember, it’s up to you if you use these or any other solutions.

Debugging
I use one of these 3 debugger solutions. Each one has its advantages.
Alcon
Arthropod
DeMonster

Global event handling & global variables
Some time ago I discovered this post by Reyco1 about a centralized event system. This is very useful for events that need to be used all over your project. For example, in Fleb there are 3 of those “global” events: onDeeplink, onLanguageChange, onStageResize. These event classes are included in Fleb. Based on this concept I have created a very simple class called VarCentral, which is a singleton that stores any variable you can globally access from anywhere in your project (an object, for example):

 VarCentral.getInstance().vars.hello = {a:1, b:2}

Loading assets
For simple cases, I use a slightly enhanced class  found in Colin Moock’s Book “Essential Actionscript 3″, LoadChildAsset. That is okay for most of my needs. If you need a more sophisticated class, you have to check out the BulkLoader from Arthur Debert. It’s awesome!
And this also looks very promising (though I have not used it yet): Queueloader by Donovan Adams.

Browser window resizing
If I need a script that resizes my flash movie automatically if the browser window size changes, i use swffit.

Tweening
TweenLite/Tweenmax
GO
Desuade Motion Package (not really tested yet, it’s quite new but looks very promising)

Cheers!
Christian

What is the Fleb Framework?

A front end flash framework. It focusses heavily on SEO, based on the example found at asual.com. Because SEO was (and still is) always a discussion point wether to create a website in flash or html. I always try to do everything in flash, so I had to find a way to wipe out the arguments against flash. Check out the movie below to get an idea and play with the demosite online.

www.youtube.com/watch?v=WQRa8G_7gqI

Overview of the Fleb Framework

In order to use the framework you need to enable mod_rewrite in .htaccess file. It uses PHP and XML. Just read on for more details.

Fleb Framework Overview

1. index.php

The index.php embeds base.swf. It uses SWFObject to detect the flash plugin and SWFAddress for URL rewriting (by using mod_rewrite in .htaccess). Every request is rerouted to index.php.

2. base.swf

This is the base of your website. Its whole purpose is to load the main website (main.swf, see 3). It contains only the neccessary setup and a preloader. This SWF should be kept as small as possible in order to display the preloader very soon.

3. main.swf

This is where the “brain” of the website resides. In main.swf the global navigation is initialized, the content (pages) is handled (preloading, fading in/out, crossfading, unloading etc.) and event handlers are added (SWFAddress, navigation, language etc.). All is open for you to finetune, extend and so on.

4. [content].swf

Your actual content. I’ve put the name in square brackets because it could be any name, like “about_us.swf” or “products.swf”. It’s completely up to you how you create these content SWFs.

5. structure.xml

This is the “plan” of your website: It contains the title, description, keywords of your website as well as the navigation structure and the source XML files with the content. Here is an example:

<structure>
<site>
<title>Flebsite Demo</title>
<description>This website is a pure flash website, or short: a flebsite!{Dies ist eine reine flash website, oder einfacher: eine flebsite </description>
<keywords>flash,website framework,cms</keywords>
</site>
<navigation>
<button id="home" btnSWF="mainBtn.swf" btnPosX="0" btnPosY="0" btnSpacingX="5" btnAddLabelSpace="10" btnLabel="Home{Startseite" btnStayActive="false">
<data swf="" source="home" seosource="_page.php" title="Welcome to %site%{Willkommen! - %site%" address="/en/{/de/" keywords="%site%" description="%site%"/>
<yournode test="any data"/>
</button>
<button id="about_us" btnSWF="mainBtn.swf" btnAddLabelSpace="10" btnLabel="About us{Über uns">
<data swf="_page.swf" source="_about_us.xml{_ueber_uns.xml" seosource="_page.php" title="About us - %site%{Über uns - %site%" address="/en/about-us/{/de/ueber-uns/" keywords="about us,%site%{über uns,%site%" description="about us - %site%{über uns - %site%"/>
<yournode test="hello world 1">This is text of yournode 1</yournode>
<yournode test="hello world 2">This is text of yournode 2</yournode>
</button>
</navigation>
</structure>

6. [contentData].xml

Holds the data of your content pages. This XML file is loaded in the SWF and also in PHP for SEO. I prefer to use XML whenever possible instead of JSON/PHP to store content because XML can be loaded directly into an SWF while testing in the Flash IDE. Here is an example:

<page>
<title>About us</title>
<body bgColor="699306"><![CDATA[ABOUT US: But I must explain to you how all this mistaken.......]]></body>
<pic url="images/b6nature_animals_sea000.jpg">This is a nice description of the image for SEO!</pic>
</page>

7. seonavig.php

This file is included in index.php. It parses structure.xml and creates the navigation for SEO. With correct indentation etc.

8. datasource.php

datasource.php is also included in index.php. It parses structure.xml and stores the navigation data in an object. It than compares the SWFAddress value to the parsed address values of structure.xml and loads the corresponding content source file (page.php, see next point) for SEO.

Update 08/06/2009: Please have a look at this post. I have merged “seonavig.php” and “datasource.php” into “structure.php” to make it all clearer.

9. [page].php

As in point 6 I have used square brackets because these PHP files can have any name. Usually there is always a pair of a PHP and an XML file. I use this to parse the content XML file for SEO. page.php is only used to load data for SEO, either by parsing the XML file, by a MySQL query or JSON etc.

Conclusion

The Fleb Framework will be available open source very soon. As with my other code, I will create a documentation for this. The FLAs are already well commented, so there will be a lot of information in the code.

Stay tuned!

Christian

—————————————————————————————————-

March 26, 2009

I’ve been using the SEO solution of SWFAddress for more then 2 years and I’m completely happy with it.

You can find the demo here. It uses Javascript and mod_rewrite to provide clean urls. In Gaia, you can SEO-scaffold your project. It will create html pages for each flash page, which in fact is very nice if you have a small website with no more than 10 to 15 pages. There is nothing to say about that. But if you have a large project, a website that dynamically generates content, it would not be wise to create thousands of physical html pages on your server. So here we need another solution. Check out this flash site, it has over 16’000 pages in the Google index…

The other drawback is that it does not generate “nice” urls. It looks something like this http://www.mydomain.com/news.html#/about-us/
when I actually want this:

http://www.mydomain.com/#/about-us/

Read more in the gaia forum

The original SWFAddress SEO solution:

…and here is what it looks like when implemented in Gaia:

Use the context menu (right-click) to navigate. Now deactivate Javascript, navigate, activate it again, navigate… and always watch the browser address bar.
Another nice thing about this implementation is that the navigation menu is dynamically created by parsing the site.xml. This is done using SimpleXML, so be sure you have PHP 5 installed!

Overview

Download all the source files here.

Before you upload the files to your server, open the file .htaccess and change this line…
RewriteBase  /wp-content/data/gaia_swfaddress_seo_demo
…to the folder where your uploaded files will be.

Please note that for this SEO solution the Gaia site attribute “landing” is required! This attribute is used to determine if a menu item is active (clickable) or not. Check seonavig.php for more info.
The content of the site is defined in datasource.php. This file is accessed by index.php and dynamicContainer.swf.

Questions? Suggestions? Let me know!

Happy coding!
Christian

.