FROGANS A. Tamas
FSDL 2.1 STG Interactive
May 2004
Frogans Slide Description Language - 2.1
Status
Destined to the developer community, this document specifies version
2.1 of the FSDL and replaces and renders obsolete any previous
specifications concerning the FSDL. Distribution of this document is
unlimited under the terms of the copyright statement.
Comments on this document are welcome and may be made by e-mail at
the address: fsdl@frogans.com.
Abstract
This document serves as a reference guide for the markup language
called the Frogans Slide Description Language (FSDL) which is used
for developing frogans.
The frogans are a means for end-users to consult content on the
Internet or on private IP networks. Frogans are independent from, but
compatible with, other existing applications such as WWW, Newsgroup,
E-mail, and IRC.
Copyright Notice
Copyright (C) STG Interactive (2000-2004). All Rights Reserved.
Document URL: http://www.frogans.com/en/doc/FSDL21.txt
See 21.1. Full Copyright Statement of the FSDL Specifications.
Terms of Use for Developers and Software Publishers
The free use of the FSDL as a markup language for developers of
frogans and publishers of authoring tools and server applications is
subject to their respective terms of use.
See 21.2. Use of the FSDL by Developers of Frogans.
See 21.3. Use of the FSDL by Publishers of Authoring Tools.
See 21.4. Use of the FSDL by Publishers of Server Applications.
STG Interactive Frogans Page [1]
FSDL 2.1 Frogans Slide Description Language May 2004
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3
2. Terms . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
3. FSDL Documents . . . . . . . . . . . . . . . . . . . . . . . 6
3.1. Frogans Root Directory . . . . . . . . . . . . . . . . . . 6
3.2. Document Structure . . . . . . . . . . . . . . . . . . . . 7
3.3. Document Character Set and Encoding . . . . . . . . . . . . 8
3.4. Character and Entity References . . . . . . . . . . . . . . 8
3.5. File Sizes . . . . . . . . . . . . . . . . . . . . . . . . 9
3.6. Loading Times . . . . . . . . . . . . . . . . . . . . . . . 9
3.7. Cache . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
4. Starting and Ending the Slide - FROGANS element . . . . . . . 11
5. Setting Image Resources - SETIMAGE element . . . . . . . . . 13
6. Setting Pixels Resources - SETPIXELS and PIX elements . . . . 18
7. Setting Draw Resources - SETDRAW element . . . . . . . . . . 21
8. Managing Text Resources . . . . . . . . . . . . . . . . . . . 24
8.1. Defining Fonts - FONT element . . . . . . . . . . . . . . . 24
8.2. Setting Text Resources - SETTEXT and TEXT elements . . . . 27
9. Setting Duplicated Resources - SETCOPY element . . . . . . . 33
10. Pre-processing of Resources - PROCESS and FILTER elements . . 34
11. Defining the Shape of the Slide - SHAPE element . . . . . . . 38
12. Defining the Content of the Slide - CONTENT element . . . . . 43
13. Enhancing the Content of the Slide . . . . . . . . . . . . . 48
13.1. Applying Masks - MASK element . . . . . . . . . . . . . . . 48
13.2. Sketching Reliefs - RELIEF element . . . . . . . . . . . . 52
13.3. Adding Shadows - SHADOW element . . . . . . . . . . . . . . 54
14. Linking and Navigation - BUTTON element . . . . . . . . . . . 56
15. Auto-Refresh and Slide Show - NEXT element . . . . . . . . . 62
16. Redirecting to Another Slide - REDIRECT element . . . . . . . 64
17. Creating and Maintaining Sessions - SESSION element . . . . . 66
18. Planning for Statistics - STATS element . . . . . . . . . . . 68
19. Going On-line . . . . . . . . . . . . . . . . . . . . . . . . 70
19.1. Requesting Identifiers from End-users . . . . . . . . . . . 70
19.2. Choosing a Network Protocol . . . . . . . . . . . . . . . . 72
19.3. Hosting a Frogans on a HTTP Server . . . . . . . . . . . . 73
20. Creating Short-cuts and Links to a Frogans . . . . . . . . . 79
20.1. Making a Frogans Short-cut File . . . . . . . . . . . . . . 79
20.2. Hosting Frogans Short-cuts on a HTTP Server . . . . . . . . 80
20.3. Editing a leaptofrogans.net Hyperlink . . . . . . . . . . . 81
21. Working with the FSDL . . . . . . . . . . . . . . . . . . . . 82
21.1. Full Copyright Statement of the FSDL Specifications . . . . 83
21.2. Use of the FSDL by Developers of Frogans . . . . . . . . . 84
21.3. Use of the FSDL by Publishers of Authoring Tools . . . . . 84
21.4. Use of the FSDL by Publishers of Server Applications . . . 84
STG Interactive Frogans Page [2]
FSDL 2.1 Frogans Slide Description Language May 2004
1. Introduction
The Frogans Slide Description Language (FSDL) is a complete markup
language exclusively dedicated to the development of frogans which
are published on scalable, virtual networks established on the
Internet or on private IP networks, called frogans networks.
Frogans is a hyperlink-based, distributed information system which
was created by STG Interactive to provide the Internet community with
a very simple means of publishing and consulting content, on multiple
devices.
Frogans are known for their unique and creative format which is easy
to use, light and does not compete with open applications on the
end-user's screen. Each frogans can contain an unlimited number of
pages (slides) which are developed using the FSDL.
As for all information systems, Frogans has its own dedicated system
for addressing content. Each frogans is identified by a unique
frogans address, whose structure creates an even greater affinity
between the editor's content and the end-user.
A frogans address starts with the name of the frogans network on
which the frogans is published. For example, frogans addresses
starting 'frogans*' are associated with the main frogans network,
that is operated by STG Interactive.
The FSDL eliminates barriers for developers in working with enhanced
graphics and hyperlinks, by providing a clear and comprehensible
structure for the code which is closely related to the slide's
layout.
FSDL documents can be quickly and easily hand-coded. They can also be
produced dynamically on a server to automatically update or
personalize the frogans for the end-user.
As it supports all reading directions for written languages and is
ISO 10646/Unicode compliant, the FSDL actively helps to promote the
compatible exchange of information over the Internet.
This document specifies version 2.1 of the FSDL. Future versions
presenting additional features of this markup language will be
released with higher version numbers, following input from the
frogans developer community.
STG Interactive Frogans Page [3]
FSDL 2.1 Frogans Slide Description Language May 2004
2. Terms
dedicated frogans network
A public frogans network or a private frogans network that is
not the main frogans network.
end-user
A person using the Frogans Player software to consult frogans.
end-user's system
A computer or device connected to the Internet, or to a private
IP network, that can display frogans.
frogans
Sets of uniquely shaped slides which can be visualized by the
end-user using the Frogans Player. A frogans is published by a
frogans editor, on a frogans network, through a frogans address.
frogans address
An address which serves to reference a frogans. The format of a
frogans address is 'network*gatename' or
'network*gatename.extension', where 'network' is the name of
the frogans network on which the frogans is published. On the
main frogans network, where addresses start with 'frogans*',
the 'gatename' and 'extension' are chosen by the frogans editor.
frogans editor
A content editor who publishes a frogans on a frogans network.
frogans favorites
An end-user's selection of frogans addresses. Each frogans
favorite has its session information saved on the end-user's
system until the end-user reopens the frogans.
frogans network
A scalable virtual network established on the Internet or on a
private IP network to publish frogans.
Frogans Network System Language, FNSL
A complete markup language dedicated to the operation of frogans
networks.
Frogans Player
A free downloadable software, published by STG Interactive, that
lets end-users browse and navigate frogans.
frogans root directory
A server directory which contains a frogans (FSDL documents and
resources). Its location on the Internet or on a private IP
network is transmitted through the frogans address.
STG Interactive Frogans Page [4]
FSDL 2.1 Frogans Slide Description Language May 2004
frogans short-cut
A file containing a frogans address which is destined to
facilitate the opening of a frogans by the end-user as well as
the transmission of frogans addresses from end-user to end-user.
frogans slide, slide
A frogans slide is comparable to a page on the World Wide Web.
A frogans slide is a set of files containing a FSDL document and
its related resources. An unlimited number of slides can be
grouped together to make up a frogans.
Frogans Slide Publisher
A free downloadable software, published by STG Interactive, that
helps developers create frogans slides.
FSDL document
A file containing a sequence of characters which are organized
according to the FSDL specifications.
home slide
A frogans slide which is displayed every time the end-user opens
the frogans.
login and password
A login and password given by the frogans editor to the end-user
to gain access to the frogans. Login and passwords can be used
to personalize the content or services in the frogans and are an
alternative to PIDs.
main frogans network
A public frogans network, operated by STG Interactive, where
frogans addresses start with 'frogans*'. On the main frogans
network, frogans can be published by any frogans editor,
individual or organization, from anywhere in the world, in any
language.
PID, personal identifier
A personal identifier given by the frogans editor to the end-
user to gain access to the frogans. PIDs can be used to
personalize the content or services in the frogans and are an
alternative to login and passwords.
private frogans network
A frogans network established on a private IP network.
public frogans network
A frogans network established on the Internet.
STG Interactive Frogans Page [5]
FSDL 2.1 Frogans Slide Description Language May 2004
3. FSDL Documents
3.1. Frogans Root Directory
All files of a frogans must be regrouped into a single directory
called the frogans root directory.
The frogans root directory contains FSDL documents and associated
resources; it can be organized with sub-directories.
For example:
--Frogans root directory
|
|--SubDir1
| |
| | Slide2.fsdl
| | Pix2.gif
|
| Slide1.fsdl
| Pix1a.png
| Pix1b.jpg
In a FSDL document, file names of resources and other associated FSDL
documents must include the complete file path from the frogans root
directory. The name of the frogans root directory is not included in
the file path. File names always start with a slash (/).
For example: the files in the preceding example are named
'/Slide1.fsdl', '/Pix1a.png', '/Pix1b.jpg', '/SubDir1/Slide2.fsdl'
and '/SubDir1/Pix2.gif'.
File names, including their path, are case sensitive strings of
alphanumeric characters: A-Z, a-z, 0-9, underscore, dash, dot and
slash (/). File names cannot end with a slash or a dot. File names
cannot contain the sequences '..', './', '/.' and '//'. Spaces and
backslashes (\) are not accepted. File names must contain between 2
and 128 characters.
The file name of a FSDL document should have the extension '.fsdl' or
'.fsd', but is not mandatory. For example, if the FSDL document is
delivered dynamically by the server hosting the frogans, file name
extensions such as '.php', '.asp' or '.jsp' may also be used.
For more information about hosting the frogans on a server, see 19.
Going On-line.
STG Interactive Frogans Page [6]
FSDL 2.1 Frogans Slide Description Language May 2004
3.2. Document Structure
The FSDL document conforms to XML 1.0 specifications to assure
maximum interoperability with servers and end-user systems.
The FSDL document must start with one of the following XML
declarations:
As the FSDL document encoding is transmitted through the frogans
address, the encoding attribute in the XML declaration is not used by
the Frogans Player. See 3.3. Document Character Set And Encoding.
The XML declaration is then followed by one of these document type
declarations:
To maintain FSDL document clarity and readability, the document type
declaration must not contain an internal subset.
The root element of the FSDL document is FROGANS. See 4. FROGANS
element.
All element names and their attributes are always written in
uppercase in the FSDL document. Attribute values are delimited by
single or double quotation marks.
All elements contained in the FSDL document must have an end tag. For
example:
Block Of Text
Empty elements must either have an end tag or the start tag must end
with />. For example:
can also be written
The FSDL document may contain comments using the common syntax
.
An error left in the FSDL document will lead to a parsing error
message.
STG Interactive Frogans Page [7]
FSDL 2.1 Frogans Slide Description Language May 2004
3.3. Document Character Set and Encoding
The encoding is not specified in the XML declaration as it is
transmitted through the frogans address.
When publishing a frogans on the main frogans network, the FSDL
document encoding is specified in 'my account' on frogans.com
(frogans address parameters).
At the time of publication (May 2004), the character set of the FSDL
document is ISO 10646/Unicode and the format used to encode the FSDL
document must be either UTF-8 (RFC 2279) or UTF-16 (RFC 2781). For
more information, see FNSL specifications version 3.0 (10. Making a
Lookup Record).
In the future, other character sets and formats used to encode the
FSDL document may be recognized by the Frogans Player.
An optional BOM (Byte Order Mark) can be placed at the start of the
FSDL document.
When using UTF-16 encoding, the BOM is used to determine if the FSDL
document is serialized in big-endian or little-endian order; if there
is no BOM at the start of the FSDL document, big-endian order is
assumed.
3.4. Character and Entity References
The FSDL document may contain numeric character references and entity
references.
Numeric character references can be used with the syntax: D; or
H; where D is the decimal value, and H the non-case sensitive,
hexadecimal value of the character in ISO 10646/Unicode.
Examples:
N (letter N)
N (letter N)
N (letter N)
Recognized entity references are:
< less than sign (<) (<)
> greater than sign (>) (>)
" double quote sign (") (")
& ampersand (&) (&)
' apostrophe (') (')
© copyright sign (©)
® registered trademark (®)
# number sign (#) (#)
$ dollar sign ($) ($)
STG Interactive Frogans Page [8]
FSDL 2.1 Frogans Slide Description Language May 2004
€ euro sign (€)
non-breaking space ( )
Entity references are case sensitive.
An ampersand (&) or a less than sign (<) must always be replaced by
their numeric character references or their entity references in the
value of an attribute and in the text characters placed between the
start and end tags of an element.
3.5. File Sizes
The total file size, including the FSDL document and the resources
used to display the slide, is categorized as follows:
- Very light: up to 4,096 bytes
- Light: 4,097 to 8,192 bytes
- Normal: 8,193 to 16,384 bytes
- Heavy: 16,385 to 32,768 bytes
- Very Heavy: 32,769 to 65,536 bytes
The total file size should not exceed 32,768 bytes in order to
minimize the loading time of the slide on the end-user's system.
The total file size must not exceed 65,536 bytes.
The maximum file size of an image downloaded to a separate viewer is
1,048,576 bytes (1 MB). See 14. BUTTON element (GOTO attribute).
The maximum file size of a file downloaded to the end-user's system
is 8,388,608 bytes (8 MB). See 14. BUTTON element (GOTO attribute).
3.6. Loading Times
The loading time of the FSDL document must not exceed 60 seconds,
otherwise a time out will occur on the end-user's system.
The loading time of the resources used to display the slide must not
exceed 90 seconds, otherwise the slide will be displayed with missing
resources.
The loading time of an image downloaded to a separate viewer must not
exceed 7,200 seconds, otherwise a time out will occur on the end-
user's system. See 14. BUTTON element (GOTO attribute).
The loading time of a file downloaded to the end-user's system must
not exceed 7,200 seconds, otherwise a time out will occur on the end-
user's system. See 14. BUTTON element (GOTO attribute).
STG Interactive Frogans Page [9]
FSDL 2.1 Frogans Slide Description Language May 2004
3.7. Cache
FSDL documents are never cached on the end-user's system.
In order to reuse an image file in different slides of the frogans
without repeated loading of the same file by the Frogans Player,
see 5. SETIMAGE element (CACHE attribute).
Images downloaded to a separate viewer are not cached on the end-
user's system. See 14. BUTTON element (GOTO attribute).
Files downloaded are not cached on the end-user's system. See 14.
BUTTON element (GOTO attribute).
STG Interactive Frogans Page [10]
FSDL 2.1 Frogans Slide Description Language May 2004
4. Starting and Ending the Slide - FROGANS element
The FROGANS element defines the beginning and the end of the FSDL
document. It is a root element as it contains all other elements
necessary to define the frogans slide:
- Resource management elements are SETIMAGE, SETPIXELS, SETDRAW,
FONT, SETTEXT, SETCOPY and PROCESS,
- Layout elements are SHAPE and CONTENT,
- Linking and navigation elements are BUTTON, NEXT, REDIRECT, SESSION
and STATS.
The attributes associated with the FROGANS element are:
VERSION - Required
The version of the specifications to which the FSDL document
conforms. Is not case sensitive.
The value of this attribute must be identical to the FSDL
version which is transmitted through the frogans address.
When the frogans is published on the main frogans network, the
FSDL version is specified in 'my account' on frogans.com
(frogans address parameters).
* "FSDL2.1" : FSDL specifications version 2.1
COLOR - Optional
The background color of the slide. Is a non-case sensitive,
six-digit hexadecimal number prefixed by a hash mark (each color
component is represented by two digits, in the order of red,
green, blue).
The default value is "#FFFFFF" (white).
Examples of accepted values:
COLOR="#FFFFFF" (white)
COLOR="#ffffff" (white)
COLOR="#000000" (black)
COLOR="#808080" (gray)
COLOR="#FF0000" (red)
COLOR="#008000" (green)
COLOR="#0000FF" (blue)
COLOR="#FFFF00" (yellow)
STG Interactive Frogans Page [11]
FSDL 2.1 Frogans Slide Description Language May 2004
Examples of refused values:
COLOR=""
COLOR="# FF0000"
COLOR="FF0000"
COLOR="#FF000"
COLOR="#F00"
COLOR="red"
EDGECOLOR - Optional
The color of the inner edge of the slide. Is a non-case
sensitive six-digit hexadecimal number prefixed by a hash mark
(each color component is represented by two digits, in the order
of red, green, blue).
The inner edge is used to make the frogans slide stand out on
the screen of the end-user's system and therefore, can not be
removed or enlarged. Its thickness is constant in all sizes of
the slide on the screen.
The default value is "#000000" (black).
Examples of accepted values:
EGDECOLOR="#000000" (black)
EDGECOLOR="#FFFFFF" (white)
EDGECOLOR="#ffffff" (white)
EGDECOLOR="#C0C0C0" (silver)
EGDECOLOR="#800000" (maroon)
EGDECOLOR="#800080" (purple)
EGDECOLOR="#FF00FF" (fuchsia)
EGDECOLOR="#00FF00" (lime)
EGDECOLOR="#808000" (olive)
EGDECOLOR="#008080" (teal)
EGDECOLOR="#00FFFF" (aqua)
Examples of refused values:
EGDECOLOR=""
EGDECOLOR="# FF0000"
EGDECOLOR="FF0000"
EGDECOLOR="#FF000"
EGDECOLOR="#F00"
EGDECOLOR="red"
STG Interactive Frogans Page [12]
FSDL 2.1 Frogans Slide Description Language May 2004
5. Setting Image Resources - SETIMAGE element
The SETIMAGE element designs an image resource which can be used to
contribute to the shape of the slide (see 11. SHAPE element), to fill
an area within the slide (see 12. CONTENT element), or to apply a
mask to a content (see 13.1. MASK element).
The SETIMAGE element is placed between the start and end tags of the
FROGANS element. The SETIMAGE element does not contain any other
elements.
A single image resource can be reused many times within the same
slide.
The format used to encode the image file must be either JPEG, PNG or
GIF (if GIF file is animated, only the first frame is displayed).
The image file may contain transparency information (such as certain
PNG or GIF image files) to define transparent areas in the resource.
The image file is limited to 1024 pixels width by 1024 pixels height
in order to minimize the loading and processing time of image
resources on the end-user's system.
The total file size of the slide, including its image files, is
limited to 65,536 bytes. See 3.5. File Sizes.
To display an image in a larger size on the end-user's system, a
separate viewer can be used. See 14. BUTTON element (GOTO attribute).
If different image resources have identical FILE and DATA attributes
in the FSDL document, the specified image file is loaded only once by
the Frogans Player.
The image file is loaded by the Frogans Player even if there is no
SHAPE, CONTENT or MASK element in the FSDL document which refers to
the image resource.
The attributes associated with the SETIMAGE element are:
RESID - Required
The unique identifier of the image resource for the slide. Is a
non-case sensitive string of alphanumeric characters: A-Z, a-z,
0-9, underscore, without spaces. The string must contain between
1 and 16 characters.
Examples of accepted values:
RESID="foo1"
RESID="Foo1"
RESID="foo2"
STG Interactive Frogans Page [13]
FSDL 2.1 Frogans Slide Description Language May 2004
RESID="foo_1"
Examples of refused values:
RESID=""
RESID="foo-1"
RESID="foo/1"
RESID="foo.1"
RESID="foo 1"
RESID="foo1, foo2"
ASPECT - Required
The way the image resource occupies the areas of its associated
SHAPE, CONTENT or MASK elements (defined by their SIZE or RSIZE
attributes). Is not case sensitive.
* "BASE" specifies that the whole image resource is
displayed in its original proportions to occupy the
largest part of the area. Can be combined with ADJUST
attribute to pan the image resource
* "SPREAD" specifies that the image resource is spread out
to completely occupy the area. Does not preserve the
original proportions of the image resource
* "ECHO" specifies that the whole image resource is
displayed in its original proportions to occupy the
largest part of the area, and is then duplicated to occupy
the remaining parts. Can be combined with ADJUST attribute
to pan the image resource
* "ZOOM" specifies that a part of the image resource is
displayed in its original proportions to completely occupy
the area. Can be combined with ADJUST attribute to pan the
image resource
ADJUST - Optional
Applicable only if ASPECT="BASE", "ECHO" and "ZOOM"
Adjusts the position of the image resource, through a left to
right or top to bottom pan effect, on the areas of its
associated SHAPE, CONTENT or MASK elements. Is a whole decimal
number between -100 and 100. Spaces are accepted between the
sign and the first digit.
The default value is "0" (centered).
Examples of accepted values:
ADJUST="0" (centered)
ADJUST="-100" (far left or top position)
ADJUST="100" (far right or bottom position)
STG Interactive Frogans Page [14]
FSDL 2.1 Frogans Slide Description Language May 2004
ADJUST="33" (one third of the position to the right or
bottom of center)
ADJUST="- 100"
ADJUST="+100"
Examples of refused values:
ADJUST=""
ADJUST="33.3"
ADJUST="200"
FILE - Required
The file name of the image in the frogans root directory. Is a
case sensitive string of alphanumeric characters: A-Z, a-z, 0-9,
underscore, dash, dot and slash (/). The string cannot end with
a slash or a dot. The string cannot contain the sequences '..',
'./', '/.' and '//'. Spaces and backslashes (\) are not
accepted. The string must contain between 2 and 128 characters.
The file name always starts with a slash (/).
If the image is located in a sub-directory, the file name must
include the complete file path from the frogans root directory.
See 3.1. Frogans Root Directory.
An image file extension is not relevant and therefore, is not
required.
Examples of accepted values:
FILE="/pic1.jpg"
FILE="/pic-1.jpg"
FILE="/pic_1.jpg"
FILE="/subdir/pic1.jpg"
FILE="/pic1.png"
FILE="/pic1.gif"
FILE="/pic1.php"
FILE="/pic1.asp"
FILE="/pic1.jsp"
FILE="/pic1.cgi"
FILE="/pic1"
Examples of refused values:
FILE=""
FILE="/"
FILE="pic1.jpg"
FILE="/.jpg"
FILE="/pic1."
FILE="\pic1.jpg"
FILE="./pic1.jpg"
FILE="../pic1.jpg"
FILE="subdir/pic1.jpg"
STG Interactive Frogans Page [15]
FSDL 2.1 Frogans Slide Description Language May 2004
FILE="/subdir/"
FILE="/subdir//pic1.jpg"
FILE="/subdir\pic1.jpg"
FILE="/pic1.php?option=2"
FILE="/pic1.php?option=2&language=Swedish"
FILE="frogans*GateName/pic1.jpg"
FILE="http://SpecificDomainName.com/pic1.jpg"
DATA - Optional
Additional data that can be sent to the server hosting the
frogans, at the time of the request for the image file by the
Frogans Player.
Is a case sensitive, comma separated list of items in the
'name=value' format. A maximum of 32 items is accepted in the
list. Spaces can be placed before or after commas and equal
signs.
'name' is a case sensitive string of alphanumeric characters:
A-Z, a-z, 0-9, underscore, without spaces. The string must
contain between 1 and 16 characters. Each string of characters
must be different from the others and cannot contain the
non-case sensitive string of characters 'FROGANS'. The following
non-case sensitive strings of characters are reserved and cannot
be used: 'ADDRESS', 'PID', 'LOGIN', 'PASSWORD', 'SESSION',
'CERTIFICATE', 'KEY'.
'value' is a case sensitive string of alphanumeric characters:
A-Z, a-z, 0-9, underscore, dash and percent sign, without
spaces. The string must contain between 1 and 128 characters.
For more information about the way data is sent by the Frogans
Player to the server hosting the frogans, see 19. Going On-line.
The default value is "" (no data).
Examples of accepted values:
DATA="" (no data)
DATA="option=2"
DATA="option=2,language=Swedish"
DATA="option = 2 , language=Swedish"
DATA="option=2,language=Swedish,First_Name=Laura"
DATA=
"referer=http%3A%2F%2Fwww%2ESpecificDomainName%2Ecom%2F"
Examples of refused values:
DATA="?option=2"
DATA="option=2&language=Swedish"
DATA="pic1.php?option=2"
DATA="slide2.php?option=2"
STG Interactive Frogans Page [16]
FSDL 2.1 Frogans Slide Description Language May 2004
DATA="session=abc123"
DATA="referer=http://www.SpecificDomainName.com/"
CACHE - Optional
Indicates if the image file must be temporarily saved in a cache
on the end-user's system once loaded. Is not case sensitive.
Cache is used to avoid the repeated loading of the same image
file for display in other slides of the same frogans.
If data is specified in the DATA attribute, the image file is
loaded by the Frogans Player and is not saved in the cache, no
matter what the value specified in the CACHE attribute is.
Each frogans open on the screen of the end-user's system has its
own cache, which contains up to 512 image files, representing up
to 1,048,576 bytes (1 MB). If the cache is full and a new image
file is added, the oldest image files in the cache are removed.
Image files are automatically removed from the cache when the
end-user closes the frogans or after 24 hours.
When the Frogans Player receives a request from the end-user to
reload the slide, the image file will also reload even if the
value of the CACHE attribute is set to "ON".
An image file is included in the total file size of the slide,
even if it has already been saved in the cache. See 3.5. File
Sizes.
The default value is "ON".
* "ON" specifies image file is saved in the cache once
loaded. The image file will not reload if it is already
saved in the cache.
* "OFF" specifies image file is not saved in the cache once
loaded. If the image file is already in the cache, it will
be removed before loading.
STG Interactive Frogans Page [17]
FSDL 2.1 Frogans Slide Description Language May 2004
6. Setting Pixels Resources - SETPIXELS and PIX elements
The SETPIXELS element designs a resource made up of pixels which can
be used to contribute to the shape of the slide (see 11. SHAPE
element), to fill an area within the slide (see 12. CONTENT element),
or to apply a mask to a content (see 13.1. MASK element).
The SETPIXELS element is placed between the start and end tags of the
FROGANS element. The SETPIXELS element only contains PIX elements.
A single pixels resource can be reused many times within the same
slide.
The size of a pixels resource is 1 to 16 pixels in width and 1 to 16
pixels in height. A pixels resource can be used to handle color
gradients, masks and other effects, without loading an image file
(see 5. SETIMAGE element).
The pixels are regrouped line by line, between the start and end tags
of PIX elements. The number of PIX elements represents the height of
the pixel resource.
All PIX elements are placed between the start and end tags of the
SETPIXELS element. The PIX element does not contain any other
elements, just characters.
Each line in a PIX element is a comma separated list of pixels
organized from left to right. Each pixel is specified by a
non-case sensitive, hexadecimal number prefixed by a hash mark.
Spaces can be placed before or after commas.
Each PIX element contains the number of pixels specified in the WIDTH
attribute of the SETPIXELS element.
The format for the hexadecimal number depends on the type of pixels
resource specified in the BITMAP attribute of the SETPIXELS element.
For example:
#FF000080,#00FF00FF,#0000FFFF
#00FF00FF,#0000FF80,#FF000000
The SETPIXELS element can contain between 1 and 16 PIX elements. The
PIX element can contain between 1 and 16 pixels.
There are no attributes associated with the PIX element.
STG Interactive Frogans Page [18]
FSDL 2.1 Frogans Slide Description Language May 2004
The attributes associated with the SETPIXELS element are:
RESID - Required
The unique identifier of the pixels resource for the slide. Is a
non-case sensitive string of alphanumeric characters: A-Z, a-z,
0-9, underscore, without spaces. The string must contain between
1 and 16 characters.
Examples: see 5. SETIMAGE element
WIDTH - Required
The width of the pixels resource in number of pixels. Is a whole
decimal number between 1 and 16. Signs are not accepted.
Examples of accepted values:
WIDTH="1" (minimum width)
WIDTH="16" (maximum width)
WIDTH="8" (average width)
Examples of refused values:
WIDTH=""
WIDTH="+1"
WIDTH="8.5"
WIDTH="20"
BITMAP - Required
Denotes the type of pixels resource to be used. Is not case
sensitive.
When using "RGBA", "A" or "YA", an alpha channel is available to
create transparent pixels. A pixel is opaque if its alpha
component is "FF"; it is fully transparent if its alpha
component is "00".
* "RGB" specifies a color bitmap. Each pixel is represented
by #RRGGBB where RR, GG and BB are the two-digit
hexadecimal numbers for the red, green and blue components
* "RGBA" specifies a color bitmap with an alpha channel.
Each pixel is represented by #RRGGBBAA where RR, GG, BB
and AA are the two-digit hexadecimal numbers for the red,
green, blue and alpha components
* "A" specifies a single color bitmap with an alpha channel.
Each pixel is represented by #AA where AA is the two-digit
hexadecimal number for the alpha component. The color of
the pixels is specified in the COLOR attribute
STG Interactive Frogans Page [19]
FSDL 2.1 Frogans Slide Description Language May 2004
* "Y" specifies a grayscale bitmap. Each pixel is
represented by #YY where YY is the two-digit hexadecimal
number for the gray component
* "YA" specifies a grayscale bitmap with an alpha channel.
Each pixel is represented by #YYAA where YY and AA are the
two-digit hexadecimal numbers for the gray and alpha
components
COLOR - Optional
Applicable only if BITMAP="A"
The uniform color of the pixels resource. Is a non-case
sensitive, six-digit hexadecimal number prefixed by a hash mark
(each color component is represented by two digits, in the order
of red, green, blue).
The default value is "#0000FF" (blue).
Examples: see 4. FROGANS element
STG Interactive Frogans Page [20]
FSDL 2.1 Frogans Slide Description Language May 2004
7. Setting Draw Resources - SETDRAW element
The SETDRAW element designs a graphic resource which can be used to
contribute to the shape of the slide (see 11. SHAPE element), to fill
an area within the slide (see 12. CONTENT element), or to apply a
mask to a content (see 13.1. MASK element).
The SETDRAW element is placed between the start and end tags of the
FROGANS element. The SETDRAW element does not contain any other
elements.
A single graphic resource can be reused many times within the same
slide.
The attributes associated with the SETDRAW element are:
RESID - Required
The unique identifier of the graphic resource for the slide. Is
a non-case sensitive string of alphanumeric characters: A-Z,
a-z, 0-9, underscore, without spaces. The string must contain
between 1 and 16 characters.
Examples: see 5. SETIMAGE element
FORM - Required
Denotes the form of the graphic resource. Is not case sensitive.
* "RECT-P" specifies a rectangular perimeter
* "RECT-A" specifies a rectangular area
* "RREC-P" specifies a rounded rectangular perimeter
* "RREC-A" specifies a rounded rectangular area
* "ELLI-P" specifies an elliptical perimeter
* "ELLI-A" specifies an elliptical area
* "POLY-P" specifies a polygonal line
* "POLY-A" specifies a polygonal area
* "POLX-A" specifies an alternating polygonal area (for
complex polygons with crisscrossing coordinates)
STG Interactive Frogans Page [21]
FSDL 2.1 Frogans Slide Description Language May 2004
THICK - Optional
Applicable only if FORM="RECT-P", "RREC-P", "ELLI-P" and
"POLY-P"
Thickness of the line which designates the perimeter. Is a
whole decimal number between 0 and 100. It represents the
percentage of the width or the height of the resource, whichever
is lower, divided by two (SIZE or RSIZE attributes of SHAPE,
CONTENT and MASK elements). Signs are not accepted.
The default value is "25" (one quarter of the maximum
thickness).
Examples of accepted values:
THICK="25" (one quarter of the maximum thickness)
THICK="0" (no thickness)
THICK="100" (maximum thickness)
THICK="33" (one third of the maximum thickness)
Examples of refused values:
THICK=""
THICK="+33"
THICK="33.3"
THICK="200"
THICK="-33"
RSIZE - Optional
Applicable only if FORM="RREC-P" and "RREC-A"
Relative width and height of the ellipse defined for the corners
of the rounded rectangular perimeter/area. Is a comma separated,
pair of whole decimal numbers between 0 and 100. It represents
the percentage of the width or the height of the resource (SIZE
or RSIZE attributes of SHAPE, CONTENT and MASK elements). Spaces
can be placed before or after the comma. Signs are not accepted.
The default value is "25,25" (quarter width, quarter height).
Examples of accepted values:
RSIZE="25,25" (quarter width, quarter height)
RSIZE="100,100" (full width, full height)
RSIZE="50,100" (half width, full height)
RSIZE="50,50" (half width, half height)
RSIZE="50 , 50" (half width, half height)
Examples of refused values:
RSIZE=""
RSIZE="+100,100"
RSIZE="200,100"
RSIZE="-50,100"
STG Interactive Frogans Page [22]
FSDL 2.1 Frogans Slide Description Language May 2004
RSIZE="100"
RSIZE="50.5,100"
COORDS - Required
Applicable only if FORM="POLY-P", "POLY-A" and "POLX-A"
Relative X,Y coordinates of the points of the polygonal
perimeter/area. Is a comma separated, pair of whole decimal
numbers between 0 and 100. The coordinate 0,0 is top-left of
the resource and the coordinate 100,100 is bottom-right.
Spaces can be placed before or after commas. Signs are not
accepted.
A maximum of 256 X,Y coordinates is possible.
If FORM="POLY-P", the first X,Y coordinate must be repeated
at the end of the value to close the polygon.
If FORM="POLY-P", at least two different points must be
specified. If FORM="POLY-A" and "POLX-A", at least three
different points must be specified.
Examples of accepted values:
COORDS="0,100,50,50,75,75,100,0" (chart graphic line)
COORDS="50,0,100,100,0,50" (triangular area)
COORDS="50,0,100,100,0,50,50,0" (triangular perimeter)
COORDS="50,0,75,100,0,30,100,30,25,100" (star shaped area)
COORDS="50,0,75,100,0,30,100,30,25,100,50,0" (star shaped
perimeter)
COORDS="50 , 0 , 100 , 100 , 0 , 50" (triangular area)
Examples of refused values:
COORDS=""
COORDS="50,0"
COORDS="+50,0,100,100,0,-50"
COORDS="50,0,100,100,0,50,100"
COLOR - Optional
The uniform color of the form. Is a non-case sensitive,
six-digit hexadecimal number prefixed by a hash mark (each color
component is represented by two digits, in the order of red,
green, blue).
The default value is "#0000FF" (blue).
Examples: see 4. FROGANS element
STG Interactive Frogans Page [23]
FSDL 2.1 Frogans Slide Description Language May 2004
8. Managing Text Resources
To set a text resource, one or more fonts must be defined in the FSDL
document using FONT elements.
8.1. Defining Fonts - FONT element
The FONT element designs a font which can be used in the context of
a text resource (see 8.2. SETTEXT and TEXT elements).
The FONT element is placed between the start and end tags of the
FROGANS element. The FONT element does not contain any other
elements.
Up to 32 different FONT elements can be used in the slide.
A single font can be reused for different text resources within the
same slide.
The attributes associated with the FONT element are:
FONTID - Required
The unique identifier of the font for the slide. Is a non-case
sensitive string of alphanumeric characters: A-Z, a-z, 0-9,
underscore, without spaces. The string must contain between 1
and 16 characters.
Examples of accepted values:
FONTID="foo1"
FONTID="Foo1"
FONTID="foo2"
FONTID="foo_1"
Examples of refused values:
FONTID=""
FONTID="foo-1"
FONTID="foo/1"
FONTID="foo.1"
FONTID="foo 1"
FONTID="foo1, foo2"
NAME - Optional
The name of the font used to display the characters of the text.
Is a comma separated list of five possible font names, which
takes into account non-recognition of a font by the end-user's
system. Spaces can be placed before or after commas.
A font name is a non-case sensitive string of alphanumeric
characters: A-Z, a-z, 0-9, dash, commercial at (@), and spaces.
STG Interactive Frogans Page [24]
FSDL 2.1 Frogans Slide Description Language May 2004
The string must contain between 1 and 31 characters.
The end-user's system will display the first available font on
the list. If none is available, a substitute font will be
displayed.
The default value is "Arial,Verdana,Times New Roman".
Examples of accepted values:
NAME="Arial,Verdana,Times New Roman"
NAME="Arial , Verdana , Times New Roman"
NAME="Arial"
NAME="Verdana"
NAME="Times New Roman"
Examples of refused values:
NAME=""
NAME="Arial,"
NAME="Arial,,Verdana"
NAME="Arial+Verdana"
STYLE - Optional
The style of the font used to display the characters of the
text. Is a non-case sensitive, comma separated list of up to
four letters which can be used individually or in combination,
in any order. Spaces can be placed before or after commas.
The default value is "" (no style).
* "B" specifies bold style
* "I" specifies italic style
* "U" specifies underline style
* "S" specifies strikeout style
Examples of accepted values:
STYLE="" (no style)
STYLE="B" (bold style)
STYLE="b" (bold style)
STYLE="B,I" (bold + italic styles)
STYLE="B , I" (bold + italic styles)
STYLE="I,B" (bold + italic styles)
STYLE="B,I,U,S" (bold + italic + underline + strikeout
styles)
Examples of refused values:
STYLE=","
STYLE="B,"
STG Interactive Frogans Page [25]
FSDL 2.1 Frogans Slide Description Language May 2004
STYLE="B,B"
STYLE="BI"
STYLE="B I"
STYLE="B,,I"
STYLE="B,I,"
STYLE="B,I,A"
COLOR - Optional
The color of the font used to display the characters of the
text. Is a non-case sensitive, six-digit hexadecimal number
prefixed by a hash mark (each color component is represented by
two digits, in the order of red, green, blue).
The default value is "#0000FF" (blue).
Examples: see 4. FROGANS element
SPACING - Optional
The spacing between each character of the text. Is a whole
decimal number between -100 and 100. Spaces are accepted between
the sign and the first digit.
The default value is "0" (default spacing).
Examples of accepted values:
SPACING="0" (default spacing)
SPACING="100" (maximum spacing)
SPACING="33" (one third of the maximum spacing)
SPACING="-100" (no spacing, fully superimposed)
SPACING="+100"
SPACING="- 100"
Examples of refused values:
SPACING=""
SPACING="33.3"
SPACING="200"
STG Interactive Frogans Page [26]
FSDL 2.1 Frogans Slide Description Language May 2004
8.2. Setting Text Resources - SETTEXT and TEXT elements
The SETTEXT element designs a text resource which can be used to
contribute to the shape of the slide (see 11. SHAPE element), to fill
an area within the slide (see 12. CONTENT element), or to apply a
mask to a content (see 13.1. MASK element).
The SETTEXT element is placed between the start and end tags of the
FROGANS element. The SETTEXT element only contains TEXT elements.
A single text resource can be reused many times within the same
slide.
The text characters are regrouped block by block between the start
and end tags of TEXT elements.
All TEXT elements are placed between the start and end tags of the
SETTEXT element. The TEXT element does not contain any other
elements, just text characters.
For example:
This is a block of text
This is a second block of text
The text characters can be displayed horizontally or vertically, to
be read from left to right (LTR), right to left (RTL), top to bottom
(TTB) or bottom to top (BTT), using the FORMAT attribute of the
SETTEXT element.
The text resource can be made up of 1 to 16 lines (rows or columns)
of text characters. The number of lines is specified in the LINES
attribute of the SETTEXT element.
If the line is horizontal, the default height of the font used to
display the text characters is the height of the associated SHAPE,
CONTENT or MASK elements (defined by their SIZE or RSIZE attributes)
divided by the specified number of lines.
If the line is vertical, the default width of the font used to
display the text characters (column width) is the width of the
associated SHAPE, CONTENT or MASK elements (defined by their SIZE or
RSIZE attributes) divided by the specified number of lines.
The spacing between the lines of the text resource can be changed
using the LINESPACE attribute of the SETTEXT element. The font's
width or height will be increased or reduced in proportion to the
value of the LINESPACE attribute.
STG Interactive Frogans Page [27]
FSDL 2.1 Frogans Slide Description Language May 2004
The text characters of a block of text are displayed on one or more
lines of the text resource. When using the STRETCH attribute of the
SETTEXT element, the block of text is displayed in a single line of
the text resource.
Each block of text begins on a new line of the text resource, except
when using the JOIN attribute of the TEXT element.
If there is not enough space for all of the text characters defined
in the SETTEXT element to be displayed, the remaining text characters
will be ignored.
If the text characters do not completely fill the available space,
the last lines of the text resource can remain empty.
The font used to display the text characters must be designed in a
preceding FONT element (see 8.1. FONT element). The font's identifier
is specified in the FONTID attribute of the SETTEXT element.
Each TEXT element can have a different font (FONTID attribute of the
TEXT element) and can reverse the direction of the text when it is
displayed (REVDIR attribute of the TEXT element).
To use different fonts and text directions in a single block of text,
several TEXT elements can be joined together (JOIN attribute of the
TEXT element).
For example:
This is a block of text
This is
dnoces a
block of text
The SETTEXT element can contain up to 16 TEXT elements. Each block of
text can contain up to 768 text characters.
Numeric character references and entity references can be used.
See 3.4. Character and Entity References.
Horizontal tabulation ( ) and line feed (
) characters
are automatically replaced by the space character ( ).
Any combination of two or more values denoting a space will result in
a single space. Spaces immediately following or preceding the TEXT
element tags are not taken into account. Non-breaking spaces can be
used to place succeeding spaces anywhere in a line of text.
STG Interactive Frogans Page [28]
FSDL 2.1 Frogans Slide Description Language May 2004
The attributes associated with the SETTEXT element are:
RESID - Required
The unique identifier of the text resource for the slide. Is a
non-case sensitive string of alphanumeric characters: A-Z, a-z,
0-9, underscore, without spaces. The string must contain between
1 and 16 characters.
Examples: see 5. SETIMAGE element
FORMAT - Required
The format of the text resource. Is not case sensitive.
* "H-TTB-LTR" specifies that the characters must be
displayed horizontally, in rows organized from top to
bottom, reading left to right
* "H-TTB-RTL" specifies that the characters must be
displayed horizontally, in rows organized from top to
bottom, reading right to left
* "H-BTT-LTR" specifies that the characters must be
displayed horizontally, in rows organized from bottom to
top, reading left to right
* "H-BTT-RTL" specifies that the characters must be
displayed horizontally, in rows organized from bottom to
top, reading right to left
* "V-LTR-TTB" specifies that the characters must be
displayed vertically, in columns organized from left to
right, reading top to bottom
* "V-LTR-BTT" specifies that the characters must be
displayed vertically, in columns organized from left to
right, reading bottom to top
* "V-RTL-TTB" specifies that the characters must be
displayed vertically, in columns organized from right to
left, reading top to bottom
* "V-RTL-BTT" specifies that the characters must be
displayed vertically, in columns organized from right to
left, reading bottom to top
STG Interactive Frogans Page [29]
FSDL 2.1 Frogans Slide Description Language May 2004
LINES - Required
The number of lines (rows or columns) to make up the text
resource. Is a whole decimal number between 1 and 16. Signs are
not accepted.
Examples of accepted values:
LINES="1" (one line)
LINES="8" (eight lines)
Examples of refused values:
LINES=""
LINES="+1"
LINES="8.5"
LINES="20"
FONTID - Required
The unique identifier of the default font to be used to display
the text resource. Is a non-case sensitive string of
alphanumeric characters: A-Z, a-z, 0-9, underscore, without
spaces. The string must contain between 1 and 16 characters.
Examples: see 8.1. FONT element
TALIGN - Optional
The default alignment of the blocks of text in the text resource
(horizontal or vertical). Is not case sensitive.
The default value is "BEGIN" (align start of the block of text).
* "BEGIN" specifies align start of the block of text
* "END" specifies align end of the block of text
* "CENTER" specifies align center
* "JUSTIFY" specifies align justified
LINESPACE - Optional
The spacing between each line of the text resource. Is a whole
decimal number between -100 and 100. Spaces are accepted between
the sign and the first digit.
Has no effect if there is only one line in the text resource
(LINES attribute).
The default value is "0" (default spacing).
STG Interactive Frogans Page [30]
FSDL 2.1 Frogans Slide Description Language May 2004
Examples of accepted values:
LINESPACE="0" (default spacing)
LINESPACE="100" (maximum spacing)
LINESPACE="33" (one third of the maximum spacing)
LINESPACE="-100" (no spacing, fully superimposed)
LINESPACE="+100"
LINESPACE="- 100"
Examples of refused values:
LINESPACE=""
LINESPACE="33.3"
LINESPACE="200"
STRETCH - Optional
Forces each block of text to occupy a single line in the text
resource, in relation to the other blocks of text. Is not case
sensitive.
The longest block of text to be displayed will completely occupy
its line in the text resource by changing the original
proportions of the font.
The other blocks of text will be displayed using the same font
proportions as the longest line.
Must be set to "OFF" in order to preserve the original
proportions of the font.
The default value is "OFF" (no stretch).
* "OFF" specifies no stretch
* "ON" specifies stretch
The attributes associated with the TEXT element are:
FONTID - Optional
The unique identifier of the font to be used to display the
text characters placed between the start and end tags of the
TEXT element. Is a non-case sensitive string of alphanumeric
characters: A-Z, a-z, 0-9, underscore, without spaces. The
string must contain between 1 and 16 characters.
The default value is specified in the FONTID attribute of the
SETTEXT element which contains the TEXT element.
Examples: see 8.1. FONT element
STG Interactive Frogans Page [31]
FSDL 2.1 Frogans Slide Description Language May 2004
TALIGN - Optional
The alignment of the block of text (horizontal or vertical). Is
not case sensitive.
If the block of text is made up of several TEXT elements (JOIN
attribute), the value of the TALIGN attribute used to align the
block of text is found in the first TEXT element.
The default value is specified in the TALIGN attribute of the
SETTEXT element which contains the TEXT element.
Examples: see 8.2. SETTEXT element
REVDIR - Optional
Reverses the direction of the text characters placed between
the start and end tags of the TEXT element. Is not case
sensitive. The initial direction is specified in the FORMAT
attribute of the SETTEXT element which contains the TEXT
element.
The default value is "OFF" (direction is not reversed)
* "OFF" specifies direction is not reversed
* "ON" specifies direction is reversed
JOIN - Optional
Indicates if the text characters, placed between the start and
end tags of the TEXT element, must be joined with the text
characters of the previous TEXT element to display a single
block of text with different fonts or text directions. Is not
case sensitive.
Has no effect on the first TEXT element of the SETTEXT element.
The default value is "OFF" (text characters are not joined).
* "OFF" specifies text characters are not joined
* "ON" specifies text characters are joined with a space
character
* "NOSPACE" specifies text characters are joined without
a space character
STG Interactive Frogans Page [32]
FSDL 2.1 Frogans Slide Description Language May 2004
9. Setting Duplicated Resources - SETCOPY element
The SETCOPY element initializes a copy of an existing resource
(image, graphic, pixels or text) designed in a preceding element.
The SETCOPY element is placed between the start and end tags of the
FROGANS element. The SETCOPY element does not contain any other
elements.
The new resource has the identical attribute values of the original
resource and retains the processes already applied on the original
(see 10. PROCESS and FILTER elements). Additional processes can be
applied on the new resource.
The attributes associated with the SETCOPY element are:
RESID - Required
The unique identifier of the new resource for the slide. Is a
non-case sensitive string of alphanumeric characters: A-Z, a-z,
0-9, underscore, without spaces. The string must contain between
1 and 16 characters.
Examples: see 5. SETIMAGE element
SOURCE - Required
The unique identifier of the original resource for the slide. Is
a non-case sensitive string of alphanumeric characters: A-Z,
a-z, 0-9, underscore, without spaces. The string must contain
between 1 and 16 characters.
Examples of accepted values:
SOURCE="foo1"
SOURCE="Foo1"
SOURCE="foo2"
SOURCE="foo_1"
Examples of refused values:
SOURCE=""
SOURCE="foo-1"
SOURCE="foo/1"
SOURCE="foo.1"
SOURCE="foo 1"
SOURCE="foo1, foo2"
STG Interactive Frogans Page [33]
FSDL 2.1 Frogans Slide Description Language May 2004
10. Pre-processing of Resources - PROCESS and FILTER elements
The PROCESS element defines a series of processes to be applied on a
resource (image, graphic, pixels or text), before it is used in the
SHAPE, CONTENT and MASK elements. The resource must be designed in a
preceding element.
The PROCESS element is placed between the start and end tags of the
FROGANS element. The PROCESS element only contains FILTER elements.
Up to 16 different processes can be applied on the same resource
using successive FILTER elements. The first FILTER element represents
the first process to be applied, and so on.
All FILTER elements are placed between the start and end tags of the
PROCESS element. The FILTER element does not contain any other
elements.
For example:
To reuse the same resource in the slide, but each with different
processes, the original resource must be duplicated using the SETCOPY
element before applying processes on the copies. By treating the
original resource, all copies will be affected.
The only attribute associated with the PROCESS element is:
RESID - Required
The unique identifier of the resource to be processed. Is a
non-case sensitive string of alphanumeric characters: A-Z, a-z,
0-9, underscore, without spaces. The string must contain between
1 and 16 characters.
Examples: see 5. SETIMAGE element
The attributes associated with the FILTER element are:
CUE - Required
Denotes the filter used to process the red, green and blue (RGB)
and alpha (A) components of the resource. Is not case sensitive.
* "LIGHT" specifies a filter which modifies the brightness
of the resource (affects RGB components)
STG Interactive Frogans Page [34]
FSDL 2.1 Frogans Slide Description Language May 2004
* "CONTRAST" specifies a filter which modifies the contrast
of the resource (affects RGB components)
* "SATURATION" specifies a filter which modifies the color
saturation of the resource (affects RGB components)
* "HUE" specifies a filter which modifies the color hue of
the resource (affects RGB components)
* "SOLARIZE" specifies a filter which applies color
solarization to the resource (affects RGB components)
* "ADDCOLOR" specifies a filter which adds or subtracts a
certain color uniformly to/from the resource (affects RGB
components)
* "MIXCOLOR" specifies a filter which blends a certain color
uniformly with the resource (affects RGB components)
* "NEGATIVE" specifies a filter which applies a negative
effect to the resource (affects RGB components)
* "ADDTRANS" specifies a filter which adds or subtracts a
uniform transparency to/from the resource (affects A
component)
* "REVERSE" specifies a filter which reverses the
transparency of the resource (affects A component)
* "LUMAKEY" specifies a filter which gives transparency to
areas of the resource whose luminance is of a certain
value (affects A component)
* "CHROMAKEY" specifies a filter which gives transparency to
areas of the resource whose color is of a certain value
(affects A component)
* "LUMATOALPHA" specifies a filter which transfers the
luminance of the resource to its alpha/transparency
channel (affects A component)
* "ALPHATOLUMA" specifies a filter which transfers the
alpha/transparency channel of the resource to its
luminance (affects RGB components)
STG Interactive Frogans Page [35]
FSDL 2.1 Frogans Slide Description Language May 2004
LEVEL - Optional
Applicable only if CUE="LIGHT", "CONTRAST", "SATURATION",
"SOLARIZE", "ADDCOLOR", "MIXCOLOR" and "ADDTRANS"
The level of the effect to be applied on the resource. Is a
whole decimal number between -100 and 100. Spaces are accepted
between the sign and the first digit. Level zero is considered
as having no effect.
If CUE="SOLARIZE" and "MIXCOLOR", only positive levels are
processed.
The default value is "25" (one quarter of the maximum positive
effect).
Examples of accepted values:
LEVEL="25" (one quarter of the maximum positive effect)
LEVEL="100" (maximum positive effect)
LEVEL="0" (no effect)
LEVEL="-25" (one quarter of the maximum negative effect)
LEVEL="-100" (maximum negative effect)
LEVEL="+25"
LEVEL="- 25"
Examples of refused values:
LEVEL=""
LEVEL="33.3"
LEVEL="200"
ANGLE - Optional
Applicable only if CUE="HUE"
The angle added to the H component of each pixel of the resource
(in HSV color space). Is a whole decimal number representing
degrees between -180 and 180. Spaces are accepted between the
sign and the first digit.
The default value is "90" (90 degrees).
Examples of accepted values:
ANGLE="90" (90 degrees)
ANGLE="0" (0 degree)
ANGLE="-45" (-45 degrees)
ANGLE="+90"
ANGLE="- 45"
Examples of refused values:
ANGLE=""
ANGLE="33.3"
ANGLE="270"
STG Interactive Frogans Page [36]
FSDL 2.1 Frogans Slide Description Language May 2004
TOLERANCE - Optional
Applicable only if CUE="LUMAKEY" and "CHROMAKEY"
The tolerance of the effect to be applied on the resource. Is a
whole decimal number between 0 and 100. Level zero means no
tolerance. Signs are not accepted.
The default value is "10" (one tenth of the maximum tolerance).
Examples of accepted values:
TOLERANCE="10" (one tenth of the maximum tolerance)
TOLERANCE="100" (maximum tolerance)
TOLERANCE="0" (no tolerance)
Examples of refused values:
TOLERANCE=""
TOLERANCE="33.3"
TOLERANCE="+25"
TOLERANCE="-25"
TOLERANCE="200"
COLOR - Optional
Applicable only if CUE="ADDCOLOR", "MIXCOLOR", "LUMAKEY" and
"CHROMAKEY"
The color to be used in the process. Is a non-case sensitive,
six-digit hexadecimal number prefixed by a hash mark (each color
component is represented by two digits, in the order of red,
green, blue).
If CUE="LUMAKEY", only the luminance of the specified color is
used (a gray value can be specified, such as "#A0A0A0").
The default value is "#FF0000" (red).
Examples: see 4. FROGANS element
STG Interactive Frogans Page [37]
FSDL 2.1 Frogans Slide Description Language May 2004
11. Defining the Shape of the Slide - SHAPE element
The SHAPE element defines a specific shape, which contributes to the
overall shape of the slide, by using an existing resource (image,
graphic, pixels or text). The resource must be designed in a
preceding element.
The SHAPE element is placed between the start and end tags of the
FROGANS element. The SHAPE element does not contain any other
elements.
Up to 64 different SHAPE elements can be combined successively to
define complex shapes (COMBINE attribute).
The slide layout is conducted on a grid which is used for sizing and
positioning specified shapes.
The size of the grid is 800 units width by 600 units height which
corresponds to a 4 by 3 ratio. The grid uses vector units of
measurement, which are the same for both horizontal and vertical
axes. For example, an elliptical area whose width and height are
identical on the grid will appear as a circle.
Coordinate 0,0 is left-top on the grid. The coordinate 799,599 is
right-bottom.
If no SHAPE element is found in the FSDL document, or if the shape
(can be a combined shape) is less than 25% of the grid area, the
default shape of the slide is a rounded rectangle.
The attributes associated with the SHAPE element are:
RESID - Required
The unique identifier of the resource to be used in specifying
the shape. Is a non-case sensitive string of alphanumeric
characters: A-Z, a-z, 0-9, underscore, without spaces. The
string must contain between 1 and 16 characters.
Examples: see 5. SETIMAGE element
SIZE - Required
The size of the specified shape on the grid before rotation. Is
a comma separated, pair of whole decimal numbers, representing
its width and height. The width is a number between 0 and 800
and the height is a number between 0 and 600. Spaces can be
placed before or after the comma. Signs are not accepted.
STG Interactive Frogans Page [38]
FSDL 2.1 Frogans Slide Description Language May 2004
Examples of accepted values:
SIZE="80,40"
SIZE="80, 40"
SIZE="80 , 40"
SIZE="100,200"
Examples of refused values:
SIZE=""
SIZE="+80,40"
SIZE="80"
SIZE="80.5,40"
POS - Required
The position of the specified shape on the grid. Is a comma
separated, pair of whole decimal numbers representing its X,Y
coordinate. X is a number between 0 and 799 and Y is a number
between 0 and 599. Spaces can be placed before or after the
comma. Signs are not accepted.
Examples of accepted values:
POS="400,300" (center of the grid)
POS="0,0" (left-top of the grid)
POS="799,599" (right-bottom of the grid)
POS="400, 300"
POS="400 , 300"
Examples of refused values:
POS=""
POS="+400,300"
POS="800,600"
POS="400"
POS="400.5,300"
POS="-200,300"
ALIGN - Optional
The alignments of the specified shape in relation to its
position on the grid (POS attribute). Is a comma separated list
of two constants representing its horizontal and vertical
alignments. The horizontal alignment can be left, center or
right. The vertical alignment can be top, middle or bottom.
Spaces can be placed before or after the comma.
The horizontal alignment always precedes the vertical alignment.
The default value is "CENTER,MIDDLE" (center and middle align).
* "LEFT,TOP" specifies left and top align
STG Interactive Frogans Page [39]
FSDL 2.1 Frogans Slide Description Language May 2004
* "LEFT,MIDDLE" specifies left and middle align
* "LEFT,BOTTOM" specifies left and bottom align
* "CENTER,TOP" specifies center and top align
* "CENTER,MIDDLE" specifies center and middle align
* "CENTER,BOTTOM" specifies center and bottom align
* "RIGHT,TOP" specifies right and top align
* "RIGHT,MIDDLE" specifies right and middle align
* "RIGHT,BOTTOM" specifies right and bottom align
ANGLE - Optional
The clockwise rotation angle of the specified shape on the grid.
The rotation axis corresponds to the position of the specified
shape on the grid (POS attribute).
Is a whole decimal number representing degrees between -180 and
180. Spaces are accepted between the sign and the first digit.
The default value is "0" (no rotation).
Examples: see 10. FILTER element
FLIP - Optional
Flips the specified shape on the grid. Is not case sensitive.
The default value is "OFF" (the shape is not flipped).
* "OFF" specifies that the shape is not flipped
* "ON" specifies that the shape is to be flipped along its
horizontal and vertical dimensions
* "XDIR" specifies that the shape is to be flipped along its
horizontal dimension
* "YDIR" specifies that the shape is to be flipped along its
vertical dimension
STG Interactive Frogans Page [40]
FSDL 2.1 Frogans Slide Description Language May 2004
DROPOUT - Optional
The transparency threshold over which areas of the resource are
dropped out when defining the shape. Is a non-case sensitive,
two-digit hexadecimal number prefixed by a hash mark.
The default value is "#80" (areas with a transparency of less
than "#80" are dropped out).
Examples of accepted values:
DROPOUT="#80" (areas with a transparency of less than "#80"
are dropped out)
DROPOUT="#FF" (all areas are dropped out unless opaque)
DROPOUT="#00" (no area is dropped out)
DROPOUT="#ff"
Examples of refused values:
DROPOUT=""
DROPOUT="# FF"
DROPOUT="FF"
DROPOUT="#F"
COMBINE - Optional
The mode used to combine the specified shape with preceding
SHAPE elements in the FSDL document. Is not case sensitive.
Has no effect if the shape is the first SHAPE element in the
FSDL document to be combined for each size of the slide (LEAPOUT
attribute).
The default value is "OR" (union of the specified shape to the
existing).
* "OR" specifies the union of the specified shape to the
existing
* "AND" specifies the intersection of the specified shape
with the existing
* "DIFF" specifies the subtraction of the specified shape
from the existing
* "XOR" specifies the exclusive union of the specified shape
to the existing
STG Interactive Frogans Page [41]
FSDL 2.1 Frogans Slide Description Language May 2004
LEAPOUT - Optional
The conditions under which the specified shape is combined
depending on the size of the slide on the screen (of the end-
user's system). Is not case sensitive.
The default value is "ANYSIZE".
* "ANYSIZE" specifies that the shape is combined in all
sizes of the slide on the screen
* "SMALL" specifies that the shape is combined only when the
slide on the screen is smaller than one quarter of its
largest size
* "LARGE" specifies that the shape is combined only when the
slide on the screen is larger than one quarter of its
largest size
STG Interactive Frogans Page [42]
FSDL 2.1 Frogans Slide Description Language May 2004
12. Defining the Content of the Slide - CONTENT element
The CONTENT element defines a content to be displayed on the slide by
using an existing resource (image, graphic, pixels or text). The
resource must be designed in a preceding element.
The CONTENT element is placed between the start and end tags of the
FROGANS element or between the start and end tags of the BUTTON
element. The CONTENT element only contains MASK, RELIEF and SHADOW
elements.
Up to 128 different CONTENT elements can be used to create complex
content.
Specified contents are displayed within the slide, one on top of the
other, in the order that their CONTENT elements appear in the FSDL
document.
The slide layout is conducted on a grid which is used for sizing and
positioning specified content.
The size of the grid is 800 units width by 600 units height which
corresponds to a 4 by 3 ratio. The grid uses vector units of
measurement, which are the same for both horizontal and vertical
axes. For example, an elliptical area whose width and height are
identical on the grid will appear as a circle.
Coordinate 0,0 is left-top on the grid. The coordinate 799,599 is
right-bottom.
To enhance the specified content, optional elements can be placed
between the start and end tags of the CONTENT element. See 13.
MASK, RELIEF and SHADOW elements.
The attributes associated with the CONTENT element are:
RESID - Required
The unique identifier of the resource to be used in specifying
the content. Is a non-case sensitive string of alphanumeric
characters: A-Z, a-z, 0-9, underscore, without spaces. The
string must contain between 1 and 16 characters.
Examples: see 5. SETIMAGE element
STG Interactive Frogans Page [43]
FSDL 2.1 Frogans Slide Description Language May 2004
SIZE - Required
The size of the specified content on the grid before rotation.
Is a comma separated, pair of whole decimal numbers,
representing its width and height. The width is a number between
0 and 800 and the height is a number between 0 and 600. Spaces
can be placed before or after the comma. Signs are not accepted.
Examples: see 11. SHAPE element
POS - Required
The position of the specified content on the grid. Is a comma
separated, pair of whole decimal numbers representing its X,Y
coordinate. X is a number between 0 and 799 and Y is a number
between 0 and 599. Spaces can be placed before or after the
comma. Signs are not accepted.
Examples: see 11. SHAPE element
ALIGN - Optional
The alignments of the specified content in relation to its
position on the grid (POS attribute). Is a comma separated list
of two constants representing its horizontal and vertical
alignments. The horizontal alignment can be left, center or
right. The vertical alignment can be top, middle or bottom.
Spaces can be placed before or after the comma.
The horizontal alignment always precedes the vertical alignment.
The default value is "CENTER,MIDDLE" (center and middle align).
* "LEFT,TOP" specifies left and top align
* "LEFT,MIDDLE" specifies left and middle align
* "LEFT,BOTTOM" specifies left and bottom align
* "CENTER,TOP" specifies center and top align
* "CENTER,MIDDLE" specifies center and middle align
* "CENTER,BOTTOM" specifies center and bottom align
* "RIGHT,TOP" specifies right and top align
* "RIGHT,MIDDLE" specifies right and middle align
* "RIGHT,BOTTOM" specifies right and bottom align
STG Interactive Frogans Page [44]
FSDL 2.1 Frogans Slide Description Language May 2004
ANGLE - Optional
The clockwise rotation angle of the specified content on the
grid. The rotation axis corresponds to the position of the
specified content on the grid (POS attribute).
Is a whole decimal number representing degrees between -180 and
180. Spaces are accepted between the sign and the first digit.
The default value is "0" (no rotation).
Examples: see 10. FILTER element
FLIP - Optional
Flips the specified content on the grid. Is not case sensitive.
The default value is "OFF" (the content is not flipped).
* "OFF" specifies that the content is not flipped
* "ON" specifies that the content is to be flipped along its
horizontal and vertical dimensions
* "XDIR" specifies that the content is to be flipped along
its horizontal dimension
* "YDIR" specifies that the content is to be flipped along
its vertical dimension
BLUR - Optional
The level of the blur effect to be applied on the content. Is a
whole decimal number between 0 and 100. Signs are not accepted.
The default value is "0" (no effect).
Examples of accepted values:
BLUR="0" (no effect)
BLUR="100" (maximum effect)
BLUR="33" (one third of the maximum effect)
Examples of refused values:
BLUR=""
BLUR="33.3"
BLUR="200"
BLUR="+25"
BLUR="-25"
STG Interactive Frogans Page [45]
FSDL 2.1 Frogans Slide Description Language May 2004
OPACITY - Optional
The percentage of opacity for the content, after optional masks
have been applied (MASK element). Is a whole decimal number
between 0 and 100. Signs are not accepted.
The default value is "100" (opacity is not modified).
Examples of accepted values:
OPACITY="100" (opacity is not modified)
OPACITY="0" (fully transparent)
OPACITY="50" (half opacity)
Examples of refused values:
OPACITY=""
OPACITY="33.3"
OPACITY="200"
OPACITY="+25"
OPACITY="-25"
ANTIALIAS - Optional
Indicates if an antialiasing effect is applied on the content,
before its rotation. Is not case sensitive.
Antialiasing effect is applied on content specified with graphic
and text resources (SETDRAW and SETTEXT elements).
The default value is "ON" (antialiasing effect is applied).
* "ON" specifies antialiasing effect is applied
* "OFF" specifies antialiasing effect is not applied
VISIBLE - Optional
Applicable only if the CONTENT element is contained in a
BUTTON element
The conditions under which the content is visible in the button,
in relation to the mouse cursor position on the slide. Is not
case sensitive.
The default value is "ALWAYS" (the content is displayed at all
times).
* "ALWAYS" specifies that the content is displayed at all
times
* "MOUSEOVER" specifies that the content is displayed only
if the mouse cursor passes over the button
STG Interactive Frogans Page [46]
FSDL 2.1 Frogans Slide Description Language May 2004
* "MOUSEAWAY" specifies that the content is displayed only
if the mouse cursor is not on the button
CURSOR - Optional
The transparency threshold over which areas of the content are
not reactive to the mouse cursor. Is a non-case sensitive,
two-digit hexadecimal number prefixed by a hash mark.
Can be used whether or not the CONTENT element is contained in a
BUTTON element.
The default value is "#80" (areas with a transparency of less
than "#80" are not reactive to the mouse cursor).
Examples of accepted values:
CURSOR="#80" (areas with a transparency of less than "#80"
are not reactive to the mouse cursor)
CURSOR="#FF" (only opaque areas are reactive)
CURSOR="#00" (all areas are reactive to the mouse cursor)
CURSOR="#ff"
Examples of refused values:
CURSOR=""
CURSOR="# FF"
CURSOR="FF"
CURSOR="#F"
LEAPOUT - Optional
The conditions under which the content is displayed depending on
the size of the slide on the screen (of the end-user's system).
Is not case sensitive.
If the CONTENT element is contained in a BUTTON element, the
default value is "LARGE". Otherwise, it is "ANYSIZE".
* "ANYSIZE" specifies that the content is displayed in all
sizes of the slide on the screen
* "SMALL" specifies that the content is displayed only when
the slide on the screen is smaller than one quarter of its
largest size
* "LARGE" specifies that the content is displayed only when
the slide on the screen is larger than one quarter of its
largest size
STG Interactive Frogans Page [47]
FSDL 2.1 Frogans Slide Description Language May 2004
13. Enhancing the Content of the Slide
To enhance a content to be displayed on the slide, MASK, RELIEF and
SHADOW elements can be defined and placed between the start and end
tags of the CONTENT element.
13.1. Applying Masks - MASK element
The MASK element defines a mask which is applied to a content on the
slide. The mask is defined by using an existing resource (image,
graphic, pixels or text) whose transparency is combined with the
transparency of the content (COMBINE attribute).
Up to eight different masks can be applied on the content using
successive MASK elements. The masks are combined in the order that
their MASK elements appear in the FSDL document.
If the content is rotated, the mask is applied before the rotation.
The MASK element is placed between the start and end tags of the
CONTENT element. The MASK element does not contain any other
elements.
For example:
The specified mask is positioned on the same grid used for the
CONTENT element. See 12. CONTENT element.
The attributes associated with the MASK element are:
RESID - Required
The unique identifier of the resource to be used in specifying
the mask. Is a non-case sensitive string of alphanumeric
characters: A-Z, a-z, 0-9, underscore, without spaces. The
string must contain between 1 and 16 characters.
Examples: see 5. SETIMAGE element
RSIZE - Optional
The relative size of the specified mask on the grid. Is a comma
separated, pair of whole decimal numbers between 0 and 100. It
represents the percentage of the width or the height of the
content on the grid. Spaces can be placed before or after the
comma. Signs are not accepted.
STG Interactive Frogans Page [48]
FSDL 2.1 Frogans Slide Description Language May 2004
The size of the mask is always equal to or smaller than the
content size.
The default value is "100,100" (full width, full height).
Examples: see 7. SETDRAW element
RPOS - Optional
The relative position of the specified mask on the grid. Is a
comma separated, pair of whole decimal numbers, representing the
X,Y coordinate of the center of the mask, relative to where the
content is placed.
X is a number between -399 and 400 and Y is a number between
-299 and 300. Spaces can be placed before or after the comma,
and are accepted between the sign and the first digit.
The default value is "0,0" (same position)
Examples of accepted values:
RPOS="0,0" (same position)
RPOS="20,20" (bottom-right)
RPOS="-20,-20" (top-left)
RPOS="20 , - 20"
RPOS="+20,20"
Examples of refused values:
RPOS=""
RPOS="20"
RPOS="20.5,20"
ANGLE - Optional
The clockwise rotation angle of the specified mask, relative to
the content's rotation angle, on the grid. The rotation axis
corresponds to the center of the specified mask.
Is a whole decimal number representing degrees between -180 and
180. Spaces are accepted between the sign and the first digit.
The default value is "0" (no rotation).
Examples: see 10. FILTER element
STG Interactive Frogans Page [49]
FSDL 2.1 Frogans Slide Description Language May 2004
FLIP - Optional
Flips the specified mask on the grid. Is not case sensitive.
The default value is "OFF" (the mask is not flipped).
* "OFF" specifies that the mask is not flipped
* "ON" specifies that the mask is to be flipped along its
horizontal and vertical dimensions
* "XDIR" specifies that the mask is to be flipped along its
horizontal dimension
* "YDIR" specifies that the mask is to be flipped along its
vertical dimension
BLUR - Optional
The level of the blur effect to be applied on the specified
mask. Is a whole decimal number between 0 and 100. Signs are not
accepted.
The default value is "0" (no effect).
Examples: see 12. CONTENT element
OPACITY - Optional
The percentage of opacity for the specified mask. Is a whole
decimal number between 0 and 100. Signs are not accepted.
The default value is "100" (opacity is not modified).
Examples: see 12. CONTENT element
ANTIALIAS - Optional
Indicates if an antialiasing effect is applied on the specified
mask, before its rotation. Is not case sensitive.
Antialiasing effect is applied on masks specified with graphic
and text resources (SETDRAW and SETTEXT elements).
The default value is "ON" (antialiasing effect is applied).
* "ON" specifies antialiasing effect is applied
* "OFF" specifies antialiasing effect is not applied
STG Interactive Frogans Page [50]
FSDL 2.1 Frogans Slide Description Language May 2004
COMBINE - Optional
The mode used to combine the transparency of the specified mask
with the transparency of the existing content. Is not case
sensitive.
The default value is "OR" (union of the specified mask to the
existing).
* "OR" specifies the union of the specified mask to the
existing
* "AND" specifies the intersection of the specified mask
with the existing
* "DIFF" specifies the subtraction of the specified mask
from the existing
* "XOR" specifies the exclusive union of the specified mask
to the existing
STG Interactive Frogans Page [51]
FSDL 2.1 Frogans Slide Description Language May 2004
13.2. Sketching Reliefs - RELIEF element
The RELIEF element defines a relief which is applied to a content.
Up to four different reliefs can be applied to the content using
successive RELIEF elements.
Reliefs are displayed, one on top of the other, in the order that
their RELIEF elements appear in the FSDL document.
If the content is rotated, the relief is applied before the rotation.
The RELIEF element is placed between the start and end tags of the
CONTENT element. The RELIEF element does not contain any other
elements.
For example:
The specified relief is positioned on the same grid used for the
CONTENT element. See 12. CONTENT element.
The attributes associated with the RELIEF element are:
RPOS - Optional
The relative position of the specified relief on the grid. Is a
comma separated, pair of whole decimal numbers, representing the
X,Y coordinate of the center of the relief, relative to where
the content is placed.
X is a number between -399 and 400 and Y is a number between
-299 and 300. Spaces can be placed before or after the comma,
and are accepted between the sign and the first digit.
The default value is "20,20" (bottom-right)
Examples: see 13.1. MASK element
COLOR - Optional
The color of the specified relief. Is a non-case sensitive,
six-digit hexadecimal number prefixed by a hash mark (each color
component is represented by two digits, in the order of red,
green, blue).
STG Interactive Frogans Page [52]
FSDL 2.1 Frogans Slide Description Language May 2004
The default value is "#FFFFFF" (white).
Examples: see 4. FROGANS element
BLUR - Optional
The level of the blur effect to be applied on the specified
relief. Is a whole decimal number between 0 and 100. Signs are
not accepted.
The default value is "0" (no effect).
Examples: see 12. CONTENT element
OPACITY - Optional
The percentage of opacity for the specified relief. Is a whole
decimal number between 0 and 100. Signs are not accepted.
The default value is "100" (opacity is not modified).
Examples: see 12. CONTENT element
STG Interactive Frogans Page [53]
FSDL 2.1 Frogans Slide Description Language May 2004
13.3. Adding Shadows - SHADOW element
The SHADOW element defines a shadow which is applied to a content. A
shadow is displayed next to the content on the slide.
If the content contains transparent areas, the transparency of those
areas will be applied to the shadow.
Up to four different shadows can be added to the content using
successive SHADOW elements.
Shadows are displayed, one on top of the other, in the order that
their SHADOW elements appear in the FSDL document.
If the content is rotated, the shadow is applied after the rotation.
The SHADOW element is placed between the start and end tags of the
CONTENT element. The SHADOW element does not contain any other
elements.
For example:
The specified shadow is positioned on the same grid used for the
CONTENT element. See 12. CONTENT element.
Shadows are not reactive to the mouse cursor.
The attributes associated with the SHADOW element are:
RPOS - Optional
The relative position of the specified shadow on the grid. Is a
comma separated, pair of whole decimal numbers, representing the
X,Y coordinate of the center of the shadow, relative to where
the content is placed.
X is a number between -399 and 400 and Y is a number between
-299 and 300. Spaces can be placed before or after the comma,
and are accepted between the sign and the first digit.
The default value is "20,20" (bottom-right)
Examples: see 13.1. MASK element
STG Interactive Frogans Page [54]
FSDL 2.1 Frogans Slide Description Language May 2004
COLOR - Optional
The color of the specified shadow. Is a non-case sensitive,
six-digit hexadecimal number prefixed by a hash mark (each color
component is represented by two digits, in the order of red,
green, blue).
The default value is "#000000" (black).
Examples: see 4. FROGANS element
BLUR - Optional
The level of the blur effect to be applied on the specified
shadow. Is a whole decimal number between 0 and 100. Signs are
not accepted.
The default value is "0" (no effect).
Examples: see 12. CONTENT element
OPACITY - Optional
The percentage of opacity for the specified shadow. Is a whole
decimal number between 0 and 100. Signs are not accepted.
The default value is "100" (opacity is not modified).
Examples: see 12. CONTENT element
STG Interactive Frogans Page [55]
FSDL 2.1 Frogans Slide Description Language May 2004
14. Linking and Navigation - BUTTON element
The BUTTON element defines a button on the slide which is made up of
one or more specified contents.
The BUTTON element is placed between the start and end tags of the
FROGANS element. The BUTTON element only contains CONTENT elements.
Up to 32 different BUTTON elements can be used to create complex
content.
Multiple contents can be combined to create complex roll-over
buttons.
The CONTENT elements which define the specified contents are placed
between the start and end tags of the BUTTON element.
For example:
The VISIBLE attribute of each CONTENT element indicates how the
content in the button is displayed in relation to the mouse cursor
position on the slide. See 12. CONTENT element.
A button on the slide always takes priority over any button which may
be displayed under it.
The area of the frogans slide covered by one or more buttons should
not exceed 50% of the grid area, so the end-user can easily move the
frogans on screen.
Buttons are not reactive on the edge of the frogans slide, as this
area is reserved to let the end-user resize the frogans on screen.
The attributes associated with the BUTTON element are:
GOTO - Required
Denotes the type of button to be used. Is not case sensitive.
* "SLIDE" specifies a button which leads to another slide in
the same frogans
* "PIC" specifies a button which begins the process of
downloading an image to be displayed in a larger size on
the end-user's system, in a separate viewer. The image
file is found in the frogans root directory.
STG Interactive Frogans Page [56]
FSDL 2.1 Frogans Slide Description Language May 2004
The format used to encode the image file must be either
JPEG, PNG or GIF (if GIF file is animated, only the first
frame is displayed). The image file is limited to 1600
pixels width by 1600 pixels height. For information about
image file size limitations, see 3.5. File Sizes.
* "FILE" specifies a button which begins the process of
downloading a file to be saved on the end-user's system.
The file is found in the frogans root directory.
For information about file size limitations, see 3.5. File
Sizes.
* "REOPEN" specifies a button which closes the frogans and
reopens it automatically, to re-request a PID or login and
password for example.
* "FROGANS" specifies a button which opens another frogans,
that has a different frogans address
* "WEB" specifies a button which opens the end-user's
default browser to display a Web document whose URL
starts with 'http://'
* "SWEB" specifies a button which opens the end-user's
default browser to display a Web document whose URL
starts with 'https://' (secured protocol)
* "EMAIL" specifies a button which opens the end-user's
default mailer to send an e-mail
FILE - Required
Applicable only if GOTO="SLIDE", "PIC" and "FILE"
The file name in the frogans root directory. Is a case sensitive
string of alphanumeric characters: A-Z, a-z, 0-9, underscore,
dash, dot and slash (/). The string cannot end with a slash or a
dot. The string cannot contain the sequences '..', './', '/.'
and '//'. Spaces and backslashes (\) are not accepted. The
string must contain between 2 and 128 characters.
The file name always starts with a slash (/).
If the file is located in a sub-directory, the file name must
include the complete file path from the frogans root directory.
See 3.1. Frogans Root Directory.
Examples: see 5. SETIMAGE element and 15. NEXT element
STG Interactive Frogans Page [57]
FSDL 2.1 Frogans Slide Description Language May 2004
DATA - Optional
Applicable only if GOTO="SLIDE", "PIC" and "FILE"
Additional data that can be sent to the server hosting the
frogans, at the time of the request for the FSDL document, the
image file or the file to be downloaded, by the Frogans Player.
See 5. DATA attribute of the SETIMAGE element.
For more information about the way data is sent by the Frogans
Player to the server hosting the frogans, see 19. Going On-line.
The default value is "" (no data).
ADDRESS - Required
Applicable only if GOTO="FROGANS"
The address of another frogans.
If this frogans is published on the main frogans network, the
address is a case sensitive string of characters in the format
'frogans*gatename' or 'frogans*gatename.extension', without
spaces.
If this frogans is published on a dedicated frogans network, the
address is a case sensitive string of characters in the format
'network*gatename' or 'network*gatename.extension', without
spaces, where 'network' is the name of the dedicated frogans
network.
'gatename' is a case sensitive string of alphanumeric
characters: A-Z, a-z, 0-9 and dash. The string cannot start or
end with a dash. The string must contain between 2 and 32
characters.
'extension' is a case sensitive string of alphanumeric
characters: A-Z, a-z, 0-9 and dash. The string cannot start or
end with a dash. The string must contain between 3 and 16
characters.
'network' is a case sensitive string of alphanumeric characters:
A-Z, a-z, 0-9 and dash. The string cannot start or end with a
dash. The string must contain between 1 and 24 characters.
Examples of accepted values:
ADDRESS="frogans*GateName"
ADDRESS="frogans*GateName.Extension"
ADDRESS="frogans*gatename"
ADDRESS="MyNetwork*GateName"
ADDRESS="my-network*GateName.Extension"
STG Interactive Frogans Page [58]
FSDL 2.1 Frogans Slide Description Language May 2004
Examples of refused values:
ADDRESS=""
ADDRESS="frogans*-GateName"
ADDRESS="frogans*GateName.Extension-"
ADDRESS="frogans*"
ADDRESS="GateName"
ADDRESS="GateName.Extension"
ADDRESS="*GateName"
ADDRESS="frogans * GateName"
ADDRESS="frogans*GateName . Extension"
ADDRESS="frogans*GateName/subdir/"
ADDRESS="frogans*GateName/file.fsdl"
ADDRESS="http://www.SpecificDomainName.com/"
ADDRESS="http://www.SpecificDomainName.com/subdir/"
URL - Required
Applicable only if GOTO="WEB"
The URL of a document hosted on a Web server (html page, image,
mp3, animation, video, etc.).
The URL must begin with 'http://' and can contain up to 512
case sensitive characters.
The host specified in the URL cannot include a user or password
declaration. The URL cannot contain a fragment.
The & entity reference must be used in place of an ampersand
(&) in the URL. See 3.4. Character and Entity References.
Examples of accepted values:
URL="http://www.SpecificDomainName.com/"
URL="http://www.SpecificDomainName.com/page.htm"
URL="http://www.SpecificDomainName.com/dir/page.htm"
URL="http://www.SpecificDomainName.com/pic1.jpg"
URL="http://www.SpecificDomainName.com/music.mp3"
URL="http://www.SpecificDomainName.com/anim.swf"
URL="http://www.SpecificDomainName.com/video.asx"
URL="http://www.SpecificDomainName.com/video.rm"
URL="http://www.SpecificDomainName.com/home.asp?a=7&b=2"
URL="http://www.SpecificDomainName.com:81/page.htm"
URL="http://1.2.3.4/"
Examples of refused values:
URL=""
URL="http://www.SpecificDomainName.com"
URL="www.SpecificDomainName.com"
URL="http://www.SpecificDomainName.com/page.html#top"
URL="http://www.SpecificDomainName.com/home.asp?a=7&b=2"
URL="https://www.SpecificDomainName.com/"
URL="mailto:Name@SpecificDomainName.com"
STG Interactive Frogans Page [59]
FSDL 2.1 Frogans Slide Description Language May 2004
URL="Name@SpecificDomainName.com"
URL="rtsp://www.SpecificDomainName.com/video.rm"
URL="http://frogans*GateName"
URL="frogans*GateName"
SURL - Required
Applicable only if GOTO="SWEB"
The URL of a document hosted on a Web server (html page, image,
mp3, animation, video, etc.) using a secured protocol.
The URL must begin with 'https://' and can contain up to 512
case sensitive characters.
The host specified in the URL cannot include a user or password
declaration. The URL cannot contain a fragment.
The & entity reference must be used in place of an ampersand
(&) in the URL. See 3.4. Character and Entity References.
Examples of accepted values:
SURL="https://www.SpecificDomainName.com/"
SURL="https://www.SpecificDomainName.com/page.htm"
SURL="https://www.SpecificDomainName.com/dir/page.htm"
SURL="https://www.SpecificDomainName.com/pic1.jpg"
SURL="https://www.SpecificDomainName.com/music.mp3"
SURL="https://www.SpecificDomainName.com/anim.swf"
SURL="https://www.SpecificDomainName.com/video.asx"
SURL="https://www.SpecificDomainName.com/video.rm"
SURL=
"https://www.SpecificDomainName.com/home.asp?a=7&b=2"
SURL="https://www.SpecificDomainName.com:81/page.htm"
SURL="https://1.2.3.4/"
Examples of refused values:
SURL=""
SURL="https://www.SpecificDomainName.com"
SURL="www.SpecificDomainName.com"
SURL="https://www.SpecificDomainName.com/page.html#top"
SURL="https://www.SpecificDomainName.com/home.asp?a=7&b=2"
SURL="http://www.SpecificDomainName.com/"
SURL="mailto:Name@SpecificDomainName.com"
SURL="Name@SpecificDomainName.com"
SURL="rtsp://www.SpecificDomainName.com/video.rm"
SURL="https://frogans*GateName"
SURL="frogans*GateName"
STG Interactive Frogans Page [60]
FSDL 2.1 Frogans Slide Description Language May 2004
EMAIL - Required
Applicable only if GOTO="EMAIL"
The e-mail address. It can contain up to 128 case sensitive
characters.
Examples of accepted values:
EMAIL="Name@SpecificDomainName.com"
Examples of refused values:
EMAIL=""
EMAIL="Name@SpecificDomainName.com,
Name2@SpecificDomainName.com"
EMAIL="mailto:Name@SpecificDomainName.com"
EMAIL="Name@SpecificDomainName.com?subject=Hello"
EMAIL="http://www.SpecificDomainName.com/"
EMAIL="frogans*GateName"
SUBJECT - Optional
Applicable only if GOTO="EMAIL"
The subject of the e-mail. Is a case sensitive string of up to
32 alphanumeric characters: A-Z, a-z, 0-9, spaces and .-,_()!*:;
The default value is "" (no subject).
Examples of accepted values:
SUBJECT="" (no subject)
SUBJECT="Hello"
SUBJECT="Hello, :-)"
SUBJECT="Hello 19."
Examples of refused values:
SUBJECT="Date & Time"
SUBJECT="Name@SpecificDomainName.com"
SUBJECT="Name@SpecificDomainName.com?subject=Hello"
STG Interactive Frogans Page [61]
FSDL 2.1 Frogans Slide Description Language May 2004
15. Auto-Refresh and Slide Show - NEXT element
The NEXT element defines another slide in the same frogans to be
loaded and displayed automatically.
The NEXT element is placed between the start and end tags of the
FROGANS element. The NEXT element does not contain any other
elements.
The NEXT element is optional. Only one NEXT element can be used in
the FSDL document.
The next slide is displayed after a delay, plus the time necessary to
load the slide file and its image resources. Loading times will vary
according to the physical network's capacity between the server
hosting the frogans and the end-user's system.
If the end-user clicks on a button leading to another slide in the
same frogans before the delay has expired or before the next slide is
fully loaded, the procedure is cancelled. If the end-user closes the
Frogans Player, all frogans navigation is stopped.
The attributes associated with the NEXT element are:
DELAY - Required
The period of time until the next slide begins to load. Is a
whole decimal number representing seconds between 5 and 86400.
Signs are not accepted.
Examples of accepted values:
DELAY="5" (minimum delay, 5 seconds)
DELAY="86400" (maximum delay, 24 hours)
DELAY="60" (60 seconds delay)
Examples of refused values:
DELAY=""
DELAY="0"
DELAY="3"
DELAY="+5"
FILE - Required
The file name of the FSDL document in the frogans root directory
representing the next slide. Is a case sensitive string of
alphanumeric characters: A-Z, a-z, 0-9, underscore, dash, dot
and slash (/). The string cannot end with a slash or a dot. The
string cannot contain the sequences '..', './', '/.' and '//'.
Spaces and backslashes (\) are not accepted. The string must
contain between 2 and 128 characters.
STG Interactive Frogans Page [62]
FSDL 2.1 Frogans Slide Description Language May 2004
The file name always starts with a slash (/).
If the FSDL document is located in a sub-directory, the file
name must include the complete file path from the frogans root
directory. See 3.1. Frogans Root Directory.
Examples of accepted values:
FILE="/slide2.fsdl"
FILE="/slide-2.fsdl"
FILE="/slide_2.fsdl"
FILE="/subdir/slide2.fsdl"
FILE="/slide2.fsd"
FILE="/slide2.php"
FILE="/slide2.asp"
FILE="/slide2.jsp"
FILE="/slide2.cgi"
FILE="/slide2"
Examples of refused values:
FILE=""
FILE="/"
FILE="slide2.fsdl"
FILE="/.fsdl"
FILE="/slide2."
FILE="\slide2.fsdl"
FILE="./slide2.fsdl"
FILE="../slide2.fsdl"
FILE="subdir/slide2.fsdl"
FILE="/subdir/"
FILE="/subdir//slide2.fsdl"
FILE="/subdir\slide2.fsdl"
FILE="/slide2.php?option=2"
FILE="/slide2.php?option=2&language=Swedish"
FILE="frogans*GateName/slide2.fsdl"
FILE="http://SpecificDomainName.com/slide2.fsdl"
DATA - Optional
Additional data that can be sent to the server hosting the
frogans, at the time of the request for the FSDL document by the
Frogans Player.
See 5. DATA attribute of the SETIMAGE element.
For more information about the way data is sent by the Frogans
Player to the server hosting the frogans, see 19. Going On-line.
The default value is "" (no data).
STG Interactive Frogans Page [63]
FSDL 2.1 Frogans Slide Description Language May 2004
16. Redirecting to Another Slide - REDIRECT element
The REDIRECT element indicates that another slide in the same frogans
must be loaded and displayed automatically without delay.
The FSDL document containing the REDIRECT element will not result in
a displayed slide. A session can be maintained with a redirect (see
17. SESSION element).
The REDIRECT element is placed between the start and end tags of the
FROGANS element. The REDIRECT element does not contain any other
elements.
The REDIRECT element is optional. Only one REDIRECT element can be
used in the FSDL document.
When using the REDIRECT element, the SESSION element is the only
other element which can be placed between the start and end tags of
the FROGANS element.
The REDIRECT element cannot be used if the FSDL document has been
loaded from another FSDL document containing a REDIRECT element.
The attributes associated with the REDIRECT element are:
FILE - Required
The file name of the FSDL document in the frogans root
directory. Is a case sensitive string of alphanumeric
characters: A-Z, a-z, 0-9, underscore, dash, dot and slash (/).
The string cannot end with a slash or a dot. The string cannot
contain the sequences '..', './', '/.' and '//'. Spaces and
backslashes (\) are not accepted. The string must contain
between 2 and 128 characters.
The file name always starts with a slash (/).
If the FSDL document is located in a sub-directory, the file
name must include the complete file path from the frogans root
directory. See 3.1. Frogans Root Directory.
Examples: see 15. NEXT element
DATA - Optional
Additional data that can be sent to the server hosting the
frogans, at the time of the request for the FSDL document by the
Frogans Player.
STG Interactive Frogans Page [64]
FSDL 2.1 Frogans Slide Description Language May 2004
See 5. DATA attribute of the SETIMAGE element.
For more information about the way data is sent by the Frogans
Player to the server hosting the frogans, see 19. Going On-line.
The default value is "" (no data).
STG Interactive Frogans Page [65]
FSDL 2.1 Frogans Slide Description Language May 2004
17. Creating and Maintaining Sessions - SESSION element
The SESSION element defines a session identifier for the slide
(SESSID attribute).
The SESSION element is placed between the start and end tags of the
FROGANS element. The SESSION element does not contain any other
elements.
The SESSION element is optional. Only one SESSION element can be used
in the FSDL document.
The session identifier is sent to the server hosting the frogans by
the Frogans Player at the time of the request for:
- a FSDL document, representing another slide in the frogans, whose
file is defined in the FILE attribute of a BUTTON, NEXT or REDIRECT
element. Additional data may also be sent to the server at the
time of the request (DATA attribute of the BUTTON, NEXT and
REDIRECT elements).
- an image file, specified in the FILE attribute of a SETIMAGE
element, if additional data is specified (DATA attribute of the
SETIMAGE element). If no additional data is specified, the session
identifier is not sent.
- an image file or a file to be downloaded, specified in the FILE
attribute of a BUTTON element (where GOTO="PIC" or GOTO="FILE"), if
additional data is specified (DATA attribute of the BUTTON
element). If no additional data is specified, the session
identifier is not sent.
No session identifier is sent by the Frogans Player to the server
when there is no SESSION element in the FSDL document or if the
SESSID attribute is "".
For more information about the way the session identifier and
additional data are sent by the Frogans Player to the server hosting
the frogans, see 19. Going On-line.
The session identifier can be changed from slide to slide by the
server hosting the frogans in order to update the information
contained within the session identifier.
In order to maintain a session when the end-user navigates from slide
to slide, it is necessary to place the SESSION element in each slide
of the frogans. The session ends when no SESSION element is found in
the FSDL document or if the SESSID attribute is "".
If the value of the RETURN attribute is set to "ON" and the end-user
has added the frogans to his frogans favorites, the session
STG Interactive Frogans Page [66]
FSDL 2.1 Frogans Slide Description Language May 2004
identifier is saved on the end-user's system if the frogans is
closed. This session identifier will be sent to the server hosting
the frogans by the Frogans Player when the end-user reopens the
frogans; at that time, the PID or login and password would not be
requested by the Frogans Player nor sent to the server.
The attributes associated with the SESSION element are:
SESSID - Required
The session identifier for the slide. Is a case sensitive string
of alphanumeric characters: A-Z, a-z, 0-9, underscore, dash and
percent sign, without spaces. The string can contain up to 2048
characters.
Examples of accepted values:
SESSID="" (no session identifier)
SESSID="123"
SESSID="abc-ABC"
SESSID="abc_ABC"
SESSID="abc%20ABC"
SESSID="abc%2FABC"
Examples of refused values:
SESSID="abc ABC"
SESSID="abc/123"
SESSID="abc?123"
SESSID="abc=123"
SESSID="abc#123"
SESSID="abc:123"
SESSID="abc.123"
RETURN - Required
Indicates if the session identifier can be saved on the
end-user's system if the frogans is closed. Is not case
sensitive. A session identifier is saved only if the end-user
has added the frogans to his frogans favorites.
If the server hosting the frogans changes the session identifier
from slide to slide, the last identifier received from the
server is saved when the frogans is closed.
* "OFF" specifies that the session identifier cannot be
saved. If a previous session identifier has been saved, it
will be removed.
* "ON" specifies that the session identifier can be saved
STG Interactive Frogans Page [67]
FSDL 2.1 Frogans Slide Description Language May 2004
18. Planning for Statistics - STATS element
The STATS element indicates that a hit must be processed
automatically on a server used for collecting statistics about the
end-user's navigation on the frogans.
The hit is processed by the Frogans Player just before the slide is
displayed on the end-user's system.
The STATS element is placed between the start and end tags of the
FROGANS element. The STATS element does not contain any other
elements.
The STATS element is optional. Only one STATS element can be used in
the FSDL document.
When the Frogans Player receives a request from the end-user to
reload the slide, the hit will be processed again.
The attributes associated with the STATS element are:
HIT - Required
Denotes the type of hit to be processed. Is not case sensitive.
* "WEB" specifies a hit on a Web server
URL - Required
Applicable only if HIT="WEB"
The URL of a Web document requested by the Frogans Player.
The URL must begin with 'http://' and can contain up to 512
case sensitive characters.
The host specified in the URL cannot include a user or password
declaration. The URL cannot contain a fragment.
The & entity reference must be used in place of an ampersand
(&) in the URL. See 3.4. Character and Entity References.
If the frogans is published on the main frogans network or
another public frogans network, the server hosting the Web
document is accessed by the Frogans Player using public IP
addresses.
If the frogans is published on a private frogans network, the
server hosting the Web document is accessed by the Frogans
Player using private IP addresses.
STG Interactive Frogans Page [68]
FSDL 2.1 Frogans Slide Description Language May 2004
The hit is processed using HTTP 1.0 (RFC 1945) GET method. The
default port is port 80. The only request header fields sent by
the Frogans Player are: 'Pragma', 'User-Agent', 'Accept' and
'Host'.
The value of 'Pragma' is: 'no-cache'
The value of 'User-Agent' is: 'Frogans Player/x.y' where 'x.y'
indicates the release version of the Frogans Player.
Note: the value of 'User-Agent' of the Frogans Slide Publisher
is 'Frogans Slide Publisher/x.y' where 'x.y' indicates its
release version.
The value of 'Accept' is: '*/*'
No entity-header field is sent.
Response status code, response header fields, entity-header
fields (except 'Content-Length'), cache and time information,
cookies and the Web document content are not used by the Frogans
Player.
The Frogans Player can establish a connection through a proxy
server or a Socks server, version 4, version 4A or version 5.
See 19.3. Hosting a Frogans on a HTTP Server: Proxy.
The Web document's maximum size is 128 bytes.
The loading time of the Web document must not exceed 15 seconds,
otherwise the hit is cancelled.
Examples: see 14. BUTTON element
STG Interactive Frogans Page [69]
FSDL 2.1 Frogans Slide Description Language May 2004
19. Going On-line
19.1. Requesting Identifiers from End-users
The editor's use of PID or login and password requests is optional
and is transmitted through the frogans address.
When publishing a frogans on the main frogans network, the editor's
use of PID or login and password requests is specified in
'my account' on frogans.com (frogans address parameters).
A PID is a case sensitive string of alphanumeric characters: A-Z,
a-z, 0-9, without spaces. The string must contain between 6 and 16
characters.
A login is a case sensitive string of alphanumeric characters: A-Z,
a-z, 0-9, without spaces. The string must contain between 6 and 16
characters.
A password is a case sensitive string of alphanumeric characters:
A-Z, a-z, 0-9, without spaces. The string must contain between 6 and
16 characters.
The PID or login and password are entered by the end-user when he
opens the frogans, before its home slide is displayed.
The PID or login and password are sent to the server hosting the
frogans by the Frogans Player at the time of the request for the FSDL
document representing the home slide. The PID or login and password
will not be re-sent by the Frogans Player during navigation on the
frogans.
If the end-user indicates that he has no PID, the PID information
sent by the Frogans Player to the server hosting the frogans is
replaced by 'PID_UNKNOWN'.
If the end-user indicates that he has forgotten his PID, the PID
information sent by the Frogans Player to the server hosting the
frogans is replaced by 'PID_FORGOT'.
If the end-user indicates that he has no login and password, the
login and password information sent by the Frogans Player to the
server hosting the frogans is replaced by 'LOGIN_UNKNOWN' for the
login and 'PASSWORD_UNKNOWN' for the password.
If the end-user indicates that he has forgotten his login and
password, the login and password information sent by the Frogans
Player to the server hosting the frogans is replaced by
'LOGIN_FORGOT' for the login and 'PASSWORD_FORGOT' for the password.
STG Interactive Frogans Page [70]
FSDL 2.1 Frogans Slide Description Language May 2004
For more information about the way PID or login and password are sent
by the Frogans Player to the server hosting the frogans and security
considerations, see 19. Going On-line.
If the PID or login and password entered are not recognized by the
server, the return slide may contain a button to reopen the frogans.
See 14. BUTTON element. By clicking on this button, the end-user will
be asked to re-enter the PID or login and password.
If the frogans is in the end-user's frogans favorites and if a
session identifier was saved on the end-user's system during the last
visit, the PID or login and password are not requested and no PID or
login and password information will be sent by the Frogans Player to
the server. See 17. SESSION element.
There are two kinds of PID requests that can be used by the frogans
editor:
- PID Standard Request: the PID is requested for each frogans
independently from any other frogans, published on the same frogans
network, that have the same 'gatename' in their addresses.
- PID Grouped Request: the PID is requested for a chosen group of
frogans published on the same frogans network, that have the same
'gatename' in their addresses. The PID is requested when any of the
frogans in the group is being opened and will not be requested
again as long as one of those frogans remains open on screen.
When publishing frogans on the main frogans network, this group is
made up of frogans that have their End-user Authentication
parameter set to "PID Grouped Request" in 'my account' on
frogans.com (frogans address parameters).
Only one group can be defined for all the frogans published on a
frogans network that have the same 'gatename' in their addresses.
This function can be used by editors who permit the end-user to
access several frogans with the same PID.
There are two kinds of login and password requests that can be used
by the frogans editor:
- Login and Password Standard Request: the login and password are
requested for each frogans independently from any other frogans,
published on the same frogans network, that have the same
'gatename' in their addresses.
- Login and Password Grouped Request: the login and password are
requested for a chosen group of frogans published on the same
frogans network, that have the same 'gatename' in their addresses.
The login and password are requested when any of the frogans in the
STG Interactive Frogans Page [71]
FSDL 2.1 Frogans Slide Description Language May 2004
group is being opened and will not be requested again as long as
one of those frogans remains open on screen.
When publishing frogans on the main frogans network, this group is
made up of frogans that have their End-user Authentication
parameter set to "Login and Password Grouped Request" in
'my account' on frogans.com (frogans address parameters).
Only one group can be defined for all the frogans published on a
frogans network that have the same 'gatename' in their addresses.
This function can be used by editors who permit the end-user to
access several frogans with the same login and password.
For more information about the frogans address format, see 14.
ADDRESS attribute of the BUTTON element.
The Frogans Player does not save the PID or login and password on the
end-user's system. Only session identifiers can be saved on the end-
user's system. See 17. SESSION element.
19.2. Choosing a Network Protocol
The location of the frogans root directory on the Internet or a
private IP network and the file name of the home slide's FSDL
document are transmitted through the frogans address.
When publishing a frogans on the main frogans network, the location
of the frogans root directory on the Internet and the file name of
the home slide's FSDL document is specified in 'my account' on
frogans.com (frogans address parameters).
The server hosting the frogans must be able to communicate using a
network protocol recognized by the Frogans Player. The network
protocol is transmitted through the frogans address.
When publishing a frogans on the main frogans network, the network
protocol is specified in 'my account' on frogans.com (frogans address
parameters).
At the time of publication (May 2004), the Frogans Player only
recognizes the network protocol HTTP. For more information, see FNSL
specifications version 3.0 (10. Making a Lookup Record).
In the future, other network protocols may be recognized by the
Frogans Player to let the end-user benefit from new functions while
browsing frogans on the Internet or on private IP networks, or to
permit access from other devices and networks.
The addition of other protocols will be indicated in future releases
of the FNSL and FSDL specifications.
STG Interactive Frogans Page [72]
FSDL 2.1 Frogans Slide Description Language May 2004
19.3. Hosting a Frogans on a HTTP Server
If the frogans is published on the main frogans network or another
public frogans network, the server hosting the frogans is accessed by
the Frogans Player using public IP addresses.
If the frogans is published on a private frogans network, the server
hosting the frogans is accessed by the Frogans Player using private
IP addresses.
Hosting the frogans on a HTTP server does not need specific knowledge
of HTTP protocol, unless dynamic content is being delivered.
The Frogans Player applies the following HTTP protocol rules:
- Version: HTTP/1.0 (RFC 1945)
- Default port: 80
- Request method: GET or POST, depending on the type of file and the
context of the request.
When opening the frogans without a PID or login and password
request:
* if no session identifier was saved on the end-user's system
during the last visit, the method to request the FSDL document
representing the home slide of the frogans is GET.
* if a session identifier was saved on the end-user's system
during the last visit, the method to request the FSDL document
representing the home slide of the frogans is POST.
When opening the frogans with a PID or login and password
request:
* the method to request the FSDL document representing the home
slide of the frogans is POST.
During navigation on the frogans:
* If the requested file is an image file specified in a SETIMAGE
element and if no additional data is specified (DATA attribute
of the SETIMAGE element), the method is GET.
* If the requested file is an image file specified in a SETIMAGE
element and if additional data is specified (DATA attribute of
the SETIMAGE element), the method is POST.
STG Interactive Frogans Page [73]
FSDL 2.1 Frogans Slide Description Language May 2004
* If the requested file is an image file or a file to be
downloaded that is specified in a BUTTON element (where
GOTO="PIC" or GOTO="FILE") and if no additional data is
specified (DATA attribute of the BUTTON element), the method
is GET.
* If the requested file is an image file or a file to be
downloaded that is specified in a BUTTON element (where
GOTO="PIC" or GOTO="FILE") and if additional data is specified
(DATA attribute of the BUTTON element), the method is POST.
A FSDL document with additional data (DATA attribute) can be
specified in a BUTTON element (where GOTO="SLIDE") or in a NEXT
element or in a REDIRECT element:
* If there is no additional data nor session for the slide, the
method to request the FSDL document representing the slide is
GET.
* If there is additional data or session for the slide, the
method to request the FSDL document representing the slide is
POST.
For information about sessions, see 17. SESSION element.
- Request header fields:
The request header fields sent by the Frogans Player are:
'Pragma', 'User-Agent', 'Accept' and 'Host'.
The value of 'Pragma' is: 'no-cache'
The value of 'User-Agent' is: 'Frogans Player/x.y' where 'x.y'
indicates the release version of the Frogans Player.
Note: the value of 'User-Agent' of the Frogans Slide Publisher
is 'Frogans Slide Publisher/x.y' where 'x.y' indicates its
release version.
The value of 'Accept' is: '*/*'
The following request header fields are not sent by the Frogans
Player: 'Date', 'Authorization', 'From', 'If-Modified-Since',
'Referer', 'Accept-Charset', 'Accept-Encoding',
'Accept-Language' and 'MIME-Version'.
When GET method is used by the Frogans Player, no entity-header
field is sent.
STG Interactive Frogans Page [74]
FSDL 2.1 Frogans Slide Description Language May 2004
When POST method is used by the Frogans Player, the only
entity-header fields sent are: 'Content-Length' and
'Content-Type'.
The value of 'Content-Type' is:
'application/x-www-form-urlencoded'
Note: the Frogans Player does not URL encode any of the values
in the FSDL document. However, the values of the DATA attribute
(see 14. BUTTON element) and the SESSID attribute (see 16.
SESSION element) can contain URL encoded characters.
The following entity-header fields are not sent by the Frogans
Player: 'Allow', 'Content-Encoding', 'Expires', 'Last-Modified',
'Content-Language', 'Link', 'Title' and 'URI'.
- Data sent: only when POST method is used by the Frogans Player.
When opening the frogans:
* If there is a session for the home slide, data is sent in the
format 'session=value' where 'value' is the session identifier
saved on the end-user's system.
For example, if the saved session identifier is 'abc%20ABC',
the data sent is: 'session=abc%20ABC'.
* If a PID is requested from the end-user, data is sent in the
format 'pid=value' where 'value' is the PID.
For example, if the PID is 'LauraWhite22', the data sent is:
'pid=LauraWhite22'.
* If a login and password is requested from the end-user, data
is sent in the format 'login=value1&password=value2' where
'value1' is the login and 'value2' is the password.
For example, if the login is 'LauraWhite' and the password
is '123456789XML' the data sent is:
'login=LauraWhite&password=123456789XML'.
During navigation on the frogans:
* If there is a session for the slide, but no additional data,
data is sent in the format 'session=value' where 'value' is
the session identifier (SESSID attribute).
For example, if SESSID="abc%20ABC", the data sent is:
'session=abc%20ABC'.
STG Interactive Frogans Page [75]
FSDL 2.1 Frogans Slide Description Language May 2004
* If there is additional data, but no session for the slide,
data is sent in an ampersand separated list of items in the
'name=value' format. Items are taken from the DATA attribute's
value, in the order they appear.
For example, if DATA="name1=value1,name2=value2", the data
sent is: 'name1=value1&name2=value2'.
* If there is additional data and a session for the slide, data
is sent by joining the information with an ampersand (&). The
session data appears first.
For example, if DATA="name1=value1,name2=value2" and
SESSID="abc%20ABC", the data sent is:
'session=abc%20ABC&name1=value1&name2=value2'.
For more information about sessions, see 17. SESSION element.
Note: when the Frogans Player receives a request from the end-
user to reload a slide, it will re-send all the data for that
slide.
- Response Status Code: the only valid status codes recognized by the
Frogans Player are 200 (OK) and 201 (Created).
All other status codes, in particular 301 (Moved Permanently)
and 302 (Moved Temporarily), will lead to an error message
displayed in the frogans.
In order to redirect to another slide with the FSDL, see 16.
REDIRECT element.
- Response header fields:
The following response header fields are not used by the Frogans
Player: 'Date', 'Pragma', 'Location', 'Server',
'WWW-Authenticate', 'MIME-Version' and 'Retry-After'.
No other response header field is used by the Frogans Player.
The only entity-header field used by the Frogans Player is:
'Content-Length', if it is sent by the server.
The following entity-header fields are not used by the Frogans
Player: 'Allow', 'Content-Encoding', 'Content-Type', 'Expires',
'Last-Modified', 'Content-Language', 'Link', 'Title' and 'URI'.
STG Interactive Frogans Page [76]
FSDL 2.1 Frogans Slide Description Language May 2004
- Proxy:
The Frogans Player can establish a connection through a proxy
server. Authentication of the end-user on the proxy server is
supported using Basic Access Authentication (RFC 2617).
The Frogans Player can also establish a connection through a
Socks server, version 4, version 4A or version 5 (RFC 1928).
Authentication of the end-user on the Socks server is supported
using Username/Password Authentication (RFC 1929).
- Cache: not applicable
Cache and time information supplied by the server in the header
of the response are not used by the Frogans Player for managing
the cache on the end-user's system.
For more information about the cache, see 3.7. Cache.
- Cookies: not applicable
The HTTP State Management Mechanism (RFC 2109 and 2965) is not
supported by the Frogans Player.
To create and maintain a session with the FSDL, see 17. SESSION
element.
- Access Authentication: not applicable
Basic Access Authentication of HTTP/1.0 and the extension of
HTTP known as Digest Access Authentication (RFC 2617) are not
supported by the Frogans Player.
A basic authentication mechanism for the frogans can be created
by using information supplied by the end-user during navigation
on dedicated slides.
To allow access to the frogans with a PID or login and password,
see 19.1. Requesting Identifiers from End-users.
- Security: not applicable
The network protocol HTTP/1.0 is not secure as data is
transmitted in clear text across the physical network, between
the Frogans Player and the server hosting the frogans.
This protocol is not meant to be used when exchanging secured
data with the end-user.
STG Interactive Frogans Page [77]
FSDL 2.1 Frogans Slide Description Language May 2004
If PID or login and password are considered by the frogans
editor to be secured data, they should not be requested from the
end-user when using this protocol.
Future releases of the FSDL specifications may contain an
encryption mechanism (including certificate delivery) that would
be associated with the frogans addresses.
STG Interactive Frogans Page [78]
FSDL 2.1 Frogans Slide Description Language May 2004
20. Creating Short-cuts and Links to a Frogans
The end-user can open the frogans by entering the frogans address in
the Frogans Player, by selecting the address in a menu (favorites,
recently visited, family...), or by clicking on a button in another
frogans.
It is also possible to open the frogans by clicking on a frogans
short-cut or by following a hyperlink on a Web document, if the end-
user has already downloaded the Frogans Player.
Links to download the free Frogans Player on frogans.com can be
placed on any Web page, newsgroup, e-mail, etc.
A frogans short-cut can be hand-coded or it can be created
automatically using the Frogans Player.
Frogans short-cuts can be transmitted as attachments in e-mails and
saved on the end-user's system, to be reused at any time. Short-cuts
can be hosted on a HTTP server. See 20.2. Hosting Frogans Short-cuts
on a HTTP server.
20.1. Making a Frogans Short-cut File
A frogans short-cut is a file with the extension '.ltf' (leap to
frogans), which contains:
''
where 'value' is a frogans address. For more information about the
frogans address format, see 14. ADDRESS attribute of the BUTTON
element.
The encoding of the frogans short-cut file is UTF-8 (RFC 2279). An
optional BOM (Byte Order Mark) can be placed at the start of the
file.
The LEAPTOFROGANS element and the ADDRESS attribute are always
written in uppercase. The value of the ADDRESS attribute is delimited
by single or double quotation marks. Additional spaces can be placed
before or after the name of the ADDRESS attribute and before or after
the quotation marks of the value.
Text characters, comments and other elements cannot be placed before
or after the LEAPTOFROGANS element. They also cannot be contained
within the LEAPTOFROGANS element. The LEAPTOFROGANS element cannot be
written as ''. A XML
declaration is not accepted in the frogans short-cut file.
STG Interactive Frogans Page [79]
FSDL 2.1 Frogans Slide Description Language May 2004
20.2. Hosting Frogans Short-cuts on a HTTP Server
On any HTTP server, the extension '.ltf' can be associated with the
MIME type 'application/vnd.frogans.ltf' to create hyperlinks on a Web
page leading to a frogans.
Frogans short-cuts can also be delivered dynamically on a HTTP server
using a script. An example of HTML code for a hyperlink using the
script could be:
'frogans*GateName'
where 'www.SpecificDomainName.com' is the domain name of the server
hosting the script and 'scriptname' is the name of the script.
The hyperlink may be associated with an image, a script, or used
within a form.
The script specifications could be:
- Request parameters: 'address' (required)
- Request method: GET or POST
- If the value of the 'address' parameter is empty:
Response MIME type: 'text/html'
Response content (example):
'Leap to frogans error: missing "address" parameter'
- If the value of the 'address' parameter is not empty:
Response MIME type: 'application/vnd.frogans.ltf'
Response encoding: UTF-8
Response content:
''
where 'value' is the value of the 'address' parameter.
Editors with very large audiences must use this method to lead end-
users to their frogans, instead of using a leaptofrogans.net
hyperlink.
STG Interactive Frogans Page [80]
FSDL 2.1 Frogans Slide Description Language May 2004
20.3. Editing a leaptofrogans.net Hyperlink
Leaptofrogans.net is a service hosted by STG Interactive which is not
meant to be used by editors with very large audiences. See conditions
on frogans.com, as well as 20.2. Hosting Frogans Short-cuts on a HTTP
Server.
A leaptofrogans.net hyperlink is a link to a script which delivers
a frogans short-cut and leads the end-user to a frogans.
The URL format for the hyperlink is:
'http://leaptofrogans.net/?address=value'
where 'value' is a frogans address.
Example of HTML code for the hyperlink:
'
frogans*GateName'
The hyperlink can be associated with an image, a script, or used
within a form (form parameter is 'address', method is GET or POST).
STG Interactive Frogans Page [81]
FSDL 2.1 Frogans Slide Description Language May 2004
21. Working with the FSDL
The use of the FSDL specifications document and of the FSDL as a
markup language for developing frogans is subject to the following
terms and conditions. Under these terms and conditions, no user
declaration is required, nor is there any fee due to STG Interactive.
The limited permissions granted in the following terms and conditions
are perpetual and will not be revoked by STG Interactive or its
successors or assignees.
Any use which has not been explicitly laid out in the present
document is unauthorized except by prior written agreement from STG
Interactive. In particular, these terms and conditions do not allow
for the development of software to consult frogans (browser), no
matter what the operating system or end-user device is, nor do they
allow for the partial or total use of the FSDL for anything other
than the creation of FSDL documents for the publication of frogans on
the main frogans network or on dedicated frogans networks according
to the FSDL specifications.
Should any doubt arise about possible uses of the FSDL that have not
been specified under the present terms and conditions, please send
your question to: fsdl-use@frogans.com.
Should any doubt arise about the interpretation of the FSDL
specifications, please send your question to: fsdl@frogans.com.
Questions and answers will be posted on the frogans.com Web site in
the "Developers" section to complement the FSDL specifications, or
will be taken into account for future versions of the FSDL
specifications.
Frogans is a registered trademark of STG Interactive, in France, in
the United-States and other countries. STG Interactive permits the
use of the Frogans trademark as a reference relating to the FSDL and
the Frogans publishing technology, only in the context limited to the
uses which have been explicitly laid out in the present document. The
mention "Frogans is a registered trademark of STG Interactive" must
be included in the appropriate sections of any medium concerned and
in their documentation. Under no conditions can the Frogans trademark
be used by an individual or an organization to name a product or a
service, even one relating to the FSDL and the Frogans publishing
technology, except by prior written agreement from STG Interactive.
The following limitation of liability applies to all of the present
terms and conditions:
STG INTERACTIVE PROVIDES THE FSDL SPECIFICATIONS DOCUMENT FREE OF
CHARGE, "AS IS", WITH NO EXPRESS NOR IMPLIED WARRANTY OF ANY KIND,
INCLUDING WARRANTY OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE DEVELOPER, EITHER AN INDIVIDUAL OR AN ORGANIZATION,
STG Interactive Frogans Page [82]
FSDL 2.1 Frogans Slide Description Language May 2004
ACKNOWLEDGES THAT HE IS SOLELY RESPONSIBLE FOR QUALITY AND EFFECTS
RELATING TO THE USE OF THE FSDL SPECIFICATIONS DOCUMENT AND OF THE
FSDL AS A MARKUP LANGUAGE FOR DEVELOPING FROGANS.
EXCEPT AS OTHERWISE SPECIFIED BY LAW OR WRITTEN AGREEMENT, STG
INTERACTIVE SHALL NOT BE HELD LIABLE FOR ANY DAMAGES, DIRECT OR
INDIRECT, CONSEQUENTIAL OR OTHER (DAMAGES FOR LOSS OF BUSINESS
PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS INFORMATION, ETC.)
THAT MAY ARISE FROM THE USE OF OR INABILITY TO USE THE FSDL
SPECIFICATIONS DOCUMENT OR THE FSDL AS A MARKUP LANGUAGE FOR
DEVELOPING FROGANS.
STG Interactive is a "Societe Anonyme" incorporated under French Law
(RCS Paris B 428 738 546), whose headquarters are located at
29 avenue Mozart, 75016 Paris, France. Any difficulties arising from
the interpretation or conformance to the present terms and conditions
of use and all disputes relating to the use of the FSDL
specifications document and the FSDL as a markup language for
developing frogans shall be governed by French Law and the Paris
courts shall have sole jurisdiction.
21.1. Full Copyright Statement of the FSDL Specifications
Copyright (C) STG Interactive (2000-2004). All Rights Reserved.
Document URL: http://www.frogans.com/en/doc/FSDL21.txt
The FSDL specifications document can be freely reproduced, translated
into any language, in whole or in part, distributed to third parties,
by any means, in exchange for a fee paid by third parties or not, in
any country, provided that the copyright mention, the FSDL
specifications document's URL as it is written above and this
paragraph are included in all copies. The contents of the FSDL
specifications document cannot be modified in any manner, except for
the purpose of translation to a language other than English. If the
document has been translated, all copies shall bear the notice "free
translation" next to the title of the document. In all circumstances,
the original document published by STG Interactive, in its original
English version, prevails over any copy or translation that may
exist. STG Interactive disclaims all responsibility for reproductions
and translations, as well as their use by third parties.
The FSDL specifications document can be freely used to create and
distribute to third parties any derivative works aimed at informing
about or teaching how to publish frogans on the main frogans network
or on dedicated frogans networks with the FSDL, in any medium, in
exchange for a fee paid by third parties or not, in any language, in
any country, provided that they respect all the FSDL specifications
outlined in the present document and that the copyright mention, the
FSDL specifications document's URL as it is written above and this
paragraph are included in all derivative works and their copies. STG
Interactive disclaims all responsibility for derivative works and
STG Interactive Frogans Page [83]
FSDL 2.1 Frogans Slide Description Language May 2004
their use by third parties.
21.2. Use of the FSDL by Developers of Frogans
All developers, both individuals and organizations, can freely use
the FSDL to create FSDL documents for the publication of frogans on
the main frogans network or on dedicated frogans networks, for
themselves or for third parties, in exchange for a fee paid by third
parties or not, in any country, provided that they respect in all
circumstances, including when using an authoring tool to help create
FSDL documents, all the FSDL specifications outlined in the present
document. STG Interactive disclaims all responsibility for all FSDL
documents created by developers and their use by third parties.
21.3. Use of the FSDL by Publishers of Authoring Tools
All software publishers, both individuals and organizations, can
freely use the FSDL to create and distribute to third parties any
authoring tools to help create FSDL documents for the publication of
frogans on the main frogans network or on dedicated frogans networks,
for themselves or for third parties, in exchange for a fee paid by
third parties or not, in any country, provided that they respect all
the FSDL specifications outlined in the present document and that the
copyright mention, the FSDL specifications document's URL as it is
written above and this paragraph are included in all software license
agreements. STG Interactive disclaims all responsibility for any
authoring tools created by software publishers, and their use by
third parties.
21.4. Use of the FSDL by Publishers of Server Applications
All software publishers, both individuals and organizations, can
freely use the FSDL to create and distribute to third parties, any
server applications which permit FSDL documents to be delivered
dynamically for the publication of frogans on the main frogans
network or on dedicated frogans networks, for themselves or for third
parties, in exchange for a fee paid by third parties or not, in any
country, provided that they respect all the FSDL specifications
outlined in the present document and that the copyright mention, the
FSDL specifications document's URL as it is written above and this
paragraph are included in all software license agreements. STG
Interactive disclaims all responsibility for any server applications
created by software publishers, and their use by third parties.
STG Interactive Frogans Page [84]