Custom Apps : App Packages and App Files
App Packages and App Files
A custom app is defined by a set of files that you add to the MashZone NextGen Repository using the App Editor in MashZone NextGen Hub. These files are organized in an App package with this base folder structure:
This basic app package includes the following app files:
File Type
Default File Name
Description
App Specification
app.xml
This is an XML file that defines configuration and meta-data for the app. See the App Specification Reference for links to information on the elements you use in an App Spec.
HTML
html/app.html
This can be a full HTML page or just a fragment, such as a <div>, that renders the user interface for this app. It can have any file name.
index.html
This page is not required when users run apps, but is part of the standard package for custom app development. It allows you to run your custom app as you work with the code to test it within your own development environment and tools.
JavaScript libraries
js/app.js
This JavaScript file contains the code that you write specifically for this app.
other libraries as needed
You may include any other JavaScript libraries in an app including:
*Any JavaScript file within the folder tree of your app. You use a relative URL for these files. Relative paths cannot redirect up the folder tree.
*Common JavaScript frameworks or plug-in libraries that are hosted in MashZone NextGen including prototype, jQuery and many others. You simply identify these frameworks and libraries by name. MashZone NextGen handles all dependencies for named libraries.
*Other JavaScript frameworks or libraries hosted externally or internally using an absolute URL.
CSS
css/app.css
This CSS file contains the styles you define for your custom app.
You can include other CSS files in any folder within the app’s folder tree using a relative URL. Or you can include CSS files hosted externally or internally using an absolute URL.
Images
The standard development package for a custom app does not include any image files. You can include images for this app in any folder within the app’s folder tree using a relative URL.
Other
Files for other media or protocols as needed by your app. Like images, files for other media must reside in folders within the app package and use a relative URL.
You can get a starting app package by starting a new app in the App Editor and downloading this. See Create Custom Apps from the Base App Package for more information. Or you can download the app package for an existing app that you have opened in the App Editor.
In most cases, you update the app package and individual app resources in your own development environment, then zip up these updates and use this to update the app in MashZone NextGen. You can, however, add or remove files for apps in the App Editor. See Working in the App Editor for more information.
MashZone NextGen administrators can also manage files for apps from the Admin Console.
Copyright © 2013-2016 Software AG, Darmstadt, Germany.

Product LogoContact Support   |   Community   |   Feedback