|
|
|
|
MioFactory
TechNotes
Help
JavaScriptLibraries
Products
|
|
The XML configuration file contains all the application settings that can be updated live.
This file can be updated manually or with Admin Panel.
You can add your own tags for the specific needs of your application.
To download the XML configuration file, see xml_settings_download
To retrieve the individual values of the settings, see mioxml_getElement
Minimum Tags
The following tags are required.
<MIOAPP>
<UPDATE version="nnn" url="...">
</MIOAPP>
The application can check if the version number in the configuration file is higher than the current version number.
See xml_settings_appUpdate for more information.
Standard Tags
<SEARCH></SEARCH>
| |
Specify a search URL for a search field if the application, if any.
The string [KEYWORDS] in the URL is replaced by the value of the search field as specified by the user.
|
<CHANNELS interval="..."></CHANNELS>
| |
This tag contains the list of default channels (or RSS feeds) to be used by the application.
This list of channels can be used in a scrolling ticker, a RSS newsreader, etc.
The attribute interval is the default refresh interval for all the channels, in minutes.
Each channel is defined as follow:
<ITEM url="..." value="n" cat="..." subCat="..." trackingID="...">title</ITEM>
| |
An item is a single RSS feed.
The title is the content of the tag.
Value can be set to one of the following values:
- 0: The feed is not selected, and the user can select it
- 1: The feed is selected, and the user can unselect it
- 2: The feed is selected and mandatory: the user cannot unselect it
Not all the applications make it possible for the end-user to select or unselect channels. If the user cannot select the feeds, value should be set to 1 for all the channels.
cat and subCat are used by some applications to categorize the list of channels in the dialog box where the user can enable or disable some of them.
trackingID is used to track the number of users who have downloaded this channel one time or more.
|
|
<LINKS></LINKS>
| |
This tag contains the list of links to external web sites provided to the end user.
This list of links can be available from a link menu, from the options menu or other depending on the application.
Each link is defined as follow:
<ITEM url="..." value="n">...</ITEM>
| |
The title of the link is defined by the content of the tag
|
|
<ALERTS interval="n"></ALERTS>
| |
This tag contains the list of sources of alerts to scan.
The attribute Interval is the default refresh interval for each alert, in minutes.
Each alert is defined as follow:
<ITEM url="..." id="..." optimized="..." forced="...">...</ITEM>
| |
The title of the alert is defined by the content of the tag
The attribute url is the root to the alert files.
The attribute ID can be used for any purpose. This attribute is used by Mioplanet Admin Panel to retrieve settings about an alert.
The attribute optimized can be set to yes for a feed using a version file to optimize the bandwidth, or no for a standard RSS feed.
Set this attribute to yes if the feed is an alert feed updated with Mioplanet Admin Panel or if you maintain a version file for your XML feed.
The attribute forced is used to define if the URL should be made unique by the alert engine.
If the attribute is set to 0, the original URL is preserved. The application may not view the latest version of the XML file and content delivery cannot be guaranteed in time, so do not use this value except if your feed cannot work with the other possible values.
If the attribute is set to 1, the string ?uid=N is concatenated at the end of the URL. N is an unique number, so the URL is unique.
If the attribute is set to 2, the string &uid=N is concatenated at the end of the URL. N is an unique number, so the URL is unique.
Use this value if your URL already contains arguments. When the & is used, the unique number is considered as an additional argument and the URL should work correctly.
|
|
<ADS interval="n"></ADS>
| |
This tag is used if your application displays ads.
.
The attribute interval is the default delay before another ad is displayed, in seconds.
Each ad is defined as follow:
<ITEM url="..." src="...">...</ITEM>
| |
The title of the tag, displayed when the mouse is over, is defined by the content of the tag
The attribute url is the web page to be opened when the user click on the ad.
The attribute src is the path to the image file (both GIF and JPG are supported).
The format of the image depends on the application.
|
|
<STATS></STATS>
| |
Used to send tracking information to a server.
<software id="...">...</software>
| |
URL of the server based script in charge of tracking the number of unique users.
id is the software ID.
|
<tracking gid="...">...</tracking>
| |
URL of the server based script in charge of tracking usage.
gid is the group ID. Software ID can be used as group ID.
|
|
<GENE_OMENU>...</GENE_OMENU>
| |
This tag is used to define the options menu available for the end users.
For more information: optionsMenu.js.
|
<ABOUT>...</ABOUT>
| |
This tag is the HTML code displayed in the about dialog box.
|
<TICKER dir="RTL|LTR"></TICKER>
| |
This tag is used if your application displays a scrolling ticker.
The attribute dir is the direction of the scrolling and can be RTL (right to left) or LTR (left to right).
<HEADER></HEADER>
| |
The content of this field defines the header of the scrolling text.
HTML is supported.
|
<TEMPLATE></TEMPLATE>
| |
The content of this field defines the HTML code to be used to display an headline.
|
<SEPARATOR></SEPARATOR>
| |
The content of this field defines the HTML code to be used as separator between headlines.
|
Special Tags
<APP_EX></APP_EX>
| |
The content of this tag is preserved by the Mioplanet Admin Panel and can be used to add tags specific to your application.
|
|
JavaScript Sample Code
<MIOAPP>
<UPDATE version="100" url="http://www..."></UPDATE>
<SEARCH url="http://www....?keywords=[KEYWORDS]"></SEARCH>
<CHANNELS interval="5">
<ITEM url="http://www...." value="0" cat="World" subcat="News">
<![CDATA[News from MyNewsChannel]]>
</ITEM>
<ITEM url="http://www...." value="0" cat="Sports" subcat="News">
<![CDATA[News from MySportsNewsChannel]]>
</ITEM>
</CHANNELS>
<LINKS>
<ITEM url="http://www.mioplanet.com/">Mioplanet.com</ITEM>
</LINKS>
<ADS interval="60">
<ITEM url="http://www...." src="http://....jpg">My Ad</ITEM>
</ADS>
<GENE_OMENU>101100</GENE_OMENU>
<ABOUT><![CDATA[Version 1.15<BR><BR>Copyright 2006]]></ABOUT>
</MIOAPP> |
|
|
|
