
WiseNav Inc.
Design Note (Version1)

WiseNav HSP Install Guide
 
Author(s):	Leo Pelland	   
		   
Last Modified Date:	4/15/2008 5:06 PM	   
Version:	1	   
Filename:	wnHspInstallGuide.doc	 

To use a design note:
Use the File->Properties (Summary) option to modify the title and author. Use the 
(custom option to modify the design note number. The created date/modified date and 
filename will be updated automatically. To update all the fields use ctrl A and then 
press F9. That will bring the document up to date.Table of Contents

1.	Introduction
2.	Architecture
2.1.	How the Current Viewer (runtime) Works
2.2.	Admin Tool
3.	Directory Structure for a WiseNav site
4.	Installing WiseNav into a User.s Account
5.	An Example of a Free Trial Site
6.	Auto-update
7.	Branding (white label)
8.	WiseNav Templates
8.1.	Template Viewer Embedded in Admin Tool
8.2.	Template Manager
9.	Requirements
9.1.	Viewing and Editing a WiseNav Web Site
9.2.	Template Manager
9.3.	Server requirements for hosting a WiseNav site


1.	Introduction
This document is a guide to help hosting companies install WiseNav on their server.  
The document will first have a quick overview of the runtime and the admin tools, 
followed by a more in-depth discussion.


2.	Architecture
2.1.	How the Current Viewer (runtime) Works

The runtime.s purpose is to display the user.s content that was created with the 
WiseNav admin tool.

Figure 1 gives a quick overview of the current architecture.  Basically, when a user 
goes to a WiseNav site, the file index.html is loaded into the user.s browser.  The 
HTML page contains a FLASH object; this FLASH object represents our WiseNav engine.

Once the HTML page is loaded, the embedded flash movie starts up; this flash movie 
is the main Flash movie and it is always running.  The main Flash movie will simply 
determine what scene to load, fetch the corresponding encrypted XML document for the 
scene, and display the content for the scene.

2.2.	Admin Tool
The admin tool is used by a user to create scenes for his website.  The only 
requirement is that the user has the latest Flash plug in installed (version 8 or 
above) for his browser.  A user can also download a desktop application (available 
via the WiseNav admin tool) to help convert and upload images, audio and video 
files.  This conversion utility is a helper application that communicates directly 
with the WiseNav admin tool in the browser and it will automatically convert 
unsupported formats to a format supported by the Flash player.  The conversion 
utility will also resize and compress images to minimize upload time (and also 
download time when images are downloaded to a user.s computer when viewing the web 
site).  The conversion manager is not required but without it, the user will only be 
able to upload files supported by Flash and the image will not be automatically 
resized and compressed.


3.	Directory Structure for a WiseNav site

Is here a representation of the directory structure of a WiseNav site, where the top 
level is in the user.s web root (or any directory located below the web root):

Here is a brief description of each folder inside the webRoot folder:

content: this is where all the content is stored for each scene
php: contains all the php files 
preview: a folder holding temporary files needed when a user wants to preview his 
site or his current scene while in the admin tool
swfaddress & swfobject: extra files to help detecting if the user has the flash 
player plugging is installed in his browser and also required to navigate from scene 
to scene via the browser.s back and forward buttons.
swfRuntime: contains the flash files for the runtime
wisenavAdmin: contains all files related to the admin tool (see more details below)
wnHelp: contains the help files used by the admin tool

The webRoot folder also contains the following files:

index.html: the main HTML page that is loaded and it embeds the WiseNav admin tool
sceneMenus.xml: contains info about the scene menus for the site
webserverConfig.xml: contains configuration information for the site, such as the 
name of the starting scene, the colors of the header and footer in the runtime, etc.
*.php: when a scene is saved, a corresponding php file is created (or updated); each 
php file contains a copy of the content for the scene in HTML format so that it can 
be indexed by search engines.

Here is a description of the wisenavAdmin folder:

php: php files for the admin tool, mostly used for writing content to disk
phpUpdate: php files needed for the auto-update
resources: any extra resources needed by the software, such as images
swfAdmin: contains all the flash files for the admin tool
WVTemplates: contains pertinent files needed to create a new site or a new scene.


4.	Installing WiseNav into a User.s Account

A zip file containing all the content described in Section .3. above is created with 
each release of WiseNav.   

Simply follow the following 2 steps to manually activate a WiseNav account:
Unzip the latest zip file into a user.s web root directory.
Verify that all files and folders have read and write permissions for the user.

The above steps could be automated via a script.

Afterwards, a user will be able to see his new WiseNav site by simply entering the 
URL of his site in a browser.  To edit his site, the user once again simply needs to 
enter the URL of his site, followed by ./wisenavAdmin.; this will display the 
WiseNav Admin tool in the browser.  To prevent other users from editing the site, it 
is strongly recommended to add a protected URL to the wisenavAdmin directory.


5.	An Example of a Free Trial Site

You can go to www.visualwebsite.com to sign up for a free trial of WiseNav.   We are 
planning on extracting this login mechanism and making it available, so that a 
hosting organization can offer a free trial to users.

Basically, this setup automatically takes care of creating and managing trial 
accounts.  The only requirement is to simply update the install directory when a new 
version of WiseNav is available.  The content of the install directory is simply 
copied into new trial accounts.   

* note that a database is also required to keep track of the accounts

6.	Auto-update

To keep all users updated with new releases, WiseNav has an auto-update feature.  
Each time a user starts the WiseNav admin tool, WiseNav checks if a new release is 
available.  If a new version is available, a dialog is displayed to the user giving 
him the choice to update.  If the user selects to update, the new files are 
automatically downloaded and installed in the user.s account.  A progress bar is 
displayed with pertinent information during the auto-update.

By default, the files for the auto-update are downloaded from the server located at 
www.wisenav.co.uk.  To improve performance, the files for the auto-update can also 
be copied on the hosting organization.s server and then, for an auto-update, WiseNav 
will copy the files directly from disk to the user.s account instead of retrieving 
each file from the UK server via HTTP.  Enabling this functionality is as simple as 
adding a special file in a user.s account containing pertinent information for the 
auto-update.  The only requirement for the hosting organization is to download the 
auto-update package to his server so that it.s available to all users.  

* Note that the auto-update can create new directories and new files into the user.s 
account, making it very important that all directories are readable and writable by 
WiseNav.

7.	Branding (white label)

By default, the admin tool is branded for WiseNav.  It is possible to brand some of 
the text in the WiseNav interface via a lookup table.   Branding is as simple as 
dropping the new lookup table into the user.s account.   The current lookup table 
values are limited to some key areas for branding, but a future goal is to have all 
text included in the lookup table, giving WiseNav the ability to support multiple 
languages via a lookup tables.


8.	WiseNav Templates
8.1.	Template Viewer Embedded in Admin Tool

To help users create their website, the admin tool has an embedded feature that lets 
a user view available WiseNav templates.  The user can select a template and WiseNav 
will automatically download and install the new template into the user.s account.

By default, the templates are being downloaded via the server located at 
www.wisenav.co.uk.

8.2.	Template Manager
A template manager tool exists (also running via a browser) to help a hosting 
organization create and maintain templates.  The template manager makes use of a 
MySQL database to keep track of all pertinent information related to each template.   


9.	Requirements

9.1.	Viewing and Editing a WiseNav Web Site

To be able to view a site created with WiseNav, a user simply needs to have the 
Flash player (version 8 or above) installed for his browser.  The same applies for 
editing a site.

9.2.	Template Manager
The Flash player version 9 (or above) is required to run the Template manager.

9.3.	Server requirements for hosting a WiseNav site
The only requirement for hosting WiseNav is a web server that supports PHP.  Note 
that most processing takes place in the user.s browser hence there is not any added 
processing time on the server.  The php scripts mostly simply write files to disk 
(such as when a user saves his scene). 

If a hosting organization want to maintain its own templates via the WiseNav 
Template Manager, then one MySQL database is also required.



