project.xml
By editing the project.xml file, the various characteristics of the app can be customized.
The project.xml file opens in the Appspresso Configuration Editor which are formed in the various taps when the project.xml file is double clicked.
Common Tab
Define values using commonly on Android app , iOS app and W3C Widget(WAC).
- Start Page : Specifies application’s start page. Default value is index.html.
1. Plugin management
Add the Built-in Plugin.
Appspresso already has plugins that supports WAC API and Appspresso extend API. The plugins support WAC API that name starts with deviceapis. And the plugins support Appspresso extend API that name starts with ax.ext(Appspresso Framework Extension). Choose Built-In Plugin that want to use on Plugin List.
Add Plugin Project that user defined
Add Appspresso Plugin Project to Appspresso Application Project for build together. Press “Add Plugin Project” and select Appspresso Plugin Project’s path. If you want to know how to create Appspresso Plugin Project and develop plugin, please read Appspresso PDK page on homepage.
Add Plugin File that user defined
Add Appspresso Plugin that you or another people developed. Press “Add Plugin File ” and select Appspresso Plugin Archive file that has .axp extension. If you want to know how to create .axp file, please read Appspresso PDK page on homepage.
Remove Plugin
If plugin is built-in plugin, uncheck plugin that you want to remove. If plugin is user defined plugin, select plugin that you want to remove and press “Remove Plugin” (or Click right button on plugin then select “Remove Plugin”).
Show Plugin information
Double-click plugin on plugin list, or click right button on plugin then select “Show detailed information about the plugin.
2. Activate Features.
Feature is activate automatically when add plugin from plugin list and that plugin provides feature. If deactivate feature but add plugin, never use function from plugin.
Feature ID looks like URL, but this is not available site address. WAC API feature id starts with “http://wacapps.net/api” and Appspresso API feature id starts with “http://appspresso.com/api”.
※ Waikiki API 2.0 beta feature id starts with “http://waclists.org/api” but now starts with “http://wacapps.net/api”. If you see feature id starts with old style, please edit new style.
3. Using Widget Preference
Save key-value information. Running App can edit this information using W3C Widget Interface.
W3C Widget(WAC) tab
Define W3C Widget(WAC) setting values. This tab’s information uses for making config.xml file for W3C widget package(.wgt file).
If you want to know detail information about this setting, please read Widget Packaging and XML Configuration.
- ID : Identify widget. ID uses IRI style value.
- Version : This is widget version. User agent use this string value for widget update.
- Height : Specifies widget default view height. This integer value must be upper than 0.
- Width : Specifies widget default view width. This integer value must be upper than 0.
- Viewmodes : Show supported view modes. There’s floating, fullscreen, maximized, minimized and windowed modes. If you want to know more detail, please read The ‘view-mode’ media feature.
- Language : Specifies default language setting for widget. If you want to know more detail, please read IANA Language Subtag Registry.
- Name : Specifies name on menu or icons. It is possible to set for each language.
- Widget Icon : Specifies widget icon. Icon file source must be PNG, JPG(JPEG), GIF, SVG and ICO type. Show file name as relative path for “{project}/src.
- Description : Specifies widget description. It is possible to set for each language.
- License : Specifies software licence for widget package. It is possible to set for each language.
- Author : Specifies description of developer and his company.
Widget-Access
Define access to permitted network resource. If you want to know access setting, please read Widget Access Request Policy.
WAC
Specifies data about WAC.
iOS Tab
When building the projects with iOS app, select the characteristics being applied.
- ID : Bundle ID relevant rule specified by Apple is applied. The reverse domain form is recommended, and English letters, digits, -, . can only be used.
- Version : Specifies release version number.
- Certificate Name : Select the Developer certificate.
If you want to run the app in the iOS cell phone, you must register to the iOS Development Program of Apple and receive the developer certificate. Please refer to the getting started page for the detailed information.
※ In the preference page (Main menu> Preferences > Appspresso> iOS), if the certificate is selected, it is applied to all projects.
“Required” property must be set before when app builds.
- Bundle Version : The build version number identifies a particular internal build on an application bundle. This value, is increased by Appspresso studio automatically, uses for iTunes can update the App. If you want to update, this value must be bigger than previous one.
- Target Device : Choose target device that this app support. [iPhone, iPad, iPhone/iPad]
ID: Bundle ID relevant rule specified by Apple is applied. The reverse domain form is recommended, and English letters, digits, -, . can only be used.
“Advanced” property should be set when they need to change setting. This property’s value follows Apple’s default value.
- Application does not run in background : Application should exit when suspended to background. If check true, Application should exit when go to background. If check false, Application still runs on background.
- Enable WebView Cache : Specifies that use existing cached data or always use original source.
- Icon already includes gloss effects : Specifies whether the application’s icon already includes a shine effect. If you want to use icon’s original image, check true.
- Scales page to fit : The webpage scales to fit the view and the user can change the scale. If check true, user can change the scale of webpage using gesture. If check false, user can’t change scale of webpage and deny viewport meta tag properties.
- Splash Image Orientation : When Init the app, platform shows splash image. If you want make orientation for splash image, please check this option.
- Status bar is initially hidden : Specifies whether the status bar is initially hidden when the application launches. If you want to hide status bar, check true.
- Status bar style : Specifies the style of the status bar as the application launches. [Gray style, Transparent black style, Opaque black style]
- Supported App Orientation : Check the orientations what you want to rotate possible for the app.
※ If you want to edit App name, Icon and Splash image setting, Please see README file on “platforms/iOS” folder.
Android Tab
When building the projects with Android app, select the characteristics being applied.
- ID : Specifies App’s unique id that is same as Java package name. ID contains only alphanumeric (A-Z, a-z, 0-9) , underbar(_) and period (.) characters. The string should also be reverse DNS format and it starts with lower case alphabet.
- Version : Specifies release version number.
- Developer Sign Info
When running the program to test the app, sign it through using the basic included in the Android SDK. When you send the app as a .apk file to upload it onto the market, full keystore information is required.
※ Expiration date for debug keystore is 1 year. When it expires, an error occurs when you are building an app. In this case, you must delete the debug keystore and rebuild again. During the building process, a debug keystore with a year expiration date is automatically again created. The location of the debug keystore is as follows.
Windows XP: Documents and Settings\%username%\.android\debug.keystore
Above Vista: Users\%username%\.android\debug.keystore
OS X: ~/.android/debug.keystore
“Required” property must be set before when app builds.
- Activity Class Name : Specifies class name for the Java activity. Recommend that make distinction name between another App’s activity class.
- Min SDK Version : Specifies minimum API level required for the App to run. Android platform, smaller than this setting, can’t find App on market and can’t install.
- Target SDK Version :Specifies targeting API level for App. Android platform will provide earlier android feature for latest depending on this setting. This value should be bigger than “Min SDK Version” and smaller than “Max SDK Version”.
- Version Code : Specifies version code for the App. If you want to upgrade the App on market, please increase this value.
“Advanced” property should be set when they need to change setting.
- Application Orientation : Specifies the App orientation. Under Android API 8 did not supported Reverse Portrait and Reverse Landscape.
- Clear WebView Cache on Exit : Specifies when exits the App, clear the web view cache.
- Enable Cache : Specifies enable to use web view cache.
- Enable WebView Zoom : Specifies support web view zoom setting. If check true, user can change web view scale using gesture.
- Enable Zoom Controls : Specifies enable default zoom control button on Android browser. If check false on “Enable WebView Zoom” setting, this value was passed over.
- Install Location : If target SDK version is upper than API level 8, the App enable to Choose install location.
- Max SDK Version : Specifies maximum API level designed for the App to run. Appspresso recommend insert nothing on this section why latest android platform can find this App on market and can install. Insert something on this section may occur some android platform,that upper than this section level, can’t find this App on market and can’t install.
- Splash Image Minimum Duration : Specifies minimum time to show splash image. App will be launch after that time. If set “0″ on this section, splash image will disappear when app launch completely.
- Splash Image Orientation : When Init the app, platform shows splash image. If you want make orientation for splash image, please check this option
- Theme : Change the App’s given theme.
- Use Splash Image : Specifies enable to use splash image when App started. If you want to change splash file, please read README file on Android folder in each project. (path : /platforms/android/README)
- WebView Default Zoom : Choose web view’s zoom setting.
※ If you want to edit App name, Icon and Splash image setting, Please see README file on “platforms/Android” folder.
Source Tab
It is possible to see the source of project.xml. It is not permitted to directly edit.
