Documentation




Documentation - Unicus Template v1.0






Requirements|
Getting Started|
Creating a site|
Share Service|
Changing Fonts


::Requirements::


Basic XML knowledge
Text editor(e.g. Dreamweaver, Notepad, Textedit)
Server with PHP support
Flash CS3 or higher (optional)


Here are some linkages to understand XML:
Tutorial
Video-Tutorial


Here are some free image scaler:
PC
MAC


Top

::Getting Started::

Go to src folder to see all source files and code.
Go to bin-debug folder to see the final website and stay there for
customizing the template by your wishes.
First we will do the basic configuration. Open in xml folder the settings.xml. Each node and attribute is well explained.
Set the required colors and information in each node and attribute.
Now copy your logo in images/main folder. Name it logo and use only a png.
Last but not least set your email address, which
receives all mails from the contact form. Go to php folder and open
sendForm.php . Go to line 17 and set your email address between the
quotes.

Top

::Creating a site::
Basic information
Apps:
You are not working with modules, you are working with
apps. You can create own sites with the available apps. To view all
apps, open AllApps.xml in the xml folder.

Textfields:
Some textfields allows using HTML.The nodes which hold
the HTML text, using CDATA tags. DO NOT delete these tags. Here is a
list of all valid HTML tags in flash.
YouTube Videos:
To locate the youtube video, you need the ID of it. You find it in the
url of the video at youtube.com. This ID has 11 characters. You can also
set the quality of the video. All available
qualities(medium/large/hd720/hd1080) can be found in the player of your
video at youtube.com. Here is an image, which shows the required information.
Vimeo Videos:
To use vimeo videos in this template, you have to create an application on vimeo.
Then you get a key, enter this key in the vimeo node of the
settings.xml. To locate a vimeo video, you need the ID of it. You find
the ID in the URL of the vimeo video. This ID consists of 8 digits (only
numbers).


First create a new XML file, be sure to set the encoding to UTF-8. Save the XML file in xml/sites folder.
Now open AllApps.xml and copy an app node, you would like to use in this site.
Paste the app node in your XML file.
Now set the required values and information in the attributes and nodes of the app.
Open settings.xml and go to the sites node. Now
create a new site node and paste it in the sites node or edit an
existing site node.
Set the path of the XML file, you just created, in the xml attribute of the site node.
You can set an own media(image, swf, video, youtube
video) as background for each site too. You can also leave this blank
(""), if you need no background, e.g. when setting the dimension of the
gallery app as the dimension for your main window.
Just repeat this process for all sites, you would like to create.
If you have problems by creating/changing sites, just have a look at the example files in the download package.


App overview

HTML Textfield

You can format the text with HTML tags. Here is a list of all valid HTML tags in flash.



News Reader

You can write own posts in the xml node or use external feeds. Use only RSS 2.0 or ATOM feeds.
Valid formats:
RSS 2.0 Format
ATOM Format



Single Media Viewer

Shows a single media - image, swf, video, vimeo video or youtube video.
Just set the path of the media or the id of the youtube
in the source attribute. The app detects automatically which type of
media it is.



Gallery

You can add unlimited of medias to your gallery. The
gallery supports image, flash movies, videos, vimeo videos and youtube
videos. You can also set a scale mode for each single media (not
required for vimeo/youtube video).



Media Slider

You can add unlimited of media boxes to your media
slider. A media box holds an image, a HTML text and optional a link
button. Use the media slider e.g. for your portfolio or team. The link
button can refer to a website as well as a email address.



Contact Form

You can set own default texts for each input fields. Set
your email address, which receives all mails of the contact form in
sendForm.php.


Google Maps

First you have to sign up for google maps to get a key. Otherwise it does not work! You need also the longitude and latitude of the point, you would like to show in the app. Here is latitude/longitude calculater.




Top

::Share Service::

The template has a share widget, this runs with www.addthis.com. You can register as a member to view analytics about the click behavior on your site.
Just set your user name in the sharings node of the settings.xml.


Top

::Changing fonts::

If you would like to change the font of the text in the
modules. Go to src/fonts, there you find 2 fla´s - MenuFont.fla and
TextFont.fla.
The MenuFont.fla holds the font for the menu and for
some titles. The TextFont.fla holds the font for all textfields. You
must use the same font for the HTML textfields, which you have embed in
TextFont.swf. Otherwise you will not see the text.
To change one of these fonts, open the fla in Flash Professionel.

Create a new font symbol for adding a new font or change an existing font symbol with a double click on the font symbol.
Choice a name for the font and click "Export for Actionscript", "Export in frame 1" need to be selected also. Click "OK"!
Open the action panel and register the font with Font.registerFont(FONTNAME);.
The font name is the same name you set for the font in the library. Set
also the name of the font you would like to use for all non-html
textfields in the fontName property. Publish the flash movie. That´s it!

NOTE: Be sure to set the same font name in all font face
attributes in each xml file, which you embed in your TextFont.swf.

Tutorial about fonts embedding


Top





Rafael Dery | [e-mail] | www.radykal.de